@vertexvis/api-client-node 0.17.3 → 0.20.3

package/dist/esm/client/helpers/scenes.d.ts

@@ -17,6 +17,22 @@ export interface CreateSceneAndSceneItemsReq extends BaseReq {
     /** Whether or not to return queued scene items. */
     readonly returnQueued?: boolean;
 }
+export interface CreateSceneAndSceneItemsReqEXPERIMENTAL extends BaseReq {
+    /** A list of {@link CreateSceneItemRequest}. */
+    readonly createSceneItemReqs: Array<Array<CreateSceneItemRequest>>;
+    /** Function returning a {@link CreateSceneRequest}. */
+    readonly createSceneReq: () => CreateSceneRequest;
+    /** Whether or not to fail if any scene item fails initial validation. */
+    readonly failFast?: boolean;
+    /** How many requests to run in parallel. */
+    readonly parallelism: number;
+    /** {@link Polling} */
+    readonly polling?: Polling;
+    /** Callback with total number of requests and number complete. */
+    onProgress?: (complete: number, total: number) => void;
+    /** Whether or not to return queued scene items. */
+    readonly returnQueued?: boolean;
+}
 export interface CreateSceneAndSceneItemsRes {
     readonly errors: QueuedSceneItem[];
     readonly scene: Scene;
@@ -90,13 +106,13 @@ export declare function createSceneAndSceneItems({ client, createSceneItemReqs,
  */
 export declare function createSceneItems({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }: CreateSceneItemsReq): Promise<CreateSceneItemsRes>;
 /**
- * Create a scene with scene items.
+ * Create a scene with scene items using experimental strategy.
  */
-export declare function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast, onMsg, onProgress, parallelism, polling, returnQueued, verbose, }: CreateSceneAndSceneItemsReq): Promise<CreateSceneAndSceneItemsResEXPERIMENTAL>;
+export declare function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast, onMsg, onProgress, parallelism, polling, returnQueued, verbose, }: CreateSceneAndSceneItemsReqEXPERIMENTAL): Promise<CreateSceneAndSceneItemsResEXPERIMENTAL>;
 /**
  * Create scene items within a scene.
  */
-export declare function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }: CreateSceneItemsReq): Promise<CreateSceneItemsResEXPERIMENTAL>;
+export declare function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, parallelism, sceneId, }: CreateSceneItemsReq): Promise<CreateSceneItemsResEXPERIMENTAL>;
 /**
  * Delete all scenes.
  *

package/dist/esm/client/helpers/scenes.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import pLimit from 'p-limit';
+import { hrtime } from 'process';
 import { BatchOperationOpEnum, BatchOperationRefTypeEnum, CameraFitTypeEnum, SceneRelationshipDataTypeEnum, UpdateSceneRequestDataAttributesStateEnum, } from '../../index';
 import { defined, getPage, hasVertexError, isQueuedJob, MaxAttempts, partition, PollIntervalMs, tryStream, } from '../index';
 import { arrayChunked, delay, isApiError, toAccept } from '../utils';
@@ -113,45 +114,93 @@ export function createSceneItems({ client, createSceneItemReqs, failFast, onProg
     });
 }
 /**
- * Create a scene with scene items.
+ * Create a scene with scene items using experimental strategy.
  */
 export function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast = false, onMsg = console.log, onProgress, parallelism, polling = { intervalMs: PollIntervalMs, maxAttempts: MaxAttempts }, returnQueued = false, verbose, }) {
     return __awaiter(this, void 0, void 0, function* () {
+        const startTime = hrtime.bigint();
+        if (verbose)
+            onMsg(`Creating scene...`);
         const scene = (yield client.scenes.createScene({ createSceneRequest: createSceneReq() })).data;
         const sceneId = scene.data.id;
-        const createRes = yield createSceneItemsEXPERIMENTAL({
-            client,
-            createSceneItemReqs,
-            failFast,
-            onProgress,
-            parallelism,
-            sceneId,
-        });
-        const { a: queuedOps, b: errors } = partition(createRes.queuedBatchOps, (i) => isQueuedJob(i.res));
-        const queued = returnQueued ? createRes.queuedBatchOps : [];
-        // Nothing succeeded, return early as something is likely wrong
-        if (queuedOps.length === 0 || errors.length === createRes.chunks) {
-            return { errors, queued, scene, sceneItemErrors: [] };
-        }
         if (verbose)
-            onMsg(`Polling for completed scene-item batches...`);
-        const limit = pLimit(Math.min(parallelism, 20));
-        function poll({ ops, res, }) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const r = yield pollQueuedJob({
-                    id: res.data.id,
-                    getQueuedJob: (id, cancelToken) => client.batches.getQueuedBatch({ id }, { cancelToken }),
-                    allow404: true,
-                    limit,
-                    polling,
-                });
-                if (isPollError(r.res)) {
-                    failFast ? throwOnError(r) : errors.push({ ops, res: r.res });
-                }
-                return r;
+            onMsg(`Creating scene items...`);
+        let itemCount = 0;
+        let batchQueuedOps = [];
+        let batchErrors = [];
+        let sceneItemErrors = [];
+        for (let depth = 0; depth < createSceneItemReqs.length; depth++) {
+            const createItemReqs = createSceneItemReqs[depth];
+            itemCount += createItemReqs.length;
+            if (verbose)
+                onMsg(`Creating ${createItemReqs.length} scene items at depth ${depth}...`);
+            // Await is used intentionally to defer loop iteration
+            // until all scene items have been created at each depth.
+            // eslint-disable-next-line no-await-in-loop
+            const createRes = yield createSceneItemsEXPERIMENTAL({
+                client,
+                createSceneItemReqs: createItemReqs,
+                failFast,
+                onProgress,
+                parallelism,
+                sceneId,
             });
+            const { a: queuedOps, b: errors } = partition(createRes.queuedBatchOps, (i) => isQueuedJob(i.res));
+            batchQueuedOps = batchQueuedOps.concat(queuedOps);
+            if (errors.length) {
+                batchErrors = batchErrors.concat(errors);
+                if (verbose)
+                    onMsg(`WARNING: ${errors.length} scene item batch errors at depth ${depth}.`);
+            }
+            // Nothing succeeded, return early as something is likely wrong
+            if (queuedOps.length === 0 || errors.length === createRes.chunks) {
+                return {
+                    errors,
+                    queued: returnQueued ? createRes.queuedBatchOps : [],
+                    scene,
+                    sceneItemErrors: [],
+                };
+            }
+            const limit = pLimit(Math.min(parallelism, 20));
+            function poll({ ops, res, }) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const r = yield pollQueuedJob({
+                        id: res.data.id,
+                        getQueuedJob: (id, cancelToken) => client.batches.getQueuedBatch({ id }, { cancelToken }),
+                        allow404: true,
+                        limit,
+                        polling,
+                    });
+                    if (isPollError(r.res)) {
+                        failFast ? throwOnError(r) : errors.push({ ops, res: r.res });
+                    }
+                    return r;
+                });
+            }
+            // eslint-disable-next-line no-await-in-loop
+            const batchRes = yield Promise.all(queuedOps.map((is) => limit(poll, is)));
+            const batchItemErrors = batchRes
+                .flatMap((b, i) => isBatch(b.res)
+                ? b.res['vertexvis/batch:results'].map((r, j) => isApiError(r)
+                    ? { req: queuedOps[i].ops[j].data, res: r }
+                    : undefined)
+                : [])
+                .filter(defined);
+            if (batchItemErrors.length) {
+                sceneItemErrors = sceneItemErrors.concat(batchItemErrors);
+                if (verbose)
+                    onMsg(`WARNING: ${batchItemErrors.length} scene item creation errors at depth ${depth}.`);
+            }
+        }
+        if (verbose) {
+            onMsg(`Scene item creation complete for ${itemCount} scene items with max depth of ${createSceneItemReqs.length - 1}.`);
+            if (batchErrors.length) {
+                onMsg(`  Batch errors: ${batchErrors.length}`);
+            }
+            if (sceneItemErrors.length) {
+                onMsg(`  Scene item errors: ${sceneItemErrors.length}`);
+            }
         }
