@comapeo/core 1.0.0

package/dist/mapeo-project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapeo-project.d.ts","sourceRoot":"","sources":["../src/mapeo-project.js"],"names":[],"mappings":"AA2DA,yCAAiD;AACjD,2CAAqD;AACrD,8CAA4D;AAC5D,uCAA6C;AAC7C,8CAA4D;AAC5D,uCAA6C;AAC7C,0CAAoD;AACpD,6CAAoE;AAIpE;;GAEG;AACH;WAFmC,MAAM,IAAI;;IAsB3C,4CAAsD;IAEtD;;;;;;;;;;;;;;;OAeG;IACH,2LAdG;QAAqB,MAAM,EAAnB,MAAM;QACO,uBAAuB,EAApC,MAAM;QACmC,UAAU,EAAnD,2CAAkC;QACrB,UAAU,EAAvB,MAAM;QACQ,gBAAgB;QACqB,cAAc,EAAjE,OAAO,qBAAqB,EAAE,cAAc;QACqB,QAAQ,EAAzE,OAAO,4BAA4B,EAAE,qBAAqB;QACxC,iBAAiB,EAAnC,WAAW;QACO,WAAW,EAA7B,WAAW;QAC6C,eAAe,EAAvE,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC;QACL,UAAU,EAAtD,OAAO,kBAAkB,EAAE,UAAU;QACvB,MAAM;KAE9B,EAqRA;IAxEC,gBASE;IA0FJ,uBAEC;IAED;;;;OAIG;IACH,SAFa,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;OACG;IACH,uBAYC;IA+CD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCA1a+B,CAAC;wCAI/B,CAAC;;wCAkBG,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAhCR,oEAAoE;YAEpE,kFAAkF;YAClF,uEAAuE;YAEvE,CALA,CAAA,oEAAoE;oBAAzC,CAAC;6BAAsC,CAAA;4BAKrD,CAAC;4BAKmB,CAAC;gCAI/B,CAAC;;gCAkBG,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAhCR,oEAAoE;YAEpE,kFAAkF;YAClF,uEAAuE;YAEvE,CALA,CAAA,oEAAoE;oBAAzC,CAAC;6BAAsC,CAAA;4BAKrD,CAAC;4BAKmB,CAAC;gCAI/B,CAAC;;gCAkBG,CAAC;;;;;;;OAsZL;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAEC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAEC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAEC;IAED,yBAEC;IAED,qBAEC;IAED,mCAEC;IAED;;;OAGG;IACH,8BAHW,OAAO,CAAC,uBAAuB,CAAC,GAC9B,OAAO,CAAC,uBAAuB,CAAC,CA6B5C;IAED;;OAEG;IACH,uBAFa,OAAO,CAAC,uBAAuB,CAAC,CAW5C;IAED,+KAEC;IAED;;;;OAIG;IACH,gDAJW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAU3B;IAoDD;;OAEG;IACH,sBAEC;IAsFD;;;OAGG;IACH,6BAHI;QAAqB,UAAU,EAAvB,MAAM;KACd,GAAU,OAAO,CAAC,KAAK,EAAE,CAAC,CAkK7B;IA9eD;;OAEG;IACH,kCAEC;IAED;;OAEG;IACH,sCAEC;IAED;;OAEG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wCAxV+B,CAAC;4CAI/B,CAAC;;4CAkBG,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAhCR,oEAAoE;gBAEpE,kFAAkF;gBAClF,uEAAuE;gBAEvE,CALA,CAAA,oEAAoE;wBAAzC,CAAC;iCAAsC,CAAA;gCAKrD,CAAC;gCAKmB,CAAC;oCAI/B,CAAC;;oCAkBG,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAhCR,oEAAoE;gBAEpE,kFAAkF;gBAClF,uEAAuE;gBAEvE,CALA,CAAA,oEAAoE;wBAAzC,CAAC;iCAAsC,CAAA;gCAKrD,CAAC;gCAKmB,CAAC;oCAI/B,CAAC;;oCAkBG,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAoUL;IAED,8BAEC;IAsKD;;;;;;;OAOG;IACH,4BAFW,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;;;;+HAezD;IAED;;;OAGG;IACH,2BAHW,IAAI,CAAC,OAAO,iBAAiB,EAAE,eAAe,EAAE,MAAM,GAAG,YAAY,CAAC,GACpE,OAAO,CAAC,OAAO,iBAAiB,EAAE,UAAU,CAAC,CAuBzD;IA6CD,iCAMC;IAED;;;OAGG;IACH,sBAFa,OAAO,CAAC,IAAI,CAAC,CAoCzB;;CAuKF;sCA9zBa,IAAI,CAAC,oBAAoB,EAAE,YAAY,CAAC;6BACxC,oBAAoB,CAAC,gBAAgB,CAAC;6BAjDvB,oBAAoB;wBAOzB,eAAe;0BAHb,sBAAsB;yBACL,qBAAqB;0BAkCtC,iBAAiB;wBACE,oBAAoB;2BAItC,sBAAsB;wBAFzB,eAAe;4BAvCX,yBAAyB;8BAsB9C,qBAAqB;0BAnBF,uBAAuB;4BAErB,yBAAyB;iCAsCA,YAAY;uBAL1C,aAAa;0CAIM,iBAAiB"}

