@vertexvis/api-client-node 0.15.5 → 0.17.0

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

@@ -0,0 +1,39 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createExport = void 0;
+const index_1 = require("../index");
+/**
+ * Create an export.
+ *
+ * @param args - The {@link CreateExportReq}.
+ */
+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 (0, index_1.pollQueuedJob)({
+            id: queuedId,
+            getQueuedJob: (id) => client.exports.getQueuedExport({ id }),
+            polling: { intervalMs: index_1.PollIntervalMs, maxAttempts: index_1.MaxAttempts },
+        });
+        if ((0, index_1.isPollError)(pollRes.res))
+            (0, index_1.throwOnError)(pollRes);
+        if (verbose)
+            onMsg(`Completed export ${pollRes.res.data.id}`);
+        return pollRes.res;
+    });
+}
+exports.createExport = createExport;

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

@@ -85,8 +85,7 @@ exports.uploadFileIfNotExists = uploadFileIfNotExists;
  *
  * @param args - The {@link UploadFileReq}.
  */
-function uploadFile({ client, createFileReq, fileData, file, onMsg = console.log, verbose, }) {
-    var _a, _b;
+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({
@@ -95,9 +94,10 @@ function uploadFile({ client, createFileReq, fileData, file, onMsg = console.log
         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}`);
         }
@@ -106,9 +106,6 @@ function uploadFile({ client, createFileReq, fileData, file, onMsg = console.log
         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/cjs/client/helpers/index.d.ts

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

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

@@ -10,6 +10,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./exports"), exports);
 __exportStar(require("./files"), exports);
 __exportStar(require("./parts"), exports);
 __exportStar(require("./scenes"), exports);

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

@@ -97,7 +97,7 @@ function isPollError(r) {
 exports.isPollError = isPollError;
 function isBatch(obj) {
     const b = obj;
-    return (0, utils_1.defined)(b) && (0, utils_1.defined)(b.vertexvis_batchresults);
+    return (0, utils_1.defined)(b) && (0, utils_1.defined)(b['vertexvis/batch:results']);
 }
 exports.isBatch = isBatch;
 function throwOnError(r) {

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

@@ -182,7 +182,7 @@ function createSceneAndSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, cre
             })).scene,
             sceneItemErrors: batchRes
                 .flatMap((b, i) => (0, queued_jobs_1.isBatch)(b.res)
-                ? b.res.vertexvis_batchresults.map((r, j) => (0, utils_1.isApiError)(r)
+                ? b.res['vertexvis/batch:results'].map((r, j) => (0, utils_1.isApiError)(r)
                     ? { req: queuedOps[i].ops[j].data, res: r }
                     : undefined)
                 : [])
@@ -212,16 +212,7 @@ function createSceneItemsEXPERIMENTAL({ client, createSceneItemReqs, failFast, o
             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/cjs/client/version.d.ts

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

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.15.5';
+exports.version = '0.17.0';

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

@@ -79,6 +79,7 @@ class VertexClient {
         this.accounts = new index_1.AccountsApi(this.config, undefined, axiosInst);
         this.applications = new index_1.ApplicationsApi(this.config, undefined, axiosInst);
         this.batches = new index_1.BatchesApi(this.config, undefined, axiosInst);
+        this.exports = new index_1.ExportsApi(this.config, undefined, axiosInst);
         this.files = new index_1.FilesApi(this.config, undefined, axiosInst);
         this.geometrySets = new index_1.GeometrySetsApi(this.config, undefined, axiosInst);
         this.hits = new index_1.HitsApi(this.config, undefined, axiosInst);

package/dist/cjs/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>;