@verdant-web/common 1.11.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Grant Forrest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/EventSubscriber.d.ts

@@ -0,0 +1,17 @@
+export declare class EventSubscriber<Events extends {
+    [key: string]: (...args: any[]) => void;
+}> {
+    private _onAllUnsubscribed?;
+    protected subscribers: Record<string, Record<string, (...args: any[]) => void>>;
+    protected counts: Record<string, number>;
+    private _disabled;
+    constructor(_onAllUnsubscribed?: ((event: keyof Events) => void) | undefined);
+    get disabled(): boolean;
+    subscriberCount: (event: Extract<keyof Events, string>) => number;
+    totalSubscriberCount: () => number;
+    subscribe: <K extends Extract<keyof Events, string>>(event: K, callback: Events[K]) => () => void;
+    emit: <K extends Extract<keyof Events, string>>(event: K, ...args: Parameters<Events[K]>) => void;
+    dispose: () => void;
+    disable: () => void;
+}
+export declare type EventsOf<T extends EventSubscriber<any>> = T extends EventSubscriber<infer E> ? keyof E : never;

package/dist/cjs/EventSubscriber.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventSubscriber = void 0;
+const utils_js_1 = require("./utils.js");
+class EventSubscriber {
+    constructor(_onAllUnsubscribed) {
+        this._onAllUnsubscribed = _onAllUnsubscribed;
+        this.subscribers = {};
+        this.counts = {};
+        this._disabled = false;
+        this.subscriberCount = (event) => {
+            var _a;
+            return (_a = this.counts[event]) !== null && _a !== void 0 ? _a : 0;
+        };
+        this.totalSubscriberCount = () => {
+            return Object.values(this.counts).reduce((acc, count) => acc + count, 0);
+        };
+        this.subscribe = (event, callback) => {
+            const key = (0, utils_js_1.generateId)();
+            let subscribers = this.subscribers[event];
+            if (!subscribers) {
+                subscribers = this.subscribers[event] = {};
+            }
+            subscribers[key] = callback;
+            this.counts[event] = (this.counts[event] || 0) + 1;
+            return () => {
+                // already removed
+                if (!this.subscribers[event])
+                    return;
+                delete this.subscribers[event][key];
+                this.counts[event]--;
+                if (this.counts[event] === 0) {
+                    delete this.subscribers[event];
+                    delete this.counts[event];
+                    if (this._onAllUnsubscribed) {
+                        this._onAllUnsubscribed(event);
+                    }
+                }
+            };
+        };
+        this.emit = (event, ...args) => {
+            if (this._disabled)
+                return;
+            if (this.subscribers[event]) {
+                Object.values(this.subscribers[event]).forEach((c) => c(...args));
+            }
+        };
+        this.dispose = () => {
+            const events = Object.keys(this.subscribers);
+            this.subscribers = {};
+            this.counts = {};
+            events.forEach((event) => {
+                if (this._onAllUnsubscribed) {
+                    this._onAllUnsubscribed(event);
+                }
+            });
+        };
+        this.disable = () => {
+            this._disabled = true;
+        };
+    }
+    get disabled() {
+        return this._disabled;
+    }
+}
+exports.EventSubscriber = EventSubscriber;
+//# sourceMappingURL=EventSubscriber.js.map

package/dist/cjs/EventSubscriber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventSubscriber.js","sourceRoot":"","sources":["../../src/EventSubscriber.ts"],"names":[],"mappings":";;;AAAA,yCAAwC;AAExC,MAAa,eAAe;IAU3B,YAAoB,kBAAkD;QAAlD,uBAAkB,GAAlB,kBAAkB,CAAgC;QAP5D,gBAAW,GAGjB,EAAS,CAAC;QACJ,WAAM,GAA2B,EAAS,CAAC;QAC7C,cAAS,GAAG,KAAK,CAAC;QAQ1B,oBAAe,GAAG,CAAC,KAAoC,EAAE,EAAE;;YAC1D,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QAEF,yBAAoB,GAAG,GAAG,EAAE;YAC3B,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC;QAEF,cAAS,GAAG,CACX,KAAQ,EACR,QAAmB,EAClB,EAAE;YACH,MAAM,GAAG,GAAG,IAAA,qBAAU,GAAE,CAAC;YACzB,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,CAAC,WAAW,EAAE;gBACjB,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;aAC3C;YACD,WAAW,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;YACnD,OAAO,GAAG,EAAE;gBACX,kBAAkB;gBAClB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;oBAAE,OAAO;gBAErC,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;gBACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;oBAC7B,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;oBAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBAC1B,IAAI,IAAI,CAAC,kBAAkB,EAAE;wBAC5B,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;qBAC/B;iBACD;YACF,CAAC,CAAC;QACH,CAAC,CAAC;QAEF,SAAI,GAAG,CACN,KAAQ,EACR,GAAG,IAA2B,EAC7B,EAAE;YACH,IAAI,IAAI,CAAC,SAAS;gBAAE,OAAO;YAC3B,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;gBAC5B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;aAClE;QACF,CAAC,CAAC;QAEF,YAAO,GAAG,GAAG,EAAE;YACd,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC7C,IAAI,CAAC,WAAW,GAAG,EAAS,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,EAAS,CAAC;YACxB,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACxB,IAAI,IAAI,CAAC,kBAAkB,EAAE;oBAC5B,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;iBAC/B;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,YAAO,GAAG,GAAG,EAAE;YACd,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC;IAhEuE,CAAC;IAE1E,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;CA6DD;AA3ED,0CA2EC"}

package/dist/cjs/baseline.d.ts

@@ -0,0 +1,5 @@
+export declare type DocumentBaseline<T extends any = any> = {
+    oid: string;
+    snapshot: T;
+    timestamp: string;
+};

package/dist/cjs/baseline.js

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

package/dist/cjs/baseline.js.map

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

package/dist/cjs/batching.d.ts

@@ -0,0 +1,41 @@
+/// <reference types="node" resolution-mode="require"/>
+export declare class Batcher<T, UserData = any> {
+    private flusher;
+    private batches;
+    constructor(flusher: (items: T[], batchKey: string, userData: UserData) => any);
+    add({ key, userData, items, max, timeout, }: {
+        key: string;
+        userData?: UserData;
+        items: T[];
+        max?: number | null;
+        timeout?: number | null;
+    }): Batch<T, UserData>;
+    flush: (key: string) => any;
+    discard: (key: string) => void;
+}
+export declare class Batch<T, UserData = any> {
+    items: Array<T>;
+    max: number | null;
+    startedAt: number;
+    timeout: number | null;
+    flushTimeout?: NodeJS.Timeout;
+    userData?: any;
+    flusher: (items: T[], batchKey: string, userData: UserData) => any;
+    key: string;
+    constructor({ max, startedAt, timeout, userData, flusher, key, }: {
+        key: string;
+        max: number | null;
+        startedAt: number;
+        timeout: number | null;
+        userData?: UserData;
+        flusher: (items: T[], batchKey: string, userData: UserData) => any;
+    });
+    update: ({ items, max, timeout, userData, }: {
+        items: Array<T>;
+        max?: number | null | undefined;
+        timeout?: number | null | undefined;
+        userData?: UserData | undefined;
+    }) => void;
+    flush: () => any;
+    discard: () => void;
+}