package/dist/member-api.d.ts

@@ -0,0 +1,114 @@
+/**
+ * @import {
+ *   DeviceInfo,
+ *   DeviceInfoValue,
+ *   ProjectSettings,
+ *   ProjectSettingsValue
+ * } from '@comapeo/schema'
+ */
+/** @import { Invite, InviteResponse } from './generated/rpc.js' */
+/** @import { DataType } from './datatype/index.js' */
+/** @import { DataStore } from './datastore/index.js' */
+/** @import { deviceInfoTable } from './schema/project.js' */
+/** @import { projectSettingsTable } from './schema/client.js' */
+/** @typedef {DataType<DataStore<'config'>, typeof deviceInfoTable, "deviceInfo", DeviceInfo, DeviceInfoValue>} DeviceInfoDataType */
+/** @typedef {DataType<DataStore<'config'>, typeof projectSettingsTable, "projectSettings", ProjectSettings, ProjectSettingsValue>} ProjectDataType */
+/**
+ * @typedef {object} MemberInfo
+ * @prop {string} deviceId
+ * @prop {import('./roles.js').Role} role
+ * @prop {DeviceInfo['name']} [name]
+ * @prop {DeviceInfo['deviceType']} [deviceType]
+ * @prop {DeviceInfo['createdAt']} [joinedAt]
+ */
+export class MemberApi extends TypedEmitter<import("tiny-typed-emitter").DefaultListener> {
+    /**
+     * @param {Object} opts
+     * @param {string} opts.deviceId public key of this device as hex string
+     * @param {import('./roles.js').Roles} opts.roles
+     * @param {import('./core-ownership.js').CoreOwnership} opts.coreOwnership
+     * @param {import('./generated/keys.js').EncryptionKeys} opts.encryptionKeys
+     * @param {Buffer} opts.projectKey
+     * @param {import('./local-peers.js').LocalPeers} opts.rpc
+     * @param {Object} opts.dataTypes
+     * @param {Pick<DeviceInfoDataType, 'getByDocId' | 'getMany'>} opts.dataTypes.deviceInfo
+     * @param {Pick<ProjectDataType, 'getByDocId'>} opts.dataTypes.project
+     */
+    constructor({ deviceId, roles, coreOwnership, encryptionKeys, projectKey, rpc, dataTypes, }: {
+        deviceId: string;
+        roles: import("./roles.js").Roles;
+        coreOwnership: import("./core-ownership.js").CoreOwnership;
+        encryptionKeys: import("./generated/keys.js").EncryptionKeys;
+        projectKey: Buffer;
+        rpc: import("./local-peers.js").LocalPeers;
+        dataTypes: {
+            deviceInfo: Pick<DeviceInfoDataType, "getByDocId" | "getMany">;
+            project: Pick<ProjectDataType, "getByDocId">;
+        };
+    });
+    /**
+     * Send an invite. Resolves when receiving a response. Rejects if the invite
+     * is canceled, or if something else goes wrong.
+     *
+     * @param {string} deviceId
+     * @param {Object} opts
+     * @param {import('./roles.js').RoleIdForNewInvite} opts.roleId
+     * @param {string} [opts.roleName]
+     * @param {string} [opts.roleDescription]
+     * @returns {Promise<(
+     *   typeof InviteResponse_Decision.ACCEPT |
+     *   typeof InviteResponse_Decision.REJECT |
+     *   typeof InviteResponse_Decision.ALREADY
+     * )>}
+     */
+    invite(deviceId: string, { roleId, roleName, roleDescription }: {
+        roleId: import("./roles.js").RoleIdForNewInvite;
+        roleName?: string | undefined;
+        roleDescription?: string | undefined;
+    }): Promise<(typeof InviteResponse_Decision.ACCEPT | typeof InviteResponse_Decision.REJECT | typeof InviteResponse_Decision.ALREADY)>;
+    /**
+     * Attempt to cancel an outbound invite, if it exists.
+     *
+     * No-op if we weren't inviting this device.
+     *
+     * @param {string} deviceId
+     * @returns {void}
+     */
+    requestCancelInvite(deviceId: string): void;
+    /**
+     * @param {string} deviceId
+     * @returns {Promise<MemberInfo>}
+     */
+    getById(deviceId: string): Promise<MemberInfo>;
+    /**
+     * @returns {Promise<Array<MemberInfo>>}
+     */
+    getMany(): Promise<Array<MemberInfo>>;
+    /**
+     * @param {string} deviceId
+     * @param {import('./roles.js').RoleIdAssignableToOthers} roleId
+     * @returns {Promise<void>}
+     */
+    assignRole(deviceId: string, roleId: import("./roles.js").RoleIdAssignableToOthers): Promise<void>;
+    #private;
+}
+export type DeviceInfoDataType = DataType<DataStore<"config">, typeof deviceInfoTable, "deviceInfo", DeviceInfo, DeviceInfoValue>;
+export type ProjectDataType = DataType<DataStore<"config">, typeof projectSettingsTable, "projectSettings", ProjectSettings, ProjectSettingsValue>;
+export type MemberInfo = {
+    deviceId: string;
+    role: import("./roles.js").Role;
+    name?: string | undefined;
+    deviceType?: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | undefined;
+    joinedAt?: string | undefined;
+};
+import { TypedEmitter } from 'tiny-typed-emitter';
+import { InviteResponse_Decision } from './generated/rpc.js';
+import type { DataStore } from './datastore/index.js';
+import type { deviceInfoTable } from './schema/project.js';
+import type { DeviceInfo } from '@comapeo/schema';
+import type { DeviceInfoValue } from '@comapeo/schema';
+import type { DataType } from './datatype/index.js';
+import type { projectSettingsTable } from './schema/client.js';
+import type { ProjectSettings } from '@comapeo/schema';
+import type { ProjectSettingsValue } from '@comapeo/schema';
+//# sourceMappingURL=member-api.d.ts.map

