@verdant-web/store 2.0.1

package/dist/cjs/__tests__/undo.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"undo.test.js","sourceRoot":"","sources":["../../../src/__tests__/undo.test.ts"],"names":[],"mappings":";;AAAA,gDAA6C;AAC7C,mCAAkE;AAClE,8DAA8D;AAE9D,IAAA,iBAAQ,EAAC,oBAAoB,EAAE,GAAG,EAAE;IACnC,IAAA,WAAE,EAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,OAAO,GAAG,MAAM,IAAA,kCAAiB,GAAE,CAAC;QAE1C,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;YACpC,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE,SAAS;YACnB,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,OAAO;iBACb;aACD;SACD,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3C,IAAA,eAAM,EAAC,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAEpE,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAEjC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClE,IAAA,eAAM,EAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9B,IAAA,eAAM,EAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACnB,IAAA,eAAM,EAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAChD,IAAA,eAAM,EAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAA,eAAM,EAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,IAAA,eAAM,EAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,OAAO,GAAG,MAAM,IAAA,kCAAiB,GAAE,CAAC;QAE1C,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;YACpC,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE,SAAS;YACnB,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,OAAO;iBACb;aACD;SACD,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAEnC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAElC,MAAM,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEtC,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAEjC,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,OAAO,GAAG,MAAM,IAAA,kCAAiB,GAAE,CAAC;QAE1C,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;YACpC,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE,SAAS;YACnB,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,OAAO;iBACb;aACD;SACD,CAAC,CAAC;QAEH,MAAM,OAAO;aACX,KAAK,EAAE;aACP,GAAG,CAAC,GAAG,EAAE;YACT,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACpC,CAAC,CAAC;aACD,KAAK,EAAE,CAAC;QAEV,MAAM,OAAO;aACX,KAAK,CAAC;YACN,QAAQ,EAAE,KAAK;SACf,CAAC;aACD,GAAG,CAAC,GAAG,EAAE;YACT,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACrC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAChC,CAAC,CAAC;aACD,KAAK,EAAE,CAAC;QAEV,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAClD,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE5C,IAAA,eAAM,EAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE/C,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAEjC,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,kBAAkB;QAClB,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE5C,uCAAuC;QACvC,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QACjC,IAAA,eAAM,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,8DAA8D;AAC/D,CAAC,CAAC,CAAC"}

package/dist/cjs/client/Client.d.ts

@@ -0,0 +1,86 @@
+/// <reference types="node" resolution-mode="require"/>
+import { Migration } from '@verdant-web/common';
+import { Context } from '../context.js';
+import { DocumentManager } from '../DocumentManager.js';
+import { FileManagerConfig } from '../files/FileManager.js';
+import { Metadata } from '../metadata/Metadata.js';
+import { EntityStore } from '../reactives/EntityStore.js';
+import { ServerSyncOptions, Sync } from '../sync/Sync.js';
+import { CollectionQueries } from '../queries2/CollectionQueries.js';
+interface ClientConfig<Presence = any> {
+    syncConfig?: ServerSyncOptions<Presence>;
+    migrations: Migration[];
+    files?: FileManagerConfig;
+}
+export type ClientWithCollections = Client & {
+    [key: string]: CollectionQueries<any, any, any>;
+};
+export declare class Client {
+    private config;
+    private context;
+    readonly meta: Metadata;
+    private _entities;
+    private _queryCache;
+    private _documentManager;
+    private _fileManager;
+    readonly collectionNames: string[];
+    private _sync;
+    get sync(): Sync;
+    get entities(): EntityStore;
+    get documentManager(): DocumentManager<any>;
+    constructor(config: ClientConfig, context: Context, components: {
+        meta: Metadata;
+    });
+    private addData;
+    get documentDb(): IDBDatabase;
+    get metaDb(): IDBDatabase;
+    get schema(): import("@verdant-web/common").StorageSchema<any>;
+    get namespace(): string;
+    get undoHistory(): import("../UndoHistory.js").UndoHistory;
+    /**
+     * @deprecated - use client.sync.presence instead
+     */
+    get presence(): import("../sync/PresenceManager.js").PresenceManager<any, any>;
+    /**
+     * Batch multiple operations together to be executed in a single transaction.
+     * The changes made will not be included in the same undo history step as
+     * any other changes made outside of the batch. You can also disable undo
+     * for your batch to omit changes from undo history.
+     *
+     * Provide a batch name to apply multiple changes to the same batch
+     * across different invocations. Batches will automatically flush after
+     * a short delay or if they reach a maximum size.
+     */
+    get batch(): ({ undoable, batchName, max, timeout, }?: {
+        undoable?: boolean | undefined;
+        batchName?: string | undefined;
+        max?: number | null | undefined;
+        timeout?: number | null | undefined;
+    }) => import("../reactives/EntityStore.js").OperationBatch;
+    stats: () => Promise<{
+        collections: Record<string, {
+            count: number;
+            size: number;
+        }>;
+        meta: {
+            operationsSize: {
+                count: number;
+                size: number;
+            };
+            baselinesSize: {
+                count: number;
+                size: number;
+            };
+        };
+        storage: StorageEstimate | undefined;
+        totalMetaSize: number;
+        totalCollectionsSize: number;
+        metaToDataRatio: number;
+        quotaUsage: number | undefined;
+    }>;
+    close: () => Promise<void>;
+    __dangerous__resetLocal: () => Promise<void>;
+    export: () => Promise<Buffer>;
+    import: (buffer: Buffer) => Promise<void>;
+}
+export {};