package/dist/cjs/batching.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Batch = exports.Batcher = void 0;
+class Batcher {
+    constructor(flusher) {
+        this.flusher = flusher;
+        this.batches = new Map();
+        this.flush = (key) => {
+            const batch = this.batches.get(key);
+            if (!batch)
+                return;
+            return batch.flush();
+        };
+        this.discard = (key) => {
+            const batch = this.batches.get(key);
+            if (!batch)
+                return;
+            batch.discard();
+            this.batches.delete(key);
+        };
+    }
+    add({ key, userData, items, max, timeout, }) {
+        let batch = this.batches.get(key);
+        if (!batch) {
+            batch = new Batch({
+                max: max || null,
+                startedAt: Date.now(),
+                userData,
+                timeout: timeout || null,
+                flusher: this.flusher,
+                key,
+            });
+            this.batches.set(key, batch);
+        }
+        batch.update({
+            items,
+            max,
+            timeout,
+            userData,
+        });
+        return batch;
+    }
+}
+exports.Batcher = Batcher;
+class Batch {
+    constructor({ max, startedAt, timeout, userData, flusher, key, }) {
+        this.items = [];
+        this.update = ({ items, max, timeout, userData, }) => {
+            this.items.push(...items);
+            if (max !== undefined)
+                this.max = max;
+            if (timeout !== undefined)
+                this.timeout = timeout;
+            if (userData)
+                this.userData = userData;
+            // if the batch has items and a timeout but has not
+            // scheduled yet, schedule it
+            const needsSchedule = this.items.length !== 0 && this.timeout !== null && !this.flushTimeout;
+            // if the batch has already reached its max, skip scheduling
+            // and flush immediately
+            if (this.max !== null && this.items.length >= this.max) {
+                this.flush();
+            }
+            else if (needsSchedule && this.timeout !== null) {
+                this.flushTimeout = setTimeout(this.flush, this.timeout);
+            }
+        };
+        this.flush = () => {
+            this.flushTimeout && clearTimeout(this.flushTimeout);
+            this.flushTimeout = undefined;
+            const items = this.items;
+            this.items = [];
+            return this.flusher(items, this.key, this.userData);
+        };
+        this.discard = () => {
+            this.flushTimeout && clearTimeout(this.flushTimeout);
+            this.flushTimeout = undefined;
+            this.items = [];
+        };
+        this.max = max;
+        this.startedAt = startedAt;
+        this.timeout = timeout;
+        this.userData = userData;
+        this.flusher = flusher;
+        this.key = key;
+    }
+}
+exports.Batch = Batch;
+//# sourceMappingURL=batching.js.map

package/dist/cjs/batching.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batching.js","sourceRoot":"","sources":["../../src/batching.ts"],"names":[],"mappings":";;;AAAA,MAAa,OAAO;IAGnB,YACS,OAAkE;QAAlE,YAAO,GAAP,OAAO,CAA2D;QAHnE,YAAO,GAAoC,IAAI,GAAG,EAAE,CAAC;QAyC7D,UAAK,GAAG,CAAC,GAAW,EAAE,EAAE;YACvB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,KAAK;gBAAE,OAAO;YAEnB,OAAO,KAAK,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,CAAC;QAEF,YAAO,GAAG,CAAC,GAAW,EAAE,EAAE;YACzB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,KAAK;gBAAE,OAAO;YAEnB,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC,CAAC;IAlDC,CAAC;IAEJ,GAAG,CAAC,EACH,GAAG,EACH,QAAQ,EACR,KAAK,EACL,GAAG,EACH,OAAO,GAOP;QACA,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,EAAE;YACX,KAAK,GAAG,IAAI,KAAK,CAAC;gBACjB,GAAG,EAAE,GAAG,IAAI,IAAI;gBAChB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;gBACrB,QAAQ;gBACR,OAAO,EAAE,OAAO,IAAI,IAAI;gBACxB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,GAAG;aACH,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,KAAK,CAAC,MAAM,CAAC;YACZ,KAAK;YACL,GAAG;YACH,OAAO;YACP,QAAQ;SACR,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACd,CAAC;CAgBD;AAxDD,0BAwDC;AAED,MAAa,KAAK;IAUjB,YAAY,EACX,GAAG,EACH,SAAS,EACT,OAAO,EACP,QAAQ,EACR,OAAO,EACP,GAAG,GAQH;QAvBD,UAAK,GAAa,EAAE,CAAC;QAgCrB,WAAM,GAAG,CAAC,EACT,KAAK,EACL,GAAG,EACH,OAAO,EACP,QAAQ,GAMR,EAAE,EAAE;YACJ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;YAC1B,IAAI,GAAG,KAAK,SAAS;gBAAE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;YACtC,IAAI,OAAO,KAAK,SAAS;gBAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YAClD,IAAI,QAAQ;gBAAE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAEvC,mDAAmD;YACnD,6BAA6B;YAC7B,MAAM,aAAa,GAClB,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;YAExE,4DAA4D;YAC5D,wBAAwB;YACxB,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE;gBACvD,IAAI,CAAC,KAAK,EAAE,CAAC;aACb;iBAAM,IAAI,aAAa,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;gBAClD,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;aACzD;QACF,CAAC,CAAC;QAEF,UAAK,GAAG,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACrD,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;YAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YACzB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,YAAO,GAAG,GAAG,EAAE;YACd,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACrD,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;YAC9B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QACjB,CAAC,CAAC;QAlDD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IAChB,CAAC;CA6CD;AA5ED,sBA4EC"}

