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

package/src/resources/ShapeDiverOutputApi.ts

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

package/src/resources/ShapeDiverSdtfApi.ts

@@ -1,61 +1,95 @@
-import { ShapeDiverRequestSdtfUpload, ShapeDiverResponseDto } from "@shapediver/api.geometry-api-dto-v2"
-import { BaseResourceApi, ShapeDiverSdkApi, ShapeDiverSdkApiResponseType } from "@shapediver/sdk.geometry-api-sdk-core"
-import { sendRequest } from "../utils/utils"
+import {
+  ShapeDiverRequestSdtfUpload,
+  ShapeDiverResponseDto,
+} from "@shapediver/api.geometry-api-dto-v2";
+import {
+  BaseResourceApi,
+  ShapeDiverSdkApi,
+  ShapeDiverSdkApiResponseType,
+} from "@shapediver/sdk.geometry-api-sdk-core";
+import { sendRequest } from "../utils/utils";
 
 export class ShapeDiverSdtfApi extends BaseResourceApi {
+  constructor(api: ShapeDiverSdkApi) {
+    super(api);
+  }
 
-    constructor (api: ShapeDiverSdkApi) {
-        super(api)
-    }
+  /**
+   * List all sdTF-assets of the given namespace.
+   *
+   * @param sessionId
+   * @param namespace
+   */
+  async list(
+    sessionId: string,
+    namespace: string,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ShapeDiverResponseDto>(
+            `${this.buildSessionUri(sessionId)}/sdtf/${namespace}/list`,
+          )
+        )[1],
+    );
+  }
 
-    /**
-     * List all sdTF-assets of the given namespace.
-     *
-     * @param sessionId
-     * @param namespace
-     */
-    async list (sessionId: string, namespace: string): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.get<ShapeDiverResponseDto>(`${ this.buildSessionUri(sessionId) }/sdtf/${ namespace }/list`))[1])
-    }
+  /**
+   * Download a sdTF-asset.
+   *
+   * @param sessionId
+   * @param sdtfId - Format: "<namespace>/<sdTF id>"
+   */
+  async get(sessionId: string, sdtfId: string): Promise<ArrayBuffer> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ArrayBuffer>(
+            `${this.buildSessionUri(sessionId)}/sdtf/${sdtfId}`,
+            { responseType: ShapeDiverSdkApiResponseType.DATA },
+          )
+        )[1],
+    );
+  }
 
-    /**
-     * Download a sdTF-asset.
-     *
-     * @param sessionId
-     * @param sdtfId - Format: "<namespace>/<sdTF id>"
-     */
-    async get (sessionId: string, sdtfId: string): Promise<ArrayBuffer> {
-        return await sendRequest(async () =>
-            (await this.api.get<ArrayBuffer>(
-                `${ this.buildSessionUri(sessionId) }/sdtf/${ sdtfId }`,
-                { responseType: ShapeDiverSdkApiResponseType.DATA },
-            ))[1],
-        )
-    }
-
-    /**
-     * Delete a sdTF-asset.
-     *
-     * @param sessionId
-     * @param sdtfId
-     */
-    async delete (sessionId: string, sdtfId: string): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.delete<ShapeDiverResponseDto>(`${ this.buildSessionUri(sessionId) }/sdtf/${ sdtfId }`))[1],
-        )
-    }
-
-    /**
-     * Request an Upload-URL for a sdTF-asset.
-     *
-     * @param sessionId
-     * @param body
-     */
-    async requestUpload (sessionId: string, body: ShapeDiverRequestSdtfUpload): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.post<ShapeDiverResponseDto>(this.buildSessionUri(sessionId) + "/sdtf/upload", body))[1],
-        )
-    }
+  /**
+   * Delete a sdTF-asset.
+   *
+   * @param sessionId
+   * @param sdtfId
+   */
+  async delete(
+    sessionId: string,
+    sdtfId: string,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.delete<ShapeDiverResponseDto>(
+            `${this.buildSessionUri(sessionId)}/sdtf/${sdtfId}`,
+          )
+        )[1],
+    );
+  }
 
+  /**
+   * Request an Upload-URL for a sdTF-asset.
+   *
+   * @param sessionId
+   * @param body
+   */
+  async requestUpload(
+    sessionId: string,
+    body: ShapeDiverRequestSdtfUpload,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            this.buildSessionUri(sessionId) + "/sdtf/upload",
+            body,
+          )
+        )[1],
+    );
+  }
 }

