@vertexvis/api-client-node 0.15.2 → 0.15.6

package/dist/esm/base.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import { Configuration } from './configuration';
-import { AxiosInstance } from 'axios';
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
 /**
  *
@@ -29,7 +29,7 @@ export declare const COLLECTION_FORMATS: {
  */
 export interface RequestArgs {
     url: string;
-    options: any;
+    options: AxiosRequestConfig;
 }
 /**
  *

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

@@ -1,14 +1,12 @@
+/// <reference types="node" />
 import { BaseReq, DeleteReq } from '../../client/index';
 import { CreateFileRequest, FileMetadataData } from '../../index';
 /** Upload file arguments. */
 export interface UploadFileReq extends BaseReq {
     /** A {@link CreateFileRequest}. */
     readonly createFileReq: CreateFileRequest;
-    /** File data.
-     * @deprecated Use {@link filePath} instead.
-     */
-    readonly fileData?: unknown;
-    readonly filePath?: string;
+    /** File data. */
+    readonly fileData: Buffer;
 }
 /**
  * Delete all files.
@@ -21,10 +19,10 @@ export declare function deleteAllFiles({ client, pageSize, exceptions, }: Delete
  *
  * @param args - The {@link UploadFileReq}.
  */
-export declare function uploadFileIfNotExists({ client, createFileReq, fileData, filePath, onMsg, verbose, }: UploadFileReq): Promise<FileMetadataData>;
+export declare function uploadFileIfNotExists({ client, createFileReq, onMsg, verbose, ...rest }: UploadFileReq): Promise<FileMetadataData>;
 /**
  * Create a file resource and upload a file.
  *
  * @param args - The {@link UploadFileReq}.
  */
-export declare function uploadFile({ client, createFileReq, fileData, filePath, onMsg, verbose, }: UploadFileReq): Promise<FileMetadataData>;
+export declare function uploadFile({ client, createFileReq, fileData, onMsg, verbose, }: UploadFileReq): Promise<FileMetadataData>;

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

@@ -7,11 +7,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import fs from 'fs';
-import { promisify } from 'util';
-import { delay, encodeIfNotEncoded, getBySuppliedId, getPage, } from '../../client/index';
-const readFile = promisify(fs.readFile);
-const stat = promisify(fs.stat);
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { encodeIfNotEncoded, getBySuppliedId, getPage, } from '../../client/index';
 /**
  * Delete all files.
  *
@@ -40,7 +47,8 @@ export function deleteAllFiles({ client, pageSize = 100, exceptions = new Set(),
  *
  * @param args - The {@link UploadFileReq}.
  */
