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

package/dist/cjs/AckInfoStore.d.ts

@@ -0,0 +1,10 @@
+import { IDBService } from './IDBService.js';
+declare type AckInfo = {
+    type: 'ack';
+    globalAckTimestamp: string | null;
+};
+export declare class AckInfoStore extends IDBService {
+    getAckInfo: () => Promise<AckInfo>;
+    setGlobalAck: (ack: string) => Promise<void>;
+}
+export {};

package/dist/cjs/AckInfoStore.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AckInfoStore = void 0;
+const IDBService_js_1 = require("./IDBService.js");
+class AckInfoStore extends IDBService_js_1.IDBService {
+    constructor() {
+        super(...arguments);
+        this.getAckInfo = async () => {
+            const result = await this.run('info', (store) => store.get('ack'));
+            if (result) {
+                return result;
+            }
+            else {
+                return {
+                    globalAckTimestamp: null,
+                    type: 'ack',
+                };
+            }
+        };
+        this.setGlobalAck = async (ack) => {
+            await this.run('info', (store) => store.put({ type: 'ack', globalAckTimestamp: ack }), 'readwrite');
+        };
+    }
+}
+exports.AckInfoStore = AckInfoStore;
+//# sourceMappingURL=AckInfoStore.js.map

package/dist/cjs/AckInfoStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AckInfoStore.js","sourceRoot":"","sources":["../../src/AckInfoStore.ts"],"names":[],"mappings":";;;AAAA,mDAA6C;AAS7C,MAAa,YAAa,SAAQ,0BAAU;IAA5C;;QACC,eAAU,GAAG,KAAK,IAAsB,EAAE;YACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAU,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5E,IAAI,MAAM,EAAE;gBACX,OAAO,MAAM,CAAC;aACd;iBAAM;gBACN,OAAO;oBACN,kBAAkB,EAAE,IAAI;oBACxB,IAAI,EAAE,KAAK;iBACX,CAAC;aACF;QACF,CAAC,CAAC;QAEF,iBAAY,GAAG,KAAK,EAAE,GAAW,EAAE,EAAE;YACpC,MAAM,IAAI,CAAC,GAAG,CACb,MAAM,EACN,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,CAAC,EAC9D,WAAW,CACX,CAAC;QACH,CAAC,CAAC;IACH,CAAC;CAAA;AApBD,oCAoBC"}

package/dist/cjs/BackoffScheduler.d.ts

@@ -1,19 +1,19 @@
-import { EventSubscriber } from '@verdant-web/common';
-export declare class BackoffScheduler extends EventSubscriber<{
-    trigger: () => void;
-}> {
-    private readonly backoff;
-    private timer;
-    private isScheduled;
-    constructor(backoff: Backoff);
-    next: () => void;
-    reset: () => void;
-}
-export declare class Backoff {
-    current: number;
-    private readonly max;
-    private readonly factor;
-    constructor(max: number, factor: number);
-    next: () => void;
-    reset: () => void;
-}
+import { EventSubscriber } from '@verdant-web/common';
+export declare class BackoffScheduler extends EventSubscriber<{
+    trigger: () => void;
+}> {
+    private readonly backoff;
+    private timer;
+    private isScheduled;
+    constructor(backoff: Backoff);
+    next: () => void;
+    reset: () => void;
+}
+export declare class Backoff {
+    current: number;
+    private readonly max;
+    private readonly factor;
+    constructor(max: number, factor: number);
+    next: () => void;
+    reset: () => void;
+}

package/dist/cjs/BackoffScheduler.js

