@shapediver/sdk.geometry-api-sdk-v2 1.8.3 → 1.9.0

package/src/ShapeDiverSdk.ts

@@ -1,113 +1,114 @@
-import { BaseShapeDiverSdk, ShapeDiverSdkConfigType } from "@shapediver/sdk.geometry-api-sdk-core"
-import { ShapeDiverAnalyticsApi } from "./resources/ShapeDiverAnalyticsApi"
-import { ShapeDiverArSceneApi } from "./resources/ShapeDiverArSceneApi"
-import { ShapeDiverAssetApi } from "./resources/ShapeDiverAssetApi"
-import { ShapeDiverExportApi } from "./resources/ShapeDiverExportApi"
-import { ShapeDiverFileApi } from "./resources/ShapeDiverFileApi"
-import { ShapeDiverGltfApi } from "./resources/ShapeDiverGltfApi"
-import { ShapeDiverModelApi } from "./resources/ShapeDiverModelApi"
-import { ShapeDiverOutputApi } from "./resources/ShapeDiverOutputApi"
-import { ShapeDiverSdtfApi } from "./resources/ShapeDiverSdtfApi"
-import { ShapeDiverSessionApi } from "./resources/ShapeDiverSessionApi"
-import { ShapeDiverSystemApi } from "./resources/ShapeDiverSystemApi"
-import { ShapeDiverTextureApi } from "./resources/ShapeDiverTextureApi"
-import { ShapeDiverUtilsApi } from "./resources/ShapeDiverUtilsApi"
-
-export function create (baseUrl: string, jwt?: string): ShapeDiverSdk {
-    return new ShapeDiverSdk(baseUrl, jwt)
+import {
+  BaseShapeDiverSdk,
+  ShapeDiverSdkConfigType,
+} from "@shapediver/sdk.geometry-api-sdk-core";
+import { ShapeDiverAnalyticsApi } from "./resources/ShapeDiverAnalyticsApi";
+import { ShapeDiverArSceneApi } from "./resources/ShapeDiverArSceneApi";
+import { ShapeDiverAssetApi } from "./resources/ShapeDiverAssetApi";
+import { ShapeDiverExportApi } from "./resources/ShapeDiverExportApi";
+import { ShapeDiverFileApi } from "./resources/ShapeDiverFileApi";
+import { ShapeDiverGltfApi } from "./resources/ShapeDiverGltfApi";
+import { ShapeDiverModelApi } from "./resources/ShapeDiverModelApi";
+import { ShapeDiverOutputApi } from "./resources/ShapeDiverOutputApi";
+import { ShapeDiverSdtfApi } from "./resources/ShapeDiverSdtfApi";
+import { ShapeDiverSessionApi } from "./resources/ShapeDiverSessionApi";
+import { ShapeDiverSystemApi } from "./resources/ShapeDiverSystemApi";
+import { ShapeDiverTextureApi } from "./resources/ShapeDiverTextureApi";
+import { ShapeDiverUtilsApi } from "./resources/ShapeDiverUtilsApi";
+
+export function create(baseUrl: string, jwt?: string): ShapeDiverSdk {
+  return new ShapeDiverSdk(baseUrl, jwt);
 }
 
 export class ShapeDiverSdk extends BaseShapeDiverSdk {
-
-    private readonly _analytics: ShapeDiverAnalyticsApi
-    private readonly _arScene: ShapeDiverArSceneApi
-    private readonly _asset: ShapeDiverAssetApi
-    private readonly _export: ShapeDiverExportApi
-    private readonly _file: ShapeDiverFileApi
-    private readonly _gltf: ShapeDiverGltfApi
-    private readonly _model: ShapeDiverModelApi
-    private readonly _output: ShapeDiverOutputApi
-    private readonly _sdtf: ShapeDiverSdtfApi
-    private readonly _session: ShapeDiverSessionApi
-    private readonly _system: ShapeDiverSystemApi
-    private readonly _texture: ShapeDiverTextureApi
-    private readonly _utils: ShapeDiverUtilsApi
-
-    /**
-     * ShapeDiverSDK constructor
-     *
-     * @param baseUrl - the URL of the target system
-     * @param jwt - the client's jwt
-     */
-    constructor (baseUrl: string, jwt?: string) {
-        super(baseUrl)
-        if (jwt) this.setConfigurationValue(ShapeDiverSdkConfigType.JWT_TOKEN, jwt)
-
-        this._analytics = new ShapeDiverAnalyticsApi(this.sdkApi)
-        this._arScene = new ShapeDiverArSceneApi(this.sdkApi)
-        this._asset = new ShapeDiverAssetApi(this.sdkApi)
-        this._export = new ShapeDiverExportApi(this.sdkApi)
-        this._file = new ShapeDiverFileApi(this.sdkApi)
-        this._gltf = new ShapeDiverGltfApi(this.sdkApi)
-        this._model = new ShapeDiverModelApi(this.sdkApi)
-        this._output = new ShapeDiverOutputApi(this.sdkApi)
-        this._sdtf = new ShapeDiverSdtfApi(this.sdkApi)
-        this._session = new ShapeDiverSessionApi(this.sdkApi)
-        this._system = new ShapeDiverSystemApi(this.sdkApi)
-        this._texture = new ShapeDiverTextureApi(this.sdkApi)
-        this._utils = new ShapeDiverUtilsApi(this.sdkApi)
-    }
-
-    get analytics (): ShapeDiverAnalyticsApi {
-        return this._analytics
-    }
-
-    get arScene (): ShapeDiverArSceneApi {
-        return this._arScene
-    }
-
-    get asset (): ShapeDiverAssetApi {
-        return this._asset
-    }
-
-    get export (): ShapeDiverExportApi {
-        return this._export
-    }
-
-    get file (): ShapeDiverFileApi {
-        return this._file
-    }
-
-    get gltf (): ShapeDiverGltfApi {
-        return this._gltf
-    }
-
-    get model (): ShapeDiverModelApi {
-        return this._model
-    }
-
-    get output (): ShapeDiverOutputApi {
-        return this._output
-    }
-
-    get sdtf (): ShapeDiverSdtfApi {
-        return this._sdtf
-    }
-
-    get session (): ShapeDiverSessionApi {
-        return this._session
-    }
-
-    get system (): ShapeDiverSystemApi {
-        return this._system
-    }
-
-    get texture (): ShapeDiverTextureApi {
-        return this._texture
-    }
-
-    get utils (): ShapeDiverUtilsApi {
-        return this._utils
-    }
-
+  private readonly _analytics: ShapeDiverAnalyticsApi;
+  private readonly _arScene: ShapeDiverArSceneApi;
+  private readonly _asset: ShapeDiverAssetApi;
+  private readonly _export: ShapeDiverExportApi;
+  private readonly _file: ShapeDiverFileApi;
+  private readonly _gltf: ShapeDiverGltfApi;
+  private readonly _model: ShapeDiverModelApi;
+  private readonly _output: ShapeDiverOutputApi;
+  private readonly _sdtf: ShapeDiverSdtfApi;
+  private readonly _session: ShapeDiverSessionApi;
+  private readonly _system: ShapeDiverSystemApi;
+  private readonly _texture: ShapeDiverTextureApi;
+  private readonly _utils: ShapeDiverUtilsApi;
+
+  /**
+   * ShapeDiverSDK constructor
+   *
+   * @param baseUrl - the URL of the target system
+   * @param jwt - the client's jwt
+   */
+  constructor(baseUrl: string, jwt?: string) {
+    super(baseUrl);
+    if (jwt) this.setConfigurationValue(ShapeDiverSdkConfigType.JWT_TOKEN, jwt);
+
+    this._analytics = new ShapeDiverAnalyticsApi(this.sdkApi);
+    this._arScene = new ShapeDiverArSceneApi(this.sdkApi);
+    this._asset = new ShapeDiverAssetApi(this.sdkApi);
+    this._export = new ShapeDiverExportApi(this.sdkApi);
+    this._file = new ShapeDiverFileApi(this.sdkApi);
+    this._gltf = new ShapeDiverGltfApi(this.sdkApi);
+    this._model = new ShapeDiverModelApi(this.sdkApi);
+    this._output = new ShapeDiverOutputApi(this.sdkApi);
+    this._sdtf = new ShapeDiverSdtfApi(this.sdkApi);
+    this._session = new ShapeDiverSessionApi(this.sdkApi);
+    this._system = new ShapeDiverSystemApi(this.sdkApi);
+    this._texture = new ShapeDiverTextureApi(this.sdkApi);
+    this._utils = new ShapeDiverUtilsApi(this.sdkApi);
+  }
+
+  get analytics(): ShapeDiverAnalyticsApi {
+    return this._analytics;
+  }
+
+  get arScene(): ShapeDiverArSceneApi {
+    return this._arScene;
+  }
+
+  get asset(): ShapeDiverAssetApi {
+    return this._asset;
+  }
+
+  get export(): ShapeDiverExportApi {
+    return this._export;
+  }
+
+  get file(): ShapeDiverFileApi {
+    return this._file;
+  }
+
+  get gltf(): ShapeDiverGltfApi {
+    return this._gltf;
+  }
+
+  get model(): ShapeDiverModelApi {
+    return this._model;
+  }
+
+  get output(): ShapeDiverOutputApi {
+    return this._output;
+  }
+
+  get sdtf(): ShapeDiverSdtfApi {
+    return this._sdtf;
+  }
+
+  get session(): ShapeDiverSessionApi {
+    return this._session;
+  }
+
+  get system(): ShapeDiverSystemApi {
+    return this._system;
+  }
+
+  get texture(): ShapeDiverTextureApi {
+    return this._texture;
+  }
+
+  get utils(): ShapeDiverUtilsApi {
+    return this._utils;
+  }
 }

package/src/index.ts

@@ -1,18 +1,17 @@
-export * from "@shapediver/api.geometry-api-dto-v2"
+export * from "@shapediver/api.geometry-api-dto-v2";
 export {
-    ShapeDiverError,
-    ShapeDiverRequestError,
-    ShapeDiverSdkApiResponseType,
-    ShapeDiverSdkConfig,
-    ShapeDiverSdkConfigType
-} from "@shapediver/sdk.geometry-api-sdk-core"
-export { ShapeDiverResponseError } from "./ShapeDiverErrors"
-export { ShapeDiverSdk, create } from "./ShapeDiverSdk"
-export { ShapeDiverResponseFileInfo } from "./resources/ShapeDiverFileApi"
+  ShapeDiverError,
+  ShapeDiverRequestError,
+  ShapeDiverSdkApiResponseType,
+  ShapeDiverSdkConfig,
+  ShapeDiverSdkConfigType,
+} from "@shapediver/sdk.geometry-api-sdk-core";
+export { ShapeDiverResponseError } from "./ShapeDiverErrors";
+export { ShapeDiverSdk, create } from "./ShapeDiverSdk";
+export { ShapeDiverResponseFileInfo } from "./resources/ShapeDiverFileApi";
 export {
-    isGBError,
-    isGBGenericError,
-    isGBRequestError,
-    isGBResponseError
-} from "./utils/utils"
-
+  isGBError,
+  isGBGenericError,
+  isGBRequestError,
+  isGBResponseError,
+} from "./utils/utils";

package/src/resources/ShapeDiverAnalyticsApi.ts

@@ -1,22 +1,34 @@
-import { ShapeDiverRequestAnalyticsModel, ShapeDiverResponseDto } from "@shapediver/api.geometry-api-dto-v2"
-import { BaseResourceApi, ShapeDiverSdkApi } from "@shapediver/sdk.geometry-api-sdk-core"
-import { sendRequest } from "../utils/utils"
+import {
+  ShapeDiverRequestAnalyticsModel,
+  ShapeDiverResponseDto,
+} from "@shapediver/api.geometry-api-dto-v2";
+import {
+  BaseResourceApi,
+  ShapeDiverSdkApi,
+} from "@shapediver/sdk.geometry-api-sdk-core";
+import { sendRequest } from "../utils/utils";
 
 export class ShapeDiverAnalyticsApi extends BaseResourceApi {
+  constructor(api: ShapeDiverSdkApi) {
+    super(api);
+  }
 
-    constructor (api: ShapeDiverSdkApi) {
-        super(api)
-    }
-
-    /**
-     * Get model session analytics.
-     *
-     * @param body
-     */
-    async modelSessionStatistics (body: ShapeDiverRequestAnalyticsModel): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.put<ShapeDiverResponseDto>(this.buildAnalyticsUri() + "/session/model", body))[1],
-        )
-    }
-
+  /**
+   * Get model session analytics.
+   *
+   * @param body
+   */
+  async modelSessionStatistics(
+    body: ShapeDiverRequestAnalyticsModel,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.put<ShapeDiverResponseDto>(
+            this.buildAnalyticsUri() + "/session/model",
+            body,
+          )
+        )[1],
+    );
+  }
 }