package/dist/cjs/client/Client.js

@@ -0,0 +1,227 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const common_1 = require("@verdant-web/common");
+const DocumentManager_js_1 = require("../DocumentManager.js");
+const FileManager_js_1 = require("../files/FileManager.js");
+const idb_js_1 = require("../idb.js");
+const openDocumentDatabase_js_1 = require("../openDocumentDatabase.js");
+const EntityStore_js_1 = require("../reactives/EntityStore.js");
+const Sync_js_1 = require("../sync/Sync.js");
+const CollectionQueries_js_1 = require("../queries2/CollectionQueries.js");
+const QueryCache_js_1 = require("../queries2/QueryCache.js");
+class Client {
+    get sync() {
+        return this._sync;
+    }
+    get entities() {
+        return this._entities;
+    }
+    get documentManager() {
+        return this._documentManager;
+    }
+    constructor(config, context, components) {
+        var _a;
+        this.config = config;
+        this.context = context;
+        this.addData = (data) => {
+            return this._entities.addData(data);
+        };
+        this.stats = async () => {
+            const collectionNames = Object.keys(this.schema.collections);
+            let collections = {};
+            for (const collectionName of collectionNames) {
+                collections[collectionName] = await (0, idb_js_1.getSizeOfObjectStore)(this.documentDb, collectionName);
+            }
+            const meta = await this.meta.stats();
+            const storage = typeof navigator !== 'undefined' &&
+                typeof navigator.storage !== 'undefined' &&
+                'estimate' in navigator.storage
+                ? await navigator.storage.estimate()
+                : undefined;
+            // determine data:metadata ratio for total size of all collections vs metadata
+            const totalCollectionsSize = Object.values(collections).reduce((acc, { size }) => acc + size, 0);
+            const totalMetaSize = meta.baselinesSize.size + meta.operationsSize.size;
+            const metaToDataRatio = totalMetaSize / totalCollectionsSize;
+            return {
+                collections,
+                meta,
+                storage,
+                totalMetaSize,
+                totalCollectionsSize,
+                metaToDataRatio,
+                quotaUsage: (storage === null || storage === void 0 ? void 0 : storage.usage) && (storage === null || storage === void 0 ? void 0 : storage.quota)
+                    ? storage.usage / storage.quota
+                    : undefined,
+            };
+        };
+        this.close = async () => {
+            var _a, _b;
+            await this.entities.flushPatches();
+            this.sync.stop();
+            this.sync.dispose();
+            this.meta.close();
+            this._entities.destroy();
+            await (0, idb_js_1.closeDatabase)(this.documentDb);
+            await (0, idb_js_1.closeDatabase)(this.metaDb);
+            (_b = (_a = this.context).log) === null || _b === void 0 ? void 0 : _b.call(_a, 'Client closed');
+        };
+        this.__dangerous__resetLocal = async () => {
+            this.sync.stop();
+            const req1 = indexedDB.deleteDatabase([this.namespace, 'meta'].join('_'));
+            const req2 = indexedDB.deleteDatabase([this.namespace, 'collections'].join('_'));
+            await Promise.all([
+                new Promise((resolve, reject) => {
+                    req1.onsuccess = resolve;
+                    req1.onerror = reject;
+                }),
+                new Promise((resolve, reject) => {
+                    req2.onsuccess = resolve;
+                    req2.onerror = reject;
+                }),
+            ]);
+            window.location.reload();
+        };
+        this.export = async () => {
+            const metaExport = await this.meta.export();
+            return Buffer.from(JSON.stringify(metaExport));
+        };
+        this.import = async (buffer) => {
+            this.context.log('Importing data...');
+            // close the document DB
+            await (0, idb_js_1.closeDatabase)(this.context.documentDb);
+            const metaExport = JSON.parse(buffer.toString());
+            await this.meta.resetFrom(metaExport);
+            // now reset the document DB to the specified version
+            // and run migrations to get it to the latest version
+            const version = metaExport.schema.version;
+            const deleteReq = indexedDB.deleteDatabase([this.namespace, 'collections'].join('_'));
+            await new Promise((resolve, reject) => {
+                deleteReq.onsuccess = resolve;
+                deleteReq.onerror = reject;
+            });
+            // reset our context to the imported schema for now
+            const currentSchema = this.context.schema;
+            this.context.schema = metaExport.schema;
+            // now open the document DB empty at the specified version
+            // and initialize it from the meta DB
+            this.context.documentDb = await (0, openDocumentDatabase_js_1.openDocumentDatabase)({
+                meta: this.meta,
+                migrations: this.config.migrations,
+                context: this.context,
+                version,
+            });
+            // re-initialize data
+            this.context.log('Re-initializing data from imported data...');
+            await this._entities.addData({
+                operations: metaExport.operations,
+                baselines: metaExport.baselines,
+                reset: true,
+            });
+            // close the database and reopen to latest version, applying
+            // migrations
+            await (0, idb_js_1.closeDatabase)(this.context.documentDb);
+            this.context.log('Migrating up to latest schema...');
+            // put the schema back
+            this.context.schema = currentSchema;
+            this.context.documentDb = await (0, openDocumentDatabase_js_1.openDocumentDatabase)({
+                meta: this.meta,
+                migrations: this.config.migrations,
+                context: this.context,
+                version: currentSchema.version,
+            });
+        };
+        this.meta = components.meta;
+        this.collectionNames = Object.keys(context.schema.collections);
+        this._sync = this.config.syncConfig
+            ? new Sync_js_1.ServerSync(this.config.syncConfig, {
+                meta: this.meta,
+                onData: this.addData,
+                log: this.context.log,
+            })
+            : new Sync_js_1.NoSync();
+        this._fileManager = new FileManager_js_1.FileManager({
+            db: this.metaDb,
+            sync: this.sync,
+            context: this.context,
+            config: this.config.files,
+            meta: this.meta,
+        });
+        this._entities = new EntityStore_js_1.EntityStore({
+            context: this.context,
+            meta: this.meta,
+            files: this._fileManager,
+        });
+        this._queryCache = new QueryCache_js_1.QueryCache({
+            context,
+        });
+        this._documentManager = new DocumentManager_js_1.DocumentManager(this.meta, this.schema, this._entities);
+        this.documentDb.addEventListener('versionchange', () => {
+            var _a, _b;
+            (_b = (_a = this.context).log) === null || _b === void 0 ? void 0 : _b.call(_a, `Another tab has requested a version change for ${this.namespace}`);
+            this.documentDb.close();
+            if (typeof window !== 'undefined') {
+                window.location.reload();
+            }
+        });
+        this.metaDb.addEventListener('versionchange', () => {
+            var _a, _b;
+            (_b = (_a = this.context).log) === null || _b === void 0 ? void 0 : _b.call(_a, `Another tab has requested a version change for ${this.namespace}`);
+            this.metaDb.close();
+            if (typeof window !== 'undefined') {
+                window.location.reload();
+            }
+        });
+        // self-assign collection shortcuts. these are not typed
+        // here but are typed in the generated code...
+        for (const [name, _collection] of Object.entries(context.schema.collections)) {
+            const collection = _collection;
+            const collectionName = (_a = collection.pluralName) !== null && _a !== void 0 ? _a : collection.name + 's';
+            // TODO: untangle this requirement
+            (0, common_1.assert)(collectionName === name, `The key of the collection in the schema must be the plural of the name (expected: "${collectionName}")`);
+            this[collectionName] = new CollectionQueries_js_1.CollectionQueries({
+                collection: collectionName,
+                cache: this._queryCache,
+                context: this.context,
+                entities: this.entities,
+                documentManager: this.documentManager,
+            });
+        }
+    }
+    get documentDb() {
+        return this.context.documentDb;
+    }
+    get metaDb() {
+        return this.context.metaDb;
+    }
+    get schema() {
+        return this.context.schema;
+    }
+    get namespace() {
+        return this.context.namespace;
+    }
+    get undoHistory() {
+        return this.context.undoHistory;
+    }
+    /**
+     * @deprecated - use client.sync.presence instead
+     */
+    get presence() {
+        return this.sync.presence;
+    }
+    /**
+     * Batch multiple operations together to be executed in a single transaction.
+     * The changes made will not be included in the same undo history step as
+     * any other changes made outside of the batch. You can also disable undo
+     * for your batch to omit changes from undo history.
+     *
+     * Provide a batch name to apply multiple changes to the same batch
+     * across different invocations. Batches will automatically flush after
+     * a short delay or if they reach a maximum size.
+     */
+    get batch() {
+        return this.entities.batch;
+    }
+}
+exports.Client = Client;
+//# sourceMappingURL=Client.js.map