-export function uploadFileIfNotExists({ client, createFileReq, fileData, filePath, onMsg = console.log, verbose, }) {
+export function uploadFileIfNotExists(_a) {
+    var { client, createFileReq, onMsg = console.log, verbose } = _a, rest = __rest(_a, ["client", "createFileReq", "onMsg", "verbose"]);
     return __awaiter(this, void 0, void 0, function* () {
         const suppliedId = createFileReq.data.attributes.suppliedId;
         const existingFile = suppliedId
@@ -64,14 +72,7 @@ export function uploadFileIfNotExists({ client, createFileReq, fileData, filePat
                 yield client.files.deleteFile({ id: fileId });
             }
         }
-        return uploadFile({
-            client,
-            createFileReq,
-            fileData,
-            filePath,
-            onMsg,
-            verbose,
-        });
+        return uploadFile(Object.assign({ client, createFileReq, onMsg, verbose }, rest));
     });
 }
 /**
@@ -79,7 +80,7 @@ export function uploadFileIfNotExists({ client, createFileReq, fileData, filePat
  *
  * @param args - The {@link UploadFileReq}.
  */
-export function uploadFile({ client, createFileReq, fileData, filePath, onMsg = console.log, verbose, }) {
+export function uploadFile({ client, createFileReq, fileData, onMsg = console.log, verbose, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const fileName = createFileReq.data.attributes.name;
         const createRes = yield client.files.createFile({
@@ -88,25 +89,20 @@ export function uploadFile({ client, createFileReq, fileData, filePath, onMsg =
         const fileId = createRes.data.data.id;
         if (verbose)
             onMsg(`Created file '${fileName}', ${fileId}`);
-        const [body, { size }] = filePath
-            ? yield Promise.all([readFile(filePath), stat(filePath)])
-            : [fileData, { size: -1 }];
-        yield client.files.uploadFile({ id: fileId, body }, { headers: size >= 0 ? { 'Content-Length': size } : undefined });
-        if (verbose)
-            onMsg(`Uploaded file ${fileId}`);
-        const updated = (yield client.files.getFile({ id: fileId })).data.data;
-        if (size >= 0 && updated.attributes.size !== size) {
-            onMsg(`File ${fileId} size mismatch, expected ${size} got ${updated.attributes.size}`);
+        const uploadRes = yield client.files.uploadFile({
+            id: fileId,
+            body: fileData,
+        });
+        if (uploadRes.status !== 204) {
+            throw new Error(`Uploading file ${fileId} failed with status code ${uploadRes.status}`);
         }
-        const status = updated.attributes.status;
-        if (status === 'error')
+        const getRes = (yield client.files.getFile({ id: fileId })).data.data;
+        const status = getRes.attributes.status;
+        if (status === 'error') {
             throw new Error(`Uploading file ${fileId} failed with status ${status}`);
-        // Sanity check
-        if (status !== 'complete') {
-            if (verbose)
-                onMsg(`File ${fileId} in status ${status}, waiting...`);
-            yield delay(1000);
         }
-        return updated;
+        if (verbose)
+            onMsg(`Uploaded file ${fileId}, status ${status}`);
+        return getRes;
     });
 }

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

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { AxiosResponse } from 'axios';
 import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, PartData, PartRevisionData, QueuedJob } from '../../index';
 import { BaseReq, DeleteReq, Polling, RenderImageReq } from '../index';
@@ -7,15 +8,13 @@ export interface CreatePartFromFileReq extends BaseReq {
     readonly createFileReq: CreateFileRequest;
     /** Function returning a {@link CreatePartRequest}. */
     readonly createPartReq: (fileId: string) => CreatePartRequest;
-    /** File data.
-     * @deprecated Use {@link filePath} instead.
-     */
-    readonly fileData?: unknown;
-    readonly filePath?: string;
+    /** File data. */
+    readonly fileData: Buffer;
     /** {@link Polling} */
     readonly polling?: Polling;
     /** Whether or not to return queued translation. */
     readonly returnQueued?: boolean;
+    readonly bypassAxiosEXPERIMENTAL?: boolean;
 }
 export interface CreatePartFromFileRes {
     /** A {@link PartRevisionData}. */
@@ -39,7 +38,7 @@ export interface GetPartRevisionBySuppliedIdReq extends BaseReq {
  *
  * @param args - The {@link CreatePartFromFileReq}.
  */
-export declare function createPartFromFile({ client, createFileReq, createPartReq, fileData, filePath, onMsg, polling, returnQueued, verbose, }: CreatePartFromFileReq): Promise<CreatePartFromFileRes>;
+export declare function createPartFromFile({ client, createPartReq, onMsg, polling, returnQueued, verbose, ...rest }: CreatePartFromFileReq): Promise<CreatePartFromFileRes>;
 /**
  * Create part and file resources if they don't already exist.
  *

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

@@ -7,6 +7,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 import { encodeIfNotEncoded, getBySuppliedId, getPage, head, MaxAttempts, PollIntervalMs, prettyJson, toAccept, tryStream, uploadFileIfNotExists, } from '../index';
 import { isPollError, pollQueuedJob, throwOnError } from './queued-jobs';
 /**
@@ -14,17 +25,11 @@ import { isPollError, pollQueuedJob, throwOnError } from './queued-jobs';
  *
  * @param args - The {@link CreatePartFromFileReq}.
  */
-export function createPartFromFile({ client, createFileReq, createPartReq, fileData, filePath, onMsg = console.log, polling = { intervalMs: PollIntervalMs, maxAttempts: MaxAttempts }, returnQueued = false, verbose, }) {
-    var _a, _b;
+export function createPartFromFile(_a) {
+    var _b, _c;
+    var { client, createPartReq, onMsg = console.log, polling = { intervalMs: PollIntervalMs, maxAttempts: MaxAttempts }, returnQueued = false, verbose } = _a, rest = __rest(_a, ["client", "createPartReq", "onMsg", "polling", "returnQueued", "verbose"]);
     return __awaiter(this, void 0, void 0, function* () {
-        const file = yield uploadFileIfNotExists({
-            client,
-            verbose,
-            fileData,
-            filePath,
-            createFileReq,
-            onMsg,
-        });
+        const file = yield uploadFileIfNotExists(Object.assign({ client, verbose, onMsg }, rest));
         const createPartRequest = createPartReq(file.id);
         const suppliedPartId = createPartRequest.data.attributes.suppliedId;
         const suppliedRevisionId = createPartRequest.data.attributes.suppliedRevisionId;
@@ -61,11 +66,11 @@ export function createPartFromFile({ client, createFileReq, createPartReq, fileD
         });
         if (isPollError(pollRes.res))
             throwOnError(pollRes);
-        const partRevision = head((_a = pollRes.res.included) === null || _a === void 0 ? void 0 : _a.filter((pr) => pr.attributes.suppliedId === suppliedRevisionId));
+        const partRevision = head((_b = pollRes.res.included) === null || _b === void 0 ? void 0 : _b.filter((pr) => pr.attributes.suppliedId === suppliedRevisionId));
         if (!partRevision)
             throw new Error(`Error creating part revision.\nRes: ${prettyJson(pollRes)}`);
         if (verbose) {
-            onMsg(`Created part ${(_b = pollRes.res) === null || _b === void 0 ? void 0 : _b.data.id}, part-revision ${partRevision.id}`);
+            onMsg(`Created part ${(_c = pollRes.res) === null || _c === void 0 ? void 0 : _c.data.id}, part-revision ${partRevision.id}`);
         }
         return { partRevision, queued };
     });

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

@@ -89,7 +89,7 @@ export function isPollError(r) {
 }
 export function isBatch(obj) {
     const b = obj;
-    return defined(b) && defined(b.vertexvis_batchresults);
+    return defined(b) && defined(b['vertexvis/batch:results']);
 }
 export function throwOnError(r) {
     throw new Error(isQueuedJobError(r.res) || isFailure(r.res)

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

@@ -52,7 +52,7 @@ export interface QueuedBatchOps {
     readonly ops: BatchOperation[];
     readonly res?: Failure | QueuedJob;
 }
-interface SceneItemError {
+export interface SceneItemError {
     readonly req: CreateSceneItemRequestData;
     readonly res?: ApiError;
 }

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

@@ -174,7 +174,7 @@ export function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemRe
             })).scene,
             sceneItemErrors: batchRes
                 .flatMap((b, i) => isBatch(b.res)
-                ? b.res.vertexvis_batchresults.map((r, j) => isApiError(r)
+                ? b.res['vertexvis/batch:results'].map((r, j) => isApiError(r)
                     ? { req: queuedOps[i].ops[j].data, res: r }
                     : undefined)
                 : [])
@@ -203,16 +203,7 @@ export function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, fail
             let res;
             try {
                 res = (yield client.batches.createBatch({
-                    createBatchRequest: {
-                        vertexvis_batchoperations: ops,
-                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                        // @ts-ignore
-                        toJSON() {
-                            return {
-                                'vertexvis/batch:operations': this.vertexvis_batchoperations,
-                            };
-                        },
-                    },
+                    createBatchRequest: { 'vertexvis/batch:operations': ops },
                 })).data;
             }
             catch (error) {

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

@@ -84,7 +84,7 @@ export declare function getBySuppliedId<T extends {
  *
  * @param error: The error.
  */
-export declare function getErrorMessage(error: VertexError | AxiosError): string;
+export declare function getErrorMessage(error: VertexError | AxiosError | unknown): Error | string;
 /**
  * Get a page of results from a listing.
  *
@@ -113,7 +113,7 @@ export declare function getPage<T extends {
  * @param getKey - Function returning key to group the array by.
  * @returns A 2D array.
  */
-export declare const groupBy: <T, K extends string | number | symbol>(items: T[], getKey: (item: T) => K) => Record<K, T[]>;
+export declare const groupBy: <T, K extends never>(items: T[], getKey: (item: T) => K) => Record<K, T[]>;
 /**
  * Return the first item in an array.
  *
@@ -135,18 +135,18 @@ export declare function is4x4Identity(transform: number[][]): boolean;
  * @returns `true` if URI encoded.
  */
 export declare function isEncoded(s: string): boolean;
-export declare function isApiError(error: any): error is ApiError;
-export declare function isFailure(obj: any): obj is Failure;
-export declare function isQueuedJob(obj: any): obj is QueuedJob;
-export declare function hasVertexError(error: any): error is VertexError;
-export declare function hasVertexErrorMessage(error: any): error is VertexError;
+export declare function isApiError(error: unknown): error is ApiError;
+export declare function isFailure(obj: unknown): obj is Failure;
+export declare function isQueuedJob(obj: unknown): obj is QueuedJob;
+export declare function hasVertexError(error: unknown): error is VertexError;
+export declare function hasVertexErrorMessage(error: unknown): error is VertexError;
 /**
  * Log an Error produced by {@link VertexClient}.
  *
  * @param error: The error to log.
  * @param logger: The logger to use.
  */
-export declare function logError(error: VertexError | AxiosError, logger?: (input: Error | string) => void): void;
+export declare function logError(error: VertexError | AxiosError | unknown, logger?: (input: Error | string) => void): void;
 /**
  * Matrix multiply two 2D arrays.
  *

package/dist/esm/client/utils.js

@@ -121,9 +121,14 @@ export function getErrorMessage(error) {
         const ve = error.vertexErrorMessage;
         return ve && !ve.startsWith(UnableToStringify) ? ve : error.message;
     }
-    return error.isAxiosError && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.data)
-        ? prettyJson((_b = error.response) === null || _b === void 0 ? void 0 : _b.data)
-        : error.message;
+    const ae = error;
+    if (ae.isAxiosError) {
+        return defined((_a = ae.response) === null || _a === void 0 ? void 0 : _a.data)
+            ? prettyJson((_b = ae.response) === null || _b === void 0 ? void 0 : _b.data)
+            : ae.message;
+    }
+    const e = error;
+    return defined(e.message) ? e.message : e.toString();
 }
 /**
  * Get a page of results from a listing.
@@ -150,7 +155,6 @@ export function getPage(getListing) {
  * @param getKey - Function returning key to group the array by.
  * @returns A 2D array.
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const groupBy = (items, getKey) => items.reduce((acc, cur) => {
     var _a;
     const group = getKey(cur);
@@ -189,19 +193,16 @@ export function is4x4Identity(transform) {
 export function isEncoded(s) {
     return s !== decodeURIComponent(s);
 }
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 export function isApiError(error) {
     const ae = error;
     return defined(ae.id) && defined(ae.status) && defined(ae.code);
 }
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 export function isFailure(obj) {
     const f = obj;
     return !defined(f.errors) || f.errors.size === 0
         ? false
         : isApiError(head([...f.errors.values()]));
 }
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 export function isQueuedJob(obj) {
     var _a, _b;
     const qj = obj;
@@ -210,12 +211,10 @@ export function isQueuedJob(obj) {
         defined((_b = qj.data) === null || _b === void 0 ? void 0 : _b.type) &&
         qj.data.type.startsWith('queued-'));
 }
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 export function hasVertexError(error) {
     const ve = error;
     return defined(ve.vertexError);
 }
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
 export function hasVertexErrorMessage(error) {
     const ve = error;
     return defined(ve.vertexErrorMessage);
@@ -359,6 +358,7 @@ export function tryStream(fn) {
             return yield fn();
         }
         catch (error) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             const ae = error;
             // eslint-disable-next-line promise/param-names
             return new Promise((_resolve, reject) => {

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

@@ -1 +1 @@
-export declare const version = "0.15.2";
+export declare const version = "0.15.6";

package/dist/esm/client/version.js

@@ -1 +1 @@
-export const version = '0.15.2';
+export const version = '0.15.6';

package/dist/esm/client/vertex-client.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
-import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, FilesApi, GeometrySetsApi, HitsApi, OAuth2Token, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi } from '../index';
+import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, OAuth2Token, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi } from '../index';
 import { BasePath } from './index';
 /**
  * Static `build` function arguments.
@@ -75,6 +75,7 @@ export declare class VertexClient {
     files: FilesApi;
     geometrySets: GeometrySetsApi;
     hits: HitsApi;
+    oAuth2: Oauth2Api;
     partRevisions: PartRevisionsApi;
     parts: PartsApi;
     sceneAlterations: SceneAlterationsApi;
@@ -88,8 +89,7 @@ export declare class VertexClient {
     webhookSubscriptions: WebhookSubscriptionsApi;
     axiosInstance: AxiosInstance;
     config: Configuration;
-    private auth;
-    private token;
+    token: OAuth2Token;
     private tokenFetchedEpochMs;
     private constructor();
     /**

package/dist/esm/client/vertex-client.js

@@ -58,11 +58,11 @@ export class VertexClient {
             if (tokenValid)
                 return this.token.access_token;
             console.log('Refreshing access token');
-            this.token = yield createToken(this.auth);
+            this.token = yield createToken(this.oAuth2);
             this.tokenFetchedEpochMs = nowEpochMs();
             return this.token.access_token;
         });
-        this.auth = auth;
+        this.oAuth2 = auth;
         this.token = token;
         this.tokenFetchedEpochMs = nowEpochMs();
         this.config = new Configuration({

package/dist/esm/common.d.ts

@@ -11,7 +11,7 @@
  */
 import { Configuration } from './configuration';
 import { RequestArgs } from './base';
-import { AxiosInstance } from 'axios';
+import { AxiosInstance, AxiosResponse } from 'axios';
 /**
  *
  * @export
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
  *
  * @export
  */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.15.2",
+  "version": "0.15.6",
   "description": "The Vertex REST API client for Node.js.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
@@ -32,6 +32,25 @@
     "api-client",
     "typescript"
   ],
+  "dependencies": {
+    "axios": "^0.24",
+    "p-limit": "^3"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0",
+    "@types/node": "^16",
+    "@vertexvis/eslint-config-vertexvis-typescript": "^0.4",
+    "eslint": "^7",
+    "eslint-plugin-promise": "^5.2",
+    "eslint-plugin-simple-import-sort": "^7.0",
+    "eslint-plugin-tsdoc": "^0.2",
+    "jest": "^27.4",
+    "pinst": "^2.1",
+    "prettier": "^2.5",
+    "ts-jest": "^27.1",
+    "typedoc": "^0.22",
+    "typescript": "4.5.x"
+  },
   "scripts": {
     "build": "tsc --project tsconfig.json && tsc --project tsconfig-esm.json",
     "clean": "rm -rf dist/",
@@ -49,24 +68,5 @@
     "test:func": "yarn clean-build && node dist/functional-test.js",
     "verify": "yarn clean-build && yarn test --coverage && node dist/cjs/verify.js",
     "watch": "jest --watch"
-  },
-  "dependencies": {
-    "axios": "^0.21",
-    "p-limit": "^3.1"
-  },
-  "devDependencies": {
-    "@types/jest": "^27.0",
-    "@types/node": "^16",
-    "@vertexvis/eslint-config-vertexvis-typescript": "^0.4",
-    "eslint": "^7.32",
-    "eslint-plugin-promise": "^5.1",
-    "eslint-plugin-simple-import-sort": "^7.0",
-    "eslint-plugin-tsdoc": "^0.2",
-    "jest": "^27.2",
-    "pinst": "^2.1",
-    "prettier": "^2.4",
-    "ts-jest": "^27.0",
-    "typedoc": "^0.22",
-    "typescript": "4.4.x"
   }
 }