@comapeo/core 1.0.0

package/dist/sync/sync-api.d.ts

@@ -0,0 +1,158 @@
+/** @import { CoreOwnership as CoreOwnershipDoc } from '@comapeo/schema' */
+/** @import { CoreOwnership } from '../core-ownership.js' */
+/** @import { OpenedNoiseStream } from '../lib/noise-secret-stream-helpers.js' */
+export const kHandleDiscoveryKey: unique symbol;
+export const kSyncState: unique symbol;
+export const kRequestFullStop: unique symbol;
+export const kRescindFullStopRequest: unique symbol;
+/**
+ * @typedef {'initial' | 'full'} SyncType
+ */
+/**
+ * @typedef {'none' | 'presync' | 'all'} SyncEnabledState
+ */
+/**
+ * @internal
+ * @typedef {object} RemoteDeviceNamespaceGroupSyncState
+ * @property {boolean} isSyncEnabled do we want to sync this namespace group?
+ * @property {number} want number of blocks this device wants from us
+ * @property {number} wanted number of blocks we want from this device
+ */
+/**
+ * @internal
+ * @typedef {object} RemoteDeviceSyncState state of sync for a remote peer
+ * @property {RemoteDeviceNamespaceGroupSyncState} initial state of initial namespaces (auth, config, and blob index)
+ * @property {RemoteDeviceNamespaceGroupSyncState} data state of data namespaces (data and blob)
+ */
+/**
+ * @typedef {object} State
+ * @property {{ isSyncEnabled: boolean }} initial state of initial namespace syncing (auth, config, and blob index) for local device
+ * @property {{ isSyncEnabled: boolean }} data state of data namespace syncing (data and blob) for local device
+ * @property {Record<string, RemoteDeviceSyncState>} remoteDeviceSyncState sync states for remote peers
+ */
+/**
+ * @typedef {object} SyncEvents
+ * @property {(syncState: State) => void} sync-state
+ */
+/**
+ * @extends {TypedEmitter<SyncEvents>}
+ */
+export class SyncApi extends TypedEmitter<SyncEvents> {
+    /**
+     *
+     * @param {object} opts
+     * @param {import('../core-manager/index.js').CoreManager} opts.coreManager
+     * @param {CoreOwnership} opts.coreOwnership
+     * @param {import('../roles.js').Roles} opts.roles
+     * @param {number} [opts.throttleMs]
+     * @param {Logger} [opts.logger]
+     */
+    constructor({ coreManager, throttleMs, roles, logger, coreOwnership }: {
+        coreManager: import("../core-manager/index.js").CoreManager;
+        coreOwnership: CoreOwnership;
+        roles: import("../roles.js").Roles;
+        throttleMs?: number | undefined;
+        logger?: Logger | undefined;
+    });
+    /**
+     * Get the current sync state (initial and full). Also emitted via the 'sync-state' event
+     * @returns {State}
+     */
+    getState(): State;
+    /**
+     * Start syncing data cores.
+     *
+     * If the app is backgrounded and sync has already completed, this will do
+     * nothing until the app is foregrounded.
+     *
+     * @param {object} [options]
+     * @param {null | number} [options.autostopDataSyncAfter] If no data sync
+     * happens after this duration in milliseconds, sync will be automatically
+     * stopped as if {@link stop} was called.
+     */
+    start({ autostopDataSyncAfter }?: {
+        autostopDataSyncAfter?: number | null | undefined;
+    } | undefined): void;
+    /**
+     * Stop syncing data cores.
+     *
+     * Pre-sync cores will continue syncing unless the app is backgrounded.
+     */
+    stop(): void;
+    /**
+     * @param {null | number} autostopDataSyncAfter
+     * @returns {void}
+     */
+    setAutostopDataSyncTimeout(autostopDataSyncAfter: null | number): void;
+    /**
+     * @param {SyncType} type
+     * @returns {Promise<void>}
+     */
+    waitForSync(type: SyncType): Promise<void>;
+    [kHandleDiscoveryKey](discoveryKey: Buffer, protomux: import("protomux")<import("@hyperswarm/secret-stream")>): void;
+    /**
+     * Request a graceful stop to all sync.
+     */
+    [kRequestFullStop](): void;
+    /**
+     * Rescind any requests for a full stop.
+     */
+    [kRescindFullStopRequest](): void;
+    [kSyncState]: SyncState;
+    #private;
+}
+export type SyncType = "initial" | "full";
+export type SyncEnabledState = "none" | "presync" | "all";
+export type RemoteDeviceNamespaceGroupSyncState = {
+    /**
+     * do we want to sync this namespace group?
+     */
+    isSyncEnabled: boolean;
+    /**
+     * number of blocks this device wants from us
+     */
+    want: number;
+    /**
+     * number of blocks we want from this device
+     */
+    wanted: number;
+};
+/**
+ * state of sync for a remote peer
+ */
+export type RemoteDeviceSyncState = {
+    /**
+     * state of initial namespaces (auth, config, and blob index)
+     */
+    initial: RemoteDeviceNamespaceGroupSyncState;
+    /**
+     * state of data namespaces (data and blob)
+     */
+    data: RemoteDeviceNamespaceGroupSyncState;
+};
+export type State = {
+    /**
+     * state of initial namespace syncing (auth, config, and blob index) for local device
+     */
+    initial: {
+        isSyncEnabled: boolean;
+    };
+    /**
+     * state of data namespace syncing (data and blob) for local device
+     */
+    data: {
+        isSyncEnabled: boolean;
+    };
+    /**
+     * sync states for remote peers
+     */
+    remoteDeviceSyncState: Record<string, RemoteDeviceSyncState>;
+};
+export type SyncEvents = {
+    "sync-state": (syncState: State) => void;
+};
+import { TypedEmitter } from 'tiny-typed-emitter';
+import { SyncState } from './sync-state.js';
+import type { CoreOwnership } from '../core-ownership.js';
+import { Logger } from '../logger.js';
+//# sourceMappingURL=sync-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sync-api.d.ts","sourceRoot":"","sources":["../../src/sync/sync-api.js"],"names":[],"mappings":"AAWA,2EAA2E;AAC3E,4DAA4D;AAC5D,iFAAiF;AAEjF,gDAAiE;AACjE,uCAA8C;AAC9C,6CAAoD;AACpD,oDAA2D;AAE3D;;GAEG;AAEH;;GAEG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;GAGG;AAEH;;GAEG;AACH;IAsBE;;;;;;;;OAQG;IACH,uEANG;QAA6D,WAAW,EAAhE,OAAO,0BAA0B,EAAE,WAAW;QAC1B,aAAa,EAAjC,aAAa;QACqB,KAAK,EAAvC,OAAO,aAAa,EAAE,KAAK;QACb,UAAU;QACV,MAAM;KAAC,EAmC/B;IA8BD;;;OAGG;IACH,YAFa,KAAK,CAIjB;IAmHD;;;;;;;;;;OAUG;IACH;;yBAOC;IAED;;;;OAIG;IACH,aAGC;IAkBD;;;OAGG;IACH,kDAHW,IAAI,GAAG,MAAM,GACX,IAAI,CAOhB;IAED;;;OAGG;IACH,kBAHW,QAAQ,GACN,OAAO,CAAC,IAAI,CAAC,CAazB;oFAnHwC,2BAC3B;IAwEd;;OAEG;IACH,2BAGC;IAED;;OAEG;IACH,kCAGC;IA9NC,wBAIE;;CAqYL;uBAndY,SAAS,GAAG,MAAM;+BAIlB,MAAM,GAAG,SAAS,GAAG,KAAK;;;;;mBAMzB,OAAO;;;;UACP,MAAM;;;;YACN,MAAM;;;;;;;;;aAMN,mCAAmC;;;;UACnC,mCAAmC;;;;;;aAKnC;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE;;;;UAC1B;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE;;;;2BAC1B,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC;;;kBAKrC,CAAC,SAAS,EAAE,KAAK,KAAK,IAAI;;6BApDX,oBAAoB;0BACvB,iBAAiB;mCAWR,sBAAsB;uBATlC,cAAc"}