@@ -1,45 +1,45 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Backoff = exports.BackoffScheduler = void 0;
-const common_1 = require("@verdant-web/common");
-class BackoffScheduler extends common_1.EventSubscriber {
-    constructor(backoff) {
-        super();
-        this.timer = null;
-        this.isScheduled = false;
-        this.next = () => {
-            if (!this.isScheduled) {
-                this.isScheduled = true;
-                this.timer = setTimeout(() => {
-                    this.emit('trigger');
-                    this.isScheduled = false;
-                    this.backoff.next();
-                }, this.backoff.current);
-            }
-        };
-        this.reset = () => {
-            this.backoff.reset();
-            if (this.timer) {
-                clearTimeout(this.timer);
-                this.timer = null;
-            }
-        };
-        this.backoff = backoff;
-    }
-}
-exports.BackoffScheduler = BackoffScheduler;
-class Backoff {
-    constructor(max, factor) {
-        this.current = 0;
-        this.next = () => {
-            this.current = Math.min(this.max, this.current * this.factor);
-        };
-        this.reset = () => {
-            this.current = 0;
-        };
-        this.max = max;
-        this.factor = factor;
-    }
-}
-exports.Backoff = Backoff;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Backoff = exports.BackoffScheduler = void 0;
+const common_1 = require("@verdant-web/common");
+class BackoffScheduler extends common_1.EventSubscriber {
+    constructor(backoff) {
+        super();
+        this.timer = null;
+        this.isScheduled = false;
+        this.next = () => {
+            if (!this.isScheduled) {
+                this.isScheduled = true;
+                this.timer = setTimeout(() => {
+                    this.emit('trigger');
+                    this.isScheduled = false;
+                    this.backoff.next();
+                }, this.backoff.current);
+            }
+        };
+        this.reset = () => {
+            this.backoff.reset();
+            if (this.timer) {
+                clearTimeout(this.timer);
+                this.timer = null;
+            }
+        };
+        this.backoff = backoff;
+    }
+}
+exports.BackoffScheduler = BackoffScheduler;
+class Backoff {
+    constructor(max, factor) {
+        this.current = 0;
+        this.next = () => {
+            this.current = Math.min(this.max, this.current * this.factor);
+        };
+        this.reset = () => {
+            this.current = 0;
+        };
+        this.max = max;
+        this.factor = factor;
+    }
+}
+exports.Backoff = Backoff;
 //# sourceMappingURL=BackoffScheduler.js.map

package/dist/cjs/BaselinesStore.d.ts

@@ -0,0 +1,10 @@
+import { DocumentBaseline, ObjectIdentifier } from '@lo-fi/common';
+import { IDBService } from './IDBService.js';
+export declare class BaselinesStore extends IDBService {
+    constructor(db: IDBDatabase);
+    getAllForDocument: (oid: ObjectIdentifier) => Promise<DocumentBaseline<any>[]>;
+    getAllForMultipleDocuments: (docOids: string[]) => Promise<DocumentBaseline<any>[]>;
+    get: (oid: ObjectIdentifier) => Promise<any>;
+    set: <T>(baseline: DocumentBaseline<T>) => Promise<void>;
+    reset: () => Promise<undefined>;
+}

package/dist/cjs/BaselinesStore.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaselinesStore = void 0;
+const common_1 = require("@lo-fi/common");
+const IDBService_js_1 = require("./IDBService.js");
+class BaselinesStore extends IDBService_js_1.IDBService {
+    constructor(db) {
+        super(db);
+        this.getAllForDocument = async (oid) => {
+            return this.run('baselines', (store) => {
+                const [start, end] = (0, common_1.getOidRange)(oid);
+                return store.getAll(IDBKeyRange.bound(start, end, false, false));
+            }, 'readonly');
+        };
+        this.getAllForMultipleDocuments = async (docOids) => {
+            const result = await this.runAll('baselines', (store) => {
+                return docOids.map((oid) => {
+                    const [start, end] = (0, common_1.getOidRange)(oid);
+                    return store.getAll(IDBKeyRange.bound(start, end, false, false));
+                });
+            });
+            return result.flat();
+        };
+        this.get = async (oid) => {
+            return this.run('baselines', (store) => store.get(oid), 'readonly');
+        };
+        this.set = async (baseline) => {
+            await this.run('baselines', (store) => store.put(baseline), 'readwrite');
+        };
+        this.reset = () => {
+            return this.clear('baselines');
+        };
+    }
+}
+exports.BaselinesStore = BaselinesStore;
+//# sourceMappingURL=BaselinesStore.js.map