package/src/resources/ShapeDiverArSceneApi.ts

@@ -1,76 +1,75 @@
 import {
-    BaseResourceApi,
-    ShapeDiverResponseError,
-    ShapeDiverSdkApi,
-    ShapeDiverSdkApiResponseType,
-} from "@shapediver/sdk.geometry-api-sdk-core"
-import { sendRequest } from "../utils/utils"
+  BaseResourceApi,
+  ShapeDiverResponseError,
+  ShapeDiverSdkApi,
+  ShapeDiverSdkApiResponseType,
+} from "@shapediver/sdk.geometry-api-sdk-core";
+import { sendRequest } from "../utils/utils";
 
 export class ShapeDiverArSceneApi extends BaseResourceApi {
+  constructor(api: ShapeDiverSdkApi) {
+    super(api);
+  }
 
-    constructor (api: ShapeDiverSdkApi) {
-        super(api)
-    }
+  /**
+   * Checks the existence of the specific AR scene.
+   * @param sceneId
+   * @returns `true` when the AR scene exists, otherwise `false`.
+   */
+  async exists(sceneId: string): Promise<boolean> {
+    return await sendRequest(async () => {
+      try {
+        const [_, status] = await this.api.head(
+          `${this.buildArSceneUri()}/${sceneId}`,
+          { disableAuthorization: true },
+        );
+        return status === 200;
+      } catch (e) {
+        // A 404 HTTP status is returned when the AR scene was not found.
+        if (e instanceof ShapeDiverResponseError && e.status === 404)
+          return false;
+        else throw e;
+      }
+    });
+  }
 
-    /**
-     * Checks the existence of the specific AR scene.
-     * @param sceneId
-     * @returns `true` when the AR scene exists, otherwise `false`.
-     */
-    async exists (sceneId: string): Promise<boolean> {
-        return await sendRequest(async () => {
-            try {
-                const [ _, status ] = await this.api.head(
-                    `${ this.buildArSceneUri() }/${ sceneId }`,
-                    { disableAuthorization: true },
-                )
-                return status === 200
-            } catch (e) {
-                // A 404 HTTP status is returned when the AR scene was not found.
-                if (e instanceof ShapeDiverResponseError && e.status === 404) return false
-                else throw e
-            }
-        })
-    }
-
-    /**
-     * Download the glTF file of the specified AR scene.
-     *
-     * @param sceneId - The ID of the AR scene.
-     * @returns Array of size 2: [0] = content data, [1] = content type
-     */
-    async getGltf (sceneId: string): Promise<[ ArrayBuffer, string ]> {
-        return await sendRequest(async () => {
-            const [ header, data ] = await this.api.get<ArrayBuffer>(
-                `${ this.buildArSceneUri() }/${ sceneId }/gltf`,
-                {
-                    responseType: ShapeDiverSdkApiResponseType.DATA,
-                    disableAuthorization: true,
-                },
-            )
-            const contentType = header["Content-Type"] ?? header["content-type"]
-            return [ data, contentType ]
-        })
-    }
-
-    /**
-     * Download the USDZ file of the specified AR scene.
-     *
-     * @param sceneId - The ID of the AR scene.
-     * @returns Array of size 2: [0] = content data, [1] = content type
-     */
-    async getUsdz (sceneId: string): Promise<[ ArrayBuffer, string ]> {
-        return await sendRequest(async () => {
-            const [ header, data ] = await this.api.get<ArrayBuffer>(
-                `${ this.buildArSceneUri() }/${ sceneId }/usdz`,
-                {
-                    responseType: ShapeDiverSdkApiResponseType.DATA,
-                    disableAuthorization: true,
-                },
-            )
-            const contentType = header["Content-Type"] ?? header["content-type"]
-            return [ data, contentType ]
-        })
-    }
+  /**
+   * Download the glTF file of the specified AR scene.
+   *
+   * @param sceneId - The ID of the AR scene.
+   * @returns Array of size 2: [0] = content data, [1] = content type
+   */
+  async getGltf(sceneId: string): Promise<[ArrayBuffer, string]> {
+    return await sendRequest(async () => {
+      const [header, data] = await this.api.get<ArrayBuffer>(
+        `${this.buildArSceneUri()}/${sceneId}/gltf`,
+        {
+          responseType: ShapeDiverSdkApiResponseType.DATA,
+          disableAuthorization: true,
+        },
+      );
+      const contentType = header["Content-Type"] ?? header["content-type"];
+      return [data, contentType];
+    });
+  }
 
+  /**
+   * Download the USDZ file of the specified AR scene.
+   *
+   * @param sceneId - The ID of the AR scene.
+   * @returns Array of size 2: [0] = content data, [1] = content type
+   */
+  async getUsdz(sceneId: string): Promise<[ArrayBuffer, string]> {
+    return await sendRequest(async () => {
+      const [header, data] = await this.api.get<ArrayBuffer>(
+        `${this.buildArSceneUri()}/${sceneId}/usdz`,
+        {
+          responseType: ShapeDiverSdkApiResponseType.DATA,
+          disableAuthorization: true,
+        },
+      );
+      const contentType = header["Content-Type"] ?? header["content-type"];
+      return [data, contentType];
+    });
+  }
 }