Class MapeoProject

Hierarchy

  • TypedEmitter
    • MapeoProject

Constructors

constructor

Properties

$blobs EMPTY_PROJECT_SETTINGS

Accessors

[kBlobStore] [kCoreManager] [kCoreOwnership] [kDataTypes] [kIsArchiveDevice] $icons $member $sync $translation deviceId field observation preset remoteDetectionAlert track

Methods

[kClearData] [kGeoJSONFileName] [kProjectLeave] [kProjectReplicate] [kSetIsArchiveDevice] [kSetOwnDeviceInfo] $getOwnRole $getProjectSettings $getStats $hasSyncedProjectSettings $originalVersionIdToDeviceId $setProjectSettings close exportGeoJSONFile exportZipFile importConfig ready

Constructors

constructor

  • new MapeoProject(opts): MapeoProject

  • Parameters

    • opts: {
          coreStorage: CoreStorage;
          dbPath: string;
          encryptionKeys: EncryptionKeys;
          getFallbackProjectInfo: (() => undefined | ProjectInfo);
          getMediaBaseUrl: ((mediaType: "blobs" | "icons") => Promise<string>);
          isArchiveDevice: boolean;
          keyManager: KeyManager;
          localPeers: LocalPeers;
          logger: undefined | Logger;
          makeWebsocket: undefined | ((url: string) => WebSocket);
          projectKey: Buffer;
          projectMigrationsFolder: string;
          projectSecretKey: undefined | Buffer;
          sharedDb: BetterSQLite3Database<Record<string, never>, any>;
          sharedIndexWriter: IndexWriter<MapeoDocTables>;
      }
      • coreStorage: CoreStorage

        Folder to store all hypercore data

      • dbPath: string

        Path to store project sqlite db. Use :memory: for memory storage

      • encryptionKeys: EncryptionKeys

        Encryption keys for each namespace

      • getFallbackProjectInfo: (() => undefined | ProjectInfo)
      • getMediaBaseUrl: ((mediaType: "blobs" | "icons") => Promise<string>)
          • (mediaType): Promise<string>

          • Parameters

            • mediaType: "blobs" | "icons"

            Returns Promise<string>

      • isArchiveDevice: boolean

        Whether this device is an archive device

      • keyManager: KeyManager

        mapeo/crypto KeyManager instance

      • localPeers: LocalPeers
      • logger: undefined | Logger
      • makeWebsocket: undefined | ((url: string) => WebSocket)
      • projectKey: Buffer

        32-byte public key of the project creator core

      • projectMigrationsFolder: string

        path for drizzle migration folder for project

      • projectSecretKey: undefined | Buffer

        32-byte secret key of the project creator core

      • sharedDb: BetterSQLite3Database<Record<string, never>, any>
      • sharedIndexWriter: IndexWriter<MapeoDocTables>

    Returns MapeoProject

Properties

$blobs

$blobs: BlobApi

StaticEMPTY_PROJECT_SETTINGS

EMPTY_PROJECT_SETTINGS: Readonly<{
    sendStats: false;
}> = EMPTY_PROJECT_SETTINGS

Accessors

[kBlobStore]

[kCoreManager]

[kCoreOwnership]

[kDataTypes]

[kIsArchiveDevice]

  • get [kIsArchiveDevice](): boolean

  • Returns boolean

$icons

$member

$sync

$translation

deviceId

  • get deviceId(): string

  • Returns string

field

observation

preset

remoteDetectionAlert

track

Methods

[kClearData]

  • [kClearData](): Promise<void>

  • Clear synced data, but keep auth data and own data

    Returns Promise<void>

[kGeoJSONFileName]

  • [kGeoJSONFileName](observations, tracks): Promise<string>

  • Parameters

    • observations: boolean
    • tracks: boolean

    Returns Promise<string>

[kProjectLeave]

  • [kProjectLeave](): Promise<void>

  • Returns Promise<void>

[kProjectReplicate]

  • [kProjectReplicate](isInitiatorOrStream): ReplicationStream

  • Replicate a project to a @hyperswarm/secret-stream. Invites will not function because the RPC channel is not connected for project replication, and only this project will replicate.

    Parameters

    • isInitiatorOrStream: boolean | Duplex | Duplex<any, any, any, any, true, true, DuplexEvents<any, any>>

    Returns ReplicationStream

[kSetIsArchiveDevice]

  • [kSetIsArchiveDevice](isArchiveDevice): Promise<void>

  • Parameters

    • isArchiveDevice: boolean

    Returns Promise<void>

[kSetOwnDeviceInfo]

  • [kSetOwnDeviceInfo](value): Promise<{}>

  • Parameters

    • value: Pick<{}, "name" | "deviceType" | "selfHostedServerDetails">

    Returns Promise<{}>

$getOwnRole

  • $getOwnRole(): Promise<Role<
        | "a12a6702b93bd7ff"
        | "f7c150f5a3a9a855"
        | "012fd2d431c0bf60"
        | "9e6d29263cba36c9"
        | "8ced989b1904606b"
        | "08e4251e36f6e7ed">>

  • Returns Promise<Role<
        | "a12a6702b93bd7ff"
        | "f7c150f5a3a9a855"
        | "012fd2d431c0bf60"
        | "9e6d29263cba36c9"
        | "8ced989b1904606b"
        | "08e4251e36f6e7ed">>

$getProjectSettings

$getStats

$hasSyncedProjectSettings

  • $hasSyncedProjectSettings(): Promise<boolean>

  • Returns Promise<boolean>

$originalVersionIdToDeviceId

  • $originalVersionIdToDeviceId(originalVersionId): Promise<string>

  • Parameters

    • originalVersionId: string

      The originalVersionId from a document.

    Returns Promise<string>

    The device ID for this creator.

    Deprecated

    Throws

    When device ID cannot be found.

$setProjectSettings

close

  • close(): Promise<void>

  • Returns Promise<void>

exportGeoJSONFile

  • exportGeoJSONFile(exportFolder, options?): Promise<string>

  • Export observations and or tracks as a GeoJSON file

    Parameters

    • exportFolder: string

      Path to save the file. The file name is auto-generated

    • Optionaloptions: {
          lang: undefined | string;
          observations: undefined | boolean;
          tracks: undefined | boolean;
      } = {}
      • lang: undefined | string
      • observations: undefined | boolean

        Whether observations should be exported

      • tracks: undefined | boolean

        Whether all tracks and their observations should be exported

    Returns Promise<string>

    The full path that the file was exported at

exportZipFile

  • exportZipFile(exportFolder, options?): Promise<string>

  • Export observations, tracks, and or attachments as a zip file.

    Parameters

    • exportFolder: string

      Path to save the file. The file name is auto-generated

    • Optionaloptions: {
          attachments: undefined | boolean;
          lang: undefined | string;
          observations: undefined | boolean;
          tracks: undefined | boolean;
      } = {}
      • attachments: undefined | boolean

        Whether all attachments for observations should be exported

      • lang: undefined | string
      • observations: undefined | boolean

        Whether observations should be exported

      • tracks: undefined | boolean

        Whether all tracks and their observations should be exported

    Returns Promise<string>

    The full path that the file was exported at

importConfig

  • importConfig(opts): Promise<Error[]>

  • Parameters

    • opts: {
          configPath: string;
      }
      • configPath: string

    Returns Promise<Error[]>

ready

  • ready(): Promise<void>

  • Resolves when hypercores have all loaded

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods