@vertexvis/api-client-node 0.17.3 → 0.20.3

package/dist/cjs/client/helpers/queued-jobs.js

@@ -74,9 +74,10 @@ function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { i
         let attempts = 1;
         let pollRes = yield poll(attempts);
         /* eslint-disable no-await-in-loop */
-        while ((allowed404(allow404, pollRes.status) ||
-            validJob(pollRes.res) ||
-            isClientError(pollRes.res)) &&
+        while (!completeJob(pollRes.res) &&
+            (allowed404(allow404, pollRes.status) ||
+                validJob(pollRes.res) ||
+                isClientError(pollRes.res)) &&
             attempts <= maxAttempts) {
             attempts += 1;
             yield (0, utils_1.delay)(intervalMs);
@@ -85,7 +86,7 @@ function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { i
         /* eslint-enable no-await-in-loop */
         // At this point, the result is one of the following,
         //  - An item of type `T` after being redirected to it
-        //  - A QueuedJob (after either exceeding `maxAttempts` or with `error` status)
+        //  - A QueuedJob (after either exceeding `maxAttempts` or with `complete` or `error` status)
         //  - A Failure
         return Object.assign(Object.assign({}, pollRes), { attempts, id });
     });
@@ -115,10 +116,16 @@ function allowed404(allow404, status) {
 function validJob(r) {
     return (0, utils_1.isQueuedJob)(r) && !isStatusError(r);
 }
+function completeJob(r) {
+    return (0, utils_1.isQueuedJob)(r) && isStatusComplete(r);
+}
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 function isQueuedJobError(obj) {
     return (0, utils_1.isQueuedJob)(obj) && isStatusError(obj);
 }
+function isStatusComplete(job) {
+    return job.data.attributes.status === 'complete';
+}
 function isStatusError(job) {
     return job.data.attributes.status === 'error';
 }

package/dist/cjs/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/cjs/client/helpers/scenes.js

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateScene = exports.renderScene = exports.pollSceneReady = exports.deleteAllScenes = exports.createSceneItemsEXPERIMENTAL = exports.createSceneAndSceneItemsEXPERIMENTAL = exports.createSceneItems = exports.createSceneAndSceneItems = void 0;
 const p_limit_1 = __importDefault(require("p-limit"));
+const process_1 = require("process");
 const index_1 = require("../../index");
 const index_2 = require("../index");
 const utils_1 = require("../utils");
@@ -121,45 +122,93 @@ function createSceneItems({ client, createSceneItemReqs, failFast, onProgress, p
 }
 exports.createSceneItems = createSceneItems;
 /**
- * Create a scene with scene items.
+ * Create a scene with scene items using experimental strategy.
  */
 function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, createSceneReq, failFast = false, onMsg = console.log, onProgress, parallelism, polling = { intervalMs: index_2.PollIntervalMs, maxAttempts: index_2.MaxAttempts }, returnQueued = false, verbose, }) {
     return __awaiter(this, void 0, void 0, function* () {
+        const startTime = process_1.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 } = (0, index_2.partition)(createRes.queuedBatchOps, (i) => (0, index_2.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 = (0, p_limit_1.default)(Math.min(parallelism, 20));
-        function poll({ ops, res, }) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const r = yield (0, queued_jobs_1.pollQueuedJob)({
-                    id: res.data.id,
-                    getQueuedJob: (id, cancelToken) => client.batches.getQueuedBatch({ id }, { cancelToken }),
-                    allow404: true,
-                    limit,
-                    polling,
-                });
-                if ((0, queued_jobs_1.isPollError)(r.res)) {
-                    failFast ? (0, queued_jobs_1.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 } = (0, index_2.partition)(createRes.queuedBatchOps, (i) => (0, index_2.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 = (0, p_limit_1.default)(Math.min(parallelism, 20));
+            function poll({ ops, res, }) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const r = yield (0, queued_jobs_1.pollQueuedJob)({
+                        id: res.data.id,
+                        getQueuedJob: (id, cancelToken) => client.batches.getQueuedBatch({ id }, { cancelToken }),
+                        allow404: true,
+                        limit,
+                        polling,
+                    });
+                    if ((0, queued_jobs_1.isPollError)(r.res)) {
+                        failFast ? (0, queued_jobs_1.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) => (0, queued_jobs_1.isBatch)(b.res)
+                ? b.res['vertexvis/batch:results'].map((r, j) => (0, utils_1.isApiError)(r)
+                    ? { req: queuedOps[i].ops[j].data, res: r }
+                    : undefined)
+                : [])
+                .filter(index_2.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({
@@ -169,24 +218,30 @@ function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, cre
         });
         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: index_1.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(process_1.hrtime.bigint() - startTime) / 1000000000)}.`);
+        }
         return {
-            errors,
-            queued,
-            scene: (yield updateScene({
-                attributes: {
-                    camera: { type: index_1.CameraFitTypeEnum.FitVisibleSceneItems },
-                },
-                client,
-                sceneId,
-            })).scene,
-            sceneItemErrors: batchRes
-                .flatMap((b, i) => (0, queued_jobs_1.isBatch)(b.res)
-                ? b.res['vertexvis/batch:results'].map((r, j) => (0, utils_1.isApiError)(r)
-                    ? { req: queuedOps[i].ops[j].data, res: r }
-                    : undefined)
-                : [])
-                .filter(index_2.defined),
+            errors: batchErrors,
+            queued: batchQueuedOps,
+            scene: sceneResult,
+            sceneItemErrors,
         };
     });
 }
@@ -194,11 +249,10 @@ exports.createSceneAndSceneItemsEXPERIMENTAL = createSceneAndSceneItemsEXPERIMEN
 /**
  * Create scene items within a scene.
  */
-function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, onProgress, parallelism, sceneId, }) {
+function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, parallelism, sceneId, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const limit = (0, p_limit_1.default)(parallelism);
         const batchSize = 500;
-        let complete = 0;
         const opChunks = (0, utils_1.arrayChunked)(createSceneItemReqs.map((req) => ({
             data: req.data,
             op: index_1.BatchOperationOpEnum.Add,
@@ -222,10 +276,6 @@ function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, o
                 else
                     throw error;
             }
-            if (onProgress != null) {
-                complete += opChunk.length;
-                onProgress(complete, createSceneItemReqs.length);
-            }
             return { ops, res };
         }), opChunk)));
         return { chunks: opChunks.length, queuedBatchOps };

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

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

package/dist/cjs/client/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.17.3';
+exports.version = '0.20.3';