package/dist/cjs/client/Client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../../src/client/Client.ts"],"names":[],"mappings":";;;AAAA,gDAM6B;AAE7B,8DAAwD;AACxD,4DAAyE;AACzE,sCAAgE;AAEhE,wEAAkE;AAClE,gEAA0D;AAC1D,6CAA8E;AAC9E,2EAAqE;AACrE,6DAAuD;AAcvD,MAAa,MAAM;IAWlB,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAED,IAAI,eAAe;QAClB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;IAED,YACS,MAAoB,EACpB,OAAgB,EACxB,UAA8B;;QAFtB,WAAM,GAAN,MAAM,CAAc;QACpB,YAAO,GAAP,OAAO,CAAS;QA4EjB,YAAO,GAAG,CAAC,IAIlB,EAAE,EAAE;YACJ,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC,CAAC;QA2CF,UAAK,GAAG,KAAK,IAAI,EAAE;YAClB,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC7D,IAAI,WAAW,GAAG,EAAqD,CAAC;YACxE,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE;gBAC7C,WAAW,CAAC,cAAc,CAAC,GAAG,MAAM,IAAA,6BAAoB,EACvD,IAAI,CAAC,UAAU,EACf,cAAc,CACd,CAAC;aACF;YACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACrC,MAAM,OAAO,GACZ,OAAO,SAAS,KAAK,WAAW;gBAChC,OAAO,SAAS,CAAC,OAAO,KAAK,WAAW;gBACxC,UAAU,IAAI,SAAS,CAAC,OAAO;gBAC9B,CAAC,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACpC,CAAC,CAAC,SAAS,CAAC;YAEd,8EAA8E;YAC9E,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAC7D,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,EAC7B,CAAC,CACD,CAAC;YACF,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;YACzE,MAAM,eAAe,GAAG,aAAa,GAAG,oBAAoB,CAAC;YAE7D,OAAO;gBACN,WAAW;gBACX,IAAI;gBACJ,OAAO;gBACP,aAAa;gBACb,oBAAoB;gBACpB,eAAe;gBACf,UAAU,EACT,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,MAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAA;oBAC/B,CAAC,CAAC,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK;oBAC/B,CAAC,CAAC,SAAS;aACb,CAAC;QACH,CAAC,CAAC;QAEF,UAAK,GAAG,KAAK,IAAI,EAAE;;YAClB,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAEpB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAElB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;YAEzB,MAAM,IAAA,sBAAa,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACrC,MAAM,IAAA,sBAAa,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEjC,MAAA,MAAA,IAAI,CAAC,OAAO,EAAC,GAAG,mDAAG,eAAe,CAAC,CAAC;QACrC,CAAC,CAAC;QAEF,4BAAuB,GAAG,KAAK,IAAI,EAAE;YACpC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1E,MAAM,IAAI,GAAG,SAAS,CAAC,cAAc,CACpC,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CACzC,CAAC;YACF,MAAM,OAAO,CAAC,GAAG,CAAC;gBACjB,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC/B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;oBACzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;gBACvB,CAAC,CAAC;gBACF,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC/B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;oBACzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;gBACvB,CAAC,CAAC;aACF,CAAC,CAAC;YACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC1B,CAAC,CAAC;QAEF,WAAM,GAAG,KAAK,IAAI,EAAE;YACnB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC;QAEF,WAAM,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;YACjC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACtC,wBAAwB;YACxB,MAAM,IAAA,sBAAa,EAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE7C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAe,CAAC;YAC/D,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YACtC,qDAAqD;YACrD,qDAAqD;YACrD,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;YAC1C,MAAM,SAAS,GAAG,SAAS,CAAC,cAAc,CACzC,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CACzC,CAAC;YACF,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,SAAS,CAAC,SAAS,GAAG,OAAO,CAAC;gBAC9B,SAAS,CAAC,OAAO,GAAG,MAAM,CAAC;YAC5B,CAAC,CAAC,CAAC;YACH,mDAAmD;YACnD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YAC1C,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACxC,0DAA0D;YAC1D,qCAAqC;YACrC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,MAAM,IAAA,8CAAoB,EAAC;gBACpD,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClC,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO;aACP,CAAC,CAAC;YACH,qBAAqB;YACrB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;YAC/D,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;gBAC5B,UAAU,EAAE,UAAU,CAAC,UAAU;gBACjC,SAAS,EAAE,UAAU,CAAC,SAAS;gBAC/B,KAAK,EAAE,IAAI;aACX,CAAC,CAAC;YACH,4DAA4D;YAC5D,aAAa;YACb,MAAM,IAAA,sBAAa,EAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC7C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;YACrD,sBAAsB;YACtB,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,aAAa,CAAC;YACpC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,MAAM,IAAA,8CAAoB,EAAC;gBACpD,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClC,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,aAAa,CAAC,OAAO;aAC9B,CAAC,CAAC;QACJ,CAAC,CAAC;QAvPD,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU;YAClC,CAAC,CAAC,IAAI,oBAAU,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;gBACvC,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM,EAAE,IAAI,CAAC,OAAO;gBACpB,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;aACpB,CAAC;YACJ,CAAC,CAAC,IAAI,gBAAM,EAAE,CAAC;QAEhB,IAAI,CAAC,YAAY,GAAG,IAAI,4BAAW,CAAC;YACnC,EAAE,EAAE,IAAI,CAAC,MAAM;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;YACzB,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,IAAI,4BAAW,CAAC;YAChC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,YAAY;SACxB,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAU,CAAC;YACjC,OAAO;SACP,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,GAAG,IAAI,oCAAe,CAC1C,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,SAAS,CACd,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,eAAe,EAAE,GAAG,EAAE;;YACtD,MAAA,MAAA,IAAI,CAAC,OAAO,EAAC,GAAG,mDACf,kDAAkD,IAAI,CAAC,SAAS,EAAE,CAClE,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YACxB,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;gBAClC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;aACzB;QACF,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,eAAe,EAAE,GAAG,EAAE;;YAClD,MAAA,MAAA,IAAI,CAAC,OAAO,EAAC,GAAG,mDACf,kDAAkD,IAAI,CAAC,SAAS,EAAE,CAClE,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACpB,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;gBAClC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;aACzB;QACF,CAAC,CAAC,CAAC;QAEH,wDAAwD;QACxD,8CAA8C;QAC9C,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAC/C,OAAO,CAAC,MAAM,CAAC,WAAW,CAC1B,EAAE;YACF,MAAM,UAAU,GAAG,WAAyC,CAAC;YAC7D,MAAM,cAAc,GAAG,MAAA,UAAU,CAAC,UAAU,mCAAI,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC;YACtE,kCAAkC;YAClC,IAAA,eAAM,EACL,cAAc,KAAK,IAAI,EACvB,sFAAsF,cAAc,IAAI,CACxG,CAAC;YACD,IAAY,CAAC,cAAc,CAAC,GAAG,IAAI,wCAAiB,CAAC;gBACrD,UAAU,EAAE,cAAc;gBAC1B,KAAK,EAAE,IAAI,CAAC,WAAW;gBACvB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,eAAe,EAAE,IAAI,CAAC,eAAe;aACrC,CAAC,CAAC;SACH;IACF,CAAC;IAUD,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IAChC,CAAC;IAED,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC5B,CAAC;CAgID;AApRD,wBAoRC"}

