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

package/src/resources/ShapeDiverAssetApi.ts

@@ -1,189 +1,213 @@
 import {
-    BaseResourceApi,
-    ShapeDiverError,
-    ShapeDiverSdkApi,
-    ShapeDiverSdkApiResponseType,
-} from "@shapediver/sdk.geometry-api-sdk-core"
-import { encodeBase64, sendRequest } from "../utils/utils"
-
-const apiAssetExportUri = /.+\/session\/.+\/export\/.+/
-const apiAssetOutputUri = /.+\/session\/.+\/output\/.+/
-const apiAssetTextureUri = /.+\/session\/.+\/texture\/.+/
-
-const cdnAssetUri = /.+\/cdn-asset-(exports|outputs|textures)\/.+/
-const cdnAssetExportUri = /.+\/cdn-asset-exports\/.+/
-const cdnAssetOutputUri = /.+\/cdn-asset-outputs\/.+/
-const cdnAssetTextureUri = /.+\/cdn-asset-textures\/.+/
+  BaseResourceApi,
+  ShapeDiverError,
+  ShapeDiverSdkApi,
+  ShapeDiverSdkApiResponseType,
+} from "@shapediver/sdk.geometry-api-sdk-core";
+import { encodeBase64, sendRequest } from "../utils/utils";
+
+const apiAssetExportUri = /.+\/session\/.+\/export\/.+/;
+const apiAssetOutputUri = /.+\/session\/.+\/output\/.+/;
+const apiAssetTextureUri = /.+\/session\/.+\/texture\/.+/;
+
+const cdnAssetUri = /.+\/cdn-asset-(exports|outputs|textures)\/.+/;
+const cdnAssetExportUri = /.+\/cdn-asset-exports\/.+/;
+const cdnAssetOutputUri = /.+\/cdn-asset-outputs\/.+/;
+const cdnAssetTextureUri = /.+\/cdn-asset-textures\/.+/;
 
 export class ShapeDiverAssetApi extends BaseResourceApi {
-
-    constructor (api: ShapeDiverSdkApi) {
-        super(api)
-    }
-
-    /**
-     * Download an export.
-     *
-     * @param sessionId
-     * @param assetData
-     */
-    async getExport (sessionId: string, assetData: string): Promise<[ ArrayBuffer, string ]> {
-        return await sendRequest(async () => {
-            const [ header, data ] = await this.api.get<ArrayBuffer>(
-                `${ this.buildSessionUri(sessionId) }/export/${ assetData }`,
-                { responseType: ShapeDiverSdkApiResponseType.DATA },
-            )
-            const contentType = header["Content-Type"] ?? header["content-type"]
-            return [ data, contentType ]
-        })
-    }
-
-    /**
-     * Download an output.
-     *
-     * @param sessionId
-     * @param assetData
-     */
-    async getOutput (sessionId: string, assetData: string): Promise<[ ArrayBuffer, string ]> {
-        return await sendRequest(async () => {
-            const [ header, data ] = await this.api.get<ArrayBuffer>(
-                `${ this.buildSessionUri(sessionId) }/output/${ assetData }`,
-                { responseType: ShapeDiverSdkApiResponseType.DATA },
-            )
-            const contentType = header["Content-Type"] ?? header["content-type"]
-            return [ data, contentType ]
-        })
-    }
-
-    /**
-     * Downloads the JSON content part of a sdTF output.
-     *
-     * @param sessionId
-     * @param assetData
-     */
-    async getSdtfJsonContent (sessionId: string, assetData: string): Promise<Record<string, any>> {
-        return await sendRequest(async () =>
-            (await this.api.get<ArrayBuffer>(
-                `${ this.buildSessionUri(sessionId) }/output/${ assetData }`,
-                {
-                    responseType: ShapeDiverSdkApiResponseType.JSON,
-                    accept: "model/vnd.sdtf+json",
-                },
-            ))[1],
-        )
-    }
-
-    /**
-     * Download a texture file.
-     *
-     * @param sessionId
-     * @param assetData
-     */
-    async getTexture (sessionId: string, assetData: string): Promise<[ ArrayBuffer, string ]> {
-        return await sendRequest(async () => {
-            const [ header, data ] = await this.api.get<ArrayBuffer>(
-                `${ this.buildSessionUri(sessionId) }/texture/${ assetData }`,
-                { responseType: ShapeDiverSdkApiResponseType.DATA },
-            )
-            const contentType = header["Content-Type"] ?? header["content-type"]
-            return [ data, contentType ]
-        })
-    }
-
-    /**
-     * Download a glTF file.
-     *
-     * @param sessionId
-     * @param assetData
-     */
-    async getGltf (sessionId: string, assetData: string): Promise<ArrayBuffer> {
-        return await sendRequest(async () =>
-            (await this.api.get<ArrayBuffer>(
-                `${ this.buildSessionUri(sessionId) }/gltf/${ assetData }`,
-                { responseType: ShapeDiverSdkApiResponseType.DATA },
-            ))[1],
-        )
-    }
-
-    /**
-     * Download a USDZ file.
-     *
-     * @param sessionId
-     * @param assetData
-     */
-    async getUsdz (sessionId: string, assetData: string): Promise<ArrayBuffer> {
-        return await sendRequest(async () =>
-            (await this.api.get<ArrayBuffer>(
-                `${ this.buildSessionUri(sessionId) }/usdz/${ assetData }`,
-                { responseType: ShapeDiverSdkApiResponseType.DATA },
-            ))[1],
-        )
-    }
-
-    /**
-     * Download an image.
-     *
-     * @param sessionId
-     * @param url - The URL of the image that should be downloaded.
-     * @returns Array of size 2: [0] = content data, [1] = content type.
-     */
-    async downloadImage (sessionId: string, url: string): Promise<[ ArrayBuffer, string ]> {
-        let targetUrl: string
-
-        if (apiAssetTextureUri.test(url) || cdnAssetTextureUri.test(url)) {
-            // Call ShapeDiver texture-asset URLs directly
-            targetUrl = url
-        } else {
-            // All other source URLs are called via the download-image endpoint
-            targetUrl = `${ this.buildSessionUri(sessionId) }/image?url=${ encodeBase64(url) }`
-        }
-
-        return await sendRequest(async () => {
-            const [ header, data ] = await this.api.get<ArrayBuffer>(
-                targetUrl,
-                {
-                    responseType: ShapeDiverSdkApiResponseType.DATA,
-                    disableAuthorization: cdnAssetUri.test(url),    // disable for CDN URLs
-                },
-            )
-            const contentType = header["Content-Type"] ?? header["content-type"]
-            return [ data, contentType ]
-        })
-    }
-
-    /**
-     * Fetches a ShapeDiver asset of the following types:
-     *  * Output
-     *  * Export
-     *  * Texture
-     *
-     * This function works similar to {@link getOutput}, {@link getExport} and {@link getTexture}, but does not require
-     * extracted _session ID_ and _asset data_ parameters.
-     *
-     * @param url - The URL of the asset that should be fetched.
-     * @returns Array of size 3: [0] = content data, [1] = content type, [2] = asset type.
-     * @throws {@link ShapeDiverError} when the given URL is not a valid ShapeDiver asset URL.
-     */
-    async getAsset (url: string): Promise<[ ArrayBuffer, string, "output" | "export" | "texture" ]> {
-        let type: "output" | "export" | "texture"
-
-        // Check if the given URL is a valid API or CDN asset URL
-        if (apiAssetExportUri.test(url) || cdnAssetExportUri.test(url)) type = "export"
-        else if (apiAssetOutputUri.test(url) || cdnAssetOutputUri.test(url)) type = "output"
-        else if (apiAssetTextureUri.test(url) || cdnAssetTextureUri.test(url)) type = "texture"
-        else throw new ShapeDiverError("Cannot fetch asset: Invalid URL (only ShapeDiver asset URLs are allowed).")
-
-        return await sendRequest(async () => {
-            const [ header, data ] = await this.api.get<ArrayBuffer>(
-                url,
-                {
-                    responseType: ShapeDiverSdkApiResponseType.DATA,
-                    disableAuthorization: cdnAssetUri.test(url),    // disable for CDN URLs
-                },
-            )
-            const contentType = header["Content-Type"] ?? header["content-type"]
-            return [ data, contentType, type ]
-        })
+  constructor(api: ShapeDiverSdkApi) {
+    super(api);
+  }
+
+  /**
+   * Download an export.
+   *
+   * @param sessionId
+   * @param assetData
+   */
+  async getExport(
+    sessionId: string,
+    assetData: string,
+  ): Promise<[ArrayBuffer, string]> {
+    return await sendRequest(async () => {
+      const [header, data] = await this.api.get<ArrayBuffer>(
+        `${this.buildSessionUri(sessionId)}/export/${assetData}`,
+        { responseType: ShapeDiverSdkApiResponseType.DATA },
+      );
+      const contentType = header["Content-Type"] ?? header["content-type"];
+      return [data, contentType];
+    });
+  }
+
+  /**
+   * Download an output.
+   *
+   * @param sessionId
+   * @param assetData
+   */
+  async getOutput(
+    sessionId: string,
+    assetData: string,
+  ): Promise<[ArrayBuffer, string]> {
+    return await sendRequest(async () => {
+      const [header, data] = await this.api.get<ArrayBuffer>(
+        `${this.buildSessionUri(sessionId)}/output/${assetData}`,
+        { responseType: ShapeDiverSdkApiResponseType.DATA },
+      );
+      const contentType = header["Content-Type"] ?? header["content-type"];
+      return [data, contentType];
+    });
+  }
+
+  /**
+   * Downloads the JSON content part of a sdTF output.
+   *
+   * @param sessionId
+   * @param assetData
+   */
+  async getSdtfJsonContent(
+    sessionId: string,
+    assetData: string,
+  ): Promise<Record<string, any>> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ArrayBuffer>(
+            `${this.buildSessionUri(sessionId)}/output/${assetData}`,
+            {
+              responseType: ShapeDiverSdkApiResponseType.JSON,
+              accept: "model/vnd.sdtf+json",
+            },
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Download a texture file.
+   *
+   * @param sessionId
+   * @param assetData
+   */
+  async getTexture(
+    sessionId: string,
+    assetData: string,
+  ): Promise<[ArrayBuffer, string]> {
+    return await sendRequest(async () => {
+      const [header, data] = await this.api.get<ArrayBuffer>(
+        `${this.buildSessionUri(sessionId)}/texture/${assetData}`,
+        { responseType: ShapeDiverSdkApiResponseType.DATA },
+      );
+      const contentType = header["Content-Type"] ?? header["content-type"];
+      return [data, contentType];
+    });
+  }
+
+  /**
+   * Download a glTF file.
+   *
+   * @param sessionId
+   * @param assetData
+   */
+  async getGltf(sessionId: string, assetData: string): Promise<ArrayBuffer> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ArrayBuffer>(
+            `${this.buildSessionUri(sessionId)}/gltf/${assetData}`,
+            { responseType: ShapeDiverSdkApiResponseType.DATA },
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Download a USDZ file.
+   *
+   * @param sessionId
+   * @param assetData
+   */
+  async getUsdz(sessionId: string, assetData: string): Promise<ArrayBuffer> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ArrayBuffer>(
+            `${this.buildSessionUri(sessionId)}/usdz/${assetData}`,
+            { responseType: ShapeDiverSdkApiResponseType.DATA },
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Download an image.
+   *
+   * @param sessionId
+   * @param url - The URL of the image that should be downloaded.
+   * @returns Array of size 2: [0] = content data, [1] = content type.
+   */
+  async downloadImage(
+    sessionId: string,
+    url: string,
+  ): Promise<[ArrayBuffer, string]> {
+    let targetUrl: string;
+
+    if (apiAssetTextureUri.test(url) || cdnAssetTextureUri.test(url)) {
+      // Call ShapeDiver texture-asset URLs directly
+      targetUrl = url;
+    } else {
+      // All other source URLs are called via the download-image endpoint
+      targetUrl = `${this.buildSessionUri(sessionId)}/image?url=${encodeBase64(url)}`;
     }
 
+    return await sendRequest(async () => {
+      const [header, data] = await this.api.get<ArrayBuffer>(targetUrl, {
+        responseType: ShapeDiverSdkApiResponseType.DATA,
+        disableAuthorization: cdnAssetUri.test(url), // disable for CDN URLs
+      });
+      const contentType = header["Content-Type"] ?? header["content-type"];
+      return [data, contentType];
+    });
+  }
+
+  /**
+   * Fetches a ShapeDiver asset of the following types:
+   *  * Output
+   *  * Export
+   *  * Texture
+   *
+   * This function works similar to {@link getOutput}, {@link getExport} and {@link getTexture}, but does not require
+   * extracted _session ID_ and _asset data_ parameters.
+   *
+   * @param url - The URL of the asset that should be fetched.
+   * @returns Array of size 3: [0] = content data, [1] = content type, [2] = asset type.
+   * @throws {@link ShapeDiverError} when the given URL is not a valid ShapeDiver asset URL.
+   */
+  async getAsset(
+    url: string,
+  ): Promise<[ArrayBuffer, string, "output" | "export" | "texture"]> {
+    let type: "output" | "export" | "texture";
+
+    // Check if the given URL is a valid API or CDN asset URL
+    if (apiAssetExportUri.test(url) || cdnAssetExportUri.test(url))
+      type = "export";
+    else if (apiAssetOutputUri.test(url) || cdnAssetOutputUri.test(url))
+      type = "output";
+    else if (apiAssetTextureUri.test(url) || cdnAssetTextureUri.test(url))
+      type = "texture";
+    else
+      throw new ShapeDiverError(
+        "Cannot fetch asset: Invalid URL (only ShapeDiver asset URLs are allowed).",
+      );
+
+    return await sendRequest(async () => {
+      const [header, data] = await this.api.get<ArrayBuffer>(url, {
+        responseType: ShapeDiverSdkApiResponseType.DATA,
+        disableAuthorization: cdnAssetUri.test(url), // disable for CDN URLs
+      });
+      const contentType = header["Content-Type"] ?? header["content-type"];
+      return [data, contentType, type];
+    });
+  }
 }

package/src/resources/ShapeDiverExportApi.ts

@@ -1,85 +1,100 @@
 import {
-    ShapeDiverRequestCache,
-    ShapeDiverRequestExport,
-    ShapeDiverRequestExportDefinition,
-    ShapeDiverResponseDto,
-} from "@shapediver/api.geometry-api-dto-v2"
-import { BaseResourceApi, ShapeDiverSdkApi } from "@shapediver/sdk.geometry-api-sdk-core"
-import { sendRequest } from "../utils/utils"
+  ShapeDiverRequestCache,
+  ShapeDiverRequestExport,
+  ShapeDiverRequestExportDefinition,
+  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 ShapeDiverExportApi extends BaseResourceApi {
+  constructor(api: ShapeDiverSdkApi) {
+    super(api);
+  }
 
-    constructor(api: ShapeDiverSdkApi) {
-        super(api)
-    }
-
-    /**
-     * Request a specific version of an export.
-     *
-     * @param sessionId
-     * @param body
-     */
-    async compute(
-        sessionId: string,
-        body: ShapeDiverRequestExport,
-    ): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.put<ShapeDiverResponseDto>(
-                this.buildSessionUri(sessionId) + "/export",
-                body,
-            ))[1],
-        )
-    }
-
-    /**
-     * Check if a specific version of a requested export has been computed yet.
-     *
-     * @param sessionId
-     * @param body
-     */
-    async getCache(
-        sessionId: string,
-        body: ShapeDiverRequestCache | ShapeDiverRequestExport,
-    ): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.put<ShapeDiverResponseDto>(
-                this.buildSessionUri(sessionId) + "/export/cache",
-                body,
-            ))[1],
-        )
-    }
-
-    /**
-     * Updates the definitions of the given exports.
-     *
-     * @param modelId
-     * @param body
-     */
-    async updateDefinitions(
-        modelId: string,
-        body: ShapeDiverRequestExportDefinition,
-    ): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.patch<ShapeDiverResponseDto>(
-                this.buildModelUri(modelId) + "/export",
-                body,
-            ))[1],
-        )
-    }
+  /**
+   * Request a specific version of an export.
+   *
+   * @param sessionId
+   * @param body
+   */
+  async compute(
+    sessionId: string,
+    body: ShapeDiverRequestExport,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.put<ShapeDiverResponseDto>(
+            this.buildSessionUri(sessionId) + "/export",
+            body,
+          )
+        )[1],
+    );
+  }
 