package/dist/cjs/files.d.ts

@@ -0,0 +1,19 @@
+export declare type FileRef = {
+    '@@type': 'file';
+    id: string;
+};
+export declare function isFileRef(value: any): value is FileRef;
+export declare function createFileRef(id: string): FileRef;
+export declare type FileData = {
+    id: string;
+    /**
+     * For locally created files, this starts false, until it's uploaded
+     * Remote files this is always true
+     */
+    remote: boolean;
+    name: string;
+    type: string;
+    file?: Blob;
+    url?: string;
+};
+export declare function getAllFileFields(snapshot: any): [string, FileRef][];

package/dist/cjs/files.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllFileFields = exports.createFileRef = exports.isFileRef = void 0;
+function isFileRef(value) {
+    return value && value['@@type'] === 'file';
+}
+exports.isFileRef = isFileRef;
+function createFileRef(id) {
+    return {
+        '@@type': 'file',
+        id,
+    };
+}
+exports.createFileRef = createFileRef;
+function getAllFileFields(snapshot) {
+    return Object.entries(snapshot).filter((entry) => isFileRef(entry[1]));
+}
+exports.getAllFileFields = getAllFileFields;
+//# sourceMappingURL=files.js.map

package/dist/cjs/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/files.ts"],"names":[],"mappings":";;;AAKA,SAAgB,SAAS,CAAC,KAAU;IACnC,OAAO,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC;AAC5C,CAAC;AAFD,8BAEC;AACD,SAAgB,aAAa,CAAC,EAAU;IACvC,OAAO;QACN,QAAQ,EAAE,MAAM;QAChB,EAAE;KACF,CAAC;AACH,CAAC;AALD,sCAKC;AAeD,SAAgB,gBAAgB,CAAC,QAAa;IAC7C,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAGlE,CAAC;AACL,CAAC;AALD,4CAKC"}

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

@@ -0,0 +1 @@
+export {};