package/dist/cjs/BaselinesStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaselinesStore.js","sourceRoot":"","sources":["../../src/BaselinesStore.ts"],"names":[],"mappings":";;;AAAA,0CAAgF;AAChF,mDAA6C;AAE7C,MAAa,cAAe,SAAQ,0BAAU;IAC7C,YAAY,EAAe;QAC1B,KAAK,CAAC,EAAE,CAAC,CAAC;QAGX,sBAAiB,GAAG,KAAK,EAAE,GAAqB,EAAE,EAAE;YACnD,OAAO,IAAI,CAAC,GAAG,CACd,WAAW,EACX,CAAC,KAAK,EAAE,EAAE;gBACT,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAA,oBAAW,EAAC,GAAG,CAAC,CAAC;gBACtC,OAAO,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YAClE,CAAC,EACD,UAAU,CACV,CAAC;QACH,CAAC,CAAC;QAEF,+BAA0B,GAAG,KAAK,EAAE,OAAiB,EAAE,EAAE;YACxD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAC/B,WAAW,EACX,CAAC,KAAK,EAAE,EAAE;gBACT,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;oBAC1B,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAA,oBAAW,EAAC,GAAG,CAAC,CAAC;oBACtC,OAAO,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;gBAClE,CAAC,CAAC,CAAC;YACJ,CAAC,CACD,CAAC;YACF,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC,CAAC;QAEF,QAAG,GAAG,KAAK,EAAE,GAAqB,EAAE,EAAE;YACrC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;QACrE,CAAC,CAAC;QAEF,QAAG,GAAG,KAAK,EAAK,QAA6B,EAAE,EAAE;YAChD,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,CAAC;QAC1E,CAAC,CAAC;QAEF,UAAK,GAAG,GAAG,EAAE;YACZ,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChC,CAAC,CAAC;IApCF,CAAC;CAqCD;AAxCD,wCAwCC"}

package/dist/cjs/DocumentManager.d.ts

@@ -1,28 +1,31 @@
-import { StorageSchema } from '@verdant-web/common';
-import { EntityStore } from './entities/EntityStore.js';
-import { Metadata } from './metadata/Metadata.js';
-/**
- * Exposes functionality for creating documents,
- * the only mutation which is available as an entry
- * point in the storage system.
- */
-export declare class DocumentManager<Schema extends StorageSchema<any>> {
-    private meta;
-    private schema;
-    private entities;
-    constructor(meta: Metadata, schema: Schema, entities: EntityStore);
-    private getOid;
-    private addDefaults;
-    create: (collection: string, init: any, options?: {
-        undoable?: boolean;
-    }) => Promise<any>;
-    delete: (collection: string, primaryKey: string, options?: {
-        undoable?: boolean;
-    }) => Promise<void>;
-    deleteAll: (ids: [string, string][], options?: {
-        undoable?: boolean;
-    }) => Promise<void>;
-    deleteAllFromCollection: (collection: string, ids: string[], options?: {
-        undoable?: boolean;
-    }) => Promise<void>;
-}
+import { StorageSchema } from '@verdant-web/common';
+import { EntityStore } from './entities/EntityStore.js';
+import { Metadata } from './metadata/Metadata.js';
+/**
+ * Exposes functionality for creating documents,
+ * the only mutation which is available as an entry
+ * point in the storage system.
+ */
+export declare class DocumentManager<Schema extends StorageSchema<any>> {
+    private meta;
+    private schema;
+    private entities;
+    constructor(meta: Metadata, schema: Schema, entities: EntityStore);
+    private getOid;
+    private addDefaults;
+    create: (collection: string, init: any, options?: {
+        undoable?: boolean;
+    }) => Promise<any>;
+    delete: (collection: string, primaryKey: string, options?: {
+        undoable?: boolean;
+    }) => Promise<void>;
+    deleteAll: (ids: [
+        string,
+        string
+    ][], options?: {
+        undoable?: boolean;
+    }) => Promise<void>;
+    deleteAllFromCollection: (collection: string, ids: string[], options?: {
+        undoable?: boolean;
+    }) => Promise<void>;
+}

package/dist/cjs/DocumentManager.js