+  /**
+   * Check if a specific version of a requested export has been computed yet.
+   *
+   * @param sessionId
+   * @param body
+   */
+  async getCache(
+    sessionId: string,
+    body: ShapeDiverRequestCache | ShapeDiverRequestExport,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.put<ShapeDiverResponseDto>(
+            this.buildSessionUri(sessionId) + "/export/cache",
+            body,
+          )
+        )[1],
+    );
+  }
 
-    /**
-     * List all cached versions of the specified export.
-     *
-     * @param sessionId
-     * @param exportId
-     */
-    async listVersions(sessionId: string, exportId: string): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.get<ShapeDiverResponseDto>(
-                this.buildSessionUri(sessionId) + "/export/" + exportId + "/list"
-            ))[1],
-        )
-    }
+  /**
+   * Updates the definitions of the given exports.
+   *
+   * @param modelId
+   * @param body
+   */
+  async updateDefinitions(
+    modelId: string,
+    body: ShapeDiverRequestExportDefinition,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.patch<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/export",
+            body,
+          )
+        )[1],
+    );
+  }
 
+  /**
+   * List all cached versions of the specified export.
+   *
+   * @param sessionId
+   * @param exportId
+   */
+  async listVersions(
+    sessionId: string,
+    exportId: string,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ShapeDiverResponseDto>(
+            this.buildSessionUri(sessionId) + "/export/" + exportId + "/list",
+          )
+        )[1],
+    );
+  }
 }