@shapediver/sdk.geometry-api-sdk-v2 2.1.0 → 2.2.0

package/README.md

@@ -108,30 +108,44 @@ The SDK provides a helper function to extract ShapeDiver error information from
 ```typescript
 import {
   processError,
-  SdError,
-  SdRequestError,
-  SdResponseError,
+  SdGeometryError,
+  RequestError,
+  ResponseError,
 } from "@shapediver/sdk.geometry-api-sdk-v2"
 
 try {
   sdk.model.get("be5d4ce5-f76d-417d-8496-1f038e6f0cab")
-catch (err) {
+} 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 (e instanceof SdGeometryError) {
+    /*
+     * Generic ShapeDiver error.
+     *
+     * Generic errors are the base class of all custom ShapeDiver errors, like RequestError,
+     * ResponseError, IllegalArgumentError, TimeoutError, etc.
+     *
+     * Warning:
+     *  Generic Axios errors (non-request/response errors) that are thrown when setting up the
+     *  request are not converted into a SdGeometryError!
+     */
   }
 
-  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 (e instanceof RequestError) {
+    /*
+     * Wrapper around an Axios request error.
+     *
+     * In this case, the request was made but no response was received.
+     */
   }
 
-  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 (e instanceof ResponseError) {
+    /*
+     * Wrapper around an Axios 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.
+     */
   }
 }
 ```

package/dist/configuration.d.ts