package/dist/sync/sync-state.d.ts

@@ -0,0 +1,40 @@
+/** @import { Namespace } from '../types.js' */
+/**
+ * @typedef {Record<
+ *  Namespace,
+ *  import('./namespace-sync-state.js').SyncState
+ * >} State
+ */
+/**
+ * Emit sync state when it changes
+ * @extends {TypedEmitter<{ state: (state: State) => void}>}
+ */
+export class SyncState extends TypedEmitter<{
+    state: (state: State) => void;
+}> {
+    /**
+     *
+     * @param {object} opts
+     * @param {import('../core-manager/index.js').CoreManager} opts.coreManager
+     * @param {Map<string, import('./peer-sync-controller.js').PeerSyncController>} opts.peerSyncControllers
+     * @param {number} [opts.throttleMs]
+     */
+    constructor({ coreManager, peerSyncControllers, throttleMs }: {
+        coreManager: import("../core-manager/index.js").CoreManager;
+        peerSyncControllers: Map<string, import("./peer-sync-controller.js").PeerSyncController>;
+        throttleMs?: number | undefined;
+    });
+    /**
+     * @param {string} peerId
+     */
+    addPeer(peerId: string): void;
+    /**
+     * @returns {State}
+     */
+    getState(): State;
+    #private;
+}
+export type State = Record<Namespace, import("./namespace-sync-state.js").SyncState>;
+import { TypedEmitter } from 'tiny-typed-emitter';
+import type { Namespace } from '../types.js';
+//# sourceMappingURL=sync-state.d.ts.map