package/dist/member-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"member-api.d.ts","sourceRoot":"","sources":["../src/member-api.js"],"names":[],"mappings":"AAcA;;;;;;;GAOG;AACH,mEAAmE;AACnE,sDAAsD;AACtD,wDAAwD;AACxD,6DAA6D;AAC7D,iEAAiE;AAEjE,qIAAqI;AACrI,sJAAsJ;AACtJ;;;;;;;GAOG;AAEH;IAYE;;;;;;;;;;;OAWG;IACH,6FAVG;QAAqB,QAAQ,EAArB,MAAM;QAC2B,KAAK,EAAtC,OAAO,YAAY,EAAE,KAAK;QACwB,aAAa,EAA/D,OAAO,qBAAqB,EAAE,aAAa;QACQ,cAAc,EAAjE,OAAO,qBAAqB,EAAE,cAAc;QAC/B,UAAU,EAAvB,MAAM;QACsC,GAAG,EAA/C,OAAO,kBAAkB,EAAE,UAAU;QACxB,SAAS,EAC9B;YAA2E,UAAU,EAA7E,IAAI,CAAC,kBAAkB,EAAE,YAAY,GAAG,SAAS,CAAC;YACE,OAAO,EAA3D,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC;SAC7C;KAAA,EAkBA;IAED;;;;;;;;;;;;;;OAcG;IACH,iBAXW,MAAM,yCAEd;QAAsD,MAAM,EAApD,OAAO,YAAY,EAAE,kBAAkB;QACzB,QAAQ;QACR,eAAe;KACrC,GAAU,OAAO,CAAC,CACpB,OAAW,uBAAuB,CAAC,MAAM,GACzC,OAAW,uBAAuB,CAAC,MAAM,GACzC,OAAW,uBAAuB,CAAC,OAAO,CACvC,CAAC,CAkFJ;IAmDD;;;;;;;OAOG;IACH,8BAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;OAGG;IACH,kBAHW,MAAM,GACJ,OAAO,CAAC,UAAU,CAAC,CA4B/B;IAED;;OAEG;IACH,WAFa,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAmCtC;IAED;;;;OAIG;IACH,qBAJW,MAAM,UACN,OAAO,YAAY,EAAE,wBAAwB,GAC3C,OAAO,CAAC,IAAI,CAAC,CAIzB;;CACF;iCAlSa,SAAS,UAAU,QAAQ,CAAC,EAAE,sBAAsB,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,CAAC;8BAChG,SAAS,UAAU,QAAQ,CAAC,EAAE,2BAA2B,EAAE,iBAAiB,EAAE,eAAe,EAAE,oBAAoB,CAAC;;cAGxH,MAAM;UACN,OAAO,YAAY,EAAE,IAAI;;;;;6BAhCN,oBAAoB;wCAET,oBAAoB;+BAqB7B,sBAAsB;qCAChB,qBAAqB;gCALhD,iBAAiB;qCAAjB,iBAAiB;8BAGG,qBAAqB;0CAGT,oBAAoB;qCANpD,iBAAiB;0CAAjB,iBAAiB"}

