@speckle/objectloader2 2.25.1 → 2.25.7

package/dist/esm/operations/traverser.d.ts

@@ -0,0 +1,19 @@
+import { Base } from '../types/types.js';
+import { ObjectLoader2 } from './objectLoader2.js';
+export type ProgressStage = 'download' | 'construction';
+export type OnProgress = (e: {
+    stage: ProgressStage;
+    current: number;
+    total: number;
+}) => void;
+export interface TraverserOptions {
+    excludeProps?: string[];
+}
+export default class Traverser {
+    #private;
+    constructor(loader: ObjectLoader2, options?: TraverserOptions);
+    traverse(onProgress?: OnProgress): Promise<Base>;
+    traverseArray(array: Array<unknown>, onProgress?: OnProgress): Promise<void>;
+    traverseBase(base: Base, onProgress?: OnProgress): Promise<Base>;
+}
+//# sourceMappingURL=traverser.d.ts.map

package/dist/esm/operations/traverser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverser.d.ts","sourceRoot":"","sources":["../../../src/operations/traverser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAA4C,MAAM,mBAAmB,CAAA;AAClF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,cAAc,CAAA;AACvD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,EAAE;IAC3B,KAAK,EAAE,aAAa,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;CACd,KAAK,IAAI,CAAA;AAEV,MAAM,WAAW,gBAAgB;IAC/B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB;AAED,MAAM,CAAC,OAAO,OAAO,SAAS;;gBAOhB,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAKvD,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAehD,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5E,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAuDvE"}

package/dist/esm/operations/traverser.js