@@ -1,45 +1,45 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentManager = void 0;
-const common_1 = require("@verdant-web/common");
-/**
- * Exposes functionality for creating documents,
- * the only mutation which is available as an entry
- * point in the storage system.
- */
-class DocumentManager {
-    constructor(meta, schema, entities) {
-        this.meta = meta;
-        this.schema = schema;
-        this.entities = entities;
-        this.getOid = (collection, init) => {
-            const primaryKeyName = this.schema.collections[collection]
-                .primaryKey;
-            const primaryKey = init[primaryKeyName];
-            (0, common_1.assert)(primaryKey, `Document must have a primary key: ${primaryKeyName.toString()} (got: ${JSON.stringify(init)})`);
-            return (0, common_1.createOid)(collection, primaryKey);
-        };
-        this.addDefaults = (collectionName, init) => {
-            const collection = this.schema.collections[collectionName];
-            return (0, common_1.addFieldDefaults)(collection, init);
-        };
-        this.create = async (collection, init, options = {}) => {
-            const defaulted = this.addDefaults(collection, init);
-            const oid = this.getOid(collection, defaulted);
-            // documents are always objects at the root
-            return this.entities.create(defaulted, oid, options);
-        };
-        this.delete = async (collection, primaryKey, options = {}) => {
-            const oid = (0, common_1.createOid)(collection, primaryKey);
-            return this.entities.delete(oid, options);
-        };
-        this.deleteAll = async (ids, options = {}) => {
-            return this.entities.deleteAll(ids.map(([collection, primaryKey]) => (0, common_1.createOid)(collection, primaryKey)), options);
-        };
-        this.deleteAllFromCollection = async (collection, ids, options = {}) => {
-            return this.entities.deleteAll(ids.map((primaryKey) => (0, common_1.createOid)(collection, primaryKey)), options);
-        };
-    }
-}
-exports.DocumentManager = DocumentManager;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentManager = void 0;
+const common_1 = require("@verdant-web/common");
+/**
+ * Exposes functionality for creating documents,
+ * the only mutation which is available as an entry
+ * point in the storage system.
+ */
+class DocumentManager {
+    constructor(meta, schema, entities) {
+        this.meta = meta;
+        this.schema = schema;
+        this.entities = entities;
+        this.getOid = (collection, init) => {
+            const primaryKeyName = this.schema.collections[collection]
+                .primaryKey;
+            const primaryKey = init[primaryKeyName];
+            (0, common_1.assert)(primaryKey, `Document must have a primary key: ${primaryKeyName.toString()} (got: ${JSON.stringify(init)})`);
+            return (0, common_1.createOid)(collection, primaryKey);
+        };
+        this.addDefaults = (collectionName, init) => {
+            const collection = this.schema.collections[collectionName];
+            return (0, common_1.addFieldDefaults)(collection, init);
+        };
+        this.create = async (collection, init, options = {}) => {
+            const defaulted = this.addDefaults(collection, init);
+            const oid = this.getOid(collection, defaulted);
+            // documents are always objects at the root
+            return this.entities.create(defaulted, oid, options);
+        };
+        this.delete = async (collection, primaryKey, options = {}) => {
+            const oid = (0, common_1.createOid)(collection, primaryKey);
+            return this.entities.delete(oid, options);
+        };
+        this.deleteAll = async (ids, options = {}) => {
+            return this.entities.deleteAll(ids.map(([collection, primaryKey]) => (0, common_1.createOid)(collection, primaryKey)), options);
+        };
+        this.deleteAllFromCollection = async (collection, ids, options = {}) => {
+            return this.entities.deleteAll(ids.map((primaryKey) => (0, common_1.createOid)(collection, primaryKey)), options);
+        };
+    }
+}
+exports.DocumentManager = DocumentManager;
 //# sourceMappingURL=DocumentManager.js.map

package/dist/cjs/Entity.d.ts