package/dist/roles.d.ts

@@ -0,0 +1,157 @@
+/** @import { Namespace } from './types.js' */
+export const CREATOR_ROLE_ID: "a12a6702b93bd7ff";
+export const COORDINATOR_ROLE_ID: "f7c150f5a3a9a855";
+export const MEMBER_ROLE_ID: "012fd2d431c0bf60";
+export const BLOCKED_ROLE_ID: "9e6d29263cba36c9";
+export const LEFT_ROLE_ID: "8ced989b1904606b";
+export const NO_ROLE_ID: "08e4251e36f6e7ed";
+export const isRoleIdForNewInvite: (value: unknown) => value is "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9";
+export const isRoleIdAssignableToOthers: (value: unknown) => value is "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9";
+/**
+ * @typedef {object} DocCapability
+ * @property {boolean} readOwn - can read own data
+ * @property {boolean} writeOwn - can write own data
+ * @property {boolean} readOthers - can read other's data
+ * @property {boolean} writeOthers - can edit or delete other's data
+ */
+/**
+ * @template {RoleId} [T=RoleId]
+ * @typedef {object} Role
+ * @property {T} roleId
+ * @property {string} name
+ * @property {Record<import('@comapeo/schema').MapeoDoc['schemaName'], DocCapability>} docs
+ * @property {RoleIdAssignableToOthers[]} roleAssignment
+ * @property {Record<Namespace, 'allowed' | 'blocked'>} sync
+ */
+/**
+ * This is currently the same as 'Coordinator' role, but defined separately
+ * because the creator should always have ALL powers, but we could edit the
+ * 'Coordinator' powers in the future.
+ *
+ * @type {Role<typeof CREATOR_ROLE_ID>}
+ */
+export const CREATOR_ROLE: Role<typeof CREATOR_ROLE_ID>;
+/**
+ * This is the role assumed for a device when no role record can be found. This
+ * can happen when an invited device did not manage to sync with the device that
+ * invited them, and they then try to sync with someone else. We want them to be
+ * able to sync the auth and config store, because that way they may be able to
+ * receive their role record, and they can get the project config so that they
+ * can start collecting data.
+ *
+ * @type {Role<typeof NO_ROLE_ID>}
+ */
+export const NO_ROLE: Role<typeof NO_ROLE_ID>;
+/** @type {{ [K in RoleId]: Role<K> }} */
+export const ROLES: { [K in RoleId]: Role<K>; };
+/**
+ * @typedef {object} RolesEvents
+ * @property {(docIds: Set<string>) => void} update Emitted when new role records are indexed
+ */
+/**
+ * @extends {TypedEmitter<RolesEvents>}
+ */
+export class Roles extends TypedEmitter<RolesEvents> {
+    static NO_ROLE: Role<"08e4251e36f6e7ed">;
+    /**
+     *
+     * @param {object} opts
+     * @param {import('./datatype/index.js').DataType<
+     *   import('./datastore/index.js').DataStore<'auth'>,
+     *   typeof import('./schema/project.js').roleTable,
+     *   'role',
+     *   import('@comapeo/schema').Role,
+     *   import('@comapeo/schema').RoleValue
+     * >} opts.dataType
+     * @param {import('./core-ownership.js').CoreOwnership} opts.coreOwnership
+     * @param {import('./core-manager/index.js').CoreManager} opts.coreManager
+     * @param {Buffer} opts.projectKey
+     * @param {Buffer} opts.deviceKey public key of this device
+     */
+    constructor({ dataType, coreOwnership, coreManager, projectKey, deviceKey }: {
+        dataType: import("./datatype/index.js").DataType<import("./datastore/index.js").DataStore<"auth">, typeof import("./schema/project.js").roleTable, "role", import("@comapeo/schema").Role, import("@comapeo/schema").RoleValue>;
+        coreOwnership: import("./core-ownership.js").CoreOwnership;
+        coreManager: import("./core-manager/index.js").CoreManager;
+        projectKey: Buffer;
+        deviceKey: Buffer;
+    });
+    /**
+     * Get the role for device `deviceId`.
+     *
+     * @param {string} deviceId
+     * @returns {Promise<Role>}
+     */
+    getRole(deviceId: string): Promise<Role>;
+    /**
+     * Get roles of all devices in the project. For your own device, if you have
+     * not yet synced your own role record, the "no role" capabilties is
+     * returned. The project creator will have the creator role unless a
+     * different one has been assigned.
+     *
+     * @returns {Promise<Map<string, Role>>} Map of deviceId to Role
+     */
+    getAll(): Promise<Map<string, Role>>;
+    /**
+     * Assign a role to the specified `deviceId`. Devices without an assigned role
+     * are unable to sync, except the project creator who can do anything. Only
+     * the project creator can assign their own role. Will throw if the device's
+     * role cannot assign the role by consulting `roleAssignment`.
+     *
+     * @param {string} deviceId
+     * @param {RoleIdAssignableToAnyone} roleId
+     */
+    assignRole(deviceId: string, roleId: RoleIdAssignableToAnyone): Promise<void>;
+    #private;
+}
+export type ElementOf<T> = T extends Iterable<infer U> ? U : never;
+export type RoleId = ElementOf<typeof ROLE_IDS>;
+export type RoleIdForNewInvite = ElementOf<typeof ROLE_IDS_FOR_NEW_INVITE>;
+export type RoleIdAssignableToOthers = ElementOf<typeof ROLE_IDS_ASSIGNABLE_TO_OTHERS>;
+export type RoleIdAssignableToAnyone = ElementOf<typeof ROLE_IDS_ASSIGNABLE_TO_ANYONE>;
+export type DocCapability = {
+    /**
+     * - can read own data
+     */
+    readOwn: boolean;
+    /**
+     * - can write own data
+     */
+    writeOwn: boolean;
+    /**
+     * - can read other's data
+     */
+    readOthers: boolean;
+    /**
+     * - can edit or delete other's data
+     */
+    writeOthers: boolean;
+};
+export type Role<T extends RoleId = "a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed"> = {
+    roleId: T;
+    name: string;
+    docs: Record<import("@comapeo/schema").MapeoDoc["schemaName"], DocCapability>;
+    roleAssignment: RoleIdAssignableToOthers[];
+    sync: Record<Namespace, "allowed" | "blocked">;
+};
+export type RolesEvents = {
+    /**
+     * Emitted when new role records are indexed
+     */
+    update: (docIds: Set<string>) => void;
+};
+import { TypedEmitter } from 'tiny-typed-emitter';
+/**
+ * @typedef {T extends Iterable<infer U> ? U : never} ElementOf
+ * @template T
+ */
+/** @typedef {ElementOf<typeof ROLE_IDS>} RoleId */
+declare const ROLE_IDS: Set<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">;
+/** @typedef {ElementOf<typeof ROLE_IDS_FOR_NEW_INVITE>} RoleIdForNewInvite */
+declare const ROLE_IDS_FOR_NEW_INVITE: Set<"f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9">;
+/** @typedef {ElementOf<typeof ROLE_IDS_ASSIGNABLE_TO_OTHERS>} RoleIdAssignableToOthers */
+declare const ROLE_IDS_ASSIGNABLE_TO_OTHERS: Set<"f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9">;
+/** @typedef {ElementOf<typeof ROLE_IDS_ASSIGNABLE_TO_ANYONE>} RoleIdAssignableToAnyone */
+declare const ROLE_IDS_ASSIGNABLE_TO_ANYONE: Set<"f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b">;
+import type { Namespace } from './types.js';
+export {};
+//# sourceMappingURL=roles.d.ts.map

