@vertexvis/api-client-node 0.15.1 → 0.15.2

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

@@ -4,7 +4,7 @@ import { CreateFileRequest, FileMetadataData } from '../../index';
 export interface UploadFileReq extends BaseReq {
     /** A {@link CreateFileRequest}. */
     readonly createFileReq: CreateFileRequest;
-    /** File data, use {@link Buffer} in Node.
+    /** File data.
      * @deprecated Use {@link filePath} instead.
      */
     readonly fileData?: unknown;

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

@@ -7,8 +7,11 @@ export interface CreatePartFromFileReq extends BaseReq {
     readonly createFileReq: CreateFileRequest;
     /** Function returning a {@link CreatePartRequest}. */
     readonly createPartReq: (fileId: string) => CreatePartRequest;
-    /** File data, use {@link Buffer} in Node. */
-    readonly fileData: unknown;
+    /** File data.
+     * @deprecated Use {@link filePath} instead.
+     */
+    readonly fileData?: unknown;
+    readonly filePath?: string;
     /** {@link Polling} */
     readonly polling?: Polling;
     /** Whether or not to return queued translation. */
@@ -36,7 +39,7 @@ export interface GetPartRevisionBySuppliedIdReq extends BaseReq {
  *
  * @param args - The {@link CreatePartFromFileReq}.
  */
-export declare function createPartFromFile({ client, createFileReq, createPartReq, fileData, onMsg, polling, returnQueued, verbose, }: CreatePartFromFileReq): Promise<CreatePartFromFileRes>;
+export declare function createPartFromFile({ client, createFileReq, createPartReq, fileData, filePath, onMsg, polling, returnQueued, verbose, }: CreatePartFromFileReq): Promise<CreatePartFromFileRes>;
 /**
  * Create part and file resources if they don't already exist.
  *

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

@@ -17,13 +17,14 @@ const queued_jobs_1 = require("./queued-jobs");
  *
  * @param args - The {@link CreatePartFromFileReq}.
  */
-function createPartFromFile({ client, createFileReq, createPartReq, fileData, onMsg = console.log, polling = { intervalMs: index_1.PollIntervalMs, maxAttempts: index_1.MaxAttempts }, returnQueued = false, verbose, }) {
+function createPartFromFile({ client, createFileReq, createPartReq, fileData, filePath, onMsg = console.log, polling = { intervalMs: index_1.PollIntervalMs, maxAttempts: index_1.MaxAttempts }, returnQueued = false, verbose, }) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         const file = yield (0, index_1.uploadFileIfNotExists)({
             client,
             verbose,
             fileData,
+            filePath,
             createFileReq,
             onMsg,
         });

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

@@ -28,7 +28,7 @@ export interface Polling {
     readonly maxAttempts: number;
 }
 /**
- * Render image arguments. Render functions return Streams in Node. Here's an
+ * Render image arguments. Render functions return Streams. Here's an
  * example awaiting file creation,
  *
  * @example

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

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

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.1';
+exports.version = '0.15.2';

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

@@ -6,7 +6,7 @@ import { BasePath } from './index';
  */
 export interface BuildReq {
     /**
-     * A {@link AxiosRequestConfig}. For example, to use HTTP keep-alive in Node,
+     * A {@link AxiosRequestConfig}. For example, to use HTTP keep-alive,
      *
      *  * @example
      * ```typescript

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

@@ -4,7 +4,7 @@ import { CreateFileRequest, FileMetadataData } from '../../index';
 export interface UploadFileReq extends BaseReq {
     /** A {@link CreateFileRequest}. */
     readonly createFileReq: CreateFileRequest;
-    /** File data, use {@link Buffer} in Node.
+    /** File data.
      * @deprecated Use {@link filePath} instead.
      */
     readonly fileData?: unknown;

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

@@ -7,8 +7,11 @@ export interface CreatePartFromFileReq extends BaseReq {
     readonly createFileReq: CreateFileRequest;
     /** Function returning a {@link CreatePartRequest}. */
     readonly createPartReq: (fileId: string) => CreatePartRequest;
-    /** File data, use {@link Buffer} in Node. */
-    readonly fileData: unknown;
+    /** File data.
+     * @deprecated Use {@link filePath} instead.
+     */
+    readonly fileData?: unknown;
+    readonly filePath?: string;
     /** {@link Polling} */
     readonly polling?: Polling;
     /** Whether or not to return queued translation. */
@@ -36,7 +39,7 @@ export interface GetPartRevisionBySuppliedIdReq extends BaseReq {
  *
  * @param args - The {@link CreatePartFromFileReq}.
  */
-export declare function createPartFromFile({ client, createFileReq, createPartReq, fileData, onMsg, polling, returnQueued, verbose, }: CreatePartFromFileReq): Promise<CreatePartFromFileRes>;
+export declare function createPartFromFile({ client, createFileReq, createPartReq, fileData, filePath, onMsg, polling, returnQueued, verbose, }: CreatePartFromFileReq): Promise<CreatePartFromFileRes>;
 /**
  * Create part and file resources if they don't already exist.
  *

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

@@ -14,13 +14,14 @@ import { isPollError, pollQueuedJob, throwOnError } from './queued-jobs';
  *
  * @param args - The {@link CreatePartFromFileReq}.
  */
-export function createPartFromFile({ client, createFileReq, createPartReq, fileData, onMsg = console.log, polling = { intervalMs: PollIntervalMs, maxAttempts: MaxAttempts }, returnQueued = false, verbose, }) {
+export function createPartFromFile({ client, createFileReq, createPartReq, fileData, filePath, onMsg = console.log, polling = { intervalMs: PollIntervalMs, maxAttempts: MaxAttempts }, returnQueued = false, verbose, }) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         const file = yield uploadFileIfNotExists({
             client,
             verbose,
             fileData,
+            filePath,
             createFileReq,
             onMsg,
         });

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

@@ -28,7 +28,7 @@ export interface Polling {
     readonly maxAttempts: number;
 }
 /**
- * Render image arguments. Render functions return Streams in Node. Here's an
+ * Render image arguments. Render functions return Streams. Here's an
  * example awaiting file creation,
  *
  * @example

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

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

package/dist/esm/client/version.js

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

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

@@ -6,7 +6,7 @@ import { BasePath } from './index';
  */
 export interface BuildReq {
     /**
-     * A {@link AxiosRequestConfig}. For example, to use HTTP keep-alive in Node,
+     * A {@link AxiosRequestConfig}. For example, to use HTTP keep-alive,
      *
      *  * @example
      * ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.15.1",
+  "version": "0.15.2",
   "description": "The Vertex REST API client for Node.js.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",