@verdant-web/store 2.0.1

package/dist/cjs/QueryStore.js

@@ -0,0 +1,146 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryStore = void 0;
+const common_1 = require("@lo-fi/common");
+const idb_js_1 = require("./idb.js");
+const Query_js_1 = require("./Query.js");
+class QueryStore {
+    constructor(db, entities, config) {
+        this.db = db;
+        this.entities = entities;
+        this.cache = new Map();
+        this.log = () => { };
+        this.getStore = (collection, write) => {
+            return this.db
+                .transaction(collection, write ? 'readwrite' : 'readonly')
+                .objectStore(collection);
+        };
+        this.getQueryKey = (_a) => {
+            var { range } = _a, rest = __rest(_a, ["range"]);
+            let hashedRange;
+            if (range instanceof IDBKeyRange) {
+                hashedRange = (0, common_1.hashObject)({
+                    includes: range.includes,
+                    lower: range.lower,
+                    lowerOpen: range.lowerOpen,
+                    upper: range.upper,
+                    upperOpen: range.upperOpen,
+                });
+            }
+            else {
+                hashedRange = range;
+            }
+            return (0, common_1.hashObject)(Object.assign({ range: hashedRange }, rest));
+        };
+        this.get = (config) => {
+            const { collection, range, index, direction, limit, write, single } = config;
+            const key = this.getQueryKey(config);
+            if (this.cache.has(key)) {
+                return this.cache.get(key);
+            }
+            let run;
+            if (single) {
+                if (!range)
+                    throw new Error('Single object query requires a range value');
+                run = async () => {
+                    const store = this.getStore(collection, write);
+                    const source = index ? store.index(index) : store;
+                    const request = source.getKey(range);
+                    const key = await (0, idb_js_1.storeRequestPromise)(request);
+                    return key
+                        ? await this.entities.get((0, common_1.createOid)(collection, key.toString(), []))
+                        : null;
+                };
+            }
+            else {
+                run = async () => {
+                    const store = this.getStore(collection, write);
+                    const source = index ? store.index(index) : store;
+                    const request = source.openCursor(range, direction);
+                    const oids = await new Promise((resolve, reject) => {
+                        const result = [];
+                        request.onsuccess = async () => {
+                            const cursor = request.result;
+                            if (cursor === null || cursor === void 0 ? void 0 : cursor.primaryKey) {
+                                result.push((0, common_1.createOid)(collection, cursor.primaryKey.toString(), []));
+                                if (limit && result.length >= limit) {
+                                    resolve(result);
+                                }
+                                else {
+                                    cursor.continue();
+                                }
+                            }
+                            else {
+                                resolve(result);
+                            }
+                        };
+                        request.onerror = () => reject(request.error);
+                    });
+                    return Promise.all(oids.map((oid) => this.entities.get(oid)));
+                };
+            }
+            const query = new Query_js_1.Query(key, collection, run, (query) => {
+                const cached = this.cache.get(key);
+                if (cached && cached !== query) {
+                    console.warn('Query already exists in cache for key', key, ', this is not an error but suggests your code is creating multiple queries of the same type in the same frame and subscribing to them, and will produce less efficient memory usage.');
+                }
+                this.cache.set(key, query);
+            }, (query) => {
+                this.prepareToCleanupQuery(query);
+            });
+            this.cache.set(key, query);
+            this.prepareToCleanupQuery(query);
+            return query;
+        };
+        /**
+         * If a query is unsubscribed after 1 tick, it is removed from the cache.
+         * To persist a query in the cache a user must subscribe to it.
+         */
+        this.prepareToCleanupQuery = (query) => {
+            setTimeout(() => {
+                if (!query.isActive) {
+                    const cached = this.cache.get(query.key);
+                    if (cached === query) {
+                        this.cache.delete(query.key);
+                    }
+                }
+            }, 100);
+        };
+        this.update = (key) => {
+            var _a;
+            (_a = this.cache.get(key)) === null || _a === void 0 ? void 0 : _a[Query_js_1.UPDATE]();
+        };
+        this.onCollectionsChanged = (collections) => {
+            let updated = 0;
+            // FIXME: This is a naive implementation, improve beyond O(n)
+            for (const [key, query] of this.cache) {
+                if (collections.includes(query.collection)) {
+                    query[Query_js_1.UPDATE]();
+                    updated++;
+                    this.log('🔄 updated query', key);
+                }
+            }
+        };
+        this.destroy = () => {
+            for (const query of this.cache.values()) {
+                query.dispose();
+            }
+            this.cache.clear();
+        };
+        this.entities.subscribe('collectionsChanged', this.onCollectionsChanged);
+        this.log = config.log || this.log;
+    }
+}
+exports.QueryStore = QueryStore;
+//# sourceMappingURL=QueryStore.js.map

package/dist/cjs/QueryStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryStore.js","sourceRoot":"","sources":["../../src/QueryStore.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,0CAAgF;AAChF,qCAA+C;AAE/C,yCAA2C;AAE3C,MAAa,UAAU;IAItB,YACS,EAAe,EACf,QAAqB,EAC7B,MAEC;QAJO,OAAE,GAAF,EAAE,CAAa;QACf,aAAQ,GAAR,QAAQ,CAAa;QALtB,UAAK,GAAG,IAAI,GAAG,EAAsB,CAAC;QACtC,QAAG,GAA6B,GAAG,EAAE,GAAE,CAAC,CAAC;QAazC,aAAQ,GAAG,CAAC,UAAkB,EAAE,KAAe,EAAE,EAAE;YAC1D,OAAO,IAAI,CAAC,EAAE;iBACZ,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC;iBACzD,WAAW,CAAC,UAAU,CAAC,CAAC;QAC3B,CAAC,CAAC;QAEF,gBAAW,GAAG,CAAC,EAWd,EAAE,EAAE;gBAXU,EACd,KAAK,OAUL,EATG,IAAI,cAFO,SAGd,CADO;YAUP,IAAI,WAAW,CAAC;YAChB,IAAI,KAAK,YAAY,WAAW,EAAE;gBACjC,WAAW,GAAG,IAAA,mBAAU,EAAC;oBACxB,QAAQ,EAAE,KAAK,CAAC,QAAQ;oBACxB,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,SAAS,EAAE,KAAK,CAAC,SAAS;oBAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,SAAS,EAAE,KAAK,CAAC,SAAS;iBAC1B,CAAC,CAAC;aACH;iBAAM;gBACN,WAAW,GAAG,KAAK,CAAC;aACpB;YACD,OAAO,IAAA,mBAAU,kBAAG,KAAK,EAAE,WAAW,IAAK,IAAI,EAAG,CAAC;QACpD,CAAC,CAAC;QAEF,QAAG,GAAG,CAAC,MAQN,EAAE,EAAE;YACJ,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAClE,MAAM,CAAC;YACR,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACrC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBACxB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;aAC5B;YAED,IAAI,GAAuB,CAAC;YAC5B,IAAI,MAAM,EAAE;gBACX,IAAI,CAAC,KAAK;oBAAE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;gBAC1E,GAAG,GAAG,KAAK,IAAI,EAAE;oBAChB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;oBAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;oBAClD,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBACrC,MAAM,GAAG,GAAG,MAAM,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;oBAC/C,OAAO,GAAG;wBACT,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAA,kBAAS,EAAC,UAAU,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;wBACpE,CAAC,CAAC,IAAI,CAAC;gBACT,CAAC,CAAC;aACF;iBAAM;gBACN,GAAG,GAAG,KAAK,IAAI,EAAE;oBAChB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;oBAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;oBAClD,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;oBACpD,MAAM,IAAI,GAAG,MAAM,IAAI,OAAO,CAC7B,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;wBACnB,MAAM,MAAM,GAAU,EAAE,CAAC;wBACzB,OAAO,CAAC,SAAS,GAAG,KAAK,IAAI,EAAE;4BAC9B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;4BAC9B,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,EAAE;gCACvB,MAAM,CAAC,IAAI,CACV,IAAA,kBAAS,EAAC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CACvD,CAAC;gCACF,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK,EAAE;oCACpC,OAAO,CAAC,MAAM,CAAC,CAAC;iCAChB;qCAAM;oCACN,MAAM,CAAC,QAAQ,EAAE,CAAC;iCAClB;6BACD;iCAAM;gCACN,OAAO,CAAC,MAAM,CAAC,CAAC;6BAChB;wBACF,CAAC,CAAC;wBACF,OAAO,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;oBAC/C,CAAC,CACD,CAAC;oBACF,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC/D,CAAC,CAAC;aACF;YACD,MAAM,KAAK,GAAG,IAAI,gBAAK,CACtB,GAAG,EACH,UAAU,EACV,GAAG,EACH,CAAC,KAAK,EAAE,EAAE;gBACT,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,MAAM,IAAI,MAAM,KAAK,KAAK,EAAE;oBAC/B,OAAO,CAAC,IAAI,CACX,uCAAuC,EACvC,GAAG,EACH,sLAAsL,CACtL,CAAC;iBACF;gBACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC5B,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;gBACT,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC,CACD,CAAC;YACF,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAClC,OAAO,KAAK,CAAC;QACd,CAAC,CAAC;QAEF;;;WAGG;QACK,0BAAqB,GAAG,CAAC,KAAiB,EAAE,EAAE;YACrD,UAAU,CAAC,GAAG,EAAE;gBACf,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;oBACpB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACzC,IAAI,MAAM,KAAK,KAAK,EAAE;wBACrB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;qBAC7B;iBACD;YACF,CAAC,EAAE,GAAG,CAAC,CAAC;QACT,CAAC,CAAC;QAEF,WAAM,GAAG,CAAC,GAAW,EAAE,EAAE;;YACxB,MAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAG,iBAAM,GAAG,CAAC;QACjC,CAAC,CAAC;QAEM,yBAAoB,GAAG,CAAC,WAAqB,EAAE,EAAE;YACxD,IAAI,OAAO,GAAG,CAAC,CAAC;YAChB,6DAA6D;YAC7D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE;gBACtC,IAAI,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;oBAC3C,KAAK,CAAC,iBAAM,CAAC,EAAE,CAAC;oBAChB,OAAO,EAAE,CAAC;oBACV,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;iBAClC;aACD;QACF,CAAC,CAAC;QAEF,YAAO,GAAG,GAAG,EAAE;YACd,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE;gBACxC,KAAK,CAAC,OAAO,EAAE,CAAC;aAChB;YACD,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC,CAAC;QA1JD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACzE,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;IACnC,CAAC;CAyJD;AAtKD,gCAsKC"}