-        const batchRes = yield Promise.all(queuedOps.map((is) => limit(poll, is)));
         if (verbose)
             onMsg(`Committing scene and polling until ready...`);
         yield updateScene({
@@ -161,35 +210,40 @@ export function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemRe
         });
         yield pollSceneReady({ client, id: sceneId, onMsg, polling, verbose });
         if (verbose)
-            onMsg(`Fitting scene's camera to scene-items...`);
+            onMsg(`Fitting scene's camera to scene items...`);
+        const sceneResult = (yield updateScene({
+            attributes: {
+                camera: { type: CameraFitTypeEnum.FitVisibleSceneItems },
+            },
+            client,
+            sceneId,
+        })).scene;
+        if (verbose) {
+            const formatTime = (seconds) => {
+                const h = Math.floor(seconds / 3600);
+                const m = Math.floor((seconds % 3600) / 60);
+                const s = Math.round(seconds % 60);
+                return [h, m > 9 ? m : h ? '0' + m : m || '0', s > 9 ? s : '0' + s]
+                    .filter(Boolean)
+                    .join(':');
+            };
+            onMsg(`Scene creation completed in ${formatTime(Number(hrtime.bigint() - startTime) / 1000000000)}.`);
+        }
         return {
-            errors,
-            queued,
-            scene: (yield updateScene({
-                attributes: {
-                    camera: { type: CameraFitTypeEnum.FitVisibleSceneItems },
-                },
-                client,
-                sceneId,
-            })).scene,
-            sceneItemErrors: batchRes
-                .flatMap((b, i) => isBatch(b.res)
-                ? b.res['vertexvis/batch:results'].map((r, j) => isApiError(r)
-                    ? { req: queuedOps[i].ops[j].data, res: r }
-                    : undefined)
-                : [])
-                .filter(defined),
+            errors: batchErrors,
+            queued: batchQueuedOps,
+            scene: sceneResult,
+            sceneItemErrors,
         };
     });
 }
 /**
  * Create scene items within a scene.
  */
-export function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }) {
+export function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, parallelism, sceneId, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const limit = pLimit(parallelism);
         const batchSize = 500;
-        let complete = 0;
         const opChunks = arrayChunked(createSceneItemReqs.map((req) => ({
             data: req.data,
             op: BatchOperationOpEnum.Add,
@@ -213,10 +267,6 @@ export function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, fail
                 else
                     throw error;
             }
-            if (onProgress != null) {
-                complete += opChunk.length;
-                onProgress(complete, createSceneItemReqs.length);
-            }
             return { ops, res };
         }), opChunk)));
         return { chunks: opChunks.length, queuedBatchOps };

package/dist/esm/client/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.17.3";
+export declare const version = "0.20.3";

package/dist/esm/client/version.js

@@ -1 +1 @@
-export const version = '0.17.3';
+export const version = '0.20.3';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.17.3",
+  "version": "0.20.3",
   "description": "The Vertex REST API client for Node.js.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
@@ -33,7 +33,7 @@
     "typescript"
   ],
   "dependencies": {
-    "axios": "^0.24",
+    "axios": "^0.27.2",
     "p-limit": "^3"
   },
   "devDependencies": {