@speckle/objectloader2 2.25.0 → 2.25.4

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.0",
+  "version": "2.25.4",
   "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.0",
+    "@speckle/shared": "^2.25.4",
     "dexie": "^4.0.11"
   },
   "devDependencies": {