package/dist/sync/sync-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-state.d.ts","sourceRoot":"","sources":["../../src/sync/sync-state.js"],"names":[],"mappings":"AAKA,+CAA+C;AAE/C;;;;;GAKG;AAEH;;;GAGG;AACH;WAFmC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI;;IAIvD;;;;;;OAMG;IACH,8DAJG;QAA6D,WAAW,EAAhE,OAAO,0BAA0B,EAAE,WAAW;QAC4B,mBAAmB,EAA7F,GAAG,CAAC,MAAM,EAAE,OAAO,2BAA2B,EAAE,kBAAkB,CAAC;QACrD,UAAU;KAAC,EAanC;IAED;;OAEG;IACH,gBAFW,MAAM,QAMhB;IAED;;OAEG;IACH,YAFa,KAAK,CAOjB;;CAKF;oBAtDY,MAAM,CAClB,SAAY,EACZ,OAAU,2BAA2B,EAAE,SAAS,CAC7C;6BAXyB,oBAAoB;+BAKlB,aAAa"}

package/dist/translation-api.d.ts

@@ -0,0 +1,288 @@
+/** @import { Translation, TranslationValue } from '@comapeo/schema' */
+/** @import { SetOptional } from 'type-fest' */
+export const ktranslatedLanguageCodeToSchemaNames: unique symbol;
+export default class TranslationApi {
+    /**
+     * @param {Object} opts
+     * @param {import('./datatype/index.js').DataType<
+     *   import('./datastore/index.js').DataStore<'config'>,
+     *   typeof import('./schema/project.js').translationTable,
+     *   'translation',
+     *   Translation,
+     *   TranslationValue
+     * >}  opts.dataType
+     * @param {typeof import('./schema/project.js').translationTable} opts.table
+     */
+    constructor({ dataType, table }: {
+        dataType: import("./datatype/index.js").DataType<import("./datastore/index.js").DataStore<"config">, typeof import("./schema/project.js").translationTable, "translation", Translation, TranslationValue>;
+        table: typeof import("./schema/project.js").translationTable;
+    });
+    /** @returns {Promise<void>} */
+    ready(): Promise<void>;
+    /**
+     * @param {TranslationValue} value
+     */
+    put(value: TranslationValue): Promise<{
+        schemaName: "translation";
+        docRef: {
+            docId: string;
+            versionId: string;
+        };
+        docRefType: "type_unspecified" | "deviceInfo" | "preset" | "field" | "observation" | "projectSettings" | "role" | "track" | "UNRECOGNIZED";
+        propertyRef: string;
+        languageCode: string;
+        regionCode?: string | undefined;
+        message: string;
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
+    } & {
+        forks: string[];
+    }>;
+    /** @typedef {SetOptional<TranslationValue['docRef'], 'versionId'>} DocRefWithOptionalVersionId */
+    /**
+     * @param {SetOptional<
+     * Omit<TranslationValue,'schemaName' | 'message' | 'docRef'>,
+     * 'propertyRef' | 'regionCode'> & {docRef: DocRefWithOptionalVersionId}} value
+     * @returns {Promise<import('@comapeo/schema').Translation[]>}
+     */
+    get(value: SetOptional<Omit<TranslationValue, "schemaName" | "message" | "docRef">, "propertyRef" | "regionCode"> & {
+        docRef: {
+            docId: string;
+            versionId?: string | undefined;
+        };
+    }): Promise<import("@comapeo/schema").Translation[]>;
+    /**
+     * @param {TranslationValue} doc
+     */
+    index(doc: TranslationValue): void;
+    get dataType(): import("./datatype/index.js").DataType<import("./datastore/index.js").DataStore<"config", "translation" | "preset" | "field" | "projectSettings" | "deviceInfo" | "icon">, import("drizzle-orm/sqlite-core").SQLiteTableWithColumns<{
+        name: "translation";
+        schema: undefined;
+        columns: {
+            readonly docId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+                name: "docId";
+                tableName: "translation";
+                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: "translation";
+                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: "translation";
+                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: "translation";
+                dataType: "string";
+                columnType: "SQLiteText";
+                data: "translation";
+                driverParam: string;
+                notNull: true;
+                hasDefault: false;
+                enumValues: ["translation"];
+                baseColumn: never;
+            }, object>;
+            readonly createdAt: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+                name: "createdAt";
+                tableName: "translation";
+                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: "translation";
+                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: "translation";
+                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: "translation";
+                dataType: "boolean";
+                columnType: "SQLiteBoolean";
+                data: boolean;
+                driverParam: number;
+                notNull: true;
+                hasDefault: false;
+                enumValues: undefined;
+                baseColumn: never;
+            }, object>;
+            readonly docRef: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+                name: "docRef";
+                tableName: "translation";
+                dataType: "custom";
+                columnType: "SQLiteCustomColumn";
+                data: {
+                    docId: string;
+                    versionId: string;
+                };
+                driverParam: string;
+                notNull: true;
+                hasDefault: false;
+                enumValues: undefined;
+                baseColumn: never;
+            }, object>;
+            readonly docRefType: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+                name: "docRefType";
+                tableName: "translation";
+                dataType: "string";
+                columnType: "SQLiteText";
+                data: "UNRECOGNIZED" | "observation" | "track" | "preset" | "field" | "projectSettings" | "deviceInfo" | "role" | "type_unspecified";
+                driverParam: string;
+                notNull: true;
+                hasDefault: false;
+                enumValues: ["type_unspecified", "deviceInfo", "preset", "field", "observation", "projectSettings", "role", "track", "UNRECOGNIZED"];
+                baseColumn: never;
+            }, object>;
+            readonly propertyRef: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+                name: "propertyRef";
+                tableName: "translation";
+                dataType: "string";
+                columnType: "SQLiteText";
+                data: string;
+                driverParam: string;
+                notNull: true;
+                hasDefault: false;
+                enumValues: [string, ...string[]];
+                baseColumn: never;
+            }, object>;
+            readonly languageCode: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+                name: "languageCode";
+                tableName: "translation";
+                dataType: "string";
+                columnType: "SQLiteText";
+                data: string;
+                driverParam: string;
+                notNull: true;
+                hasDefault: false;
+                enumValues: [string, ...string[]];
+                baseColumn: never;
+            }, object>;
+            readonly regionCode: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+                name: "regionCode";
+                tableName: "translation";
+                dataType: "string";
+                columnType: "SQLiteText";
+                data: string;
+                driverParam: string;
+                notNull: false;
+                hasDefault: false;
+                enumValues: [string, ...string[]];
+                baseColumn: never;
+            }, object>;
+            readonly message: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+                name: "message";
+                tableName: "translation";
+                dataType: "string";
+                columnType: "SQLiteText";
+                data: string;
+                driverParam: string;
+                notNull: true;
+                hasDefault: false;
+                enumValues: [string, ...string[]];
+                baseColumn: never;
+            }, object>;
+            forks: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+                name: "forks";
+                tableName: "translation";
+                dataType: "custom";
+                columnType: "SQLiteCustomColumn";
+                data: string[];
+                driverParam: string;
+                notNull: true;
+                hasDefault: false;
+                enumValues: undefined;
+                baseColumn: never;
+            }, object>;
+        };
+        dialect: "sqlite";
+    }>, "translation", {
+        schemaName: "translation";
+        docRef: {
+            docId: string;
+            versionId: string;
+        };
+        docRefType: "type_unspecified" | "deviceInfo" | "preset" | "field" | "observation" | "projectSettings" | "role" | "track" | "UNRECOGNIZED";
+        propertyRef: string;
+        languageCode: string;
+        regionCode?: string | undefined;
+        message: string;
+        docId: string;
+        versionId: string;
+        originalVersionId: string;
+        createdAt: string;
+        updatedAt: string;
+        links: string[];
+        deleted: boolean;
+    }, {
+        schemaName: "translation";
+        docRef: {
+            docId: string;
+            versionId: string;
+        };
+        docRefType: "type_unspecified" | "deviceInfo" | "preset" | "field" | "observation" | "projectSettings" | "role" | "track" | "UNRECOGNIZED";
+        propertyRef: string;
+        languageCode: string;
+        regionCode?: string | undefined;
+        message: string;
+    }>;
+    get [ktranslatedLanguageCodeToSchemaNames](): Map<string, Set<import("@comapeo/schema/dist/types.js").SchemaName>>;
+    #private;
+}
+import type { TranslationValue } from '@comapeo/schema';
+import type { SetOptional } from 'type-fest';
+import type { Translation } from '@comapeo/schema';
+//# sourceMappingURL=translation-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"translation-api.d.ts","sourceRoot":"","sources":["../src/translation-api.js"],"names":[],"mappings":"AAIA,uEAAuE;AACvE,+CAA+C;AAE/C,iEAEC;AACD;IASE;;;;;;;;;;OAUG;IACH,iCATG;QAMS,QAAQ,EANT,OAAO,qBAAqB,EAAE,QAAQ,CAChD,OAAW,sBAAsB,EAAE,SAAS,CAAC,QAAQ,CAAC,EACtD,cAAkB,qBAAqB,EAAE,gBAAgB,EACzD,aAAiB,EACjB,WAAe,EACf,gBAAoB,CACjB;QACmE,KAAK,EAAjE,cAAc,qBAAqB,EAAE,gBAAgB;KAC/D,EAYA;IAED,+BAA+B;IAC/B,SADc,OAAO,CAAC,IAAI,CAAC,CAG1B;IAED;;OAEG;IACH,WAFW,gBAAgB;;;;;;;;;;;;;;;;;;;;OAgB1B;IAED,kGAAkG;IAElG;;;;;OAKG;IACH,WALW,YACR,IAAI,CAAC,gBAAgB,EAAC,YAAY,GAAG,SAAS,GAAG,QAAQ,CAAC,EAC5D,aAAe,GAAG,YAAY,CAAC,GAAG;QAAC,MAAM;;;UAA6B;KAAC,GAC3D,OAAO,CAAC,OAAO,iBAAiB,EAAE,WAAW,EAAE,CAAC,CAqC5D;IAED;;OAEG;IACH,WAFW,gBAAgB,QAkB1B;IAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAEC;IALD,mHAEC;;CAIF;sCAxIkD,iBAAiB;iCACnC,WAAW;iCADO,iBAAiB"}

