@vertexvis/api-client-node 0.20.9 → 0.21.0

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { AxiosError, AxiosResponse, Method } from 'axios';
 import { ParsedUrlQuery } from 'querystring';
-import { ApiError, Failure, ImageType, Matrix4, Oauth2Api, OAuth2Token, QueuedJob } from '../index';
+import { ApiError, Failure, ImageType, Matrix4, Oauth2Api, OAuth2Token, QueuedJob, RelationshipData } from '../index';
 export interface Cursors {
     readonly next?: string;
     readonly self?: string;
@@ -136,6 +136,7 @@ export declare function is4x4Identity(transform: number[][]): boolean;
  */
 export declare function isEncoded(s: string): boolean;
 export declare function isApiError(error: unknown): error is ApiError;
+export declare function isSceneItemRelationship(data: unknown): data is RelationshipData;
 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;
@@ -225,3 +226,9 @@ export declare function tryStream<T>(fn: () => Promise<T>): Promise<T>;
  * @returns `true` if webhook signature is valid and body is safe to parse.
  */
 export declare function isWebhookValid(body: string, secret: string, signature: string): boolean;
+/**
+ * Formats a number in seconds as a time formatted string.
+ * @param seconds number of seconds to be formatted
+ * @returns `string` in the form of HH:MM:SS based on input
+ */
+export declare function formatTime(seconds: number): string;

package/dist/cjs/client/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWebhookValid = exports.tryStream = exports.toTransform = exports.to4x4Transform = exports.toFloats = exports.toAccept = exports.thrw = exports.required = exports.prettyJson = exports.partition = exports.parseUrl = exports.defined = exports.nowEpochMs = exports.multiply = exports.logError = exports.hasVertexErrorMessage = exports.hasVertexError = exports.isQueuedJob = exports.isFailure = exports.isApiError = exports.isEncoded = exports.is4x4Identity = exports.head = exports.groupBy = exports.getPage = exports.getErrorMessage = exports.getBySuppliedId = exports.envVar = exports.encodeIfNotEncoded = exports.delay = exports.createToken = exports.arrayChunked = exports.arrayEq2d = exports.arrayEq = exports.Utf8 = void 0;
+exports.formatTime = exports.isWebhookValid = exports.tryStream = exports.toTransform = exports.to4x4Transform = exports.toFloats = exports.toAccept = exports.thrw = exports.required = exports.prettyJson = exports.partition = exports.parseUrl = exports.defined = exports.nowEpochMs = exports.multiply = exports.logError = exports.hasVertexErrorMessage = exports.hasVertexError = exports.isQueuedJob = exports.isFailure = exports.isSceneItemRelationship = exports.isApiError = exports.isEncoded = exports.is4x4Identity = exports.head = exports.groupBy = exports.getPage = exports.getErrorMessage = exports.getBySuppliedId = exports.envVar = exports.encodeIfNotEncoded = exports.delay = exports.createToken = exports.arrayChunked = exports.arrayEq2d = exports.arrayEq = exports.Utf8 = void 0;
 const crypto_1 = require("crypto");
 const querystring_1 = require("querystring");
 const common_1 = require("../common");
@@ -212,9 +212,14 @@ function isEncoded(s) {
 exports.isEncoded = isEncoded;
 function isApiError(error) {
     const ae = error;
-    return defined(ae.id) && defined(ae.status) && defined(ae.code);
+    return defined(ae.status) && defined(ae.code);
 }
 exports.isApiError = isApiError;
+function isSceneItemRelationship(data) {
+    const rd = data;
+    return defined(rd.id) && defined(rd.type) && rd.type === 'scene-item';
+}
+exports.isSceneItemRelationship = isSceneItemRelationship;
 function isFailure(obj) {
     const f = obj;
     return !defined(f.errors) || f.errors.size === 0
@@ -428,3 +433,17 @@ exports.isWebhookValid = isWebhookValid;
 function arrayLenEq(a, b) {
     return Array.isArray(a) && Array.isArray(b) && a.length === b.length;
 }
+/**
+ * Formats a number in seconds as a time formatted string.
+ * @param seconds number of seconds to be formatted
+ * @returns `string` in the form of HH:MM:SS based on input
+ */
+function 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(':');
+}
+exports.formatTime = formatTime;

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

@@ -1 +1 @@
-export declare const version = "0.20.9";
+export declare const version = "0.21.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.20.9';
+exports.version = '0.21.0';

package/dist/esm/api.d.ts

@@ -1277,6 +1277,12 @@ export interface CreateSceneItemOverrideRequestDataAttributes {
      * @memberof CreateSceneItemOverrideRequestDataAttributes
      */
     selected?: ColorMaterial;
+    /**
+     * Phantom state of the item.
+     * @type {boolean}
+     * @memberof CreateSceneItemOverrideRequestDataAttributes
+     */
+    phantom?: boolean;
 }
 /**
  *
@@ -1348,7 +1354,13 @@ export interface CreateSceneItemRequestDataAttributes {
      */
     name?: string;
     /**
-     * ID provided for correlation. For example, an existing ID from a PLM system.
+     * A 0-based index used for defining a consistent ordering amongst sibling scene items.
+     * @type {number}
+     * @memberof CreateSceneItemRequestDataAttributes
+     */
+    ordinal?: number;
+    /**
+     * Optional ability to specify a parent scene item by scene item supplied ID. For example, an  existing ID from a PLM system. This approach is an alternative to providing a specific scene  item ID with the relationship parent property.
      * @type {string}
      * @memberof CreateSceneItemRequestDataAttributes
      */
@@ -1383,6 +1395,12 @@ export interface CreateSceneItemRequestDataAttributes {
      * @memberof CreateSceneItemRequestDataAttributes
      */
     visible?: boolean;
+    /**
+     * Phantom state of the item.
+     * @type {boolean}
+     * @memberof CreateSceneItemRequestDataAttributes
+     */
+    phantom?: boolean;
     /**
      * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
      * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
@@ -4030,6 +4048,12 @@ export interface SceneItemDataAttributes {
      * @memberof SceneItemDataAttributes
      */
     name?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SceneItemDataAttributes
+     */
+    phantom?: boolean;
     /**
      *
      * @type {string}
@@ -4191,6 +4215,12 @@ export interface SceneItemOverrideDataAttributes {
      * @memberof SceneItemOverrideDataAttributes
      */
     selected?: ColorMaterial;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SceneItemOverrideDataAttributes
+     */
+    phantom?: boolean;
 }
 /**
  *
@@ -5179,6 +5209,12 @@ export interface UpdateSceneItemOverrideRequestDataAttributes {
      * @memberof UpdateSceneItemOverrideRequestDataAttributes
      */
     selected?: ColorMaterialNullable | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateSceneItemOverrideRequestDataAttributes
+     */
+    phantom?: boolean | null;
 }
 /**
  *
@@ -5262,6 +5298,12 @@ export interface UpdateSceneItemRequestDataAttributes {
     metadata?: {
         [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
+    /**
+     * Phantom state of the item.
+     * @type {boolean}
+     * @memberof UpdateSceneItemRequestDataAttributes
+     */
+    phantom?: boolean;
 }
 /**
  *