@shapediver/sdk.geometry-api-sdk-v2 2.10.0 → 3.1.0

package/src/client/base.ts

@@ -4,7 +4,7 @@
  * Geometry Backend API v2
  * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
  *
- * The version of the OpenAPI document: 1.13.0
+ * The version of the OpenAPI document: 2.0.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,10 +21,6 @@ import globalAxios from 'axios';
 
 export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
 
-/**
- *
- * @export
- */
 export const COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
@@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = {
     pipes: "|",
 };
 
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
 
-/**
- *
- * @export
- * @class BaseAPI
- */
 export class BaseAPI {
     protected configuration: Configuration | undefined;
 
@@ -58,12 +44,6 @@ export class BaseAPI {
     }
 };
 
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export class RequiredError extends Error {
     constructor(public field: string, msg?: string) {
         super(msg);
@@ -78,9 +58,5 @@ interface ServerMap {
     }[];
 }
 
-/**
- *
- * @export
- */
 export const operationServerMap: ServerMap = {
 }

package/src/client/common.ts

@@ -4,7 +4,7 @@
  * Geometry Backend API v2
  * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
  *
- * The version of the OpenAPI document: 1.13.0
+ * The version of the OpenAPI document: 2.0.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,22 +12,16 @@
  * Do not edit the class manually.
  */
 
-
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
 import { RequiredError } from "./base";
 
-/**
- *
- * @export
- */
 export const DUMMY_BASE_URL = 'https://example.com'
 
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
     if (paramValue === null || paramValue === undefined) {
@@ -35,10 +29,6 @@ export const assertParamExists = function (functionName: string, paramName: stri
     }
 }
 
-/**
- *
- * @export
- */
 export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -48,20 +38,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri
     }
 }
 
-/**
- *
- * @export
- */
 export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 }
 
-/**
- *
- * @export
- */
 export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -71,10 +53,6 @@ export const setBearerAuthToObject = async function (object: any, configuration?
     }
 }
 
-/**
- *
- * @export
- */
 export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -84,42 +62,35 @@ export const setOAuthToObject = async function (object: any, name: string, scope
     }
 }
 
+
 function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
     if (parameter == null) return;
     if (typeof parameter === "object") {
         if (Array.isArray(parameter)) {
             (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
-        } 
+        }
         else {
-            Object.keys(parameter).forEach(currentKey => 
+            Object.keys(parameter).forEach(currentKey =>
                 setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
             );
         }
-    } 
+    }
     else {
         if (urlSearchParams.has(key)) {
             urlSearchParams.append(key, parameter);
-        } 
+        }
         else {
             urlSearchParams.set(key, parameter);
         }
     }
 }
 
-/**
- *
- * @export
- */
 export const setSearchParams = function (url: URL, ...objects: any[]) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
     url.search = searchParams.toString();
 }
 
-/**
- *
- * @export
- */
 export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any,
         : (value || "");
 }
 
-/**
- *
- * @export
- */
 export const toPathString = function (url: URL) {
     return url.pathname + url.search + url.hash
 }
 
-/**
- *
- * @export
- */
 export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
     return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
         const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};

package/src/client/configuration.ts

@@ -1,10 +1,9 @@
 /* tslint:disable */
-/* eslint-disable */
 /**
  * Geometry Backend API v2
  * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
  *
- * The version of the OpenAPI document: 1.13.0
+ * The version of the OpenAPI document: 2.0.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,12 +11,24 @@
  * Do not edit the class manually.
  */
 