@@ -0,0 +1,96 @@
+import { EventSubscriber, ObjectIdentifier, Operation, StorageFieldSchema, StorageFieldsSchema } from '@lo-fi/common';
+import { EntityStore } from './EntityStore.js';
+export declare const UPDATE = "@@update";
+export declare const DELETE = "@@delete";
+interface CacheEvents {
+    onSubscribed: () => void;
+    onAllUnsubscribed: () => void;
+}
+declare type AccessibleEntityProperty<T> = T extends Array<any> ? number : T extends object ? keyof T : never;
+declare type DataFromInit<Init> = {
+    [Key in keyof Init]-?: Init[Key];
+};
+declare type EntityPropertyValue<Init, K extends keyof Init | number> = Init extends Array<any> ? Init[K] extends Array<any> ? ListEntity<Init[K][number]> : Init[K] extends object ? ObjectEntity<Init[K]> : Init[K] : Init extends object ? K extends keyof Init ? Init[K] extends Array<any> ? ListEntity<Init[K][number]> : Init[K] extends object ? ObjectEntity<Init[K]> : Init[K] : never : never;
+export declare function updateEntity(entity: EntityBase<any>, newValue: any): void;
+export declare function deleteEntity(entity: EntityBase<any>): void;
+export declare abstract class EntityBase<Snapshot> {
+    readonly oid: ObjectIdentifier;
+    protected readonly store: EntityStore;
+    protected readonly cacheEvents: CacheEvents;
+    protected readonly fieldSchema: StorageFieldSchema | StorageFieldsSchema;
+    protected _current: any | null;
+    protected _override: any | null;
+    protected subObjectCache: Map<ObjectIdentifier, EntityBase<any>>;
+    private cachedSnapshot;
+    protected _deleted: boolean;
+    protected events: EventSubscriber<{
+        change: () => void;
+        delete: () => void;
+        restore: () => void;
+    }>;
+    protected get value(): any;
+    get deleted(): boolean;
+    constructor(oid: ObjectIdentifier, initial: Snapshot | undefined, store: EntityStore, cacheEvents: CacheEvents, fieldSchema: StorageFieldSchema | StorageFieldsSchema);
+    protected getChildFieldSchema: (key: any) => any;
+    protected [DELETE]: () => void;
+    protected [UPDATE]: (initial: Snapshot | undefined) => void;
+    protected createSubObject: (oid: ObjectIdentifier, value: any, key: any) => EntityBase<any>;
+    dispose: () => void;
+    subscribe: (event: 'change' | 'delete' | 'restore', callback: () => void) => () => void;
+    protected addPatches: (patches: Operation[]) => void;
+    protected cloneCurrent: () => any;
+    /**
+     * When an entity creates patches, it applies them in-memory for
+     * immediate feedback. But not all patches will relate to its immediate
+     * root object. So entities propagate patches downwards to their
+     * sub-objects for in-memory application.
+     */
+    protected propagateImmediateOperations: (operations: Operation[]) => void;
+    /**
+     * Creates empty sub-objects for any missing object refs in
+     * children of this object according to its in-memory immediate
+     * value. This is used to prep sub-objects when applying immediate
+     * propagated changes before those sub-objects have been created
+     * and exist in storage.
+     */
+    protected addMissingSubObjectsForMemoryChanges: () => void;
+    protected getSubObject: (oid: ObjectIdentifier) => EntityBase<any> | undefined;
+    protected wrapValue: <Key extends AccessibleEntityProperty<Snapshot>>(value: any, key: Key) => EntityPropertyValue<Snapshot, Key>;
+    get: <Key extends AccessibleEntityProperty<Snapshot>>(key: Key) => EntityPropertyValue<Snapshot, Key>;
+    /**
+     * Returns a copy of the entity and all sub-objects as
+     * a plain object or array.
+     */
+    getSnapshot: () => Snapshot | null;
+}
+export declare class ListEntity<ItemInit> extends EntityBase<DataFromInit<ItemInit>[]> implements Iterable<EntityPropertyValue<DataFromInit<ItemInit>[], number>> {
+    private getItemOid;
+    get length(): any;
+    set: (index: number, value: ItemInit) => void;
+    push: (value: ItemInit) => void;
+    insert: (index: number, value: ItemInit) => void;
+    move: (from: number, to: number) => void;
+    moveItem: (item: DataFromInit<ItemInit>, to: number) => void;
+    delete: (index: number) => void;
+    remove: (item: DataFromInit<ItemInit>) => void;
+    [Symbol.iterator](): {
+        next: () => {
+            readonly value: DataFromInit<ItemInit> extends any[] ? ListEntity<(any[] & DataFromInit<ItemInit>)[number]> : DataFromInit<ItemInit> extends object ? ObjectEntity<DataFromInit<ItemInit>> : DataFromInit<ItemInit>;
+            readonly done: false;
+        } | {
+            readonly value: undefined;
+            readonly done: true;
+        };
+    };
+    private getAsWrapped;
+    map: <U>(callback: (value: EntityPropertyValue<DataFromInit<ItemInit>[], number>, index: number) => U) => U[];
+    filter: (callback: (value: EntityPropertyValue<DataFromInit<ItemInit>[], number>, index: number) => boolean) => (DataFromInit<ItemInit> extends any[] ? ListEntity<(any[] & DataFromInit<ItemInit>)[number]> : DataFromInit<ItemInit> extends object ? ObjectEntity<DataFromInit<ItemInit>> : DataFromInit<ItemInit>)[];
+}
+export declare class ObjectEntity<Init> extends EntityBase<DataFromInit<Init>> {
+    set: <Key extends keyof Init>(key: Key, value: Init[Key]) => void;
+    remove: (key: string) => void;
+    update: (value: Partial<DataFromInit<Init>>) => void;
+}
+export declare type Entity = ListEntity<any> | ObjectEntity<any>;
+export declare type EntityShape<E extends EntityBase<any>> = E extends ListEntity<infer T> ? T[] : E extends ObjectEntity<infer T> ? T : never;
+export {};