@vertexvis/api-client-node 0.15.5 → 0.17.0

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/exports.d.ts

@@ -0,0 +1,15 @@
+import { CreateExportRequest, Export } from '../../index';
+import { BaseReq } from '../index';
+/**
+ * Create export arguments.
+ */
+export interface CreateExportReq extends BaseReq {
+    /** Function returning a {@link CreateExportRequest}. */
+    readonly createExportReq: () => CreateExportRequest;
+}
+/**
+ * Create an export.
+ *
+ * @param args - The {@link CreateExportReq}.
+ */
+export declare function createExport({ client, createExportReq, onMsg, verbose, }: CreateExportReq): Promise<Export>;

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

@@ -0,0 +1,35 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { isPollError, MaxAttempts, PollIntervalMs, pollQueuedJob, throwOnError, } from '../index';
+/**
+ * Create an export.
+ *
+ * @param args - The {@link CreateExportReq}.
+ */
+export function createExport({ client, createExportReq, onMsg = console.log, verbose, }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const res = yield client.exports.createExport({
+            createExportRequest: createExportReq(),
+        });
+        const queuedId = res.data.data.id;
+        if (verbose)
+            onMsg(`Created export with queued-export ${queuedId}`);
+        const pollRes = yield pollQueuedJob({
+            id: queuedId,
+            getQueuedJob: (id) => client.exports.getQueuedExport({ id }),
+            polling: { intervalMs: PollIntervalMs, maxAttempts: MaxAttempts },
+        });
+        if (isPollError(pollRes.res))
+            throwOnError(pollRes);
+        if (verbose)
+            onMsg(`Completed export ${pollRes.res.data.id}`);
+        return pollRes.res;
+    });
+}

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

@@ -1,21 +1,12 @@
 /// <reference types="node" />
 import { BaseReq, DeleteReq } from '../../client/index';
 import { CreateFileRequest, FileMetadataData } from '../../index';
-export interface File {
-    /** File data. */
-    readonly data: Buffer;
-    /** File size. */
-    readonly size: number;
-}
 /** Upload file arguments. */
 export interface UploadFileReq extends BaseReq {
     /** A {@link CreateFileRequest}. */
     readonly createFileReq: CreateFileRequest;
-    /** File data.
-     * @deprecated Use {@link file} instead.
-     */
-    readonly fileData?: unknown;
-    readonly file?: File;
+    /** File data. */
+    readonly fileData: Buffer;
 }
 /**
  * Delete all files.
@@ -34,4 +25,4 @@ export declare function uploadFileIfNotExists({ client, createFileReq, onMsg, ve
  *
  * @param args - The {@link UploadFileReq}.
  */
-export declare function uploadFile({ client, createFileReq, fileData, file, onMsg, verbose, }: UploadFileReq): Promise<FileMetadataData>;
+export declare function uploadFile({ client, createFileReq, fileData, onMsg, verbose, }: UploadFileReq): Promise<FileMetadataData>;

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

@@ -80,8 +80,7 @@ export function uploadFileIfNotExists(_a) {
  *
  * @param args - The {@link UploadFileReq}.
  */
-export function uploadFile({ client, createFileReq, fileData, file, onMsg = console.log, verbose, }) {
-    var _a, _b;
+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({
@@ -90,9 +89,10 @@ export function uploadFile({ client, createFileReq, fileData, file, onMsg = cons
         const fileId = createRes.data.data.id;
         if (verbose)
             onMsg(`Created file '${fileName}', ${fileId}`);
-        const body = (_a = file === null || file === void 0 ? void 0 : file.data) !== null && _a !== void 0 ? _a : fileData;
-        const size = (_b = file === null || file === void 0 ? void 0 : file.size) !== null && _b !== void 0 ? _b : -1;
-        const uploadRes = yield client.files.uploadFile({ id: fileId, body }, { headers: size >= 0 ? { 'Content-Length': size } : undefined });
+        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}`);
         }
@@ -101,9 +101,6 @@ export function uploadFile({ client, createFileReq, fileData, file, onMsg = cons
         if (status === 'error') {
             throw new Error(`Uploading file ${fileId} failed with status ${status}`);
         }
-        else if (size >= 0 && getRes.attributes.size !== size) {
-            onMsg(`File ${fileId} size mismatch, expected ${size} got ${getRes.attributes.size}`);
-        }
         if (verbose)
             onMsg(`Uploaded file ${fileId}, status ${status}`);
         return getRes;

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

@@ -1,3 +1,4 @@
+export * from './exports';
 export * from './files';
 export * from './parts';
 export * from './scenes';

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

@@ -1,3 +1,4 @@
+export * from './exports';
 export * from './files';
 export * from './parts';
 export * from './scenes';

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

@@ -1,17 +1,15 @@
+/// <reference types="node" />
 import { AxiosResponse } from 'axios';
 import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, PartData, PartRevisionData, QueuedJob } from '../../index';
-import { BaseReq, DeleteReq, File, Polling, RenderImageReq } from '../index';
+import { BaseReq, DeleteReq, Polling, RenderImageReq } from '../index';
 /** Create parts from file arguments. */
 export interface CreatePartFromFileReq extends BaseReq {
     /** A {@link CreateFileRequest}. */
     readonly createFileReq: CreateFileRequest;
     /** Function returning a {@link CreatePartRequest}. */
     readonly createPartReq: (fileId: string) => CreatePartRequest;
-    /** File data.
-     * @deprecated Use {@link file} instead.
-     */
-    readonly fileData?: unknown;
-    readonly file?: File;
+    /** File data. */
+    readonly fileData: Buffer;
     /** {@link Polling} */
     readonly polling?: Polling;
     /** Whether or not to return queued translation. */

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/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.15.5";
+export declare const version = "0.17.0";

package/dist/esm/client/version.js

@@ -1 +1 @@
-export const version = '0.15.5';
+export const version = '0.17.0';

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, Oauth2Api, OAuth2Token, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi } from '../index';
+import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, 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.
@@ -72,6 +72,7 @@ export declare class VertexClient {
     accounts: AccountsApi;
     applications: ApplicationsApi;
     batches: BatchesApi;
+    exports: ExportsApi;
     files: FilesApi;
     geometrySets: GeometrySetsApi;
     hits: HitsApi;

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

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 var _a;
 import axios from 'axios';
-import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi, } from '../index';
+import { AccountsApi, ApplicationsApi, BatchesApi, Configuration, ExportsApi, FilesApi, GeometrySetsApi, HitsApi, Oauth2Api, PartRevisionsApi, PartsApi, SceneAlterationsApi, SceneItemOverridesApi, SceneItemsApi, ScenesApi, SceneViewsApi, SceneViewStatesApi, StreamKeysApi, TranslationInspectionsApi, WebhookSubscriptionsApi, } from '../index';
 import { createToken, isFailure, nowEpochMs, prettyJson, } from './index';
 import { version } from './version';
 const TenMinsInMs = 600000;
@@ -73,6 +73,7 @@ export class VertexClient {
         this.accounts = new AccountsApi(this.config, undefined, axiosInst);
         this.applications = new ApplicationsApi(this.config, undefined, axiosInst);
         this.batches = new BatchesApi(this.config, undefined, axiosInst);
+        this.exports = new ExportsApi(this.config, undefined, axiosInst);
         this.files = new FilesApi(this.config, undefined, axiosInst);
         this.geometrySets = new GeometrySetsApi(this.config, undefined, axiosInst);
         this.hits = new HitsApi(this.config, undefined, axiosInst);

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<never>>;
+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.5",
+  "version": "0.17.0",
   "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.22",
-    "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"
   }
 }