package/dist/roles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../src/roles.js"],"names":[],"mappings":"AAKA,8CAA8C;AAG9C,iDAAiD;AACjD,qDAAqD;AACrD,gDAAgD;AAChD,iDAAiD;AACjD,8CAA8C;AAC9C,4CAA4C;AAwB5C,uDAiBA,KAAI,iEAjB+D;AAMnE,6DAWA,KAAI,iEAX2E;AAa/E;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH;;;;;;GAMG;AACH,2BAFU,IAAI,CAAC,OAAO,eAAe,CAAC,CAmBrC;AAED;;;;;;;;;GASG;AACH,sBAFU,IAAI,CAAC,OAAO,UAAU,CAAC,CAmBhC;AAED,yCAAyC;AACzC,oBADW,GAAG,CAAW,IAAN,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,GAAE,CAsFpC;AAED;;;GAGG;AAEH;;GAEG;AACH;IAOE,yCAAwB;IAExB;;;;;;;;;;;;;;OAcG;IACH,6EAZG;QAMQ,QAAQ,EANR,OAAO,qBAAqB,EAAE,QAAQ,CAChD,OAAW,sBAAsB,EAAE,SAAS,CAAC,MAAM,CAAC,EACpD,cAAkB,qBAAqB,EAAE,SAAS,EAClD,MAAU,EACV,OAAW,iBAAiB,EAAE,IAAI,EAClC,OAAW,iBAAiB,EAAE,SAAS,CACpC;QACyD,aAAa,EAA/D,OAAO,qBAAqB,EAAE,aAAa;QACS,WAAW,EAA/D,OAAO,yBAAyB,EAAE,WAAW;QAChC,UAAU,EAAvB,MAAM;QACO,SAAS,EAAtB,MAAM;KAChB,EASA;IAED;;;;;OAKG;IACH,kBAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAuBzB;IAED;;;;;;;OAOG;IACH,UAFa,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAsCtC;IAED;;;;;;;;OAQG;IACH,qBAHW,MAAM,UACN,wBAAwB,iBA8DlC;;CAQF;sBA1YY,CAAC,IADD,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;qBAItC,SAAS,CAAC,OAAO,QAAQ,CAAC;iCAa1B,SAAS,CAAC,OAAO,uBAAuB,CAAC;uCAMzC,SAAS,CAAC,OAAO,6BAA6B,CAAC;uCAM/C,SAAS,CAAC,OAAO,6BAA6B,CAAC;;;;;aAa/C,OAAO;;;;cACP,OAAO;;;;gBACP,OAAO;;;;iBACP,OAAO;;iBAIE,CAAC,SAAV,MAAO;YAEP,CAAC;UACD,MAAM;UACN,MAAM,CAAC,OAAO,iBAAiB,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC;oBACvE,wBAAwB,EAAE;UAC1B,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;;;;;;YAoJxC,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI;;6BAvNd,oBAAoB;AAWjD;;;GAGG;AAEH,mDAAmD;AACnD,yJASC;AAGD,8EAA8E;AAC9E,yGAEC;AAGD,0FAA0F;AAC1F,+GAEC;AAGD,0FAA0F;AAC1F,oIAOC;+BAhD8B,YAAY"}

