@verdant-web/store 2.0.1

package/dist/cjs/Storage.js

@@ -0,0 +1,346 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageDescriptor = exports.Storage = void 0;
+const Sync_js_1 = require("./sync/Sync.js");
+const Metadata_js_1 = require("./metadata/Metadata.js");
+const LiveQueryMaker_js_1 = require("./queries/LiveQueryMaker.js");
+const LiveQueryStore_js_1 = require("./queries/LiveQueryStore.js");
+const openDocumentDatabase_js_1 = require("./openDocumentDatabase.js");
+const DocumentManager_js_1 = require("./DocumentManager.js");
+const EntityStore_js_1 = require("./reactives/EntityStore.js");
+const idb_js_1 = require("./idb.js");
+const openMetadataDatabase_js_1 = require("./metadata/openMetadataDatabase.js");
+const UndoHistory_js_1 = require("./UndoHistory.js");
+class Storage {
+    constructor(config, context, components) {
+        var _a;
+        this.config = config;
+        this.context = context;
+        this.initialize = () => {
+            this._entities = new EntityStore_js_1.EntityStore({
+                context: this.context,
+                meta: this.meta,
+            });
+            this._queryStore = new LiveQueryStore_js_1.LiveQueryStore(this._entities, this.context);
+            this._queryMaker = new LiveQueryMaker_js_1.LiveQueryMaker(this._queryStore, this.context);
+            this._documentManager = new DocumentManager_js_1.DocumentManager(this.meta, this.schema, this._entities);
+            this._sync = this.config.syncConfig
+                ? new Sync_js_1.ServerSync(this.config.syncConfig, {
+                    meta: this.meta,
+                    entities: this._entities,
+                    log: this.config.log,
+                })
+                : new Sync_js_1.NoSync();
+            this.documentDb.addEventListener('versionchange', () => {
+                var _a, _b;
+                (_b = (_a = this.config).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.config).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();
+                }
+            });
+        };
+        /**
+         * @deprecated - use put
+         */
+        this.create = async (...args) => {
+            return this._documentManager.create(...args);
+        };
+        this.put = async (...args) => {
+            return this._documentManager.create(...args);
+        };
+        this.delete = async (...args) => {
+            return this._documentManager.delete(...args);
+        };
+        this.get = (...args) => {
+            return this._queryMaker.get(...args);
+        };
+        this.findOne = (...args) => {
+            return this._queryMaker.findOne(...args);
+        };
+        this.findAll = (...args) => {
+            return this._queryMaker.findAll(...args);
+        };
+        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;
+            this.sync.stop();
+            this.sync.dispose();
+            this.meta.close();
+            this._queryStore.destroy();
+            this._entities.destroy();
+            await (0, idb_js_1.closeDatabase)(this.documentDb);
+            await (0, idb_js_1.closeDatabase)(this.metaDb);
+            (_b = (_a = this.config).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,
+            });
+            // re-initialize query store
+            this._queryStore.updateAll();
+        };
+        this.meta = components.meta;
+        this.collectionNames = Object.keys(context.schema.collections);
+        this.initialize();
+        // 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';
+            // @ts-ignore
+            this[collectionName] = {
+                /** @deprecated - use put */
+                create: (doc) => this._documentManager.create(name, doc),
+                put: (doc) => this._documentManager.create(name, doc),
+                delete: (id) => this._documentManager.delete(name, id),
+                deleteAll: (ids) => this._documentManager.deleteAll(ids.map((id) => [name, id])),
+                get: (id) => this._queryMaker.get(name, id),
+                findOne: (query) => this._queryMaker.findOne(name, query),
+                findAll: (query) => this._queryMaker.findAll(name, query),
+            };
+        }
+    }
+    get queryMaker() {
+        return this._queryMaker;
+    }
+    get sync() {
+        return this._sync;
+    }
+    get entities() {
+        return this._entities;
+    }
+    get queryStore() {
+        return this._queryStore;
+    }
+    get documentManager() {
+        return 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.Storage = Storage;
+/**
+ * Since storage initialization is async, this class wraps the core
+ * Storage creation promise and exposes some metadata which can
+ * be useful immediately.
+ */
+class StorageDescriptor {
+    constructor(init) {
+        this.init = init;
+        this._initializing = false;
+        this.initialize = async (init) => {
+            // if server-side, return an interminable promise
+            if (typeof window === 'undefined') {
+                return new Promise(() => { });
+            }
+            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(),
+                };
+                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 Storage({
+                    syncConfig: init.sync,
+                    migrations: init.migrations,
+                }, 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 namespace() {
+        return this._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.StorageDescriptor = StorageDescriptor;
+//# sourceMappingURL=Storage.js.map

package/dist/cjs/Storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Storage.js","sourceRoot":"","sources":["../../src/Storage.ts"],"names":[],"mappings":";;;AACA,4CAA6E;AAC7E,wDAA8D;AAC9D,mEAA6D;AAC7D,mEAA6D;AAC7D,uEAAiE;AACjE,6DAAuD;AACvD,+DAAyD;AACzD,qCAA+D;AAC/D,gFAA0E;AAC1E,qDAA+C;AAS/C,MAAa,OAAO;IA+BnB,YACS,MAAqB,EACrB,OAAgB,EACxB,UAA8B;;QAFtB,WAAM,GAAN,MAAM,CAAe;QACrB,YAAO,GAAP,OAAO,CAAS;QA6BjB,eAAU,GAAG,GAAG,EAAE;YACzB,IAAI,CAAC,SAAS,GAAG,IAAI,4BAAW,CAAC;gBAChC,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,IAAI,CAAC,IAAI;aACf,CAAC,CAAC;YACH,IAAI,CAAC,WAAW,GAAG,IAAI,kCAAc,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACpE,IAAI,CAAC,WAAW,GAAG,IAAI,kCAAc,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACtE,IAAI,CAAC,gBAAgB,GAAG,IAAI,oCAAe,CAC1C,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,SAAS,CACd,CAAC;YAEF,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClC,CAAC,CAAC,IAAI,oBAAU,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;oBACvC,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,QAAQ,EAAE,IAAI,CAAC,SAAS;oBACxB,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG;iBACnB,CAAC;gBACJ,CAAC,CAAC,IAAI,gBAAM,EAAE,CAAC;YAEhB,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,eAAe,EAAE,GAAG,EAAE;;gBACtD,MAAA,MAAA,IAAI,CAAC,MAAM,EAAC,GAAG,mDACd,kDAAkD,IAAI,CAAC,SAAS,EAAE,CAClE,CAAC;gBACF,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;gBACxB,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;oBAClC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;iBACzB;YACF,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,eAAe,EAAE,GAAG,EAAE;;gBAClD,MAAA,MAAA,IAAI,CAAC,MAAM,EAAC,GAAG,mDACd,kDAAkD,IAAI,CAAC,SAAS,EAAE,CAClE,CAAC;gBACF,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBACpB,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;oBAClC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;iBACzB;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC;QA6BF;;WAEG;QACH,WAAM,GAAmC,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;YAC1D,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;QAC9C,CAAC,CAAC;QAEF,QAAG,GAAmC,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;YACvD,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;QAC9C,CAAC,CAAC;QAEF,WAAM,GAAmC,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;YAC1D,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;QAC9C,CAAC,CAAC;QAEF,QAAG,GAA0B,CAAC,GAAG,IAAI,EAAE,EAAE;YACxC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC;QAEF,YAAO,GAA8B,CAAC,GAAG,IAAI,EAAE,EAAE;YAChD,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QAC1C,CAAC,CAAC;QAEF,YAAO,GAA8B,CAAC,GAAG,IAAI,EAAE,EAAE;YAChD,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QAC1C,CAAC,CAAC;QAgBF,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,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,WAAW,CAAC,OAAO,EAAE,CAAC;YAC3B,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,MAAM,EAAC,GAAG,mDAAG,eAAe,CAAC,CAAC;QACpC,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;YACH,4BAA4B;YAC5B,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;QAC9B,CAAC,CAAC;QAvQD,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,UAAU,EAAE,CAAC;QAElB,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,aAAa;YACb,IAAI,CAAC,cAAc,CAAC,GAAG;gBACtB,4BAA4B;gBAC5B,MAAM,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC;gBAC7D,GAAG,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC;gBAC1D,MAAM,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC9D,SAAS,EAAE,CAAC,GAAa,EAAE,EAAE,CAC5B,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;gBAC7D,GAAG,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;gBACnD,OAAO,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;gBAC9D,OAAO,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;aAC9D,CAAC;SACF;IACF,CAAC;IAjDD,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAED,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED,IAAI,eAAe;QAClB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;IA2ED,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;IA6BD;;;;;;;;;OASG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC5B,CAAC;CAkID;AA5SD,0BA4SC;AAkCD;;;;GAIG;AACH,MAAa,iBAAiB;IAc7B,YAA6B,IAA2C;QAA3C,SAAI,GAAJ,IAAI,CAAuC;QAPhE,kBAAa,GAAG,KAAK,CAAC;QAetB,eAAU,GAAG,KAAK,EAAE,IAAwB,EAAE,EAAE;YACvD,iDAAiD;YACjD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;gBAClC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,GAAE,CAAC,CAAQ,CAAC;aACpC;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;iBAClD,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,OAAO,CAC1B;oBACC,UAAU,EAAE,IAAI,CAAC,IAAI;oBACrB,UAAU,EAAE,IAAI,CAAC,UAAU;iBAC3B,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;QAhGD,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;IAVD,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IA2ED,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;AAhHD,8CAgHC"}

package/dist/cjs/Sync.d.ts

@@ -0,0 +1,117 @@
+import { ClientMessage, EventSubscriber } from '@lo-fi/common';
+import { EntityStore } from './reactives/EntityStore.js';
+import { Metadata } from './metadata/Metadata.js';
+import { PresenceManager } from './PresenceManager.js';
+declare type SyncEvents = {
+    onlineChange: (isOnline: boolean) => void;
+};
+export interface SyncTransport {
+    subscribe(event: 'onlineChange', handler: (online: boolean) => void): () => void;
+    readonly presence: PresenceManager;
+    readonly mode: SyncTransportMode;
+    send(message: ClientMessage): void;
+    start(): void;
+    stop(): void;
+    dispose(): void;
+    reconnect(): void;
+    readonly isConnected: boolean;
+    readonly status: 'active' | 'paused';
+}
+export interface Sync extends SyncTransport {
+    setMode(mode: SyncTransportMode): void;
+}
+export declare class NoSync extends EventSubscriber<SyncEvents> implements Sync {
+    readonly mode = "pull";
+    send(): void;
+    start(): void;
+    stop(): void;
+    dispose: () => void;
+    reconnect(): void;
+    setMode(): void;
+    readonly isConnected = false;
+    readonly status = "paused";
+    readonly presence: PresenceManager<{}, {}>;
+}
+export interface ServerSyncEndpointProviderConfig {
+    /**
+     * The location of the endpoint used to retrieve an
+     * authorization token for the client.
+     */
+    authEndpoint?: string;
+    /**
+     * A custom fetch function to retrieve authorization
+     * data.
+     */
+    fetchAuth?: () => Promise<{
+        accessToken: string;
+    }>;
+}
+export declare type SyncTransportMode = 'realtime' | 'pull';
+export interface ServerSyncOptions<Profile = any, Presence = any> extends ServerSyncEndpointProviderConfig {
+    /**
+     * When a client first connects, it will use this presence value.
+     */
+    initialPresence: Presence;
+    /**
+     * Before connecting to the server, the local client will have
+     * this value for their profile data. You can either cache and store
+     * profile data from a previous connection or provide defaults like
+     * empty strings.
+     */
+    defaultProfile: Profile;
+    /**
+     * Provide `false` to disable transport selection. Transport selection
+     * automatically switches between HTTP and WebSocket based sync depending
+     * on the number of peers connected. If a user is alone, they will use
+     * HTTP push/pull to sync changes. If another user joins, both users will
+     * be upgraded to websockets.
+     *
+     * Turning off this feature allows you more control over the transport
+     * which can be useful for low-power devices or to save server traffic.
+     * To modify transport modes manually, utilize `client.sync.setMode`.
+     * The built-in behavior is essentially switching modes based on
+     * the number of peers detected by client.sync.presence.
+     */
+    automaticTransportSelection?: boolean;
+    initialTransport?: SyncTransportMode;
+    autoStart?: boolean;
+    /**
+     * Optionally specify an interval, in milliseconds, to poll the server
+     * when in pull mode.
+     */
+    pullInterval?: number;
+    /**
+     * Presence updates are batched to reduce number of requests / messages
+     * sent to the server. You can specify the batching time slice, in milliseconds,
+     */
+    presenceUpdateBatchTimeout?: number;
+}
+export declare class ServerSync<Profile = any, Presence = any> extends EventSubscriber<SyncEvents> implements Sync {
+    private webSocketSync;
+    private pushPullSync;
+    private activeSync;
+    private endpointProvider;
+    private meta;
+    private entities;
+    readonly presence: PresenceManager<Profile, Presence>;
+    private log;
+    constructor({ authEndpoint, fetchAuth, initialPresence, automaticTransportSelection, autoStart, initialTransport, pullInterval, presenceUpdateBatchTimeout, defaultProfile, }: ServerSyncOptions<Profile, Presence>, { meta, entities, log, }: {
+        meta: Metadata;
+        entities: EntityStore;
+        log?: (...args: any[]) => void;
+    });
+    get canDoRealtime(): boolean;
+    private handleMessage;
+    private echoOnlineChange;
+    private handlePresenceUpdate;
+    setMode: (transport: SyncTransportMode) => void;
+    send: (message: ClientMessage) => void;
+    start: () => void;
+    stop: () => void;
+    dispose: () => void;
+    reconnect: () => void;
+    get isConnected(): boolean;
+    get status(): "active" | "paused";
+    get mode(): SyncTransportMode;
+}
+export {};