package/dist/cjs/SchemaStore.d.ts

@@ -0,0 +1,9 @@
+import { StorageSchema } from '@lo-fi/common';
+export declare class SchemaStore {
+    private readonly db;
+    readonly currentVersion: number;
+    private cached;
+    constructor(db: IDBDatabase, currentVersion: number);
+    get: () => Promise<StorageSchema<any> | null>;
+    set: (schema: StorageSchema<any>) => Promise<void>;
+}

package/dist/cjs/SchemaStore.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaStore = void 0;
+const idb_js_1 = require("./idb.js");
+class SchemaStore {
+    constructor(db, currentVersion) {
+        this.db = db;
+        this.currentVersion = currentVersion;
+        this.cached = null;
+        this.get = async () => {
+            const db = this.db;
+            const transaction = db.transaction('info', 'readonly');
+            const store = transaction.objectStore('info');
+            const request = store.get('schema');
+            const value = (await (0, idb_js_1.storeRequestPromise)(request));
+            if (!value) {
+                return null;
+            }
+            return JSON.parse(value.schema);
+        };
+        this.set = async (schema) => {
+            const db = this.db;
+            const transaction = db.transaction('info', 'readwrite');
+            const store = transaction.objectStore('info');
+            const request = store.put({
+                type: 'schema',
+                schema: JSON.stringify(schema),
+            });
+            this.cached = schema;
+            await (0, idb_js_1.storeRequestPromise)(request);
+        };
+    }
+}
+exports.SchemaStore = SchemaStore;
+//# sourceMappingURL=SchemaStore.js.map