package/dist/schema/client.d.ts

@@ -0,0 +1,284 @@
+export const projectSettingsTable: import("drizzle-orm/sqlite-core").SQLiteTableWithColumns<{
+    name: "projectSettings";
+    schema: undefined;
+    columns: {
+        readonly docId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "docId";
+            tableName: "projectSettings";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        readonly versionId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "versionId";
+            tableName: "projectSettings";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        readonly originalVersionId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "originalVersionId";
+            tableName: "projectSettings";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        readonly schemaName: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "schemaName";
+            tableName: "projectSettings";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: "projectSettings";
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: ["projectSettings"];
+            baseColumn: never;
+        }, object>;
+        readonly createdAt: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "createdAt";
+            tableName: "projectSettings";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        readonly updatedAt: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "updatedAt";
+            tableName: "projectSettings";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        readonly links: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "links";
+            tableName: "projectSettings";
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: string[];
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+        }, object>;
+        readonly deleted: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "deleted";
+            tableName: "projectSettings";
+            dataType: "boolean";
+            columnType: "SQLiteBoolean";
+            data: boolean;
+            driverParam: number;
+            notNull: true;
+            hasDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+        }, object>;
+        readonly name: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "name";
+            tableName: "projectSettings";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        readonly defaultPresets: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "defaultPresets";
+            tableName: "projectSettings";
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: {
+                point: string[];
+                area: string[];
+                vertex: string[];
+                line: string[];
+                relation: string[];
+            } | undefined;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+        }, object>;
+        readonly configMetadata: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "configMetadata";
+            tableName: "projectSettings";
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: {
+                name: string;
+                buildDate: string;
+                importDate: string;
+                fileVersion: string;
+            } | undefined;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+        }, object>;
+        forks: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "forks";
+            tableName: "projectSettings";
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: string[];
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+        }, object>;
+    };
+    dialect: "sqlite";
+}>;
+export const projectBacklinkTable: import("drizzle-orm/sqlite-core").SQLiteTableWithColumns<{
+    name: string;
+    schema: undefined;
+    columns: {
+        versionId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "versionId";
+            tableName: string;
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+    };
+    dialect: "sqlite";
+}>;
+export const projectKeysTable: import("drizzle-orm/sqlite-core").SQLiteTableWithColumns<{
+    name: "projectKeys";
+    schema: undefined;
+    columns: {
+        projectId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "projectId";
+            tableName: "projectKeys";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        projectPublicId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "projectPublicId";
+            tableName: "projectKeys";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        projectInviteId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "projectInviteId";
+            tableName: "projectKeys";
+            dataType: "json";
+            columnType: "SQLiteBlobJson";
+            data: unknown;
+            driverParam: Buffer;
+            notNull: true;
+            hasDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+        }, object>;
+        keysCipher: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "keysCipher";
+            tableName: "projectKeys";
+            dataType: "buffer";
+            columnType: "SQLiteBlobBuffer";
+            data: Buffer;
+            driverParam: Buffer;
+            notNull: true;
+            hasDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+        }, object>;
+        projectInfo: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "projectInfo";
+            tableName: "projectKeys";
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: ProjectInfo;
+            driverParam: unknown;
+            notNull: true;
+            hasDefault: true;
+            enumValues: undefined;
+            baseColumn: never;
+        }, object>;
+    };
+    dialect: "sqlite";
+}>;
+export const localDeviceInfoTable: import("drizzle-orm/sqlite-core").SQLiteTableWithColumns<{
+    name: "localDeviceInfo";
+    schema: undefined;
+    columns: {
+        deviceId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "deviceId";
+            tableName: "localDeviceInfo";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        deviceInfo: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "deviceInfo";
+            tableName: "localDeviceInfo";
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: DeviceInfoParam;
+            driverParam: unknown;
+            notNull: true;
+            hasDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+        }, object>;
+    };
+    dialect: "sqlite";
+}>;
+export type ProjectInfo = {
+    name?: string | undefined;
+};
+export type DeviceInfoParam = Omit<import("@comapeo/schema").DeviceInfoValue, "schemaName">;
+//# sourceMappingURL=client.d.ts.map

package/dist/schema/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/schema/client.js"],"names":[],"mappings":"AAsBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAGC;AACD;;;;;;;;;;;;;;;;;;GAAuE;AACvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAYE;AAYF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAGE;;;;8BAZW,IAAI,CAAC,OAAO,iBAAiB,EAAE,eAAe,EAAE,YAAY,CAAC"}