package/dist/cjs/client/ClientDescriptor.d.ts

@@ -0,0 +1,62 @@
+import { Migration, StorageSchema } from '@verdant-web/common';
+import { FileManagerConfig } from '../files/FileManager.js';
+import { ServerSyncOptions } from '../sync/Sync.js';
+import { UndoHistory } from '../UndoHistory.js';
+import { Client } from './Client.js';
+export interface ClientDescriptorOptions<Presence = any, Profile = any> {
+    /** The schema used to create this client */
+    schema: StorageSchema<any>;
+    /** Migrations, in order, to upgrade to each successive version of the schema */
+    migrations: Migration<any>[];
+    /** Provide a sync config to turn on synchronization with a server */
+    sync?: ServerSyncOptions<Profile, Presence>;
+    /** Optionally override the IndexedDB implementation */
+    indexedDb?: IDBFactory;
+    /**
+     * Namespaces are used to separate data from different clients in IndexedDB.
+     */
+    namespace: string;
+    /**
+     * Provide your own UndoHistory to have a unified undo system across multiple
+     * clients if you so desire.
+     */
+    undoHistory?: UndoHistory;
+    /**
+     * Provide a log function to log internal debug messages
+     */
+    log?: (...args: any[]) => void;
+    disableRebasing?: boolean;
+    /**
+     * Provide a specific schema number to override the schema version
+     * in the database. This is useful for testing migrations or recovering
+     * from a mistakenly deployed incorrect schema. A specific version is required
+     * so that you don't leave this on accidentally for all new schemas.
+     */
+    overrideSchemaConflict?: number;
+    /**
+     * Configuration for file management
+     */
+    files?: FileManagerConfig;
+}
+/**
+ * Since storage initialization is async, this class wraps the core
+ * Storage creation promise and exposes some metadata which can
+ * be useful immediately.
+ */
+export declare class ClientDescriptor<Presence = any, Profile = any> {
+    private readonly init;
+    private readonly _readyPromise;
+    private resolveReady;
+    private rejectReady;
+    private _resolvedValue;
+    private _initializing;
+    private _namespace;
+    get namespace(): string;
+    constructor(init: ClientDescriptorOptions<Presence, Profile>);
+    private initialize;
+    get current(): Client | undefined;
+    get readyPromise(): Promise<Client>;
+    get schema(): StorageSchema<any>;
+    open: () => Promise<Client>;
+    close: () => Promise<void>;
+}