@@ -0,0 +1,93 @@
+import { isBase, isReference, isScalar } from '../types/types.js';
+export default class Traverser {
+    #loader;
+    #options;
+    #totalChildrenCount = 0;
+    #traversedReferencesCount = 0;
+    constructor(loader, options) {
+        this.#options = options || {};
+        this.#loader = loader;
+    }
+    async traverse(onProgress) {
+        let firstObjectPromise = undefined;
+        for await (const obj of this.#loader.getObjectIterator()) {
+            if (!firstObjectPromise) {
+                firstObjectPromise = this.traverseBase(obj, onProgress);
+            }
+        }
+        if (firstObjectPromise) {
+            return await firstObjectPromise;
+        }
+        else {
+            throw new Error('No objects found');
+        }
+    }
+    async traverseArray(array, onProgress) {
+        for (let i = 0; i < 10; i++) {
+            const prop = array[i];
+            if (isScalar(prop))
+                continue;
+            if (isBase(prop)) {
+                array[i] = await this.traverseBase(prop, onProgress);
+            }
+            else if (isReference(prop)) {
+                array[i] = await this.traverseBase(await this.#loader.getObject({ id: prop.referencedId }), onProgress);
+            }
+        }
+    }
+    async traverseBase(base, onProgress) {
+        for (const ignoredProp of this.#options.excludeProps || []) {
+            delete base[ignoredProp];
+        }
+        if (base.__closure) {
+            const ids = Object.keys(base.__closure);
+            const promises = [];
+            for (const id of ids) {
+                promises.push(this.traverseBase(await this.#loader.getObject({ id }), onProgress));
+            }
+            await Promise.all(promises);
+        }
+        delete base['__closure'];
+        // De-chunk
+        if (base.speckle_type?.includes('DataChunk')) {
+            const chunk = base;
+            if (chunk.data) {
+                await this.traverseArray(chunk.data, onProgress);
+            }
+        }
+        //other props
+        for (const prop in base) {
+            if (prop === '__closure')
+                continue;
+            if (prop === 'referenceId')
+                continue;
+            if (prop === 'speckle_type')
+                continue;
+            if (prop === 'data')
+                continue;
+            const baseProp = base[prop];
+            if (isScalar(baseProp))
+                continue;
+            if (isBase(baseProp)) {
+                await this.traverseBase(baseProp, onProgress);
+            }
+            else if (isReference(baseProp)) {
+                await this.traverseBase(await this.#loader.getObject({ id: baseProp.referencedId }), onProgress);
+            }
+            else if (Array.isArray(baseProp)) {
+                await this.traverseArray(baseProp, onProgress);
+            }
+        }
+        if (onProgress) {
+            onProgress({
+                stage: 'construction',
+                current: ++this.#traversedReferencesCount > this.#totalChildrenCount
+                    ? this.#totalChildrenCount
+                    : this.#traversedReferencesCount,
+                total: this.#totalChildrenCount
+            });
+        }
+        return base;
+    }
+}
+//# sourceMappingURL=traverser.js.map

package/dist/esm/operations/traverser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverser.js","sourceRoot":"","sources":["../../../src/operations/traverser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAclF,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAe;IACtB,QAAQ,CAAkB;IAE1B,mBAAmB,GAAG,CAAC,CAAA;IACvB,yBAAyB,GAAG,CAAC,CAAA;IAE7B,YAAY,MAAqB,EAAE,OAA0B;QAC3D,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,EAAE,CAAA;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACvB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,UAAuB;QACpC,IAAI,kBAAkB,GAA8B,SAAS,CAAA;QAC7D,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC;YACzD,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;YACzD,CAAC;QACH,CAAC;QAED,IAAI,kBAAkB,EAAE,CAAC;YACvB,OAAO,MAAM,kBAAkB,CAAA;QACjC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,KAAqB,EAAE,UAAuB;QAChE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;YACrB,IAAI,QAAQ,CAAC,IAAI,CAAC;gBAAE,SAAQ;YAC5B,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjB,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;YACtD,CAAC;iBAAM,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,YAAY,CAChC,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,EACvD,UAAU,CACX,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,IAAU,EAAE,UAAuB;QACpD,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC;YAC3D,OAAQ,IAAc,CAAC,WAAW,CAAC,CAAA;QACrC,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACvC,MAAM,QAAQ,GAAoB,EAAE,CAAA;YACpC,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;gBACrB,QAAQ,CAAC,IAAI,CACX,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,UAAU,CAAC,CACpE,CAAA;YACH,CAAC;YACD,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7B,CAAC;QACD,OAAQ,IAAc,CAAC,WAAW,CAAC,CAAA;QAEnC,WAAW;QACX,IAAI,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAG,IAAiB,CAAA;YAC/B,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACf,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;YAClD,CAAC;QACH,CAAC;QAED,aAAa;QACb,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,IAAI,IAAI,KAAK,WAAW;gBAAE,SAAQ;YAClC,IAAI,IAAI,KAAK,aAAa;gBAAE,SAAQ;YACpC,IAAI,IAAI,KAAK,cAAc;gBAAE,SAAQ;YACrC,IAAI,IAAI,KAAK,MAAM;gBAAE,SAAQ;YAC7B,MAAM,QAAQ,GAAI,IAA2C,CAAC,IAAI,CAAC,CAAA;YACnE,IAAI,QAAQ,CAAC,QAAQ,CAAC;gBAAE,SAAQ;YAChC,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;YAC/C,CAAC;iBAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjC,MAAM,IAAI,CAAC,YAAY,CACrB,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,EAC3D,UAAU,CACX,CAAA;YACH,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACnC,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;YAChD,CAAC;QACH,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,UAAU,CAAC;gBACT,KAAK,EAAE,cAAc;gBACrB,OAAO,EACL,EAAE,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC,mBAAmB;oBACzD,CAAC,CAAC,IAAI,CAAC,mBAAmB;oBAC1B,CAAC,CAAC,IAAI,CAAC,yBAAyB;gBACpC,KAAK,EAAE,IAAI,CAAC,mBAAmB;aAChC,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/types/errors.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Base ObjectLoader error
+ */
+declare class BaseError extends Error {
+    /**
+     * Default message if none is passed
+     */
+    static defaultMessage: string;
+    /**
+     * @param {string} [message]
+     */
+    constructor(message: string);
+}
+export declare class ObjectLoaderConfigurationError extends BaseError {
+    static defaultMessage: string;
+}
+export declare class ObjectLoaderRuntimeError extends BaseError {
+    static defaultMessage: string;
+}
+export {};
+//# sourceMappingURL=errors.d.ts.map

package/dist/esm/types/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/types/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAM,SAAU,SAAQ,KAAK;IAC3B;;OAEG;IACH,MAAM,CAAC,cAAc,SAA8B;IAEnD;;OAEG;gBACS,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,8BAA+B,SAAQ,SAAS;IAC3D,MAAM,CAAC,cAAc,SAA0C;CAChE;AAED,qBAAa,wBAAyB,SAAQ,SAAS;IACrD,MAAM,CAAC,cAAc,SAAiD;CACvE"}

package/dist/esm/types/errors.js

@@ -0,0 +1,23 @@
+/**
+ * Base ObjectLoader error
+ */
+class BaseError extends Error {
+    /**
+     * Default message if none is passed
+     */
+    static defaultMessage = 'Unexpected error occurred';
+    /**
+     * @param {string} [message]
+     */
+    constructor(message) {
+        message ||= new.target.defaultMessage;
+        super(message);
+    }
+}
+export class ObjectLoaderConfigurationError extends BaseError {
+    static defaultMessage = 'Object loader configured incorrectly!';
+}
+export class ObjectLoaderRuntimeError extends BaseError {
+    static defaultMessage = 'Object loader encountered a runtime problem!';
+}
+//# sourceMappingURL=errors.js.map

package/dist/esm/types/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/types/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,SAAU,SAAQ,KAAK;IAC3B;;OAEG;IACH,MAAM,CAAC,cAAc,GAAG,2BAA2B,CAAA;IAEnD;;OAEG;IACH,YAAY,OAAe;QACzB,OAAO,KAAK,GAAG,CAAC,MAAM,CAAC,cAAc,CAAA;QACrC,KAAK,CAAC,OAAO,CAAC,CAAA;IAChB,CAAC;;AAGH,MAAM,OAAO,8BAA+B,SAAQ,SAAS;IAC3D,MAAM,CAAC,cAAc,GAAG,uCAAuC,CAAA;;AAGjE,MAAM,OAAO,wBAAyB,SAAQ,SAAS;IACrD,MAAM,CAAC,cAAc,GAAG,8CAA8C,CAAA"}

package/dist/esm/types/types.d.ts

@@ -0,0 +1,25 @@
+export type CustomLogger = (message?: string, ...optionalParams: unknown[]) => void;
+export type Fetcher = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+export interface Item {
+    baseId: string;
+    base: Base;
+    size?: number;
+}
+export interface Base {
+    id: string;
+    speckle_type: string;
+    __closure?: Record<string, number>;
+}
+export interface Reference {
+    speckle_type: string;
+    referencedId: string;
+    __closure?: Record<string, number>;
+}
+export interface DataChunk extends Base {
+    data?: Base[];
+}
+export declare function isBase(maybeBase?: unknown): maybeBase is Base;
+export declare function isReference(maybeRef?: unknown): maybeRef is Reference;
+export declare function isScalar(value: unknown): value is string | number | boolean | bigint | symbol | undefined;
+export declare function take<T>(it: Iterator<T>, count: number): T[];
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;AAEnF,MAAM,MAAM,OAAO,GAAG,CACpB,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,OAAO,EAC7B,IAAI,CAAC,EAAE,WAAW,KACf,OAAO,CAAC,QAAQ,CAAC,CAAA;AAEtB,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,IAAI,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,SAAU,SAAQ,IAAI;IACrC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAA;CACd;AAED,wBAAgB,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,IAAI,IAAI,CAO7D;AAED,wBAAgB,WAAW,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,IAAI,SAAS,CAOrE;AAED,wBAAgB,QAAQ,CACtB,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAWlE;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,EAAE,CAQ3D"}

package/dist/esm/types/types.js

@@ -0,0 +1,33 @@
+export function isBase(maybeBase) {
+    return (maybeBase !== null &&
+        typeof maybeBase === 'object' &&
+        'id' in maybeBase &&
+        typeof maybeBase.id === 'string');
+}
+export function isReference(maybeRef) {
+    return (maybeRef !== null &&
+        typeof maybeRef === 'object' &&
+        'referencedId' in maybeRef &&
+        typeof maybeRef.referencedId === 'string');
+}
+export function isScalar(value) {
+    const type = typeof value;
+    return (value === null ||
+        type === 'string' ||
+        type === 'number' ||
+        type === 'boolean' ||
+        type === 'bigint' ||
+        type === 'symbol' ||
+        type === 'undefined');
+}
+export function take(it, count) {
+    const result = [];
+    for (let i = 0; i < count; i++) {
+        const itr = it.next();
+        if (itr.done)
+            break;
+        result.push(itr.value);
+    }
+    return result;
+}
+//# sourceMappingURL=types.js.map

package/dist/esm/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/types/types.ts"],"names":[],"mappings":"AA6BA,MAAM,UAAU,MAAM,CAAC,SAAmB;IACxC,OAAO,CACL,SAAS,KAAK,IAAI;QAClB,OAAO,SAAS,KAAK,QAAQ;QAC7B,IAAI,IAAI,SAAS;QACjB,OAAO,SAAS,CAAC,EAAE,KAAK,QAAQ,CACjC,CAAA;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,QAAkB;IAC5C,OAAO,CACL,QAAQ,KAAK,IAAI;QACjB,OAAO,QAAQ,KAAK,QAAQ;QAC5B,cAAc,IAAI,QAAQ;QAC1B,OAAO,QAAQ,CAAC,YAAY,KAAK,QAAQ,CAC1C,CAAA;AACH,CAAC;AAED,MAAM,UAAU,QAAQ,CACtB,KAAc;IAEd,MAAM,IAAI,GAAG,OAAO,KAAK,CAAA;IACzB,OAAO,CACL,KAAK,KAAK,IAAI;QACd,IAAI,KAAK,QAAQ;QACjB,IAAI,KAAK,QAAQ;QACjB,IAAI,KAAK,SAAS;QAClB,IAAI,KAAK,QAAQ;QACjB,IAAI,KAAK,QAAQ;QACjB,IAAI,KAAK,WAAW,CACrB,CAAA;AACH,CAAC;AAED,MAAM,UAAU,IAAI,CAAI,EAAe,EAAE,KAAa;IACpD,MAAM,MAAM,GAAQ,EAAE,CAAA;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,EAAE,CAAA;QACrB,IAAI,GAAG,CAAC,IAAI;YAAE,MAAK;QACnB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speckle/objectloader2",
-  "version": "2.25.1",
+  "version": "2.25.7",
   "description": "This is an updated objectloader for the Speckle viewer written in typescript",
   "main": "./dist/commonjs/index.js",
   "module": "./dist/esm/index.js",
@@ -33,7 +33,7 @@
   "author": "AEC Systems",
   "license": "Apache-2.0",
   "dependencies": {
-    "@speckle/shared": "^2.25.1",
+    "@speckle/shared": "^2.25.7",
     "dexie": "^4.0.11"
   },
   "devDependencies": {

package/src/helpers/cachePump.disposal.spec.ts

@@ -8,7 +8,9 @@ import { DefermentManager } from './defermentManager.js'
 const makeDatabase = (): Database =>
   ({
     cacheSaveBatch: async (): Promise<void> => {},
-    getAll: async (): Promise<(Item | undefined)[]> => Promise.resolve([])
+    getAll: async (): Promise<(Item | undefined)[]> => Promise.resolve([]),
+    getItem: async (): Promise<Item | undefined> => Promise.resolve(undefined),
+    disposeAsync: async (): Promise<void> => {}
   } as unknown as Database)
 const makeGathered = (): AsyncGeneratorQueue<Item> =>
   ({

package/src/helpers/cachePump.spec.ts

@@ -78,7 +78,8 @@ describe('CachePump testing', () => {
     const i2: Item = { baseId: 'id2', base: { id: 'id', speckle_type: 'type' } }
 
     const db: Database = {
-      getAll: async () => Promise.resolve([])
+      getAll: async () => Promise.resolve([]),
+      disposeAsync: async (): Promise<void> => {}
     } as unknown as Database
     const gathered = new AsyncGeneratorQueue<Item>()
     const deferments = new DefermentManager({ maxSizeInMb: 1, ttlms: 1 })

package/src/helpers/cachePump.ts

@@ -19,6 +19,8 @@ export class CachePump implements Pump {
 
   #options: CacheOptions
 
+  #disposed = false
+
   constructor(
     database: Database,
     gathered: AsyncGeneratorQueue<Item>,
@@ -46,6 +48,12 @@ export class CachePump implements Pump {
 
   async disposeAsync(): Promise<void> {
     await this.#writeQueue?.disposeAsync()
+    await this.#database.disposeAsync()
+    this.#disposed = true
+  }
+
+  get isDisposed(): boolean {
+    return this.#disposed
   }
 
   async pumpItems(params: {
@@ -57,7 +65,7 @@ export class CachePump implements Pump {
     const maxCacheReadSize = this.#options.maxCacheReadSize
 
     for (let i = 0; i < ids.length; ) {
-      if (this.#writeQueue?.isDisposed()) break
+      if (this.isDisposed) break
       if ((this.#writeQueue?.count() ?? 0) > this.#options.maxWriteQueueSize) {
         this.#logger(
           'pausing reads (# in write queue: ' + this.#writeQueue?.count() + ')'

package/src/helpers/defermentManager.defermentTotals.spec.ts

@@ -0,0 +1,53 @@
+import { describe, test, expect, beforeEach } from 'vitest'
+import { DefermentManager } from './defermentManager.js'
+import { DefermentManagerOptions } from '../operations/options.js'
+import { Base, Item } from '../types/types.js'
+
+const makeItem = (id: string, size = 1): Item => ({
+  baseId: id,
+  base: { foo: 'bar' } as unknown as Base,
+  size
+})
+
+describe('DefermentManager totalDefermentRequests', () => {
+  let manager: DefermentManager
+  let options: DefermentManagerOptions
+
+  beforeEach(() => {
+    options = { maxSizeInMb: 1, ttlms: 1000, logger: (): void => {} }
+    manager = new DefermentManager(options)
+  })
+
+  test('tracks deferment requests for each id', () => {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    manager.defer({ id: 'a' })
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    manager.defer({ id: 'a' })
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    manager.defer({ id: 'b' })
+    // @ts-expect-error: access private for test
+    expect(manager.totalDefermentRequests.get('a')).toBe(2)
+    // @ts-expect-error: access private for test
+    expect(manager.totalDefermentRequests.get('b')).toBe(1)
+  })
+
+  test('increments and does not reset on undefer', () => {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    manager.defer({ id: 'x' })
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    manager.defer({ id: 'x' })
+    manager.undefer(makeItem('x'))
+    // @ts-expect-error: access private for test
+    expect(manager.totalDefermentRequests.get('x')).toBe(2)
+    // @ts-expect-error: access private for test
+    const deferredBase = manager.deferments.get('x')
+    expect(deferredBase).toBeDefined()
+    expect(deferredBase?.getId()).toBe('x')
+  })
+
+  test('does not increment for undefer only', () => {
+    manager.undefer(makeItem('y'))
+    // @ts-expect-error: access private for test
+    expect(manager.totalDefermentRequests.get('y')).toBeUndefined()
+  })
+})

package/src/helpers/defermentManager.ts

@@ -8,6 +8,9 @@ export class DefermentManager {
   private logger: CustomLogger
   private currentSize = 0
   private disposed = false
+  //tracks total deferment requests for each id
+  //this is used to prevent cleaning up deferments that are still being requested
+  private totalDefermentRequests: Map<string, number> = new Map()
 
   constructor(private options: DefermentManagerOptions) {
     this.resetGlobalTimer()
@@ -29,6 +32,7 @@ export class DefermentManager {
 
   async defer(params: { id: string }): Promise<Base> {
     if (this.disposed) throw new Error('DefermentManager is disposed')
+    this.trackDefermentRequest(params.id)
     const now = this.now()
     const deferredBase = this.deferments.get(params.id)
     if (deferredBase) {
@@ -44,6 +48,15 @@ export class DefermentManager {
     return notYetFound.getPromise()
   }
 
+  private trackDefermentRequest(id: string): void {
+    const request = this.totalDefermentRequests.get(id)
+    if (request) {
+      this.totalDefermentRequests.set(id, request + 1)
+    } else {
+      this.totalDefermentRequests.set(id, 1)
+    }
+  }
+
   undefer(item: Item): void {
     if (this.disposed) throw new Error('DefermentManager is disposed')
     const now = this.now()
@@ -108,6 +121,12 @@ export class DefermentManager {
       .filter((x) => x.isExpired(now))
       .sort((a, b) => this.compareMaybeBasesBySize(a.getItem(), b.getItem()))) {
       if (deferredBase.done(now)) {
+        //if the deferment is done but has been requested multiple times,
+        //we do not clean it up to allow the requests to resolve
+        const requestCount = this.totalDefermentRequests.get(deferredBase.getId())
+        if (requestCount && requestCount > 1) {
+          return
+        }
         this.currentSize -= deferredBase.getItem()?.size || 0
         this.deferments.delete(deferredBase.getId())
         cleaned++
@@ -117,7 +136,7 @@ export class DefermentManager {
       }
     }
     this.logger(
-      'cleaned deferments, cleaned, left',
+      'cleaned deferments: cleaned, left, time',
       cleaned,
       this.deferments.size,
       performance.now() - start

package/src/index.ts

@@ -1,3 +1,2 @@
-export { MemoryDatabase } from './operations/databases/memoryDatabase.js'
 export { ObjectLoader2 } from './operations/objectLoader2.js'
 export { ObjectLoader2Factory } from './operations/objectLoader2Factory.js'

package/src/operations/databases/__snapshots__/indexedDatabase.spec.ts.snap

@@ -1,31 +1,18 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`database cache > write single item to queue use getItem 1`] = `
-{
-  "base": {
-    "id": "id",
-    "speckle_type": "type",
+exports[`IndexedDatabase > should add and get multiple items 1`] = `
+[
+  {
+    "baseId": "id1",
+    "item": {
+      "foo": "bar",
+    },
   },
-  "baseId": "id",
-}
-`;
-
-exports[`database cache > write two items to queue use getItem 1`] = `
-{
-  "base": {
-    "id": "id",
-    "speckle_type": "type",
-  },
-  "baseId": "id1",
-}
-`;
-
-exports[`database cache > write two items to queue use getItem 2`] = `
-{
-  "base": {
-    "id": "id",
-    "speckle_type": "type",
+  {
+    "baseId": "id2",
+    "item": {
+      "foo": "bar",
+    },
   },
-  "baseId": "id2",
-}
+]
 `;

package/src/operations/databases/indexedDatabase.spec.ts

@@ -1,37 +1,33 @@
-import { describe, expect, test } from 'vitest'
-import IndexedDatabase from './indexedDatabase.js'
+import { describe, it, expect, beforeEach, afterEach } from 'vitest'
 import { IDBFactory, IDBKeyRange } from 'fake-indexeddb'
+import IndexedDatabase, { IndexedDatabaseOptions } from './indexedDatabase.js'
 import { Item } from '../../types/types.js'
 
-describe('database cache', () => {
-  test('write single item to queue use getItem', async () => {
-    const i: Item = { baseId: 'id', base: { id: 'id', speckle_type: 'type' } }
-    const database = new IndexedDatabase({
-      indexedDB: new IDBFactory(),
-      keyRange: IDBKeyRange
-    })
-    await database.add(i)
-    await database.disposeAsync()
+// Mock Item
+const defaultItem = (id: string): Item => ({ baseId: id, item: { foo: 'bar' } })
 
-    const x = await database.getItem({ id: 'id' })
-    expect(x).toMatchSnapshot()
+describe('IndexedDatabase', () => {
+  let db: IndexedDatabase
+  let options: IndexedDatabaseOptions
+
+  beforeEach(() => {
+    options = { indexedDB: new IDBFactory(), keyRange: IDBKeyRange }
+    db = new IndexedDatabase(options)
   })
 
-  test('write two items to queue use getItem', async () => {
-    const i1: Item = { baseId: 'id1', base: { id: 'id', speckle_type: 'type' } }
-    const i2: Item = { baseId: 'id2', base: { id: 'id', speckle_type: 'type' } }
-    const database = new IndexedDatabase({
-      indexedDB: new IDBFactory(),
-      keyRange: IDBKeyRange
-    })
-    await database.add(i1)
-    await database.add(i2)
-    await database.disposeAsync()
+  afterEach(async () => {
+    await db.disposeAsync()
+  })
 
-    const x1 = await database.getItem({ id: i1.baseId })
-    expect(x1).toMatchSnapshot()
+  it('should add and get multiple items', async () => {
+    const items = [defaultItem('id1'), defaultItem('id2')]
+    await db.cacheSaveBatch({ batch: items })
+    const result = await db.getAll(['id1', 'id2'])
+    expect(result).toMatchSnapshot()
+    expect(result).toEqual(items)
+  })
 
-    const x2 = await database.getItem({ id: i2.baseId })
-    expect(x2).toMatchSnapshot()
+  it('should dispose without error', async () => {
+    await expect(db.disposeAsync()).resolves.not.toThrow()
   })
 })

package/src/operations/databases/indexedDatabase.ts

@@ -5,7 +5,7 @@ import { isSafari } from '@speckle/shared'
 import { Dexie, DexieOptions, Table } from 'dexie'
 import { Database } from '../interfaces.js'
 
-class ObjectStore extends Dexie {
+export class ObjectStore extends Dexie {
   static #databaseName: string = 'speckle-cache'
   objects!: Table<Item, string> // Table type: <entity, primaryKey>
 
@@ -83,30 +83,6 @@ export default class IndexedDatabase implements Database {
     this.#cacheDB = await this.#openDatabase()
   }
 
-  //this is for testing only - in the real world we will not use this
-  async add(item: Item): Promise<void> {
-    await this.#setupCacheDb()
-    await this.#cacheDB!.transaction('rw', this.#cacheDB!.objects, async () => {
-      return await this.#cacheDB?.objects.add(item)
-    })
-  }
-
-  async getItem(params: { id: string }): Promise<Item | undefined> {
-    const { id } = params
-    await this.#setupCacheDb()
-    //might not be in the real DB yet, so check the write queue first
-    if (this.#writeQueue) {
-      const item = this.#writeQueue.get(id)
-      if (item) {
-        return item
-      }
-    }
-
-    return this.#cacheDB!.transaction('r', this.#cacheDB!.objects, async () => {
-      return await this.#cacheDB?.objects.get(id)
-    })
-  }
-
   async cacheSaveBatch(params: { batch: Item[] }): Promise<void> {
     await this.#setupCacheDb()
     const { batch } = params

package/src/operations/databases/memoryDatabase.spec.ts

@@ -0,0 +1,48 @@
+import { describe, it, expect, beforeEach } from 'vitest'
+import { MemoryDatabase } from './memoryDatabase.js'
+import { Base, Item } from '../../types/types.js'
+
+const makeItem = (id: string, foo = 'bar'): Item => ({
+  baseId: id,
+  base: { foo } as unknown as Base
+})
+
+describe('MemoryDatabase', () => {
+  let db: MemoryDatabase
+
+  beforeEach(() => {
+    db = new MemoryDatabase()
+  })
+
+  it('should return undefined for missing keys', async () => {
+    const result = await db.getAll(['missing'])
+    expect(result).toEqual([undefined])
+  })
+
+  it('should add and retrieve a single item', async () => {
+    const item = makeItem('id1')
+    await db.cacheSaveBatch({ batch: [item] })
+    const result = await db.getAll(['id1'])
+    expect(result).toEqual([item])
+  })
+
+  it('should add and retrieve multiple items', async () => {
+    const items = [makeItem('id1'), makeItem('id2', 'baz')]
+    await db.cacheSaveBatch({ batch: items })
+    const result = await db.getAll(['id1', 'id2'])
+    expect(result).toEqual(items)
+  })
+
+  it('should overwrite items with the same key', async () => {
+    const item1 = makeItem('id1', 'foo')
+    const item2 = makeItem('id1', 'bar')
+    await db.cacheSaveBatch({ batch: [item1] })
+    await db.cacheSaveBatch({ batch: [item2] })
+    const result = await db.getAll(['id1'])
+    expect(result).toEqual([item2])
+  })
+
+  it('disposeAsync should resolve', async () => {
+    await expect(db.disposeAsync()).resolves.not.toThrow()
+  })
+})

package/src/operations/databases/memoryDatabase.ts

@@ -29,14 +29,6 @@ export class MemoryDatabase implements Database {
     return Promise.resolve()
   }
 
-  getItem(params: { id: string }): Promise<Item | undefined> {
-    const item = this.items.get(params.id)
-    if (item) {
-      return Promise.resolve({ baseId: params.id, base: item })
-    }
-    return Promise.resolve(undefined)
-  }
-
   disposeAsync(): Promise<void> {
     return Promise.resolve()
   }