package/src/resources/ShapeDiverSessionApi.ts

@@ -1,91 +1,113 @@
 import {
-    ShapeDiverRequestCustomization,
-    ShapeDiverRequestExport,
-    ShapeDiverRequestTicket,
-    ShapeDiverResponseDto,
-} from "@shapediver/api.geometry-api-dto-v2"
-import { BaseResourceApi, ShapeDiverSdkApi } from "@shapediver/sdk.geometry-api-sdk-core"
-import { sendRequest } from "../utils/utils"
+  ShapeDiverRequestCustomization,
+  ShapeDiverRequestExport,
+  ShapeDiverRequestTicket,
+  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 ShapeDiverSessionApi extends BaseResourceApi {
+  constructor(api: ShapeDiverSdkApi) {
+    super(api);
+  }
 
-    constructor(api: ShapeDiverSdkApi) {
-        super(api)
-    }
-
-    /**
-     * Create a new ticket that allows to initialize new sessions for the
-     * specified model.
-     *
-     * @param modelId
-     * @param body
-     */
-    async ticket(modelId: string, body: ShapeDiverRequestTicket): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.post<ShapeDiverResponseDto>(
-                this.buildModelUri(modelId) + "/ticket",
-                body,
-            ))[1],
-        )
-    }
-
-    /**
-     * Create a new session for a ShapeDiver Model via a ticket.
-     *
-     * @param ticket
-     * @param request - Optional customization or export request.
-     */
-    async init(
-        ticket: string,
-        request?: ShapeDiverRequestCustomization | ShapeDiverRequestExport,
-    ): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.post<ShapeDiverResponseDto>(this.buildTicketUri(ticket), request))[1],
-        )
-    }
+  /**
+   * Create a new ticket that allows to initialize new sessions for the
+   * specified model.
+   *
+   * @param modelId
+   * @param body
+   */
+  async ticket(
+    modelId: string,
+    body: ShapeDiverRequestTicket,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/ticket",
+            body,
+          )
+        )[1],
+    );
+  }
 
-    /**
-     * Create a new session for a ShapeDiver Model.
-     *
-     * @param ticket
-     * @param request - Optional customization or export request.
-     */
-    async initForModel(
-        modelId: string,
-        request?: ShapeDiverRequestCustomization | ShapeDiverRequestExport,
-    ): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.post<ShapeDiverResponseDto>(
-                this.buildModelUri(modelId) + "/session",
-                request,
-            ))[1],
-        )
-    }
+  /**
+   * Create a new session for a ShapeDiver Model via a ticket.
+   *
+   * @param ticket
+   * @param request - Optional customization or export request.
+   */
+  async init(
+    ticket: string,
+    request?: ShapeDiverRequestCustomization | ShapeDiverRequestExport,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            this.buildTicketUri(ticket),
+            request,
+          )
+        )[1],
+    );
+  }
 
-    /**
-     * Get the full description of a ShapeDiver Model.
-     *
-     * @param sessionId
-     */
-    async default(sessionId: string): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.get<ShapeDiverResponseDto>(
-                this.buildSessionUri(sessionId) + "/default",
-            ))[1],
-        )
-    }
+  /**
+   * Create a new session for a ShapeDiver Model.
+   *
+   * @param ticket
+   * @param request - Optional customization or export request.
+   */
+  async initForModel(
+    modelId: string,
+    request?: ShapeDiverRequestCustomization | ShapeDiverRequestExport,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/session",
+            request,
+          )
+        )[1],
+    );
+  }
 
-    /**
-     * Close the specified session.
-     *
-     * @param sessionId
-     */
-    async close(sessionId: string): Promise<ShapeDiverResponseDto> {
-        return await sendRequest(async () =>
-            (await this.api.post<ShapeDiverResponseDto>(
-                this.buildSessionUri(sessionId) + "/close",
-            ))[1],
-        )
-    }
+  /**
+   * Get the full description of a ShapeDiver Model.
+   *
+   * @param sessionId
+   */
+  async default(sessionId: string): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ShapeDiverResponseDto>(
+            this.buildSessionUri(sessionId) + "/default",
+          )
+        )[1],
+    );
+  }
 
+  /**
+   * Close the specified session.
+   *
+   * @param sessionId
+   */
+  async close(sessionId: string): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            this.buildSessionUri(sessionId) + "/close",
+          )
+        )[1],
+    );
+  }
 }