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

package/README.md

@@ -4,121 +4,195 @@
   </a>
 </p>
 
-# ShapeDiver Geometry Backend API - SDK v2
+# GeometryBackendSdkTypeScript
 
-> :warning: **Version 1 is deprecated. Please upgrade to [v2](https://github.com/shapediver/GeometryBackendSdkTypeScript/tree/master/packages/sdk.geometry-api-sdk-v2) to receive the newest features - [Migration Guide](<https://help.shapediver.com/doc/geometry-backend-sdk-typescript-migration-guide#GeometryBackendSDKTypeScript-MigrationGuide-MigratingfromVersion1.x.xto2.x.x(03/11/2024)>).**
+> :warning: **You might be looking for the [v1 docs](https://github.com/shapediver/GeometryBackendSdkTypeScript/tree/legacy/v1) - [Migration Guide](https://help.shapediver.com/doc/geometry-backend-sdk-typescript-migration-guide#GeometryBackendSDKTypeScript-MigrationGuide-MigratingfromVersion1.x.xto2.x.x(03/11/2024)).**
 
-[ShapeDiver](https://www.shapediver.com/) is a cloud platform for building online applications based on parametric 3D files made with Rhinoceros 3D and Grasshopper.
+[ShapeDiver](https://www.shapediver.com/) is a cloud platform for building online applications
+based on parametric 3D files made with [Rhinoceros 3D](https://www.rhino3d.com/) and
+[Grasshopper](https://www.grasshopper3d.com/).
 
-Using the **ShapeDiver Geometry Backend API** allows accessing ShapeDiver models without using the **ShapeDiver Viewer**.
-The SDKs provide the functionality to communicate with a specific version of our Geometry Backend API, and they expose all TypeScript-types describing request and response objects.
-
-This SDK provides functionality to communicate with the **ShapeDiver Geometry Backend API v2** and exposes all TypeScript-types describing request and response objects.
-See the [API documentation](https://sdeuc1.eu-central-1.shapediver.com/api/v2/docs/) for more details.
+Using the **ShapeDiver Geometry Backend API** allows access to ShapeDiver models without using the
+**ShapeDiver Viewer**. This SDK provides functionality to communicate with the Geometry Backend API
+**version 2**, and includes type hints describing request and response data objects. See the
+[API documentation](https://sdeuc1.eu-central-1.shapediver.com/api/v2/docs/) for more details.
 
 ## Authentication
 
-The authentication system for the Geometry Backend API is based on **ticket objects** and **JWT tokens**, which are handled by the [ShapeDiver Platform](https://www.shapediver.com/app/).
-You can obtain **tickets** and **JWT tokens** by
+The authentication system for the Geometry Backend API is based on **ticket objects** and **JWT
+tokens**, which are handled by the [ShapeDiver Platform](https://www.shapediver.com/app/). You can
+obtain **tickets** and **JWT tokens** by:
 
-- using your account on the [ShapeDiver Platform](https://www.shapediver.com/app/) (tickets only), or
-- you can obtain them programmatically using the [ShapeDiver Platform API](https://app.shapediver.com/api/documentation) (both tickets and JWT tokens).
+- using your account on the [ShapeDiver Platform](https://www.shapediver.com/app/) (tickets only),
+    or
 
-An SDK for the [ShapeDiver Platform API](https://app.shapediver.com/api/documentation) will be released soon.
+- you can obtain them programmatically using the [ShapeDiver Platform API](https://app.shapediver.com/api/documentation) (both tickets and JWT tokens).
 
-When obtaining a ticket for your model from the ShapeDiver Platform, please be aware that you will need a
+An SDK for the [ShapeDiver Platform API](https://app.shapediver.com/api/documentation) will be
+released soon.
 
-- _ticket for direct embedding_ in case you are accessing the Geometry Backend API from a web browser, or a
-- _ticket for backend access_ in case you are accessing the Geometry Backend API from an arbitrary client application that is not a web browser.
+When obtaining a ticket for your model from the ShapeDiver Platform, please be aware that you will
+need a _ticket for backend access_, since you are accessing the Geometry Backend API from an
+arbitrary client application that is not a web browser. For more details see the [ShapeDiver
+Help Center developer settings](https://help.shapediver.com/doc/developers-settings).
 
 ## Base URL
 
 The base URL to use depends on which ShapeDiver Geometry Backend System your model was uploaded to.
-You can find the base URL in your model's dashboard on the ShapeDiver Platform, it is also called the _model view url_.
+You can find the base URL in your model's dashboard on the ShapeDiver Platform, it is also called
+the _model view url_.
 
 ## Usage - Ticket only
 
-```
-import { create } from "@shapediver/sdk.geometry-api-sdk-v2"
+```typescript
+import { Configuration, SessionApi } from '@shapediver/sdk.geometry-api-sdk-v2';
 
 (async function () {
-    # Please see above on how to obtain a ticket
-    const ticket = "8b23fae66cf535719a9ec797e390208b2003e3cfc894b7624ada2f6894515f8836a4-66303337623538322d34386"
+    // Please see above on how to obtain a ticket
+    const ticket = '8b23fae66cf535719a9ec797e390208b2003e3cfc894b7624ada2f6894515f8836a4-66303337623538322d34386';
 
-    # Initialize the SDK by providing the base URL
-    const sdk = create("https://sdeuc1.eu-central-1.shapediver.com")
+    // Initialize the SDK configuration instance by providing the base URL
+    const config = new Configuration({ basePath: 'https://sdeuc1.eu-central-1.shapediver.com' });
 
-    # This initializes a new session and returns your ShapeDiver Model and your session
-    const res = await sdk.session.init(ticket)
-    console.log(res)
-})()
+    // Initialize a new session using the ticket.
+    const res = (await new SessionApi(config).createSessionByTicket(ticket)).data;
+
+    console.log(res);
+})();
 ```
 
 ## Usage - Ticket and JWT
 
-It is possible to configure your ShapeDiver models such that JWT tokens are required to communicate with them, which provides a strong authorisation mechanism.
-In this case you will need to use the [ShapeDiver Platform API](https://app.shapediver.com/api/documentation) to obtain a JWT token for your model on demand.
+It is possible to configure your ShapeDiver models such that JWT tokens are required to communicate
+with them, which provides a strong authorisation mechanism. In this case you will need to use the
+[ShapeDiver Platform API](https://app.shapediver.com/api/documentation) to obtain a JWT token for
+your model on demand:
 
-```
-import { create } from "@shapediver/sdk.geometry-api-sdk-v2"
+```typescript
+import { Configuration, SessionApi } from '@shapediver/sdk.geometry-api-sdk-v2';
 
 (async function () {
-    # Please see above on how to obtain a ticket and a JWT
-    const jwt = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikp1c3QgYSB0ZXN0IiwiaWF0IjoxNjE4OTExMjcxLCJleHAiOjE2MTg5MTQ4OTcsImp0aSI6IjYzMjA3ODE3LWJiNWQtNDY3Zi04NzRkLWM4N2EyYzAxYmZlZCJ9.S5Ps_Fx5p6aJxdBOJMBKgpf2SIlp--6kkIZU55tiqEg"
-    const ticket = "8b23fae66cf535719a9ec797e390208b2003e3cfc894b7624ada2f6894515f8836a4-66303337623538322d34386"
+    // Please see above on how to obtain a ticket and a JWT.
+    const jwt = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikp1c3QgYSB0ZXN0IiwiaWF0IjoxNjE4OTExMjcxLCJleHAiOjE2MTg5MTQ4OTcsImp0aSI6IjYzMjA3ODE3LWJiNWQtNDY3Zi04NzRkLWM4N2EyYzAxYmZlZCJ9.S5Ps_Fx5p6aJxdBOJMBKgpf2SIlp--6kkIZU55tiqEg';
+    const ticket = '8b23fae66cf535719a9ec797e390208b2003e3cfc894b7624ada2f6894515f8836a4-66303337623538322d34386';
 
-    # Initialize the SDK by providing the base URL and your JWT
-    const sdk = create("https://sdeuc1.eu-central-1.shapediver.com", jwt)
+    // Initialize the SDK client instance by providing the base URL
+    const config = new Configuration({
+        basePath: 'https://sdeuc1.eu-central-1.shapediver.com',
+        accessToken: jwt,
+    });
 
-    # This initializes a new session and returns your ShapeDiver Model and your session
-    const res = await sdk.session.init(ticket)
-    console.log(res)
-})()
+    // Initialize a new session using the ticket.
+    const res = (await new SessionApi(config).createSessionByTicket(ticket)).data;
+
+    console.log(res);
+})();
 ```
 
 ## Handling Errors
 
-The SDK provides type guards to distinguish between error types.
+The SDK provides a helper function to extract ShapeDiver error information from an `AxiosError`:
 
-```
+```typescript
 import {
-  isGBError,
-  isGBGenericError,
-  isGBRequestError,
-  isGBResponseError,
+  processError,
+  SdError,
+  SdRequestError,
+  SdResponseError,
 } from "@shapediver/sdk.geometry-api-sdk-v2"
 
 try {
   sdk.model.get("be5d4ce5-f76d-417d-8496-1f038e6f0cab")
-catch (e: any) {
-  if (isGBRequestError(e)) {
+catch (err) {
+  const e = processError(err);
+
+  if (e instanceof SdRequestError) {
     // e is a request error.
     // In this case, the request was made but no response was received.
   }
 
-  if (isGBResponseError(e)) {
+  if (e instanceof SdResponseError) {
     // e is a response error.
     // In this case, the request was made and the server responded with a status code that falls
     // out of the range of 2xx.
   }
 
-  if (isGBGenericError(e)) {
+  if (e instanceof SdError) {
     // e is a generic error.
     // Generic errors are used for everything that is neither a request error nor a response error.
   }
-
-  if (isGBError(e)) {
-    // e is either a generic error, request error or response error.
-  }
 }
 ```
 
 ## Examples
 
-Some practical use cases, we will regularly extend the list:
+Examples on how to interact with available endpoints are given in the
+[tests](https://github.com/shapediver/GeometryBackendSdkTypeScript/tree/master/packages/sdk.geometry-api-sdk-v2/__tests__) folder.
+
+## Making Changes & Contributing
+
+Most of the code in this repository has been generated via the
+[OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator). The specification of the
+Geometry Backend API version 2 can be found in the
+[ShapeDiver
+OAS](https://github.com/shapediver/OpenApiSpecifications/blob/main/geometry_backend_v2.yaml)
+repository. Additionally, we have added wrappers and utility functions to improve overall
+usability.
+
+### Setup
+
+This project is written in _TypeScript_ and uses [PNPM](https://pnpm.io/) as a dependency manager.
+Project-specific commands are handled either via [NPM](https://docs.npmjs.com/cli/v8) or
+[just](https://github.com/casey/just), so make sure that both tools are installed. To get an
+overview of all available commands run `npm run -l` and `just --list`.
+
+Run the following commands to install all dependencies:
+
+```bash
+npm run init
+```
+
+## Generate Code
+
+To re-generate the code from the
+[ShapeDiver
+OAS](https://github.com/shapediver/OpenApiSpecifications/blob/main/geometry_backend_v2.yaml)
+file, you need to install version 7 of the
+[OpenAPI
+Generator](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#1---installation).
+We recommend installing it as a global NPM package:
+
+```bash
+npm i -g openapi-generator
+```
+
+Afterwards, update the local file `./oas_spec.yaml` and generate the new code via
+`just generate <version>`. The _version_ argument represents the respective Git tag from
+[ShapeDiver OAS](https://github.com/shapediver/OpenApiSpecifications/tags). For instance, use
+version "1.0.0" when targeting the Git tag "gb_v2@1.0.0".
+
+Alternatively, the client can be generated from a local file. Check out the [ShapeDiver OAS
+repository](https://github.com/shapediver/OpenApiSpecifications) and run `just generate local`.
+
+## Release
+
+Before releasing a new versions of this package ensure that you have configured everything in your
+`~/.npmrc` file. Afterwards, run `npm run publish` and follow the CLI to build, publish, and commit
+a new version of the TypeScript package.
+Before releasing a new version of this package, ensure that your `~/.npmrc` file is fully
+configured. Then, run `npm run publish` and follow the CLI instructions to build, publish, and
+commit the new version of the TypeScript package.
+
+## Test
+
+Unit and integration tests can be executed via `npm run test`. However, should you want to run only
+a single test file then run `npx jest -i --forceExit <path>` within the package instead.
+
+## Versioning
 
-- [A Twitter Bot calling a ShapeDiver Model](https://github.com/shapediver/ServerlessExample-TwitterBot):
-  This example shows how to run computations using a ShapeDiver Model which has image and data inputs and outputs.
+We take care to provide backwards compatibility for all older versions.
+However, new features might be limited to newer API versions.
+Therefore, we recommend always using the newest API version out there.
 
 ## Support
 
@@ -128,4 +202,5 @@ You can find out more about ShapeDiver [right here](https://www.shapediver.com/)
 
 ## Licensing
 
-This project is released under the [MIT License](https://github.com/shapediver/GeometryBackendSdkTypeScript/blob/master/packages/sdk.geometry-api-sdk-v2/LICENSE).
+This project is released under the [MIT
+License](https://github.com/shapediver/GeometryBackendSdkTypeScript/blob/master/LICENSE).

package/dist/UtilsApi.d.ts

@@ -0,0 +1,20 @@
+import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from 'axios';
+import { Configuration, ReqCustomization, ReqExport, ResAssetUploadHeaders, ResComputeExports, ResComputeOutputs } from './client';
+import { BaseAPI } from './client/base';
+export declare class UtilsApi extends BaseAPI {
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+    upload(url: string, data: string | Record<string, any> | ArrayBuffer | File, contentType: string, filename?: string, options?: RawAxiosRequestConfig): AxiosPromise<unknown>;
+    uploadAsset(url: string, data: string | Record<string, any> | ArrayBuffer | File, headers: ResAssetUploadHeaders, options?: RawAxiosRequestConfig): AxiosPromise<unknown>;
+    download(url: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    downloadAsset(url: string, options?: RawAxiosRequestConfig): [AxiosPromise<File>, 'export' | 'output' | 'texture'];
+    downloadImage(sessionId: string, url: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    submitAndWaitForOutput(sessionId: string, body: ReqCustomization, maxWaitMsec?: number, options?: RawAxiosRequestConfig): Promise<ResComputeOutputs>;
+    submitAndWaitForExport(sessionId: string, body: ReqExport, maxWaitMsec?: number, options?: RawAxiosRequestConfig): Promise<ResComputeExports>;
+    private waitForOutputResult;
+    private waitForExportResult;
+    private getMaxOutputDelay;
+    private getMaxExportDelay;
+    private buildRequest;
+    private disableAuthHeaderForShapeDiverUris;
+}
+//# sourceMappingURL=UtilsApi.d.ts.map

package/dist/UtilsApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UtilsApi.d.ts","sourceRoot":"","sources":["../src/UtilsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,qBAAqB,EAA0B,MAAM,OAAO,CAAC;AAEnG,OAAO,EAEH,aAAa,EAIb,gBAAgB,EAChB,SAAS,EACT,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EAKpB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAe,MAAM,eAAe,CAAC;AAkBrD,qBAAa,QAAS,SAAQ,OAAO;gBACrB,aAAa,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,aAAa;IAY5E,MAAM,CACT,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,WAAW,GAAG,IAAI,EACvD,WAAW,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,qBAAqB,GAChC,YAAY,CAAC,OAAO,CAAC;IAsBjB,WAAW,CACd,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,WAAW,GAAG,IAAI,EACvD,OAAO,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,qBAAqB,GAChC,YAAY,CAAC,OAAO,CAAC;IAqBjB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,YAAY,CAAC,IAAI,CAAC;IAY1E,aAAa,CAChB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,qBAAqB,GAChC,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IAwBjD,aAAa,CAChB,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,qBAAqB,GAChC,YAAY,CAAC,IAAI,CAAC;IAwBR,sBAAsB,CAC/B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gBAAgB,EACtB,WAAW,SAAK,EAChB,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC,iBAAiB,CAAC;IAqBhB,sBAAsB,CAC/B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,SAAS,EACf,WAAW,SAAK,EAChB,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC,iBAAiB,CAAC;YAqBf,mBAAmB;YAsDnB,mBAAmB;IAuCjC,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,iBAAiB;IA0BzB,OAAO,CAAC,YAAY;IA2BpB,OAAO,CAAC,kCAAkC;CAW7C"}

package/dist/UtilsApi.js

@@ -0,0 +1,185 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UtilsApi = void 0;
+const common_1 = require("./client/common");
+const client_1 = require("./client");
+const base_1 = require("./client/base");
+const utils_1 = require("./utils");
+const error_1 = require("./error");
+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\/.+/;
+const directDownloadUri = /^(http[s]?:\/\/)?(viewer|textures|downloads)\.shapediver\.com(\/.*)?$/;
+class UtilsApi extends base_1.BaseAPI {
+    constructor(configuration, basePath, axios) {
+        super(configuration, basePath, axios);
+    }
+    upload(url, data, contentType, filename, options) {
+        const reqHeaders = {
+            Authorization: undefined,
+            'Content-Type': contentType,
+        };
+        if (filename)
+            reqHeaders['Content-Disposition'] = (0, utils_1.contentDispositionFromFilename)(filename);
+        const reqOptions = Object.assign({}, options);
+        reqOptions.headers = Object.assign(Object.assign({}, reqHeaders), options === null || options === void 0 ? void 0 : options.headers);
+        const request = this.buildRequest('PUT', url, data, reqOptions)();
+        return request();
+    }
+    uploadAsset(url, data, headers, options) {
+        const reqHeaders = {
+            Authorization: undefined,
+            'Content-Type': headers.contentType,
+        };
+        if (headers.contentDisposition)
+            reqHeaders['Content-Disposition'] = headers.contentDisposition;
+        const reqOptions = Object.assign({}, options);
+        reqOptions.headers = Object.assign(Object.assign({}, reqHeaders), options === null || options === void 0 ? void 0 : options.headers);
+        const request = this.buildRequest('PUT', url, data, reqOptions)();
+        return request();
+    }
+    download(url, options) {
+        const request = this.buildRequest('GET', url, options)();
+        return request();
+    }
+    downloadAsset(url, options) {
+        let type;
+        this.disableAuthHeaderForShapeDiverUris(url, options);
+        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 error_1.IllegalArgumentError(`Cannot fetch asset: Invalid URL '${url}' - Only ShapeDiver asset URLs are allowed.`);
+        }
+        return [this.download(url, options), type];
+    }
+    downloadImage(sessionId, url, options) {
+        this.disableAuthHeaderForShapeDiverUris(url, options);
+        if (apiAssetTextureUri.test(url) ||
+            cdnAssetTextureUri.test(url) ||
+            directDownloadUri.test(url)) {
+            return this.download(url, options);
+        }
+        else {
+            return new client_1.AssetsApi(this.configuration).downloadImage(sessionId, url, options);
+        }
+    }
+    submitAndWaitForOutput(sessionId_1, body_1) {
+        return __awaiter(this, arguments, void 0, function* (sessionId, body, maxWaitMsec = -1, options) {
+            const startMsec = Date.now();
+            const dto = (yield new client_1.OutputApi(this.configuration).computeOutputs(sessionId, body, options)).data;
+            const waitMsec = Date.now() - startMsec;
+            maxWaitMsec = maxWaitMsec < 0 ? maxWaitMsec : Math.max(0, maxWaitMsec - waitMsec);
+            return this.waitForOutputResult(sessionId, dto, maxWaitMsec, options);
+        });
+    }
+    submitAndWaitForExport(sessionId_1, body_1) {
+        return __awaiter(this, arguments, void 0, function* (sessionId, body, maxWaitMsec = -1, options) {
+            const startMsec = Date.now();
+            const dto = (yield new client_1.ExportApi(this.configuration).computeExports(sessionId, body, options)).data;
+            const waitMsec = Date.now() - startMsec;
+            maxWaitMsec = maxWaitMsec < 0 ? maxWaitMsec : Math.max(0, maxWaitMsec - waitMsec);
+            return this.waitForExportResult(sessionId, body, dto, maxWaitMsec, options);
+        });
+    }
+    waitForOutputResult(sessionId, dto, maxWaitMsec, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!dto.outputs)
+                return dto;
+            const outputVersions = {};
+            Object.keys(dto.outputs).forEach((id) => (outputVersions[id] = dto.outputs[id].version));
+            let delay = this.getMaxOutputDelay(dto);
+            const startMsec = Date.now();
+            while (delay > 0) {
+                if (maxWaitMsec >= 0) {
+                    const waitMsec = Date.now() - startMsec;
+                    if (waitMsec >= maxWaitMsec) {
+                        throw new error_1.TimeoutError(`Maximum wait time of ${maxWaitMsec} ms reached`);
+                    }
+                    if (waitMsec + delay > maxWaitMsec) {
+                        delay = maxWaitMsec - waitMsec;
+                    }
+                }
+                yield (0, utils_1.sleep)(delay);
+                dto = (yield new client_1.OutputApi(this.configuration).getCachedOutputs(sessionId, outputVersions, options)).data;
+                delay = this.getMaxOutputDelay(dto);
+            }
+            return dto;
+        });
+    }
+    waitForExportResult(sessionId, body, dto, maxWaitMsec, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let delay = this.getMaxExportDelay(body, dto);
+            const startMsec = Date.now();
+            while (delay > 0) {
+                if (maxWaitMsec >= 0) {
+                    const waitMsec = Date.now() - startMsec;
+                    if (waitMsec >= maxWaitMsec) {
+                        throw new error_1.TimeoutError(`Maximum wait time of ${maxWaitMsec} ms reached`);
+                    }
+                    if (waitMsec + delay > maxWaitMsec) {
+                        delay = maxWaitMsec - waitMsec;
+                    }
+                }
+                yield (0, utils_1.sleep)(delay);
+                dto = (yield new client_1.ExportApi(this.configuration).getCachedExports(sessionId, body, options)).data;
+                delay = this.getMaxExportDelay(body, dto);
+            }
+            return dto;
+        });
+    }
+    getMaxOutputDelay(dto) {
+        var _a;
+        return Math.max(...Object.values((_a = dto.outputs) !== null && _a !== void 0 ? _a : {}).map((output) => { var _a; return (_a = output.delay) !== null && _a !== void 0 ? _a : -1; }), -1);
+    }
+    getMaxExportDelay(body, dto) {
+        var _a, _b, _c, _d;
+        const exports = (_a = body.exports) !== null && _a !== void 0 ? _a : [];
+        const outputs = (_b = body.outputs) !== null && _b !== void 0 ? _b : [];
+        return Math.max(...Object.values((_c = dto.exports) !== null && _c !== void 0 ? _c : {})
+            .filter((e) => exports.includes(e.id))
+            .map((e) => { var _a; return (_a = e.delay) !== null && _a !== void 0 ? _a : -1; }), ...Object.values((_d = dto.outputs) !== null && _d !== void 0 ? _d : {})
+            .filter((o) => outputs.includes(o.id))
+            .map((o) => { var _a; return (_a = o.delay) !== null && _a !== void 0 ? _a : -1; }), -1);
+    }
+    buildRequest(method, url, data, options = {}) {
+        return (basePath = '') => {
+            var _a, _b, _c;
+            const baseOptions = (_b = (_a = this.configuration) === null || _a === void 0 ? void 0 : _a.baseOptions) !== null && _b !== void 0 ? _b : {};
+            const baseHeaders = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            const reqOptions = Object.assign(Object.assign({ method }, baseOptions), options);
+            reqOptions.headers = Object.assign(Object.assign({}, baseHeaders), options.headers);
+            if (!reqOptions.data && data) {
+                const configuration = (_c = this.configuration) !== null && _c !== void 0 ? _c : new client_1.Configuration();
+                reqOptions.data = (0, common_1.serializeDataIfNeeded)(data, reqOptions, configuration);
+            }
+            const axiosArgs = { url, options: reqOptions };
+            return (0, common_1.createRequestFunction)(axiosArgs, this.axios, basePath, this.configuration).bind(this.axios);
+        };
+    }
+    disableAuthHeaderForShapeDiverUris(url, options) {
+        var _a;
+        options = Object.assign({}, options);
+        if (!((_a = options.headers) === null || _a === void 0 ? void 0 : _a.Authorization) &&
+            (cdnAssetUri.test(url) || directDownloadUri.test(url)))
+            options.headers = Object.assign({ Authorization: undefined }, options.headers);
+    }
+}
+exports.UtilsApi = UtilsApi;
+//# sourceMappingURL=UtilsApi.js.map

package/dist/UtilsApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UtilsApi.js","sourceRoot":"","sources":["../src/UtilsApi.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,4CAA+E;AAC/E,qCAekB;AAClB,wCAAqD;AACrD,mCAAgE;AAChE,mCAA6D;AAG7D,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AACxD,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AACxD,MAAM,kBAAkB,GAAG,8BAA8B,CAAC;AAG1D,MAAM,WAAW,GAAG,8CAA8C,CAAC;AACnE,MAAM,iBAAiB,GAAG,2BAA2B,CAAC;AACtD,MAAM,iBAAiB,GAAG,2BAA2B,CAAC;AACtD,MAAM,kBAAkB,GAAG,4BAA4B,CAAC;AAGxD,MAAM,iBAAiB,GAAG,uEAAuE,CAAC;AAElG,MAAa,QAAS,SAAQ,cAAO;IACjC,YAAY,aAA6B,EAAE,QAAiB,EAAE,KAAqB;QAC/E,KAAK,CAAC,aAAa,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;IAUM,MAAM,CACT,GAAW,EACX,IAAuD,EACvD,WAAmB,EACnB,QAAiB,EACjB,OAA+B;QAG/B,MAAM,UAAU,GAA2B;YACvC,aAAa,EAAE,SAAS;YACxB,cAAc,EAAE,WAAW;SAC9B,CAAC;QACF,IAAI,QAAQ;YAAE,UAAU,CAAC,qBAAqB,CAAC,GAAG,IAAA,sCAA8B,EAAC,QAAQ,CAAC,CAAC;QAE3F,MAAM,UAAU,qBAA+B,OAAO,CAAE,CAAC;QACzD,UAAU,CAAC,OAAO,mCAAQ,UAAU,GAAK,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAE,CAAC;QAE5D,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC;QAClE,OAAO,OAAO,EAAE,CAAC;IACrB,CAAC;IASM,WAAW,CACd,GAAW,EACX,IAAuD,EACvD,OAA8B,EAC9B,OAA+B;QAG/B,MAAM,UAAU,GAA2B;YACvC,aAAa,EAAE,SAAS;YACxB,cAAc,EAAE,OAAO,CAAC,WAAW;SACtC,CAAC;QACF,IAAI,OAAO,CAAC,kBAAkB;YAC1B,UAAU,CAAC,qBAAqB,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC;QAEnE,MAAM,UAAU,qBAA+B,OAAO,CAAE,CAAC;QACzD,UAAU,CAAC,OAAO,mCAAQ,UAAU,GAAK,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAE,CAAC;QAE5D,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC;QAClE,OAAO,OAAO,EAAE,CAAC;IACrB,CAAC;IAOM,QAAQ,CAAC,GAAW,EAAE,OAA+B;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC;QACzD,OAAO,OAAO,EAAE,CAAC;IACrB,CAAC;IASM,aAAa,CAChB,GAAW,EACX,OAA+B;QAE/B,IAAI,IAAqC,CAAC;QAC1C,IAAI,CAAC,kCAAkC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAGtD,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,IAAI,GAAG,QAAQ,CAAC;aAC3E,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,IAAI,GAAG,QAAQ,CAAC;aAChF,IAAI,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,IAAI,GAAG,SAAS,CAAC;aACnF,CAAC;YACF,MAAM,IAAI,4BAAoB,CAC1B,oCAAoC,GAAG,6CAA6C,CACvF,CAAC;QACN,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IASM,aAAa,CAChB,SAAiB,EACjB,GAAW,EACX,OAA+B;QAE/B,IAAI,CAAC,kCAAkC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAEtD,IACI,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC;YAC5B,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC;YAC5B,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,EAC7B,CAAC;YAEC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC;aAAM,CAAC;YAEJ,OAAO,IAAI,kBAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,aAAa,CAAC,SAAS,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QACpF,CAAC;IACL,CAAC;IAUY,sBAAsB;6DAC/B,SAAiB,EACjB,IAAsB,EACtB,WAAW,GAAG,CAAC,CAAC,EAChB,OAA+B;YAE/B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,MAAM,GAAG,GAAG,CACR,MAAM,IAAI,kBAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CACnF,CAAC,IAAI,CAAC;YACP,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YAGxC,WAAW,GAAG,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC,CAAC;YAElF,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAC1E,CAAC;KAAA;IAUY,sBAAsB;6DAC/B,SAAiB,EACjB,IAAe,EACf,WAAW,GAAG,CAAC,CAAC,EAChB,OAA+B;YAE/B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,MAAM,GAAG,GAAG,CACR,MAAM,IAAI,kBAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CACnF,CAAC,IAAI,CAAC;YACP,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YAGxC,WAAW,GAAG,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC,CAAC;YAElF,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAChF,CAAC;KAAA;IAUa,mBAAmB,CAC7B,SAAiB,EACjB,GAAsB,EACtB,WAAmB,EACnB,OAA+B;;YAE/B,IAAI,CAAC,GAAG,CAAC,OAAO;gBAAE,OAAO,GAAG,CAAC;YAG7B,MAAM,cAAc,GAAa,EAAE,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAC5B,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC,GAAI,GAAG,CAAC,OAAQ,CAAC,EAAE,CAAe,CAAC,OAAO,CAAC,CACzE,CAAC;YAEF,IAAI,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE7B,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;gBAEf,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;oBACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;oBACxC,IAAI,QAAQ,IAAI,WAAW,EAAE,CAAC;wBAC1B,MAAM,IAAI,oBAAY,CAAC,wBAAwB,WAAW,aAAa,CAAC,CAAC;oBAC7E,CAAC;oBACD,IAAI,QAAQ,GAAG,KAAK,GAAG,WAAW,EAAE,CAAC;wBACjC,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAC;oBACnC,CAAC;gBACL,CAAC;gBAED,MAAM,IAAA,aAAK,EAAC,KAAK,CAAC,CAAC;gBAGnB,GAAG,GAAG,CACF,MAAM,IAAI,kBAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,gBAAgB,CACpD,SAAS,EACT,cAAc,EACd,OAAO,CACV,CACJ,CAAC,IAAI,CAAC;gBACP,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACxC,CAAC;YAED,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAWa,mBAAmB,CAC7B,SAAiB,EACjB,IAAe,EACf,GAAsB,EACtB,WAAmB,EACnB,OAA+B;;YAE/B,IAAI,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE7B,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;gBAEf,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;oBACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;oBACxC,IAAI,QAAQ,IAAI,WAAW,EAAE,CAAC;wBAC1B,MAAM,IAAI,oBAAY,CAAC,wBAAwB,WAAW,aAAa,CAAC,CAAC;oBAC7E,CAAC;oBACD,IAAI,QAAQ,GAAG,KAAK,GAAG,WAAW,EAAE,CAAC;wBACjC,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAC;oBACnC,CAAC;gBACL,CAAC;gBAED,MAAM,IAAA,aAAK,EAAC,KAAK,CAAC,CAAC;gBAGnB,GAAG,GAAG,CACF,MAAM,IAAI,kBAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CACrF,CAAC,IAAI,CAAC;gBACP,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAC9C,CAAC;YAED,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAOO,iBAAiB,CAAC,GAA4C;;QAClE,OAAO,IAAI,CAAC,GAAG,CACX,GAAG,MAAM,CAAC,MAAM,CAAC,MAAA,GAAG,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,WAAC,OAAA,MAAC,MAAoB,CAAC,KAAK,mCAAI,CAAC,CAAC,CAAA,EAAA,CAAC,EACtF,CAAC,CAAC,CACL,CAAC;IACN,CAAC;IAQO,iBAAiB,CACrB,IAAe,EACf,GAA4C;;QAE5C,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,EAAE,CAAC;QAEnC,OAAO,IAAI,CAAC,GAAG,CACX,GAAG,MAAM,CAAC,MAAM,CAAC,MAAA,GAAG,CAAC,OAAO,mCAAI,EAAE,CAAC;aAC9B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;aACrC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,WAAC,OAAA,MAAC,CAAe,CAAC,KAAK,mCAAI,CAAC,CAAC,CAAA,EAAA,CAAC,EAC7C,GAAG,MAAM,CAAC,MAAM,CAAC,MAAA,GAAG,CAAC,OAAO,mCAAI,EAAE,CAAC;aAC9B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;aACrC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,WAAC,OAAA,MAAC,CAAe,CAAC,KAAK,mCAAI,CAAC,CAAC,CAAA,EAAA,CAAC,EAC7C,CAAC,CAAC,CACL,CAAC;IACN,CAAC;IAUO,YAAY,CAChB,MAAc,EACd,GAAW,EACX,IAAS,EACT,UAAiC,EAAE;QAEnC,OAAO,CAAC,WAAmB,EAAE,EAAE,EAAE;;YAC7B,MAAM,WAAW,GAAG,MAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,WAAW,mCAAI,EAAE,CAAC;YAC1D,MAAM,WAAW,GAAG,WAAW,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAElF,MAAM,UAAU,iCAAK,MAAM,IAAK,WAAW,GAAK,OAAO,CAAE,CAAC;YAC1D,UAAU,CAAC,OAAO,mCAAQ,WAAW,GAAK,OAAO,CAAC,OAAO,CAAE,CAAC;YAC5D,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;gBAG3B,MAAM,aAAa,GAAG,MAAA,IAAI,CAAC,aAAa,mCAAI,IAAI,sBAAa,EAAE,CAAC;gBAChE,UAAU,CAAC,IAAI,GAAG,IAAA,8BAAqB,EAAC,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;YAC7E,CAAC;YAED,MAAM,SAAS,GAAgB,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;YAC5D,OAAO,IAAA,8BAAqB,EAAC,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAClF,IAAI,CAAC,KAAK,CACb,CAAC;QACN,CAAC,CAAC;IACN,CAAC;IAGO,kCAAkC,CACtC,GAAW,EACX,OAA+B;;QAE/B,OAAO,qBAAQ,OAAO,CAAE,CAAC;QACzB,IACI,CAAC,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,aAAa,CAAA;YAC/B,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEtD,OAAO,CAAC,OAAO,mBAAK,aAAa,EAAE,SAAS,IAAK,OAAO,CAAC,OAAO,CAAE,CAAC;IAC3E,CAAC;CACJ;AApWD,4BAoWC"}