package/dist/types.d.ts

@@ -0,0 +1,115 @@
+import type { Simplify, TupleToUnion, ValueOf, RequireAtLeastOne, SetOptional } from 'type-fest';
+import { SUPPORTED_BLOB_VARIANTS } from './blob-store/index.js';
+import { MapeoCommon, MapeoDoc, MapeoValue, decode } from '@comapeo/schema';
+import type BigSparseArray from 'big-sparse-array';
+import type Protomux from 'protomux';
+import type NoiseStream from '@hyperswarm/secret-stream';
+import { Duplex } from 'streamx';
+import RandomAccessStorage from 'random-access-storage';
+import { DefaultListener, ListenerSignature } from 'tiny-typed-emitter';
+import type { NAMESPACES } from './constants.js';
+export type Namespace = (typeof NAMESPACES)[number];
+type SupportedBlobVariants = typeof SUPPORTED_BLOB_VARIANTS;
+export type BlobType = keyof SupportedBlobVariants;
+export type BlobVariant<TBlobType extends BlobType> = TupleToUnion<SupportedBlobVariants[TBlobType]>;
+type BlobIdBase<T extends BlobType> = {
+    /** Type of blob */
+    type: T;
+    /** Blob variant (some blob types have smaller previews and thumbnails available) */
+    variant: BlobVariant<T>;
+    /** unique identifier for blob (e.g. hash of content) */
+    name: string;
+    /** discovery key as hex string of hyperdrive where blob is stored */
+    driveId: string;
+};
+export type BlobId = Simplify<ValueOf<{
+    [KeyType in BlobType]: BlobIdBase<KeyType>;
+}>>;
+type ArrayAtLeastOne<T> = [T, ...T[]];
+export type BlobFilter = RequireAtLeastOne<{
+    [KeyType in BlobType]: ArrayAtLeastOne<BlobVariant<KeyType>>;
+}>;
+export type MapeoDocMap = {
+    [K in MapeoDoc['schemaName']]: Extract<MapeoDoc, {
+        schemaName: K;
+    }>;
+};
+export type MapeoValueMap = {
+    [K in MapeoValue['schemaName']]: Extract<MapeoValue, {
+        schemaName: K;
+    }>;
+};
+export type CoreOwnershipWithSignatures = Extract<ReturnType<typeof decode>, {
+    schemaName: 'coreOwnership';
+}>;
+export type CoreOwnershipWithSignaturesValue = Omit<CoreOwnershipWithSignatures, Exclude<keyof MapeoCommon, 'schemaName'>>;
+type NullToOptional<T> = SetOptional<T, NullKeys<T>>;
+type RemoveNull<T> = {
+    [K in keyof T]: Exclude<T[K], null>;
+};
+type NullKeys<Base> = NonNullable<{
+    [Key in keyof Base]: null extends Base[Key] ? Key : never;
+}[keyof Base]>;
+/**
+ * Replace an object's `Buffer` values with `string`s. Useful for serialization.
+ */
+export type MapBuffers<T> = {
+    [K in keyof T]: T[K] extends Buffer ? string : T[K];
+};
+/**
+ * Make any properties whose value include `null` optional, and remove `null`
+ * from the type. This converts the types returned from SQLite (which have all
+ * top-level optional props set to `null`) to the original types in
+ * @comapeo/schema
+ */
+export type NullableToOptional<T> = Simplify<RemoveNull<NullToOptional<T>>>;
+export type KeyPair = {
+    publicKey: PublicKey;
+    secretKey: SecretKey;
+};
+/** 32 byte buffer */
+export type PublicKey = Buffer;
+/** 32 byte buffer */
+export type SecretKey = Buffer;
+export type IdentityKeyPair = KeyPair;
+type HypercoreRemoteBitfieldPage = {
+    bitfield: Uint32Array;
+};
+/**
+ * A subset of Hypercore's `RemoteBitfield` class that we use.
+ */
+export type HypercoreRemoteBitfield = {
+    _pages: BigSparseArray<HypercoreRemoteBitfieldPage>;
+    get(index: number): boolean;
+};
+/**
+ * A subset of Hypercore's `Peer` class that we use.
+ * TODO: Contribute these types upstream.
+ */
+export type HypercorePeer = {
+    protomux: Protomux;
+    remotePublicKey: Buffer;
+    remoteBitfield: HypercoreRemoteBitfield;
+    onbitfield: (options: {
+        start: number;
+        bitfield: Buffer;
+    }) => void;
+    onrange: (options: {
+        drop: boolean;
+        start: number;
+        length: number;
+    }) => void;
+};
+export { NoiseStream };
+type ProtocolStream = Omit<NoiseStream, 'userData'> & {
+    userData: Protomux;
+};
+export type ReplicationStream = Duplex & {
+    noiseStream: ProtocolStream;
+};
+export type CoreStorage = (name: string) => RandomAccessStorage;
+export type DefaultEmitterEvents<L extends ListenerSignature<L> = DefaultListener> = {
+    newListener: (event: keyof L, listener: L[keyof L]) => void;
+    removeListener: (event: keyof L, listener: L[keyof L]) => void;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,iBAAiB,EACjB,WAAW,EACZ,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAA;AAC/D,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC3E,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,WAAW,MAAM,2BAA2B,CAAA;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,mBAAmB,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAA;AAEnD,KAAK,qBAAqB,GAAG,OAAO,uBAAuB,CAAA;AAC3D,MAAM,MAAM,QAAQ,GAAG,MAAM,qBAAqB,CAAA;AAClD,MAAM,MAAM,WAAW,CAAC,SAAS,SAAS,QAAQ,IAAI,YAAY,CAChE,qBAAqB,CAAC,SAAS,CAAC,CACjC,CAAA;AAED,KAAK,UAAU,CAAC,CAAC,SAAS,QAAQ,IAAI;IACpC,mBAAmB;IACnB,IAAI,EAAE,CAAC,CAAA;IACP,oFAAoF;IACpF,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IACvB,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAA;IACZ,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAGD,MAAM,MAAM,MAAM,GAAG,QAAQ,CAC3B,OAAO,CAAC;KACL,OAAO,IAAI,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC;CAC3C,CAAC,CACH,CAAA;AAED,KAAK,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;AAErC,MAAM,MAAM,UAAU,GAAG,iBAAiB,CAAC;KACxC,OAAO,IAAI,QAAQ,GAAG,eAAe,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;CAC7D,CAAC,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG;KACvB,CAAC,IAAI,QAAQ,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE;QAAE,UAAU,EAAE,CAAC,CAAA;KAAE,CAAC;CACpE,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;KACzB,CAAC,IAAI,UAAU,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE;QAAE,UAAU,EAAE,CAAC,CAAA;KAAE,CAAC;CACxE,CAAA;AAGD,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAC/C,UAAU,CAAC,OAAO,MAAM,CAAC,EACzB;IAAE,UAAU,EAAE,eAAe,CAAA;CAAE,CAChC,CAAA;AACD,MAAM,MAAM,gCAAgC,GAAG,IAAI,CACjD,2BAA2B,EAC3B,OAAO,CAAC,MAAM,WAAW,EAAE,YAAY,CAAC,CACzC,CAAA;AAED,KAAK,cAAc,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;AACpD,KAAK,UAAU,CAAC,CAAC,IAAI;KAClB,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;CACpC,CAAA;AAED,KAAK,QAAQ,CAAC,IAAI,IAAI,WAAW,CAE/B;KAEG,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,SAAS,IAAI,CAAC,GAAG,CAAC,GAEvC,GAAG,GAEH,KAAK;CAGV,CAAC,MAAM,IAAI,CAAC,CACd,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;KACzB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;CACpD,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAC3E,MAAM,MAAM,OAAO,GAAG;IACpB,SAAS,EAAE,SAAS,CAAA;IACpB,SAAS,EAAE,SAAS,CAAA;CACrB,CAAA;AAED,qBAAqB;AACrB,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAC9B,qBAAqB;AACrB,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAC9B,MAAM,MAAM,eAAe,GAAG,OAAO,CAAA;AAErC,KAAK,2BAA2B,GAAG;IACjC,QAAQ,EAAE,WAAW,CAAA;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,cAAc,CAAC,2BAA2B,CAAC,CAAA;IACnD,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;CAC5B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,QAAQ,CAAA;IAClB,eAAe,EAAE,MAAM,CAAA;IACvB,cAAc,EAAE,uBAAuB,CAAA;IACvC,UAAU,EAAE,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IAClE,OAAO,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;CAC7E,CAAA;AAED,OAAO,EAAE,WAAW,EAAE,CAAA;AACtB,KAAK,cAAc,GAAG,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,GAAG;IACpD,QAAQ,EAAE,QAAQ,CAAA;CACnB,CAAA;AACD,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAAA;AAExE,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,mBAAmB,CAAA;AAE/D,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,iBAAiB,CAAC,CAAC,CAAC,GAAG,eAAe,IAC9C;IACF,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,CAAA;IAC3D,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,CAAA;CAC/D,CAAA"}