+interface AWSv4Configuration {
+  options?: {
+    region?: string
+    service?: string
+  }
+  credentials?: {
+    accessKeyId?: string
+    secretAccessKey?: string,
+    sessionToken?: string
+  }
+}
 
 export interface ConfigurationParameters {
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     username?: string;
     password?: string;
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
     basePath?: string;
     serverIndex?: number;
     baseOptions?: any;
@@ -28,49 +39,43 @@ export class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
-     * override base path
-     *
-     * @type {string}
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
      * @memberof Configuration
      */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**
@@ -87,6 +92,7 @@ export class Configuration {
         this.username = param.username;
         this.password = param.password;
         this.accessToken = param.accessToken;
+        this.awsv4 = param.awsv4;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
         this.baseOptions = {

package/src/client/index.ts

@@ -4,7 +4,7 @@
  * Geometry Backend API v2
  * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
  *
- * The version of the OpenAPI document: 1.13.0
+ * The version of the OpenAPI document: 2.0.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/configuration.ts

@@ -34,7 +34,7 @@ export interface ConfigurationParameters
 }
 
 export class Configuration extends ClientConfig {
-    protected readonly sdkVersion = '2.10.0'; // WARNING: This value is updated automatically!
+    protected readonly sdkVersion = '3.1.0'; // WARNING: This value is updated automatically!
 
     public readonly useCustomAxios: boolean;
     public readonly maxRetries: number;

package/src/utils.ts

@@ -1,6 +1,13 @@
 import { AxiosError, AxiosPromise } from 'axios';
 import { RequestError, ResponseError } from './error';
 
+/** ShapeDiver error object structure. */
+type SdErrorObject = {
+    error: string;
+    desc: string;
+    message: string;
+};
+
 /** Delays the response for the given number of milliseconds */
 export function sleep(ms: number): Promise<void> {
     return new Promise((resolve) => setTimeout(resolve, ms));
@@ -92,28 +99,81 @@ export async function exists(apiCall: () => AxiosPromise<unknown>): Promise<bool
         });
 }
 
+/** Type Guard for the ShapeDiver error data object. */
+function isErrorObject(value: unknown): value is SdErrorObject {
+    if (!value || typeof value !== 'object' || Array.isArray(value)) return false;
+
+    const obj = value as Record<string, unknown>;
+    return (
+        typeof obj.error === 'string' &&
+        typeof obj.desc === 'string' &&
+        typeof obj.message === 'string'
+    );
+}
+
+/** Helper function that wraps JSON.parse and returns undefined on failure. */
+async function tryParseJson(
+    input: string | (() => string) | (() => Promise<string>)
+): Promise<unknown | undefined> {
+    try {
+        const text = typeof input === 'function' ? await input() : input;
+        return JSON.parse(text);
+    } catch {
+        return undefined;
+    }
+}
+
+function isArrayBuffer(value: unknown): value is ArrayBuffer {
+    return Object.prototype.toString.call(value) === '[object ArrayBuffer]';
+}
+
+function isArrayBufferView(value: unknown): value is ArrayBufferView {
+    return ArrayBuffer.isView(value);
+}
+
+/**
+ * Tries to extract an error object from various Axios response data types.
+ * @param data The data to extract from.
+ * @returns The extracted error object, or undefined if none could be found.
+ */
+export async function tryExtractErrorObject(data: unknown): Promise<SdErrorObject | undefined> {
+    let candidate: unknown;
+
+    if (typeof data === 'string') {
+        candidate = await tryParseJson(data);
+    } else if (isArrayBufferView(data)) {
+        candidate = await tryParseJson(() =>
+            new TextDecoder().decode(new Uint8Array(data.buffer, data.byteOffset, data.byteLength))
+        );
+    } else if (isArrayBuffer(data)) {
+        candidate = await tryParseJson(() => new TextDecoder().decode(new Uint8Array(data)));
+    } else if (typeof Blob !== 'undefined' && data instanceof Blob) {
+        candidate = await tryParseJson(async () => await data.text());
+    } else {
+        candidate = data;
+    }
+
+    return isErrorObject(candidate)
+        ? { error: candidate.error, desc: candidate.desc, message: candidate.message }
+        : undefined;
+}
+
 /**
  * Tries to convert a generic Axios error into a more specific ShapeDiver error. When no match is
  * found, the original error is returned instead.
  * @param error The Axios error to convert.
  */
-export function processError(error: AxiosError | Error): Error | RequestError | ResponseError {
+export async function processError(
+    error: AxiosError | Error
+): Promise<Error | RequestError | ResponseError> {
     if ('response' in error) {
         const err = error as AxiosError,
             status = err.response!.status,
             data = err.response!.data;
 
-        if (
-            data &&
-            typeof data === 'object' &&
-            'desc' in data &&
-            typeof data.desc === 'string' &&
-            'error' in data &&
-            typeof data.error === 'string' &&
-            'message' in data &&
-            typeof data.message === 'string'
-        ) {
-            return new ResponseError(status, data.message, data.desc, data.error);
+        const errorObj = await tryExtractErrorObject(data);
+        if (errorObj) {
+            return new ResponseError(status, errorObj.message, errorObj.desc, errorObj.error);
         } else {
             return new ResponseError(status, err.message, 'No error description provided');
         }