@shapediver/sdk.geometry-api-sdk-v2 1.12.2 → 2.0.0

package/src/resources/ShapeDiverModelStateApi.ts

@@ -1,163 +0,0 @@
-import {
-  BaseResourceApi,
-  ShapeDiverResponseError,
-  ShapeDiverSdkApi,
-  ShapeDiverSdkApiResponseType,
-} from "@shapediver/sdk.geometry-api-sdk-core";
-import { sendRequest } from "../utils/utils";
-import {
-  ShapeDiverRequestModelState,
-  ShapeDiverResponseDto,
-} from "@shapediver/api.geometry-api-dto-v2";
-
-export class ShapeDiverModelStateApi extends BaseResourceApi {
-  constructor(api: ShapeDiverSdkApi) {
-    super(api);
-  }
-
-  /**
-   * Checks the existence of a Model-State.
-   * @param modelStateId The ID of the Model-State.
-   * @returns A boolean indicating whether the Model-State exists.
-   */
-  async exists(modelStateId: string): Promise<boolean> {
-    return await sendRequest(async () => {
-      try {
-        const [_, status] = await this.api.head(
-          this.buildModelStateUri(modelStateId),
-          { disableAuthorization: true },
-        );
-        return status === 200;
-      } catch (e) {
-        // A 404 HTTP status is returned when the Model-State was not found.
-        if (e instanceof ShapeDiverResponseError && e.status === 404)
-          return false;
-        else throw e;
-      }
-    });
-  }
-
-  /**
-   * Get a Model-State.
-   * @param modelStateId The ID of the Model-State.
-   */
-  async get(modelStateId: string): Promise<ShapeDiverResponseDto> {
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.get<ShapeDiverResponseDto>(
-            this.buildModelStateUri(modelStateId),
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * Delete a Model-State.
-   * @param modelStateId The ID of the Model-State.
-   */
-  async delete(modelStateId: string): Promise<void> {
-    return await sendRequest(async () => {
-      await this.api.delete(this.buildModelStateUri(modelStateId));
-    });
-  }
-
-  /**
-   * Get a Model-State's parameter and additional data.
-   * @param modelStateId The ID of the Model-State.
-   */
-  async getData(modelStateId: string): Promise<ShapeDiverResponseDto> {
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.get<ShapeDiverResponseDto>(
-            `${this.buildModelStateUri(modelStateId)}/data`,
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * Check if the Model-State has an image.
-   * @param modelStateId The ID of the Model-State.
-   * @returns A boolean indicating whether the Model-State has an image.
-   */
-  async hasImage(modelStateId: string): Promise<boolean> {
-    return await sendRequest(async () => {
-      try {
-        const [_, status] = await this.api.head(
-          `${this.buildModelStateUri(modelStateId)}/image`,
-          { disableAuthorization: true },
-        );
-        return status === 200;
-      } catch (e) {
-        // A 404 HTTP status is returned when the Model-State image was not found.
-        if (e instanceof ShapeDiverResponseError && e.status === 404)
-          return false;
-        else throw e;
-      }
-    });
-  }
-
-  /**
-   * Downloads the Model-State image.
-   * @param modelStateId The ID of the Model-State.
-   * @returns Array of size 2: [0] = content data, [1] = content type.
-   */
-  async getImage(modelStateId: string): Promise<[ArrayBuffer, string]> {
-    return await sendRequest(async () => {
-      const [header, data] = await this.api.get<ArrayBuffer>(
-        `${this.buildModelStateUri(modelStateId)}/image`,
-        undefined,
-        {
-          responseType: ShapeDiverSdkApiResponseType.DATA,
-          disableAuthorization: true,
-        },
-      );
-      const contentType = header["Content-Type"] ?? header["content-type"];
-      return [data, contentType];
-    });
-  }
-
-  /**
-   * List Model-States of a ShapeDiver model.
-   * @param modelId The ID of the ShapeDiver model.
-   * @param offset The offset to start the list from.
-   */
-  async list(modelId: string, offset?: string): Promise<ShapeDiverResponseDto> {
-    // Build queries
-    const queries: string[] = [];
-    if (offset !== undefined) queries.push("offset=" + offset);
-
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.get<ShapeDiverResponseDto>(
-            `${this.buildModelStateUri()}/model/${modelId}/list`,
-            queries,
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * Create a new Model-State.
-   * @param modelId The ID of the ShapeDiver model.
-   * @param body The Model-State data.
-   */
-  async create(
-    sessionId: string,
-    body: ShapeDiverRequestModelState,
-  ): Promise<ShapeDiverResponseDto> {
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.post<ShapeDiverResponseDto>(
-            `${this.buildSessionUri(sessionId)}/model-state`,
-            undefined,
-            body,
-          )
-        )[1],
-    );
-  }
-}

package/src/resources/ShapeDiverOutputApi.ts

@@ -1,109 +0,0 @@
-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",
-            undefined,
-            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",
-            undefined,
-            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",
-            undefined,
-            body,
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * List all cached versions of the specified output.
-   *
-   * @param sessionId
-   * @param outputId
-   */
-  async listVersions(
-    sessionId: string,
-    outputId: string,
-    offset?: string,
-  ): Promise<ShapeDiverResponseDto> {
-    // Build queries
-    const queries: string[] = [];
-    if (offset !== undefined) queries.push("offset=" + offset);
-
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.get<ShapeDiverResponseDto>(
-            `${this.buildSessionUri(sessionId)}/output/${outputId}/list`,
-            queries,
-          )
-        )[1],
-    );
-  }
-}

package/src/resources/ShapeDiverSdtfApi.ts

@@ -1,103 +0,0 @@
-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,
-    offset?: string,
-  ): Promise<ShapeDiverResponseDto> {
-    // Build queries
-    const queries: string[] = [];
-    if (offset !== undefined) queries.push("offset=" + offset);
-
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.get<ShapeDiverResponseDto>(
-            `${this.buildSessionUri(sessionId)}/sdtf/${namespace}/list`,
-            queries,
-          )
-        )[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}`,
-            undefined,
-            { 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",
-            undefined,
-            body,
-          )
-        )[1],
-    );
-  }
-}

package/src/resources/ShapeDiverSessionApi.ts

@@ -1,142 +0,0 @@
-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",
-            undefined,
-            body,
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * Create a new session for a ShapeDiver Model via a ticket.
-   *
-   * @param ticket
-   * @param request - Optional customization or export request.
-   * @param modelStateId - ID of the Model-State to apply.
-   * @param strictValidation - When `false`, any Model-State parameter that cannot be applied to the
-   * model is ignored. However, when set to `true`, any validation error will result in an error
-   * response.
-   */
-  async init(
-    ticket: string,
-    request?: ShapeDiverRequestCustomization | ShapeDiverRequestExport,
-    modelStateId?: string,
-    strictValidation?: boolean,
-  ): Promise<ShapeDiverResponseDto> {
-    // Build queries
-    const queries: string[] = [];
-    if (modelStateId !== undefined)
-      queries.push("modelStateId=" + modelStateId);
-    if (strictValidation !== undefined)
-      queries.push("strictValidation=" + strictValidation);
-
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.post<ShapeDiverResponseDto>(
-            this.buildTicketUri(ticket),
-            queries,
-            request,
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * Create a new session for a ShapeDiver Model.
-   *
-   * @param ticket
-   * @param request - Optional customization or export request.
-   * @param modelStateId - ID of the Model-State to apply.
-   * @param strictValidation - When `false`, any Model-State parameter that cannot be applied to the
-   * model is ignored. However, when set to `true`, any validation error will result in an error
-   * response.
-   */
-  async initForModel(
-    modelId: string,
-    request?: ShapeDiverRequestCustomization | ShapeDiverRequestExport,
-    modelStateId?: string,
-    strictValidation?: boolean,
-  ): Promise<ShapeDiverResponseDto> {
-    // Build queries
-    const queries: string[] = [];
-    if (modelStateId !== undefined)
-      queries.push("modelStateId=" + modelStateId);
-    if (strictValidation !== undefined)
-      queries.push("strictValidation=" + strictValidation);
-
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.post<ShapeDiverResponseDto>(
-            this.buildModelUri(modelId) + "/session",
-            queries,
-            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],
-    );
-  }
-}

package/src/resources/ShapeDiverSystemApi.ts

@@ -1,118 +0,0 @@
-import {
-  ShapeDiverRequestAuthorizationGroup,
-  ShapeDiverRequestLogMessage,
-  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 ShapeDiverSystemApi extends BaseResourceApi {
-  constructor(api: ShapeDiverSdkApi) {
-    super(api);
-  }
-
-  /**
-   * Log the specified message.
-   *
-   * @param sessionId
-   * @param body
-   */
-  async log(
-    sessionId: string,
-    body: ShapeDiverRequestLogMessage,
-  ): Promise<ShapeDiverResponseDto> {
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.post<ShapeDiverResponseDto>(
-            this.buildSessionUri(sessionId) + "/log/message",
-            undefined,
-            body,
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * Remove a model with all it's components.
-   *
-   * **WARNING: This operation cannot be undone!**
-   *
-   * @param modelId
-   */
-  async pruneModel(modelId: string): Promise<ShapeDiverResponseDto> {
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.delete<ShapeDiverResponseDto>(
-            `${this.buildSystemUri()}/model/${modelId}`,
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * Decrypt the given ticket.
-   *
-   * @param ticket
-   */
-  async decryptTicket(ticket: string): Promise<ShapeDiverResponseDto> {
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.get<ShapeDiverResponseDto>(this.buildTicketUri(ticket))
-        )[1],
-    );
-  }
-
-  /**
-   * Create a new authentication group.
-   *
-   * @param body
-   */
-  async authGroup(
-    body: ShapeDiverRequestAuthorizationGroup,
-  ): Promise<ShapeDiverResponseDto> {
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.post<ShapeDiverResponseDto>(
-            this.buildAuthGroupUri(),
-            undefined,
-            body,
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * Returns system information about the Geometry Minions.
-   */
-  async getMinionInfo(): Promise<ShapeDiverResponseDto> {
-    return sendRequest(
-      async () =>
-        (
-          await this.api.get<ShapeDiverResponseDto>(
-            `${this.buildSystemUri()}/minions/info`,
-          )
-        )[1],
-    );
-  }
-
-  /**
-   * Returns system information about the Geometry Workers.
-   */
-  async getWorkerInfo(): Promise<ShapeDiverResponseDto> {
-    return sendRequest(
-      async () =>
-        (
-          await this.api.get<ShapeDiverResponseDto>(
-            `${this.buildSystemUri()}/workers/info`,
-          )
-        )[1],
-    );
-  }
-}

package/src/resources/ShapeDiverTextureApi.ts

@@ -1,36 +0,0 @@
-import { 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 ShapeDiverTextureApi extends BaseResourceApi {
-  constructor(api: ShapeDiverSdkApi) {
-    super(api);
-  }
-
-  /**
-   * List all textures of the specified model.
-   *
-   * @param sessionId
-   */
-  async listModelTextures(
-    sessionId: string,
-    offset?: string,
-  ): Promise<ShapeDiverResponseDto> {
-    // Build queries
-    const queries: string[] = [];
-    if (offset !== undefined) queries.push("offset=" + offset);
-
-    return await sendRequest(
-      async () =>
-        (
-          await this.api.get<ShapeDiverResponseDto>(
-            this.buildSessionUri(sessionId) + "/texture/list",
-            queries,
-          )
-        )[1],
-    );
-  }
-}