package/dist/cjs/client/ClientDescriptor.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientDescriptor = void 0;
+const common_1 = require("@verdant-web/common");
+const Metadata_js_1 = require("../metadata/Metadata.js");
+const openMetadataDatabase_js_1 = require("../metadata/openMetadataDatabase.js");
+const openDocumentDatabase_js_1 = require("../openDocumentDatabase.js");
+const UndoHistory_js_1 = require("../UndoHistory.js");
+const Client_js_1 = require("./Client.js");
+/**
+ * Since storage initialization is async, this class wraps the core
+ * Storage creation promise and exposes some metadata which can
+ * be useful immediately.
+ */
+class ClientDescriptor {
+    get namespace() {
+        return this._namespace;
+    }
+    constructor(init) {
+        this.init = init;
+        this._initializing = false;
+        this.initialize = async (init) => {
+            // if server-side and no alternative IndexedDB implementation was provided,
+            // we can't initialize the storage
+            if (!('indexedDB' in window) && !init.indexedDb) {
+                throw new Error('A verdant client was initialized in an environment without IndexedDB. If you are using verdant in a server-rendered framework, you must enforce that all clients are initialized on the client-side, or you must provide some mock interface of IDBFactory to the ClientDescriptor options.');
+            }
+            if (this._initializing || this._resolvedValue) {
+                return this._readyPromise;
+            }
+            this._initializing = true;
+            try {
+                const metaDbName = [init.namespace, 'meta'].join('_');
+                const { db: metaDb } = await (0, openMetadataDatabase_js_1.openMetadataDatabase)(this._namespace, {
+                    indexedDB: init.indexedDb,
+                    log: init.log,
+                    databaseName: metaDbName,
+                });
+                const context = {
+                    namespace: this._namespace,
+                    metaDb,
+                    schema: init.schema,
+                    log: init.log || (() => { }),
+                    undoHistory: init.undoHistory || new UndoHistory_js_1.UndoHistory(),
+                    entityEvents: new common_1.EventSubscriber(),
+                };
+                const meta = new Metadata_js_1.Metadata({
+                    context,
+                    disableRebasing: init.disableRebasing,
+                });
+                // verify schema integrity
+                await meta.updateSchema(init.schema, init.overrideSchemaConflict);
+                const documentDb = await (0, openDocumentDatabase_js_1.openDocumentDatabase)({
+                    context,
+                    version: init.schema.version,
+                    meta,
+                    migrations: init.migrations,
+                    indexedDB: init.indexedDb,
+                });
+                const fullContext = Object.assign(context, { documentDb });
+                const storage = new Client_js_1.Client({
+                    syncConfig: init.sync,
+                    migrations: init.migrations,
+                    files: init.files,
+                }, fullContext, {
+                    meta,
+                });
+                this.resolveReady(storage);
+                this._resolvedValue = storage;
+                return storage;
+            }
+            catch (err) {
+                this.rejectReady(err);
+                throw err;
+            }
+            finally {
+                this._initializing = false;
+            }
+        };
+        this.open = () => this.initialize(this.init);
+        this.close = async () => {
+            if (this._resolvedValue) {
+                this._resolvedValue.close();
+            }
+            if (this._initializing) {
+                (await this._readyPromise).close();
+            }
+        };
+        this._readyPromise = new Promise((resolve, reject) => {
+            this.resolveReady = resolve;
+            this.rejectReady = reject;
+        });
+        this._namespace = init.namespace;
+    }
+    get current() {
+        // exposing an immediate value if already resolved lets us
+        // skip the promise microtask when accessing this externally if
+        // the initialization has been completed.
+        return this._resolvedValue;
+    }
+    get readyPromise() {
+        return this._readyPromise;
+    }
+    get schema() {
+        return this.init.schema;
+    }
+}
+exports.ClientDescriptor = ClientDescriptor;
+//# sourceMappingURL=ClientDescriptor.js.map

package/dist/cjs/client/ClientDescriptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientDescriptor.js","sourceRoot":"","sources":["../../../src/client/ClientDescriptor.ts"],"names":[],"mappings":";;;AAAA,gDAAgF;AAIhF,yDAAmD;AACnD,iFAA2E;AAC3E,wEAAkE;AAElE,sDAAgD;AAChD,2CAAqC;AAsCrC;;;;GAIG;AACH,MAAa,gBAAgB;IAU5B,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IAED,YACkB,IAAgD;QAAhD,SAAI,GAAJ,IAAI,CAA4C;QAR1D,kBAAa,GAAG,KAAK,CAAC;QAiBtB,eAAU,GAAG,KAAK,EAAE,IAA6B,EAAE,EAAE;YAC5D,2EAA2E;YAC3E,kCAAkC;YAClC,IAAI,CAAC,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBAChD,MAAM,IAAI,KAAK,CACd,6RAA6R,CAC7R,CAAC;aACF;YAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,cAAc,EAAE;gBAC9C,OAAO,IAAI,CAAC,aAAa,CAAC;aAC1B;YACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;YAC1B,IAAI;gBACH,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACtD,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,8CAAoB,EAAC,IAAI,CAAC,UAAU,EAAE;oBAClE,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,GAAG,EAAE,IAAI,CAAC,GAAG;oBACb,YAAY,EAAE,UAAU;iBACxB,CAAC,CAAC;gBAEH,MAAM,OAAO,GAAgC;oBAC5C,SAAS,EAAE,IAAI,CAAC,UAAU;oBAC1B,MAAM;oBACN,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC;oBAC3B,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI,4BAAW,EAAE;oBAClD,YAAY,EAAE,IAAI,wBAAe,EAAE;iBACnC,CAAC;gBACF,MAAM,IAAI,GAAG,IAAI,sBAAQ,CAAC;oBACzB,OAAO;oBACP,eAAe,EAAE,IAAI,CAAC,eAAe;iBACrC,CAAC,CAAC;gBAEH,0BAA0B;gBAC1B,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;gBAElE,MAAM,UAAU,GAAG,MAAM,IAAA,8CAAoB,EAAC;oBAC7C,OAAO;oBACP,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;oBAC5B,IAAI;oBACJ,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;iBACzB,CAAC,CAAC;gBAEH,MAAM,WAAW,GAAY,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;gBAEpE,MAAM,OAAO,GAAG,IAAI,kBAAM,CACzB;oBACC,UAAU,EAAE,IAAI,CAAC,IAAI;oBACrB,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,KAAK,EAAE,IAAI,CAAC,KAAK;iBACjB,EACD,WAAW,EACX;oBACC,IAAI;iBACJ,CACD,CAAC;gBAEF,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAC3B,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;gBAC9B,OAAO,OAAO,CAAC;aACf;YAAC,OAAO,GAAG,EAAE;gBACb,IAAI,CAAC,WAAW,CAAC,GAAY,CAAC,CAAC;gBAC/B,MAAM,GAAG,CAAC;aACV;oBAAS;gBACT,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;aAC3B;QACF,CAAC,CAAC;QAiBF,SAAI,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAExC,UAAK,GAAG,KAAK,IAAI,EAAE;YAClB,IAAI,IAAI,CAAC,cAAc,EAAE;gBACxB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;aAC5B;YACD,IAAI,IAAI,CAAC,aAAa,EAAE;gBACvB,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,CAAC;aACnC;QACF,CAAC,CAAC;QArGD,IAAI,CAAC,aAAa,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;YAC5B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;IAClC,CAAC;IAwED,IAAI,OAAO;QACV,0DAA0D;QAC1D,+DAA+D;QAC/D,yCAAyC;QACzC,OAAO,IAAI,CAAC,cAAc,CAAC;IAC5B,CAAC;IAED,IAAI,YAAY;QACf,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;IAED,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IACzB,CAAC;CAYD;AAvHD,4CAuHC"}

package/dist/cjs/constants.d.ts

@@ -0,0 +1 @@
+export declare const TEST_API = "__unsafe__test_api__";

package/dist/cjs/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TEST_API = void 0;
+exports.TEST_API = '__unsafe__test_api__';
+//# sourceMappingURL=constants.js.map

package/dist/cjs/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,QAAQ,GAAG,sBAAsB,CAAC"}

package/dist/cjs/context.d.ts

@@ -0,0 +1,17 @@
+import { EventSubscriber, StorageSchema } from '@verdant-web/common';
+import { UndoHistory } from './UndoHistory.js';
+/**
+ * Common components utilized across various client
+ * services.
+ */
+export interface Context {
+    namespace: string;
+    metaDb: IDBDatabase;
+    documentDb: IDBDatabase;
+    undoHistory: UndoHistory;
+    schema: StorageSchema;
+    log: (...args: any[]) => void;
+    entityEvents: EventSubscriber<{
+        collectionsChanged: (names: string[]) => void;
+    }>;
+}

package/dist/cjs/context.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context.js.map

package/dist/cjs/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/context.ts"],"names":[],"mappings":""}

package/dist/cjs/files/EntityFile.d.ts

@@ -0,0 +1,27 @@
+import { EventSubscriber, FileData } from '@verdant-web/common';
+export type EntityFileEvents = {
+    change: () => void;
+};
+export declare const UPDATE: unique symbol;
+export declare const MARK_FAILED: unique symbol;
+/**
+ * Provides a consistent interface for files used in an app via
+ * Entity access.
+ */
+export declare class EntityFile extends EventSubscriber<EntityFileEvents> {
+    readonly id: string;
+    private _objectUrl;
+    private _fileData;
+    private _loading;
+    private _failed;
+    private _disposed;
+    constructor(id: string);
+    [UPDATE]: (fileData: FileData) => void;
+    [MARK_FAILED]: () => void;
+    get url(): string | null;
+    get name(): string | null;
+    get type(): string | null;
+    get loading(): boolean;
+    get failed(): boolean;
+    dispose: () => void;
+}

package/dist/cjs/files/EntityFile.js

@@ -0,0 +1,72 @@
+"use strict";
+var _a, _b;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityFile = exports.MARK_FAILED = exports.UPDATE = void 0;
+const common_1 = require("@verdant-web/common");
+exports.UPDATE = Symbol('entity-file-update');
+exports.MARK_FAILED = Symbol('entity-file-mark-failed');
+/**
+ * Provides a consistent interface for files used in an app via
+ * Entity access.
+ */
+class EntityFile extends common_1.EventSubscriber {
+    constructor(id) {
+        super();
+        this.id = id;
+        // cached object URL for a local blob file, if applicable
+        this._objectUrl = null;
+        this._fileData = null;
+        this._loading = true;
+        this._failed = false;
+        this._disposed = false;
+        this[_a] = (fileData) => {
+            this._loading = false;
+            this._failed = false;
+            this._disposed = false;
+            this._fileData = fileData;
+            if (fileData.file) {
+                if (this._objectUrl) {
+                    URL.revokeObjectURL(this._objectUrl);
+                }
+                this._objectUrl = URL.createObjectURL(fileData.file);
+            }
+            this.emit('change');
+        };
+        this[_b] = () => {
+            this._failed = true;
+            this._loading = false;
+            this.emit('change');
+        };
+        this.dispose = () => {
+            if (this._objectUrl) {
+                URL.revokeObjectURL(this._objectUrl);
+            }
+            this._disposed = true;
+        };
+    }
+    get url() {
+        var _c, _d;
+        if (this.loading)
+            return null;
+        if (this._objectUrl)
+            return this._objectUrl;
+        return (_d = (_c = this._fileData) === null || _c === void 0 ? void 0 : _c.url) !== null && _d !== void 0 ? _d : null;
+    }
+    get name() {
+        var _c, _d;
+        return (_d = (_c = this._fileData) === null || _c === void 0 ? void 0 : _c.name) !== null && _d !== void 0 ? _d : null;
+    }
+    get type() {
+        var _c, _d;
+        return (_d = (_c = this._fileData) === null || _c === void 0 ? void 0 : _c.type) !== null && _d !== void 0 ? _d : null;
+    }
+    get loading() {
+        return this._loading;
+    }
+    get failed() {
+        return this._failed;
+    }
+}
+exports.EntityFile = EntityFile;
+_a = exports.UPDATE, _b = exports.MARK_FAILED;
+//# sourceMappingURL=EntityFile.js.map

package/dist/cjs/files/EntityFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityFile.js","sourceRoot":"","sources":["../../../src/files/EntityFile.ts"],"names":[],"mappings":";;;;AAAA,gDAAgE;AAMnD,QAAA,MAAM,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;AACtC,QAAA,WAAW,GAAG,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAE7D;;;GAGG;AACH,MAAa,UAAW,SAAQ,wBAAiC;IAQhE,YAA4B,EAAU;QACrC,KAAK,EAAE,CAAC;QADmB,OAAE,GAAF,EAAE,CAAQ;QAPtC,yDAAyD;QACjD,eAAU,GAAkB,IAAI,CAAC;QACjC,cAAS,GAAoB,IAAI,CAAC;QAClC,aAAQ,GAAG,IAAI,CAAC;QAChB,YAAO,GAAG,KAAK,CAAC;QAChB,cAAS,GAAG,KAAK,CAAC;QAM1B,QAAQ,GAAG,CAAC,QAAkB,EAAE,EAAE;YACjC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,QAAQ,CAAC,IAAI,EAAE;gBAClB,IAAI,IAAI,CAAC,UAAU,EAAE;oBACpB,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;iBACrC;gBACD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aACrD;YACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC,CAAC;QAEF,QAAa,GAAG,GAAG,EAAE;YACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC,CAAC;QAwBF,YAAO,GAAG,GAAG,EAAE;YACd,IAAI,IAAI,CAAC,UAAU,EAAE;gBACpB,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aACrC;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC;IAjDF,CAAC;IAsBD,IAAI,GAAG;;QACN,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QAC9B,IAAI,IAAI,CAAC,UAAU;YAAE,OAAO,IAAI,CAAC,UAAU,CAAC;QAC5C,OAAO,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,GAAG,mCAAI,IAAI,CAAC;IACpC,CAAC;IAED,IAAI,IAAI;;QACP,OAAO,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,IAAI,mCAAI,IAAI,CAAC;IACrC,CAAC;IAED,IAAI,IAAI;;QACP,OAAO,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,IAAI,mCAAI,IAAI,CAAC;IACrC,CAAC;IAED,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;CAQD;AA5DD,gCA4DC;KAhDC,cAAM,OAcN,mBAAW"}