package/dist/cjs/files.test.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const files_js_1 = require("./files.js");
+function makeFile() {
+    return new File([''], 'test.txt', { type: 'text/plain' });
+}
+(0, vitest_1.describe)('processing files in a value', () => {
+    (0, vitest_1.it)('replaces a single file with a reference', () => {
+        const file = makeFile();
+        const list = [];
+        const result = (0, files_js_1.processValueFiles)(file, list.push.bind(list));
+        (0, vitest_1.expect)(result).toEqual({
+            '@@type': 'file',
+            id: vitest_1.expect.stringContaining(''),
+        });
+        (0, vitest_1.expect)(list).toEqual([
+            {
+                id: vitest_1.expect.stringContaining(''),
+                blob: file,
+                url: null,
+                remote: false,
+                name: 'test.txt',
+                type: 'text/plain',
+            },
+        ]);
+    });
+    (0, vitest_1.it)('replaces a list of files with references', () => {
+        const file1 = makeFile();
+        const file2 = makeFile();
+        const list = [];
+        const result = (0, files_js_1.processValueFiles)([file1, file2], list.push.bind(list));
+        (0, vitest_1.expect)(result).toEqual([
+            { '@@type': 'file', id: vitest_1.expect.stringContaining('') },
+            { '@@type': 'file', id: vitest_1.expect.stringContaining('') },
+        ]);
+        (0, vitest_1.expect)(list).toEqual([
+            {
+                id: vitest_1.expect.stringContaining(''),
+                blob: file1,
+                url: null,
+                remote: false,
+                name: 'test.txt',
+                type: 'text/plain',
+            },
+            {
+                id: vitest_1.expect.stringContaining(''),
+                blob: file2,
+                url: null,
+                remote: false,
+                name: 'test.txt',
+                type: 'text/plain',
+            },
+        ]);
+        (0, vitest_1.expect)(result[0].id).not.toEqual(result[1].id);
+    });
+    (0, vitest_1.it)('replaces nested files with references', () => {
+        const file = makeFile();
+        const list = [];
+        const result = (0, files_js_1.processValueFiles)({ a: { b: file } }, list.push.bind(list));
+        (0, vitest_1.expect)(result).toEqual({
+            a: {
+                b: {
+                    '@@type': 'file',
+                    id: vitest_1.expect.stringContaining(''),
+                },
+            },
+        });
+        (0, vitest_1.expect)(list).toEqual([
+            {
+                id: vitest_1.expect.stringContaining(''),
+                blob: file,
+                url: null,
+                remote: false,
+                name: 'test.txt',
+                type: 'text/plain',
+            },
+        ]);
+    });
+});
+//# sourceMappingURL=files.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"files.test.js","sourceRoot":"","sources":["../../src/files.test.ts"],"names":[],"mappings":";;AAAA,mCAA8C;AAC9C,yCAAyD;AAEzD,SAAS,QAAQ;IAChB,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,IAAA,iBAAQ,EAAC,6BAA6B,EAAE,GAAG,EAAE;IAC5C,IAAA,WAAE,EAAC,yCAAyC,EAAE,GAAG,EAAE;QAClD,MAAM,IAAI,GAAG,QAAQ,EAAE,CAAC;QACxB,MAAM,IAAI,GAAe,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAA,4BAAiB,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7D,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACtB,QAAQ,EAAE,MAAM;YAChB,EAAE,EAAE,eAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;SAC/B,CAAC,CAAC;QACH,IAAA,eAAM,EAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YACpB;gBACC,EAAE,EAAE,eAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC/B,IAAI,EAAE,IAAI;gBACV,GAAG,EAAE,IAAI;gBACT,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,YAAY;aAClB;SACD,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,0CAA0C,EAAE,GAAG,EAAE;QACnD,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC;QACzB,MAAM,IAAI,GAAe,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAA,4BAAiB,EAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACtB,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,eAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE;YACrD,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,eAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE;SACrD,CAAC,CAAC;QACH,IAAA,eAAM,EAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YACpB;gBACC,EAAE,EAAE,eAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC/B,IAAI,EAAE,KAAK;gBACX,GAAG,EAAE,IAAI;gBACT,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,YAAY;aAClB;YACD;gBACC,EAAE,EAAE,eAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC/B,IAAI,EAAE,KAAK;gBACX,GAAG,EAAE,IAAI;gBACT,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,YAAY;aAClB;SACD,CAAC,CAAC;QACH,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,uCAAuC,EAAE,GAAG,EAAE;QAChD,MAAM,IAAI,GAAG,QAAQ,EAAE,CAAC;QACxB,MAAM,IAAI,GAAe,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAA,4BAAiB,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3E,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACtB,CAAC,EAAE;gBACF,CAAC,EAAE;oBACF,QAAQ,EAAE,MAAM;oBAChB,EAAE,EAAE,eAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;iBAC/B;aACD;SACD,CAAC,CAAC;QACH,IAAA,eAAM,EAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YACpB;gBACC,EAAE,EAAE,eAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC/B,IAAI,EAAE,IAAI;gBACV,GAAG,EAAE,IAAI;gBACT,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,YAAY;aAClB;SACD,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,18 @@
+export * from './protocol.js';
+export * from './timestamp.js';
+export * from './operation.js';
+export * from './baseline.js';
+export * from './replica.js';
+export * from './schema/index.js';
+export * from './utils.js';
+export * from './indexes.js';
+export { migrate, migrationRange, createDefaultMigration, } from './migration.js';
+export type { Migration, MigrationIndexDescription, MigrationEngine, } from './migration.js';
+export type { UserInfo } from './presence.js';
+export * from './patch.js';
+export * from './oids.js';
+export * from './EventSubscriber.js';
+export * from './undo.js';
+export * from './batching.js';
+export * from './files.js';
+export type { Ref } from './refs.js';

