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

package/src/resources/ShapeDiverGltfApi.ts

@@ -0,0 +1,45 @@
+import {
+  ShapeDiverRequestGltfUploadQueryConversion,
+  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 ShapeDiverGltfApi extends BaseResourceApi {
+  constructor(api: ShapeDiverSdkApi) {
+    super(api);
+  }
+
+  /**
+   * Upload a glTF file.
+   *
+   * @param sessionId
+   * @param body
+   * @param type
+   * @param queryConvert
+   */
+  async upload(
+    sessionId: string,
+    body: ArrayBuffer,
+    type: string,
+    queryConvert: ShapeDiverRequestGltfUploadQueryConversion = ShapeDiverRequestGltfUploadQueryConversion.NONE,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            `${this.buildSessionUri(sessionId)}/gltf?conversion=${queryConvert}`,
+            body,
+            {
+              contentType: type,
+              responseType: ShapeDiverSdkApiResponseType.JSON,
+            },
+          )
+        )[1],
+    );
+  }
+}

package/src/resources/ShapeDiverModelApi.ts

@@ -0,0 +1,357 @@
+import {
+  ShapeDiverRequestConfigure,
+  ShapeDiverRequestCustomization,
+  ShapeDiverRequestModel,
+  ShapeDiverRequestModelComputationQueryOrder,
+  ShapeDiverRequestModelComputationQueryStatus,
+  ShapeDiverRequestModelComputationQueryType,
+  ShapeDiverRequestParameterDefinition,
+  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 ShapeDiverModelApi extends BaseResourceApi {
+  constructor(api: ShapeDiverSdkApi) {
+    super(api);
+  }
+
+  /**
+   * Get information about a ShapeDiver Model.
+   *
+   * @param modelId
+   */
+  async get(modelId: string): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ShapeDiverResponseDto>(this.buildModelUri(modelId))
+        )[1],
+    );
+  }
+
+  /**
+   * Create a new ShapeDiver Model.
+   *
+   * @param body
+   */
+  async create(body: ShapeDiverRequestModel): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (await this.api.post<ShapeDiverResponseDto>(this.commonPath, body))[1],
+    );
+  }
+
+  /**
+   * Update properties of a ShapeDiver Model.
+   *
+   * @param modelId
+   * @param body
+   */
+  async update(
+    modelId: string,
+    body: ShapeDiverRequestModel,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.put<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId),
+            body,
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Delete a ShapeDiver Model.
+   *
+   * @param modelId
+   */
+  async delete(modelId: string): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.delete<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId),
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * List models.
+   */
+  async list(): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ShapeDiverResponseDto>(`${this.commonPath}/list`)
+        )[1],
+    );
+  }
+
+  /**
+   * Get configurations of the viewer.
+   *
+   * @param modelId
+   */
+  async getConfig(modelId: string): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/config",
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Create viewer configurations.
+   *
+   * @param modelId
+   * @param body
+   */
+  async createConfig(
+    modelId: string,
+    body: ShapeDiverRequestConfigure,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/config",
+            body,
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Update viewer configurations.
+   *
+   * @param modelId
+   * @param body
+   */
+  async updateConfig(
+    modelId: string,
+    body: ShapeDiverRequestConfigure,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.patch<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/config",
+            body,
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Download the Grasshopper file of the ShapeDiver Model.
+   *
+   * @param modelId
+   */
+  async getFile(modelId: string): Promise<ArrayBuffer> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ArrayBuffer>(
+            this.buildModelUri(modelId) + "/file/download",
+            {
+              contentType: "application/json",
+              responseType: ShapeDiverSdkApiResponseType.DATA,
+            },
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Set the default parameters for the ShapeDiver Model.
+   *
+   * @param modelId
+   * @param body
+   */
+  async setDefaultParams(
+    modelId: string,
+    body: ShapeDiverRequestCustomization,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.patch<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/parameter/defval",
+            body,
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Updates the definitions of the given parameters.
+   *
+   * @param modelId
+   * @param body
+   */
+  async updateParameterDefinitions(
+    modelId: string,
+    body: ShapeDiverRequestParameterDefinition,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.patch<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/parameter",
+            body,
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Query model computation statistics.
+   *
+   * @param modelId
+   * @param timestampFrom - Timestamp to query from
+   * @param timestampTo - Timestamp to query to.
+   * @param limit - How many items to return at most.
+   * @param strictLimit - Whether the limit shall be attained (if there are enough items).
+   * @param order - Order in which to query computation stats items.
+   * @param status - Filter computations by the result status.
+   * @param type - Filter computations by type.
+   * @param offset - Continuation token for pagination.
+   */
+  async queryComputations(
+    modelId: string,
+    timestampFrom?: string,
+    timestampTo?: string,
+    limit?: number,
+    strictLimit?: boolean,
+    order?: ShapeDiverRequestModelComputationQueryOrder,
+    status?: ShapeDiverRequestModelComputationQueryStatus,
+    type?: ShapeDiverRequestModelComputationQueryType,
+    offset?: string,
+  ): Promise<ShapeDiverResponseDto> {
+    // Build queries
+    const queries: string[] = [];
+    if (timestampFrom !== undefined)
+      queries.push("timestamp_from=" + timestampFrom);
+    if (timestampTo !== undefined) queries.push("timestamp_to=" + timestampTo);
+    if (limit !== undefined) queries.push("limit=" + limit);
+    if (strictLimit !== undefined) queries.push("strict_limit=" + strictLimit);
+    if (order !== undefined) queries.push("order=" + order);
+    if (status !== undefined) queries.push("status=" + status);
+    if (type !== undefined) queries.push("type=" + type);
+    if (offset !== undefined) queries.push("offset=" + offset);
+
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/computations?" + queries.join("&"),
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Delete all export components that have been last used at or before {@link untilLastSeen} timestamp.
+   *
+   * @param modelId
+   * @param untilLastSeen - Timestamp, inclusive limit.
+   * Allowed Patterns: YYYY, YYYYMM, YYYYMMDD, YYYYMMDDhh, YYYYMMDDhhmm, YYYYMMDDhhmmss, YYYYMMDDhhmmssSSS
+   * @example
+   * untilLastSeen = "20221104112923123"
+   * represents the date-time "2022-11-04T11:29:23.123"
+   */
+  async enqueueCleanupExports(
+    modelId: string,
+    untilLastSeen: string,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) +
+              "/cleanup/export?untilLastSeen=" +
+              untilLastSeen,
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Delete all output components that have been last used at or before {@link untilLastSeen} timestamp.
+   *
+   * @param modelId
+   * @param untilLastSeen - Timestamp, inclusive limit.
+   * Allowed Patterns: YYYY, YYYYMM, YYYYMMDD, YYYYMMDDhh, YYYYMMDDhhmm, YYYYMMDDhhmmss, YYYYMMDDhhmmssSSS
+   * @example
+   * untilLastSeen = "20221104112923123"
+   * represents the date-time "2022-11-04T11:29:23.123"
+   */
+  async enqueueCleanupOutputs(
+    modelId: string,
+    untilLastSeen: string,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) +
+              "/cleanup/output?untilLastSeen=" +
+              untilLastSeen,
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Delete all texture components that have been last used at or before {@link untilLastSeen} timestamp.
+   *
+   * @param modelId
+   * @param untilLastSeen - Timestamp, inclusive limit.
+   * Allowed Patterns: YYYY, YYYYMM, YYYYMMDD, YYYYMMDDhh, YYYYMMDDhhmm, YYYYMMDDhhmmss, YYYYMMDDhhmmssSSS
+   * @example
+   * untilLastSeen = "20221104112923123"
+   * represents the date-time "2022-11-04T11:29:23.123"
+   */
+  async enqueueCleanupTextures(
+    modelId: string,
+    untilLastSeen: string,
+  ): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.post<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) +
+              "/cleanup/texture?untilLastSeen=" +
+              untilLastSeen,
+          )
+        )[1],
+    );
+  }
+
+  /**
+   * Get the status of all running model cleanup processes.
+   *
+   * @param modelId
+   */
+  async getCleanupStatus(modelId: string): Promise<ShapeDiverResponseDto> {
+    return await sendRequest(
+      async () =>
+        (
+          await this.api.get<ShapeDiverResponseDto>(
+            this.buildModelUri(modelId) + "/cleanup/status",
+          )
+        )[1],
+    );
+  }
+}

package/src/resources/ShapeDiverOutputApi.ts

@@ -0,0 +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";
+
+export class ShapeDiverOutputApi extends BaseResourceApi {
+  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],
+    );
+  }
+
+  /**
+   * 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

@@ -0,0 +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";
+
+export class ShapeDiverSdtfApi extends BaseResourceApi {
+  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],
+    );
+  }
+
+  /**
+   * 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],
+    );
+  }
+}

package/src/resources/ShapeDiverSessionApi.ts

@@ -0,0 +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";
+
+export class ShapeDiverSessionApi extends BaseResourceApi {
+  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 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],
+    );
+  }
+
+  /**
+   * 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],
+    );
+  }
+}