@@ -6,7 +6,7 @@ export interface ConfigurationParameters extends Pick<ClientConfigParams, 'acces
     maxRetries?: number;
 }
 export declare class Configuration extends ClientConfig {
-    protected readonly sdkVersion = "2.1.0";
+    protected readonly sdkVersion = "2.2.0";
     readonly useCustomAxios: boolean;
     readonly maxRetries: number;
     constructor(param?: ConfigurationParameters);

package/dist/configuration.js

@@ -6,7 +6,7 @@ class Configuration extends configuration_1.Configuration {
     constructor(param = {}) {
         var _a, _b, _c, _d;
         super(param);
-        this.sdkVersion = '2.1.0';
+        this.sdkVersion = '2.2.0';
         this.useCustomAxios = (_a = param.useCustomAxios) !== null && _a !== void 0 ? _a : true;
         this.maxRetries = (_b = param.maxRetries) !== null && _b !== void 0 ? _b : 5;
         this.baseOptions = (_c = this.baseOptions) !== null && _c !== void 0 ? _c : {};

package/dist/error.d.ts

@@ -1,21 +1,21 @@
 import { ResErrorType } from './client';
-export declare class SdError extends Error {
-    constructor(message: string);
+export declare class SdGeometryError extends Error {
+    constructor(message?: string);
 }
-export declare class SdRequestError extends Error {
+export declare class RequestError extends SdGeometryError {
     constructor(message: string);
 }
-export declare class SdResponseError extends Error {
+export declare class ResponseError extends SdGeometryError {
     readonly status: number;
     readonly type: ResErrorType;
     readonly description: string;
     constructor(status: number, message: string, desc: string, type?: string);
 }
-export declare class IllegalArgumentError extends Error {
+export declare class IllegalArgumentError extends SdGeometryError {
     field: string;
     constructor(field: string, msg?: string);
 }
-export declare class TimeoutError extends Error {
+export declare class TimeoutError extends SdGeometryError {
     field: string;
     constructor(field: string, msg?: string);
 }

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAUxC,qBAAa,OAAQ,SAAQ,KAAK;gBAClB,OAAO,EAAE,MAAM;CAI9B;AAUD,qBAAa,cAAe,SAAQ,KAAK;gBACzB,OAAO,EAAE,MAAM;CAI9B;AAWD,qBAAa,eAAgB,SAAQ,KAAK;IAEtC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAG/B,SAAgB,IAAI,EAAE,YAAY,CAAC;IAGnC,SAAgB,WAAW,EAAE,MAAM,CAAC;gBAExB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;CAU3E;AAOD,qBAAa,oBAAqB,SAAQ,KAAK;IAEhC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM,EACpB,GAAG,CAAC,EAAE,MAAM;CAKnB;AAOD,qBAAa,YAAa,SAAQ,KAAK;IAExB,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM,EACpB,GAAG,CAAC,EAAE,MAAM;CAKnB"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAUxC,qBAAa,eAAgB,SAAQ,KAAK;gBAC1B,OAAO,CAAC,EAAE,MAAM;CAI/B;AAUD,qBAAa,YAAa,SAAQ,eAAe;gBACjC,OAAO,EAAE,MAAM;CAI9B;AAWD,qBAAa,aAAc,SAAQ,eAAe;IAE9C,SAAgB,MAAM,EAAE,MAAM,CAAC;IAG/B,SAAgB,IAAI,EAAE,YAAY,CAAC;IAGnC,SAAgB,WAAW,EAAE,MAAM,CAAC;gBAExB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;CAU3E;AAOD,qBAAa,oBAAqB,SAAQ,eAAe;IAE1C,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM,EACpB,GAAG,CAAC,EAAE,MAAM;CAKnB;AAOD,qBAAa,YAAa,SAAQ,eAAe;IAElC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM,EACpB,GAAG,CAAC,EAAE,MAAM;CAKnB"}

package/dist/error.js

@@ -1,25 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimeoutError = exports.IllegalArgumentError = exports.SdResponseError = exports.SdRequestError = exports.SdError = void 0;
+exports.TimeoutError = exports.IllegalArgumentError = exports.ResponseError = exports.RequestError = exports.SdGeometryError = void 0;
 const client_1 = require("./client");
-class SdError extends Error {
+class SdGeometryError extends Error {
     constructor(message) {
         super(message);
-        this.name = 'SdError';
+        this.name = 'SdGeometryError';
     }
 }
-exports.SdError = SdError;
-class SdRequestError extends Error {
+exports.SdGeometryError = SdGeometryError;
+class RequestError extends SdGeometryError {
     constructor(message) {
         super(message);
-        this.name = 'SdRequestError';
+        this.name = 'RequestError';
     }
 }
-exports.SdRequestError = SdRequestError;
-class SdResponseError extends Error {
+exports.RequestError = RequestError;
+class ResponseError extends SdGeometryError {
     constructor(status, message, desc, type) {
         super(message);
-        this.name = 'SdResponseError';
+        this.name = 'ResponseError';
         this.status = status;
         this.description = desc;
         this.type =
@@ -28,8 +28,8 @@ class SdResponseError extends Error {
                 : client_1.ResErrorType.UNKNOWN;
     }
 }
-exports.SdResponseError = SdResponseError;
-class IllegalArgumentError extends Error {
+exports.ResponseError = ResponseError;
+class IllegalArgumentError extends SdGeometryError {
     constructor(field, msg) {
         super(msg);
         this.field = field;
@@ -37,7 +37,7 @@ class IllegalArgumentError extends Error {
     }
 }
 exports.IllegalArgumentError = IllegalArgumentError;
-class TimeoutError extends Error {
+class TimeoutError extends SdGeometryError {
     constructor(field, msg) {
         super(msg);
         this.field = field;

package/dist/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";;;AAAA,qCAAwC;AAUxC,MAAa,OAAQ,SAAQ,KAAK;IAC9B,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;IAC1B,CAAC;CACJ;AALD,0BAKC;AAUD,MAAa,cAAe,SAAQ,KAAK;IACrC,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;IACjC,CAAC;CACJ;AALD,wCAKC;AAWD,MAAa,eAAgB,SAAQ,KAAK;IAUtC,YAAY,MAAc,EAAE,OAAe,EAAE,IAAY,EAAE,IAAa;QACpE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI;YACL,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,qBAAY,CAAC,CAAC,QAAQ,CAAC,IAAoB,CAAC;gBAC9D,CAAC,CAAE,IAAqB;gBACxB,CAAC,CAAC,qBAAY,CAAC,OAAO,CAAC;IACnC,CAAC;CACJ;AApBD,0CAoBC;AAOD,MAAa,oBAAqB,SAAQ,KAAK;IAC3C,YACW,KAAa,EACpB,GAAY;QAEZ,KAAK,CAAC,GAAG,CAAC,CAAC;QAHJ,UAAK,GAAL,KAAK,CAAQ;QAIpB,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACvC,CAAC;CACJ;AARD,oDAQC;AAOD,MAAa,YAAa,SAAQ,KAAK;IACnC,YACW,KAAa,EACpB,GAAY;QAEZ,KAAK,CAAC,GAAG,CAAC,CAAC;QAHJ,UAAK,GAAL,KAAK,CAAQ;QAIpB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC/B,CAAC;CACJ;AARD,oCAQC"}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";;;AAAA,qCAAwC;AAUxC,MAAa,eAAgB,SAAQ,KAAK;IACtC,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAClC,CAAC;CACJ;AALD,0CAKC;AAUD,MAAa,YAAa,SAAQ,eAAe;IAC7C,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC/B,CAAC;CACJ;AALD,oCAKC;AAWD,MAAa,aAAc,SAAQ,eAAe;IAU9C,YAAY,MAAc,EAAE,OAAe,EAAE,IAAY,EAAE,IAAa;QACpE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI;YACL,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,qBAAY,CAAC,CAAC,QAAQ,CAAC,IAAoB,CAAC;gBAC9D,CAAC,CAAE,IAAqB;gBACxB,CAAC,CAAC,qBAAY,CAAC,OAAO,CAAC;IACnC,CAAC;CACJ;AApBD,sCAoBC;AAOD,MAAa,oBAAqB,SAAQ,eAAe;IACrD,YACW,KAAa,EACpB,GAAY;QAEZ,KAAK,CAAC,GAAG,CAAC,CAAC;QAHJ,UAAK,GAAL,KAAK,CAAQ;QAIpB,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACvC,CAAC;CACJ;AARD,oDAQC;AAOD,MAAa,YAAa,SAAQ,eAAe;IAC7C,YACW,KAAa,EACpB,GAAY;QAEZ,KAAK,CAAC,GAAG,CAAC,CAAC;QAHJ,UAAK,GAAL,KAAK,CAAQ;QAIpB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC/B,CAAC;CACJ;AARD,oCAQC"}

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
 import { AxiosError, AxiosPromise } from 'axios';
-import { SdError, SdRequestError, SdResponseError } from './error';
+import { RequestError, ResponseError } from './error';
 export declare function sleep(ms: number): Promise<void>;
 export declare function extractFileInfo(headers: Record<string, any> | undefined): {
     size: number | undefined;
@@ -8,5 +8,5 @@ export declare function extractFileInfo(headers: Record<string, any> | undefined
 export declare function contentDispositionFromFilename(filename: string): string;
 export declare function filenameFromContentDisposition(contentDisposition: string): string | undefined;
 export declare function exists(apiCall: () => AxiosPromise<unknown>): Promise<boolean>;
-export declare function processError(error: AxiosError | Error): SdError | SdRequestError | SdResponseError;
+export declare function processError(error: AxiosError | Error): Error | RequestError | ResponseError;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAGnE,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;AAOD,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,GAAG;IACvE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAcA;AAOD,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAWvE;AAQD,wBAAgB,8BAA8B,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAmB7F;AAUD,wBAAsB,MAAM,CAAC,OAAO,EAAE,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAOnF;AAMD,wBAAgB,YAAY,CACxB,KAAK,EAAE,UAAU,GAAG,KAAK,GAC1B,OAAO,GAAG,cAAc,GAAG,eAAe,CAyB5C"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAGtD,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;AAOD,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,GAAG;IACvE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAcA;AAOD,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAWvE;AAQD,wBAAgB,8BAA8B,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAmB7F;AAUD,wBAAsB,MAAM,CAAC,OAAO,EAAE,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAOnF;AAOD,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,YAAY,GAAG,aAAa,CAyB5F"}

package/dist/utils.js

@@ -77,17 +77,17 @@ function processError(error) {
             typeof data.error === 'string' &&
             'message' in data &&
             typeof data.message === 'string') {
-            return new error_1.SdResponseError(status, data.message, data.desc, data.error);
+            return new error_1.ResponseError(status, data.message, data.desc, data.error);
         }
         else {
-            return new error_1.SdResponseError(status, err.message, 'No error description provided');
+            return new error_1.ResponseError(status, err.message, 'No error description provided');
         }
     }
     else if ('request' in error) {
-        return new error_1.SdRequestError(error.message);
+        return new error_1.RequestError(error.message);
     }
     else {
-        return new error_1.SdError(error.message);
+        return error;
     }
 }
 //# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,sBAEC;AAOD,0CAiBC;AAOD,wEAWC;AAQD,wEAmBC;AAUD,wBAOC;AAMD,oCA2BC;AA5HD,mCAAmE;AAGnE,SAAgB,KAAK,CAAC,EAAU;IAC5B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC7D,CAAC;AAOD,SAAgB,eAAe,CAAC,OAAwC;IAIpE,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IAG9D,MAAM,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7E,MAAM,IAAI,GAAG,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAGjE,MAAM,kBAAkB,GAAG,OAAO,CAAC,qBAAqB,CAAC,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC5F,MAAM,QAAQ,GAAG,kBAAkB;QAC/B,CAAC,CAAC,8BAA8B,CAAC,kBAAkB,CAAC;QACpD,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAOD,SAAgB,8BAA8B,CAAC,QAAgB;IAE3D,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAC1E,IAAI,MAAM,GAAG,yBAAyB,SAAS,GAAG,CAAC;IAEnD,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,IAAI,sBAAsB,UAAU,EAAE,CAAC;IACjD,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAQD,SAAgB,8BAA8B,CAAC,kBAA0B;IACrE,IAAI,QAA4B,CAAC;IACjC,IAAI,YAAgC,CAAC;IAGrC,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACrE,IAAI,aAAa;QAAE,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAG/C,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAClF,IAAI,iBAAiB,EAAE,CAAC;QACpB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACvE,MAAM,eAAe,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;YAC1C,YAAY,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAC3D,CAAC;IAGD,OAAO,YAAY,IAAI,QAAQ,CAAC;AACpC,CAAC;AAUD,SAAsB,MAAM,CAAC,OAAoC;;QAC7D,OAAO,OAAO,EAAE;aACX,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;aAChB,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;;YACb,IAAI,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,MAAM,MAAK,GAAG;gBAAE,OAAO,KAAK,CAAC;YACjD,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;CAAA;AAMD,SAAgB,YAAY,CACxB,KAAyB;IAEzB,IAAI,UAAU,IAAI,KAAK,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,KAAmB,EAC3B,MAAM,GAAG,GAAG,CAAC,QAAS,CAAC,MAAM,EAC7B,IAAI,GAAG,GAAG,CAAC,QAAS,CAAC,IAAI,CAAC;QAE9B,IACI,IAAI;YACJ,OAAO,IAAI,KAAK,QAAQ;YACxB,MAAM,IAAI,IAAI;YACd,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;YAC7B,OAAO,IAAI,IAAI;YACf,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;YAC9B,SAAS,IAAI,IAAI;YACjB,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,EAClC,CAAC;YACC,OAAO,IAAI,uBAAe,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,uBAAe,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE,+BAA+B,CAAC,CAAC;QACrF,CAAC;IACL,CAAC;SAAM,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;QAC5B,OAAO,IAAI,sBAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;SAAM,CAAC;QACJ,OAAO,IAAI,eAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;AACL,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,sBAEC;AAOD,0CAiBC;AAOD,wEAWC;AAQD,wEAmBC;AAUD,wBAOC;AAOD,oCAyBC;AA3HD,mCAAsD;AAGtD,SAAgB,KAAK,CAAC,EAAU;IAC5B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC7D,CAAC;AAOD,SAAgB,eAAe,CAAC,OAAwC;IAIpE,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IAG9D,MAAM,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7E,MAAM,IAAI,GAAG,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAGjE,MAAM,kBAAkB,GAAG,OAAO,CAAC,qBAAqB,CAAC,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC5F,MAAM,QAAQ,GAAG,kBAAkB;QAC/B,CAAC,CAAC,8BAA8B,CAAC,kBAAkB,CAAC;QACpD,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAOD,SAAgB,8BAA8B,CAAC,QAAgB;IAE3D,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAC1E,IAAI,MAAM,GAAG,yBAAyB,SAAS,GAAG,CAAC;IAEnD,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,IAAI,sBAAsB,UAAU,EAAE,CAAC;IACjD,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAQD,SAAgB,8BAA8B,CAAC,kBAA0B;IACrE,IAAI,QAA4B,CAAC;IACjC,IAAI,YAAgC,CAAC;IAGrC,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACrE,IAAI,aAAa;QAAE,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAG/C,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAClF,IAAI,iBAAiB,EAAE,CAAC;QACpB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACvE,MAAM,eAAe,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;YAC1C,YAAY,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAC3D,CAAC;IAGD,OAAO,YAAY,IAAI,QAAQ,CAAC;AACpC,CAAC;AAUD,SAAsB,MAAM,CAAC,OAAoC;;QAC7D,OAAO,OAAO,EAAE;aACX,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;aAChB,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;;YACb,IAAI,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,MAAM,MAAK,GAAG;gBAAE,OAAO,KAAK,CAAC;YACjD,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;IACX,CAAC;CAAA;AAOD,SAAgB,YAAY,CAAC,KAAyB;IAClD,IAAI,UAAU,IAAI,KAAK,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,KAAmB,EAC3B,MAAM,GAAG,GAAG,CAAC,QAAS,CAAC,MAAM,EAC7B,IAAI,GAAG,GAAG,CAAC,QAAS,CAAC,IAAI,CAAC;QAE9B,IACI,IAAI;YACJ,OAAO,IAAI,KAAK,QAAQ;YACxB,MAAM,IAAI,IAAI;YACd,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;YAC7B,OAAO,IAAI,IAAI;YACf,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;YAC9B,SAAS,IAAI,IAAI;YACjB,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,EAClC,CAAC;YACC,OAAO,IAAI,qBAAa,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,qBAAa,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE,+BAA+B,CAAC,CAAC;QACnF,CAAC;IACL,CAAC;SAAM,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;QAC5B,OAAO,IAAI,oBAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACJ,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shapediver/sdk.geometry-api-sdk-v2",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "description": "SDK to communicate with the Geometry API version 2",
     "keywords": [
         "shapediver",
@@ -46,6 +46,7 @@
         "axios": "~1.7.7"
     },
     "devDependencies": {
+        "axios-mock-adapter": "~2.1.0",
         "jest": "~29.7.0",
         "lerna": "8.1.8",
         "typescript": "~5.5.4",

package/src/configuration.ts

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

package/src/error.ts

@@ -1,17 +1,17 @@
 import { ResErrorType } from './client';
 
 /**
- * Represents a generic (non-request and non-response) error.
+ * Represents a generic ShapeDiver error.
  *
  * Something happened in setting up the request that triggered an Error.
  * @export
- * @class SdError
+ * @class SdGeometryError
  * @extends {Error}
  */
-export class SdError extends Error {
-    constructor(message: string) {
+export class SdGeometryError extends Error {
+    constructor(message?: string) {
         super(message);
-        this.name = 'SdError';
+        this.name = 'SdGeometryError';
     }
 }
 
@@ -20,13 +20,13 @@ export class SdError extends Error {
  *
  * The request was made but no response was received.
  * @export
- * @class SdRequestError
- * @extends {Error}
+ * @class RequestError
+ * @extends {SdGeometryError}
  */
-export class SdRequestError extends Error {
+export class RequestError extends SdGeometryError {
     constructor(message: string) {
         super(message);
-        this.name = 'SdRequestError';
+        this.name = 'RequestError';
     }
 }
 
@@ -36,10 +36,10 @@ export class SdRequestError extends Error {
  * The request was made and the server responded with a status code that falls out of the range of
  * 2xx.
  * @export
- * @class SdResponseError
- * @extends {Error}
+ * @class ResponseError
+ * @extends {SdGeometryError}
  */
-export class SdResponseError extends Error {
+export class ResponseError extends SdGeometryError {
     /** The HTTP status code from the server response. */
     public readonly status: number;
 
@@ -51,7 +51,7 @@ export class SdResponseError extends Error {
 
     constructor(status: number, message: string, desc: string, type?: string) {
         super(message);
-        this.name = 'SdResponseError';
+        this.name = 'ResponseError';
         this.status = status;
         this.description = desc;
         this.type =
@@ -64,9 +64,9 @@ export class SdResponseError extends Error {
 /**
  * @export
  * @class IllegalArgumentError
- * @extends {Error}
+ * @extends {SdGeometryError}
  */
-export class IllegalArgumentError extends Error {
+export class IllegalArgumentError extends SdGeometryError {
     constructor(
         public field: string,
         msg?: string
@@ -79,9 +79,9 @@ export class IllegalArgumentError extends Error {
 /**
  * @export
  * @class TimeoutError
- * @extends {Error}
+ * @extends {SdGeometryError}
  */
-export class TimeoutError extends Error {
+export class TimeoutError extends SdGeometryError {
     constructor(
         public field: string,
         msg?: string

package/src/utils.ts

@@ -1,5 +1,5 @@
 import { AxiosError, AxiosPromise } from 'axios';
-import { SdError, SdRequestError, SdResponseError } from './error';
+import { RequestError, ResponseError } from './error';
 
 /** Delays the response for the given number of milliseconds */
 export function sleep(ms: number): Promise<void> {
@@ -93,12 +93,11 @@ export async function exists(apiCall: () => AxiosPromise<unknown>): Promise<bool
 }
 
 /**
- * Converts a generic Axios error into a more specific ShapeDiver error.
+ * 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
-): SdError | SdRequestError | SdResponseError {
+export function processError(error: AxiosError | Error): Error | RequestError | ResponseError {
     if ('response' in error) {
         const err = error as AxiosError,
             status = err.response!.status,
@@ -114,13 +113,13 @@ export function processError(
             'message' in data &&
             typeof data.message === 'string'
         ) {
-            return new SdResponseError(status, data.message, data.desc, data.error);
+            return new ResponseError(status, data.message, data.desc, data.error);
         } else {
-            return new SdResponseError(status, err.message, 'No error description provided');
+            return new ResponseError(status, err.message, 'No error description provided');
         }
     } else if ('request' in error) {
-        return new SdRequestError(error.message);
+        return new RequestError(error.message);
     } else {
-        return new SdError(error.message);
+        return error;
     }
 }