package/dist/cjs/index.js

@@ -0,0 +1,36 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDefaultMigration = exports.migrationRange = exports.migrate = void 0;
+__exportStar(require("./protocol.js"), exports);
+__exportStar(require("./timestamp.js"), exports);
+__exportStar(require("./operation.js"), exports);
+__exportStar(require("./baseline.js"), exports);
+__exportStar(require("./replica.js"), exports);
+__exportStar(require("./schema/index.js"), exports);
+__exportStar(require("./utils.js"), exports);
+__exportStar(require("./indexes.js"), exports);
+var migration_js_1 = require("./migration.js");
+Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return migration_js_1.migrate; } });
+Object.defineProperty(exports, "migrationRange", { enumerable: true, get: function () { return migration_js_1.migrationRange; } });
+Object.defineProperty(exports, "createDefaultMigration", { enumerable: true, get: function () { return migration_js_1.createDefaultMigration; } });
+__exportStar(require("./patch.js"), exports);
+__exportStar(require("./oids.js"), exports);
+__exportStar(require("./EventSubscriber.js"), exports);
+__exportStar(require("./undo.js"), exports);
+__exportStar(require("./batching.js"), exports);
+__exportStar(require("./files.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,iDAA+B;AAC/B,iDAA+B;AAC/B,gDAA8B;AAC9B,+CAA6B;AAC7B,oDAAkC;AAClC,6CAA2B;AAC3B,+CAA6B;AAC7B,+CAIwB;AAHvB,uGAAA,OAAO,OAAA;AACP,8GAAA,cAAc,OAAA;AACd,sHAAA,sBAAsB,OAAA;AAQvB,6CAA2B;AAC3B,4CAA0B;AAC1B,uDAAqC;AACrC,4CAA0B;AAC1B,gDAA8B;AAC9B,6CAA2B"}

package/dist/cjs/indexes.d.ts

@@ -0,0 +1,14 @@
+import { StorageCollectionSchema } from './index.js';
+export declare const COMPOUND_INDEX_SEPARATOR = "\uFFFFFE";
+export declare const COMPOUND_INDEX_LOWER_BOUND_SEPARATOR = "\0";
+export declare const COMPOUND_INDEX_UPPER_BOUND_SEPARATOR = "\uFFFFFF";
+declare type IndexableFieldValue = string | number | boolean | any[];
+export declare type CompoundIndexValue = string | string[];
+export declare function createCompoundIndexValue(...fields: IndexableFieldValue[]): CompoundIndexValue;
+export declare function createUpperBoundIndexValue(...fields: IndexableFieldValue[]): string;
+export declare function createLowerBoundIndexValue(...fields: IndexableFieldValue[]): string;
+export declare function computeSynthetics(schema: StorageCollectionSchema, obj: any): Record<string, any>;
+export declare function computeCompoundIndices(schema: StorageCollectionSchema<any, any, any>, doc: any): any;
+export declare function assignIndexValues(schema: StorageCollectionSchema<any, any, any>, doc: any): any;
+export declare function sanitizeIndexValue(value: unknown): string | number | (string | number)[];
+export {};

package/dist/cjs/indexes.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeIndexValue = exports.assignIndexValues = exports.computeCompoundIndices = exports.computeSynthetics = exports.createLowerBoundIndexValue = exports.createUpperBoundIndexValue = exports.createCompoundIndexValue = exports.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR = exports.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR = exports.COMPOUND_INDEX_SEPARATOR = void 0;
+// unlikely to be used unicode character
+exports.COMPOUND_INDEX_SEPARATOR = '\uFFFFFE';
+// 1 lower than separator
+exports.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR = '\u0000';
+// 1 higher than separator
+exports.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR = '\uFFFFFF';
+function createCompoundIndexValue(...fields) {
+    const value = expandArrayIndex(fields);
+    if (value.length === 1) {
+        return value[0];
+    }
+    return value;
+}
+exports.createCompoundIndexValue = createCompoundIndexValue;
+function createUpperBoundIndexValue(...fields) {
+    return (fields.join(exports.COMPOUND_INDEX_SEPARATOR) +
+        `${exports.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR}`);
+}
+exports.createUpperBoundIndexValue = createUpperBoundIndexValue;
+function createLowerBoundIndexValue(...fields) {
+    return (fields.join(exports.COMPOUND_INDEX_SEPARATOR) +
+        `${exports.COMPOUND_INDEX_SEPARATOR}${exports.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR}`);
+}
+exports.createLowerBoundIndexValue = createLowerBoundIndexValue;
+/**
+ * Whenever an array value is included in a compound index, we have to expand
+ * the value to include all permutations of values in the array.
+ * For example if we had an index id + tags on a document
+ *
+ * {
+ *   id: '1',
+ *   tags: ['a', 'b']
+ * }
+ *
+ * we want to create an index:
+ *
+ * id_tags: ['1#a', '1#b']
+ *
+ * If multiple arrays are indexed we have to exponentially expand...
+ *
+ * id_tags_tags2: ['1#a#a', '1#a#b', '1#b#a', '1#b#b']
+ *
+ * To generalize this we construct a 2-level array of strings.
+ * Iterating over indexed values, we expand each item into N items if
+ * the current value is an array.
+ *
+ * Then we combine all nested arrays into compound index values.
+ * This will produce an array of 1 element if none of the indexed values
+ * were arrays. The caller should unwrap that.
+ *
+ * This function also deduplicates values.
+ */
+function expandArrayIndex(fields) {
+    let value = [[]];
+    for (const field of fields) {
+        if (Array.isArray(field)) {
+            const newValue = [];
+            for (const previousValue of value) {
+                for (const fieldValue of field) {
+                    newValue.push(previousValue.concat(fieldValue));
+                }
+            }
+            value = newValue;
+        }
+        else {
+            for (const item of value) {
+                item.push(`${field}`);
+            }
+        }
+    }
+    return Array.from(new Set(value.map((item) => {
+        return item.join(exports.COMPOUND_INDEX_SEPARATOR);
+    })));
+}
+function computeSynthetics(schema, obj) {
+    const result = {};
+    for (const [name, property] of Object.entries(schema.synthetics || {})) {
+        result[name] = sanitizeIndexValue(property.compute(obj));
+    }
+    return result;
+}
+exports.computeSynthetics = computeSynthetics;
+function computeCompoundIndices(schema, doc) {
+    return Object.entries(schema.compounds || {}).reduce((acc, [indexKey, index]) => {
+        acc[indexKey] = createCompoundIndexValue(...index.of.map((key) => doc[key]));
+        return acc;
+    }, {});
+}
+exports.computeCompoundIndices = computeCompoundIndices;
+function assignIndexValues(schema, doc) {
+    Object.assign(doc, computeSynthetics(schema, doc));
+    Object.assign(doc, computeCompoundIndices(schema, doc));
+    return doc;
+}
+exports.assignIndexValues = assignIndexValues;
+function sanitizeIndexValue(value) {
+    if (typeof value === 'string' || typeof value === 'number') {
+        return value;
+    }
+    if (typeof value === 'boolean' || value === null) {
+        return `${value}`;
+    }
+    if (value === undefined) {
+        // this shouldn't happen ,but for resiliency...
+        return 'undefined';
+    }
+    if (Array.isArray(value)) {
+        return value.map(sanitizeIndexValue);
+    }
+    throw new Error(`Unsupported index value: ${value}`);
+}
+exports.sanitizeIndexValue = sanitizeIndexValue;
+//# sourceMappingURL=indexes.js.map

package/dist/cjs/indexes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexes.js","sourceRoot":"","sources":["../../src/indexes.ts"],"names":[],"mappings":";;;AAMA,wCAAwC;AAC3B,QAAA,wBAAwB,GAAG,UAAU,CAAC;AACnD,yBAAyB;AACZ,QAAA,oCAAoC,GAAG,QAAQ,CAAC;AAC7D,0BAA0B;AACb,QAAA,oCAAoC,GAAG,UAAU,CAAC;AAK/D,SAAgB,wBAAwB,CACvC,GAAG,MAA6B;IAEhC,MAAM,KAAK,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;KAChB;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AARD,4DAQC;AAED,SAAgB,0BAA0B,CACzC,GAAG,MAA6B;IAEhC,OAAO,CACN,MAAM,CAAC,IAAI,CAAC,gCAAwB,CAAC;QACrC,GAAG,4CAAoC,EAAE,CACzC,CAAC;AACH,CAAC;AAPD,gEAOC;AAED,SAAgB,0BAA0B,CACzC,GAAG,MAA6B;IAEhC,OAAO,CACN,MAAM,CAAC,IAAI,CAAC,gCAAwB,CAAC;QACrC,GAAG,gCAAwB,GAAG,4CAAoC,EAAE,CACpE,CAAC;AACH,CAAC;AAPD,gEAOC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAS,gBAAgB,CAAC,MAA6B;IACtD,IAAI,KAAK,GAAe,CAAC,EAAE,CAAC,CAAC;IAC7B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC3B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACzB,MAAM,QAAQ,GAAe,EAAE,CAAC;YAChC,KAAK,MAAM,aAAa,IAAI,KAAK,EAAE;gBAClC,KAAK,MAAM,UAAU,IAAI,KAAK,EAAE;oBAC/B,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;iBAChD;aACD;YACD,KAAK,GAAG,QAAQ,CAAC;SACjB;aAAM;YACN,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;gBACzB,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;aACtB;SACD;KACD;IACD,OAAO,KAAK,CAAC,IAAI,CAChB,IAAI,GAAG,CACN,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,gCAAwB,CAAC,CAAC;IAC5C,CAAC,CAAC,CACF,CACD,CAAC;AACH,CAAC;AAED,SAAgB,iBAAiB,CAAC,MAA+B,EAAE,GAAQ;IAC1E,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE;QACvE,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAC/B,QAA6C,CAAC,OAAO,CAAC,GAAG,CAAC,CAC3D,CAAC;KACF;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AARD,8CAQC;AAED,SAAgB,sBAAsB,CACrC,MAA8C,EAC9C,GAAQ;IAER,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAElD,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE;QAC5B,GAAG,CAAC,QAAQ,CAAC,GAAG,wBAAwB,CACvC,GAAI,KAA2C,CAAC,EAAE,CAAC,GAAG,CACrD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAoB,CACpC,CACD,CAAC;QACF,OAAO,GAAG,CAAC;IACZ,CAAC,EAAE,EAAwC,CAAC,CAAC;AAC9C,CAAC;AAdD,wDAcC;AAED,SAAgB,iBAAiB,CAChC,MAA8C,EAC9C,GAAQ;IAER,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,iBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IACnD,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,sBAAsB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IACxD,OAAO,GAAG,CAAC;AACZ,CAAC;AAPD,8CAOC;AAED,SAAgB,kBAAkB,CACjC,KAAc;IAEd,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC3D,OAAO,KAAK,CAAC;KACb;IACD,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;QACjD,OAAO,GAAG,KAAK,EAAE,CAAC;KAClB;IACD,IAAI,KAAK,KAAK,SAAS,EAAE;QACxB,+CAA+C;QAC/C,OAAO,WAAW,CAAC;KACnB;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAQ,CAAC;KAC5C;IACD,MAAM,IAAI,KAAK,CAAC,4BAA4B,KAAK,EAAE,CAAC,CAAC;AACtD,CAAC;AAjBD,gDAiBC"}

package/dist/cjs/indexes.test.d.ts

@@ -0,0 +1 @@
+export {};