Class MapeoManager

Hierarchy

  • TypedEmitter
    • MapeoManager

Constructors

constructor

Accessors

[kRPC] deviceId invite

Methods

[kManagerReplicate] addProject connectLocalPeer createProject getDeviceInfo getMapStyleJsonUrl getProject leaveProject listLocalPeers listProjects onBackgrounded onForegrounded setDeviceInfo startLocalPeerDiscoveryServer stopLocalPeerDiscoveryServer

Constructors

constructor

  • new MapeoManager(opts): MapeoManager

  • Parameters

    • opts: {
          clientMigrationsFolder: string;
          coreStorage: string | CoreStorage;
          dbFolder: string;
          defaultConfigPath: undefined | string;
          fastify: FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>;
          projectMigrationsFolder: string;
          rootKey: Buffer;
      }
      • clientMigrationsFolder: string

        path for drizzle migrations folder for client database

      • coreStorage: string | CoreStorage

        Folder for hypercore storage or a function that returns a RandomAccessStorage instance

      • dbFolder: string

        Folder for sqlite Dbs. Folder must exist. Use ':memory:' to store everything in-memory

      • defaultConfigPath: undefined | string
      • fastify: FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>

        Fastify server instance

      • projectMigrationsFolder: string

        path for drizzle migrations folder for project database

      • rootKey: Buffer

        16-bytes of random data that uniquely identify the device, used to derive a 32-byte master key, which is used to derive all the keypairs used for Mapeo

    Returns MapeoManager

Accessors

[kRPC]

deviceId

  • get deviceId(): string

  • Returns string

invite

Methods

[kManagerReplicate]

  • [kManagerReplicate](isInitiator): ReplicationStream

  • Create a Mapeo replication stream. This replication connects the Mapeo RPC channel and allows invites. All active projects will sync automatically to this replication stream. Only use for local (trusted) connections, because the RPC channel key is public. To sync a specific project without connecting RPC, use project[kProjectReplication].

    Parameters

    • isInitiator: boolean

    Returns ReplicationStream

addProject

  • addProject(projectJoinDetails, opts?): Promise<string>

  • Add a project to this device. After adding a project the client should await project.$waitForInitialSync() to ensure that the device has downloaded their proof of project membership and the project config.

    Parameters

    • projectJoinDetails: Pick<ProjectJoinDetails, "projectKey" | "encryptionKeys"> & {
          projectName: string;
      }
    • Optionalopts: {
          waitForSync?: boolean;
      } = {}

      For internal use in tests, set opts.waitForSync = false to not wait for sync during addProject()

      • OptionalwaitForSync?: boolean

    Returns Promise<string>

connectLocalPeer

  • connectLocalPeer(peer): void

  • Parameters

    • peer: {
          address: string;
          name: string;
          port: number;
      }
      • address: string
      • name: string
      • port: number

    Returns void

createProject

  • createProject(options?): Promise<string>

  • Create a new project.

    Parameters

    • Optionaloptions: {
          configPath?: string;
      } = {}
      • OptionalconfigPath?: string

    Returns Promise<string>

    Project public id

getDeviceInfo

getMapStyleJsonUrl

  • getMapStyleJsonUrl(): Promise<string>

  • Returns Promise<string>

getProject

leaveProject

  • leaveProject(projectPublicId): Promise<void>

  • Parameters

    • projectPublicId: string

    Returns Promise<void>

listLocalPeers

listProjects

  • listProjects(): Promise<(Pick<{}, "name"> & {
        createdAt?: string;
        projectId: string;
        updatedAt?: string;
    })[]>

  • Returns Promise<(Pick<{}, "name"> & {
        createdAt?: string;
        projectId: string;
        updatedAt?: string;
    })[]>

onBackgrounded

  • onBackgrounded(): void

  • Call this when the app goes into the background.

    Will gracefully shut down sync.

    Returns void

    See

    onForegrounded

onForegrounded

  • onForegrounded(): void

  • Call this when the app goes into the foreground.

    Will undo the effects of onBackgrounded.

    Returns void

    See

    onBackgrounded

setDeviceInfo

  • setDeviceInfo<T>(deviceInfo): Promise<void>

  • Type Parameters

    • T extends DeviceInfoParam & {
          deviceType?:
              | "UNRECOGNIZED"
              | "device_type_unspecified"
              | "mobile"
              | "tablet"
              | "desktop";
      } | ExactObject<DeviceInfoParam & {
          deviceType?:
              | "UNRECOGNIZED"
              | "device_type_unspecified"
              | "mobile"
              | "tablet"
              | "desktop";
      }, T>

    Parameters

    • deviceInfo: T

    Returns Promise<void>

startLocalPeerDiscoveryServer

  • startLocalPeerDiscoveryServer(): Promise<{
        name: string;
        port: number;
    }>

  • Returns Promise<{
        name: string;
        port: number;
    }>

stopLocalPeerDiscoveryServer

  • stopLocalPeerDiscoveryServer(opts?): Promise<void>

  • Close all servers and stop multicast advertising and browsing. Will wait for open sockets to close unless opts.force=true in which case open sockets are force-closed after opts.timeout milliseconds

    Parameters

    • Optionalopts: {
          force: undefined | boolean;
          timeout: undefined | number;
      }
      • force: undefined | boolean

        Force-close open sockets after timeout milliseconds

      • timeout: undefined | number

        Optional timeout when calling stop() with force=true

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods