@verdant-web/store 2.7.7-next.0 → 2.7.8

package/dist/cjs/client/ClientDescriptor.js

@@ -1,198 +1,198 @@
-"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 openDatabase_js_1 = require("../migration/openDatabase.js");
-const UndoHistory_js_1 = require("../UndoHistory.js");
-const Client_js_1 = require("./Client.js");
-const idb_js_1 = require("../idb.js");
-const FakeWeakRef_js_1 = require("../FakeWeakRef.js");
-const constants_js_1 = require("./constants.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 (typeof window === 'undefined' && !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 {
-                let storage;
-                if (init.schema.wip) {
-                    storage = await this.initializeWIPDatabases(init);
-                }
-                else {
-                    storage = await this.initializeDatabases(init);
-                    this.cleanupWIPDatabases(init);
-                }
-                this.resolveReady(storage);
-                this._resolvedValue = storage;
-                return storage;
-            }
-            catch (err) {
-                this.rejectReady(err);
-                throw err;
-            }
-            finally {
-                this._initializing = false;
-            }
-        };
-        this.initializeDatabases = async (init) => {
-            const metadataVersion = init[constants_js_1.METADATA_VERSION_KEY];
-            const { db: metaDb } = await (0, openMetadataDatabase_js_1.openMetadataDatabase)({
-                indexedDB: init.indexedDb,
-                log: init.log,
-                namespace: init.namespace,
-                metadataVersion,
-            });
-            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(),
-                globalEvents: new common_1.EventSubscriber(),
-                weakRef: (value) => {
-                    if (init.EXPERIMENTAL_weakRefs) {
-                        return new WeakRef(value);
-                    }
-                    else {
-                        return new FakeWeakRef_js_1.FakeWeakRef(value);
-                    }
-                },
-            };
-            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, openDatabase_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,
-            });
-            return storage;
-        };
-        this.initializeWIPDatabases = async (init) => {
-            const schemaHash = (0, common_1.hashObject)(init.schema);
-            console.info(`WIP schema in use. Opening database with hash ${schemaHash}`);
-            const wipNamespace = `@@wip_${init.namespace}_${schemaHash}`;
-            const { db: metaDb } = await (0, openMetadataDatabase_js_1.openWIPMetadataDatabase)({
-                indexedDB: init.indexedDb,
-                log: init.log,
-                namespace: init.namespace,
-                wipNamespace: wipNamespace,
-            });
-            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(),
-                globalEvents: new common_1.EventSubscriber(),
-                weakRef: (value) => {
-                    if (init.EXPERIMENTAL_weakRefs) {
-                        return new WeakRef(value);
-                    }
-                    else {
-                        return new FakeWeakRef_js_1.FakeWeakRef(value);
-                    }
-                },
-            };
-            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, openDatabase_js_1.openWIPDocumentDatabase)({
-                context,
-                version: init.schema.version,
-                meta,
-                migrations: init.migrations,
-                indexedDB: init.indexedDb,
-                wipNamespace,
-            });
-            const fullContext = Object.assign(context, { documentDb });
-            const storage = new Client_js_1.Client({
-                syncConfig: init.sync,
-                migrations: init.migrations,
-                files: init.files,
-            }, fullContext, {
-                meta,
-            });
-            return storage;
-        };
-        this.cleanupWIPDatabases = async (init) => {
-            const databaseInfo = await (0, idb_js_1.getAllDatabaseNamesAndVersions)(init.indexedDb);
-            const wipDatabases = databaseInfo
-                .filter((db) => { var _a; return (_a = db.name) === null || _a === void 0 ? void 0 : _a.startsWith('@@wip_'); })
-                .map((db) => db.name);
-            // don't clear a current WIP database.
-            const wipDatabasesToDelete = wipDatabases.filter((db) => !db.startsWith(`@@wip_${init.namespace}_${(0, common_1.hashObject)(init.schema)}`));
-            for (const db of wipDatabasesToDelete) {
-                await (0, idb_js_1.deleteDatabase)(db, init.indexedDb);
-            }
-        };
-        this.open = () => this.initialize(this.init);
-        this.close = async () => {
-            if (this._resolvedValue) {
-                this._resolvedValue.close();
-            }
-            if (this._initializing) {
-                (await this._readyPromise).close();
-            }
-        };
-        this.__dangerous__resetLocal = async () => {
-            await (0, idb_js_1.deleteAllDatabases)(this.namespace);
-        };
-        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;
+"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 openDatabase_js_1 = require("../migration/openDatabase.js");
+const UndoHistory_js_1 = require("../UndoHistory.js");
+const Client_js_1 = require("./Client.js");
+const idb_js_1 = require("../idb.js");
+const FakeWeakRef_js_1 = require("../FakeWeakRef.js");
+const constants_js_1 = require("./constants.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 (typeof window === 'undefined' && !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 {
+                let storage;
+                if (init.schema.wip) {
+                    storage = await this.initializeWIPDatabases(init);
+                }
+                else {
+                    storage = await this.initializeDatabases(init);
+                    this.cleanupWIPDatabases(init);
+                }
+                this.resolveReady(storage);
+                this._resolvedValue = storage;
+                return storage;
+            }
+            catch (err) {
+                this.rejectReady(err);
+                throw err;
+            }
+            finally {
+                this._initializing = false;
+            }
+        };
+        this.initializeDatabases = async (init) => {
+            const metadataVersion = init[constants_js_1.METADATA_VERSION_KEY];
+            const { db: metaDb } = await (0, openMetadataDatabase_js_1.openMetadataDatabase)({
+                indexedDB: init.indexedDb,
+                log: init.log,
+                namespace: init.namespace,
+                metadataVersion,
+            });
+            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(),
+                globalEvents: new common_1.EventSubscriber(),
+                weakRef: (value) => {
+                    if (init.EXPERIMENTAL_weakRefs) {
+                        return new WeakRef(value);
+                    }
+                    else {
+                        return new FakeWeakRef_js_1.FakeWeakRef(value);
+                    }
+                },
+            };
+            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, openDatabase_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,
+            });
+            return storage;
+        };
+        this.initializeWIPDatabases = async (init) => {
+            const schemaHash = (0, common_1.hashObject)(init.schema);
+            console.info(`WIP schema in use. Opening database with hash ${schemaHash}`);
+            const wipNamespace = `@@wip_${init.namespace}_${schemaHash}`;
+            const { db: metaDb } = await (0, openMetadataDatabase_js_1.openWIPMetadataDatabase)({
+                indexedDB: init.indexedDb,
+                log: init.log,
+                namespace: init.namespace,
+                wipNamespace: wipNamespace,
+            });
+            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(),
+                globalEvents: new common_1.EventSubscriber(),
+                weakRef: (value) => {
+                    if (init.EXPERIMENTAL_weakRefs) {
+                        return new WeakRef(value);
+                    }
+                    else {
+                        return new FakeWeakRef_js_1.FakeWeakRef(value);
+                    }
+                },
+            };
+            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, openDatabase_js_1.openWIPDocumentDatabase)({
+                context,
+                version: init.schema.version,
+                meta,
+                migrations: init.migrations,
+                indexedDB: init.indexedDb,
+                wipNamespace,
+            });
+            const fullContext = Object.assign(context, { documentDb });
+            const storage = new Client_js_1.Client({
+                syncConfig: init.sync,
+                migrations: init.migrations,
+                files: init.files,
+            }, fullContext, {
+                meta,
+            });
+            return storage;
+        };
+        this.cleanupWIPDatabases = async (init) => {
+            const databaseInfo = await (0, idb_js_1.getAllDatabaseNamesAndVersions)(init.indexedDb);
+            const wipDatabases = databaseInfo
+                .filter((db) => { var _a; return (_a = db.name) === null || _a === void 0 ? void 0 : _a.startsWith('@@wip_'); })
+                .map((db) => db.name);
+            // don't clear a current WIP database.
+            const wipDatabasesToDelete = wipDatabases.filter((db) => !db.startsWith(`@@wip_${init.namespace}_${(0, common_1.hashObject)(init.schema)}`));
+            for (const db of wipDatabasesToDelete) {
+                await (0, idb_js_1.deleteDatabase)(db, init.indexedDb);
+            }
+        };
+        this.open = () => this.initialize(this.init);
+        this.close = async () => {
+            if (this._resolvedValue) {
+                this._resolvedValue.close();
+            }
+            if (this._initializing) {
+                (await this._readyPromise).close();
+            }
+        };
+        this.__dangerous__resetLocal = async () => {
+            await (0, idb_js_1.deleteAllDatabases)(this.namespace);
+        };
+        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/constants.d.ts

@@ -1 +1 @@
-export declare const METADATA_VERSION_KEY: unique symbol;
+export declare const METADATA_VERSION_KEY: unique symbol;

package/dist/cjs/client/constants.js

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

package/dist/cjs/constants.d.ts

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

package/dist/cjs/constants.js

@@ -1,5 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_API = void 0;
-exports.TEST_API = '__unsafe__test_api__';
+"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/context.d.ts

@@ -1,29 +1,29 @@
-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;
-    }>;
-    globalEvents: EventSubscriber<{
-        /**
-         * A change from a future version of the application has been
-         * witnessed. These changes are not applied but it indicates
-         * the app has been updated and we should prompt the user
-         * to reload or have their app user manually reload.
-         *
-         * The parameter is the timestamp of the future change.
-         */
-        futureSeen: (timestamp: string) => void;
-    }>;
-    weakRef<T extends object>(value: T): WeakRef<T>;
-}
+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;
+    }>;
+    globalEvents: EventSubscriber<{
+        /**
+         * A change from a future version of the application has been
+         * witnessed. These changes are not applied but it indicates
+         * the app has been updated and we should prompt the user
+         * to reload or have their app user manually reload.
+         *
+         * The parameter is the timestamp of the future change.
+         */
+        futureSeen: (timestamp: string) => void;
+    }>;
+    weakRef<T extends object>(value: T): WeakRef<T>;
+}

package/dist/cjs/context.js

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