package/dist/cjs/SchemaStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaStore.js","sourceRoot":"","sources":["../../src/SchemaStore.ts"],"names":[],"mappings":";;;AACA,qCAA+C;AAO/C,MAAa,WAAW;IAGvB,YACkB,EAAe,EAChB,cAAsB;QADrB,OAAE,GAAF,EAAE,CAAa;QAChB,mBAAc,GAAd,cAAc,CAAQ;QAJ/B,WAAM,GAA8B,IAAI,CAAC;QAOjD,QAAG,GAAG,KAAK,IAAwC,EAAE;YACpD,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACvD,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACpC,MAAM,KAAK,GAAG,CAAC,MAAM,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAErC,CAAC;YACb,IAAI,CAAC,KAAK,EAAE;gBACX,OAAO,IAAI,CAAC;aACZ;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,CAAC;QAEF,QAAG,GAAG,KAAK,EAAE,MAA0B,EAAiB,EAAE;YACzD,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACxD,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC;gBACzB,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;aACd,CAAC,CAAC;YACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,MAAM,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA1BC,CAAC;CA2BJ;AAjCD,kCAiCC"}

package/dist/cjs/Storage.d.ts

@@ -0,0 +1,147 @@
+import { Migration, StorageSchema } from '@lo-fi/common';
+import { ServerSyncOptions, Sync } from './sync/Sync.js';
+import { Metadata } from './metadata/Metadata.js';
+import { LiveQueryMaker } from './queries/LiveQueryMaker.js';
+import { LiveQueryStore } from './queries/LiveQueryStore.js';
+import { DocumentManager } from './DocumentManager.js';
+import { EntityStore } from './reactives/EntityStore.js';
+import { UndoHistory } from './UndoHistory.js';
+import { Context } from './context.js';
+interface StorageConfig<Presence = any> {
+    syncConfig?: ServerSyncOptions<Presence>;
+    migrations: Migration[];
+    log?: (...args: any[]) => void;
+}
+export declare class Storage {
+    private config;
+    private context;
+    readonly meta: Metadata;
+    private _entities;
+    private _queryStore;
+    private _queryMaker;
+    private _documentManager;
+    readonly collectionNames: string[];
+    private _sync;
+    get queryMaker(): LiveQueryMaker<import("./index.js").ObjectEntity<any, any, any>, import("./queries/QueryStore.js").BaseQueryStore<import("./index.js").Query<any>>>;
+    get sync(): Sync;
+    get entities(): EntityStore;
+    get queryStore(): LiveQueryStore<import("./index.js").ObjectEntity<any, any, any> | import("./index.js").ObjectEntity<any, any, any>[] | null>;
+    get documentManager(): DocumentManager<any>;
+    constructor(config: StorageConfig, context: Context, components: {
+        meta: Metadata;
+    });
+    private initialize;
+    get documentDb(): IDBDatabase;
+    get metaDb(): IDBDatabase;
+    get schema(): StorageSchema<any>;
+    get namespace(): string;
+    get undoHistory(): UndoHistory;
+    /**
+     * @deprecated - use client.sync.presence instead
+     */
+    get presence(): import("./PresenceManager.js").PresenceManager<any, any>;
+    /**
+     * @deprecated - use put
+     */
+    create: DocumentManager<any>['create'];
+    put: DocumentManager<any>['create'];
+    delete: DocumentManager<any>['delete'];
+    get: LiveQueryMaker['get'];
+    findOne: LiveQueryMaker['findOne'];
+    findAll: LiveQueryMaker['findAll'];
+    /**
+     * 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 interface StorageInitOptions<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;
+}
+/**
+ * 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 StorageDescriptor<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: StorageInitOptions<Presence, Profile>);
+    private initialize;
+    get current(): Storage | undefined;
+    get readyPromise(): Promise<Storage>;
+    get schema(): StorageSchema<any>;
+    open: () => Promise<any>;
+    close: () => Promise<void>;
+}
+export {};