@shapediver/sdk.geometry-api-sdk-v2 3.7.0 → 4.0.0

package/src/client/runtime.ts

@@ -0,0 +1,442 @@
+/* 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: 2.5.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
+
+export interface ConfigurationParameters {
+    basePath?: string; // override base path
+    fetchApi?: FetchAPI; // override for fetch implementation
+    middleware?: Middleware[]; // middleware to apply before/after fetch requests
+    queryParamsStringify?: (params: HTTPQuery) => string; // stringify function for query strings
+    username?: string; // parameter for basic security
+    password?: string; // parameter for basic security
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>); // parameter for apiKey security
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>); // parameter for oauth2 security
+    headers?: HTTPHeaders; //header params we want to use on every request
+    credentials?: RequestCredentials; //value for the credentials param we want to use on each request
+}
+
+export class Configuration {
+    constructor(private configuration: ConfigurationParameters = {}) {}
+
+    set config(configuration: Configuration) {
+        this.configuration = configuration;
+    }
+
+    get basePath(): string {
+        return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
+    }
+
+    get fetchApi(): FetchAPI | undefined {
+        return this.configuration.fetchApi;
+    }
+
+    get middleware(): Middleware[] {
+        return this.configuration.middleware || [];
+    }
+
+    get queryParamsStringify(): (params: HTTPQuery) => string {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+
+    get username(): string | undefined {
+        return this.configuration.username;
+    }
+
+    get password(): string | undefined {
+        return this.configuration.password;
+    }
+
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === 'function' ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === 'function' ? accessToken : async () => accessToken;
+        }
+        return undefined;
+    }
+
+    get headers(): HTTPHeaders | undefined {
+        return this.configuration.headers;
+    }
+
+    get credentials(): RequestCredentials | undefined {
+        return this.configuration.credentials;
+    }
+}
+
+export const DefaultConfig = new Configuration();
+
+/**
+ * This is the base class for all generated API classes.
+ */
+export class BaseAPI {
+
+    private static readonly jsonRegex = /^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$/i;
+    private middleware: Middleware[];
+
+    constructor(protected configuration = DefaultConfig) {
+        this.middleware = configuration.middleware;
+    }
+
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]) {
+        const next = this.clone<T>();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware<T>(...middlewares);
+    }
+
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware<T>(...middlewares);
+    }
+
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean {
+        if (!mime) {
+            return false;
+        }
+        return BaseAPI.jsonRegex.test(mime);
+    }
+
+    protected async request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response> {
+        const { url, init } = await this.createFetchParams(context, initOverrides);
+        const response = await this.fetchApi(url, init);
+        if (response && (response.status >= 200 && response.status < 300)) {
+            return response;
+        }
+        throw new ResponseError(response, 'Response returned an error code');
+    }
+
+    private async createFetchParams(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction) {
+        let url = this.configuration.basePath + context.path;
+        if (context.query !== undefined && Object.keys(context.query).length !== 0) {
+            // only add the querystring to the URL if there are query parameters.
+            // this is done to avoid urls ending with a "?" character which buggy webservers
+            // do not handle correctly sometimes.
+            url += '?' + this.configuration.queryParamsStringify(context.query);
+        }
+
+        const headers = Object.assign({}, this.configuration.headers, context.headers);
+        Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
+
+        const initOverrideFn =
+            typeof initOverrides === "function"
+                ? initOverrides
+                : async () => initOverrides;
+
+        const initParams = {
+            method: context.method,
+            headers,
+            body: context.body,
+            credentials: this.configuration.credentials,
+        };
+
+        const overriddenInit: RequestInit = {
+            ...initParams,
+            ...(await initOverrideFn({
+                init: initParams,
+                context,
+            }))
+        };
+
+        let body: any;
+        if (isFormData(overriddenInit.body)
+            || (overriddenInit.body instanceof URLSearchParams)
+            || isBlob(overriddenInit.body)) {
+          body = overriddenInit.body;
+        } else if (this.isJsonMime(headers['Content-Type'])) {
+          body = JSON.stringify(overriddenInit.body);
+        } else {
+          body = overriddenInit.body;
+        }
+
+        const init: RequestInit = {
+            ...overriddenInit,
+            body
+        };
+
+        return { url, init };
+    }
+
+    protected fetchApi = async (url: string, init: RequestInit) => {
+        let fetchParams = { url, init };
+        for (const middleware of this.middleware) {
+            if (middleware.pre) {
+                fetchParams = await middleware.pre({
+                    fetch: this.fetchApi,
+                    ...fetchParams,
+                }) || fetchParams;
+            }
+        }
+        let response: Response | undefined = undefined;
+        try {
+            response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+        } catch (e) {
+            for (const middleware of this.middleware) {
+                if (middleware.onError) {
+                    response = await middleware.onError({
+                        fetch: this.fetchApi,
+                        url: fetchParams.url,
+                        init: fetchParams.init,
+                        error: e,
+                        response: response ? response.clone() : undefined,
+                    }) || response;
+                }
+            }
+            if (response === undefined) {
+              if (e instanceof Error) {
+                throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+              } else {
+                throw e;
+              }
+            }
+        }
+        for (const middleware of this.middleware) {
+            if (middleware.post) {
+                response = await middleware.post({
+                    fetch: this.fetchApi,
+                    url: fetchParams.url,
+                    init: fetchParams.init,
+                    response: response.clone(),
+                }) || response;
+            }
+        }
+        return response;
+    }
+
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone<T extends BaseAPI>(this: T): T {
+        const constructor = this.constructor as any;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+};
+
+function isBlob(value: any): value is Blob {
+    return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+
+function isFormData(value: any): value is FormData {
+    return typeof FormData !== "undefined" && value instanceof FormData;
+}
+
+export class ResponseError extends Error {
+    override name: "ResponseError" = "ResponseError";
+    constructor(public response: Response, msg?: string) {
+        super(msg);
+
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+
+export class FetchError extends Error {
+    override name: "FetchError" = "FetchError";
+    constructor(public cause: Error, msg?: string) {
+        super(msg);
+
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+
+export class RequiredError extends Error {
+    override name: "RequiredError" = "RequiredError";
+    constructor(public field: string, msg?: string) {
+        super(msg);
+
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = { [key: string]: string };
+export type HTTPQuery = { [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery };
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = { headers?: HTTPHeaders; method: HTTPMethod; credentials?: RequestCredentials; body?: HTTPBody };
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+
+export type InitOverrideFunction = (requestContext: { init: HTTPRequestInit, context: RequestOpts }) => Promise<RequestInit>
+
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+
+export function querystring(params: HTTPQuery, prefix: string = ''): string {
+    return Object.keys(params)
+        .map(key => querystringSingleKey(key, params[key], prefix))
+        .filter(part => part.length > 0)
+        .join('&');
+}
+
+function querystringSingleKey(key: string, value: string | number | null | undefined | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery, keyPrefix: string = ''): string {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value as HTTPQuery, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+
+export function exists(json: any, key: string) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+
+
+export function canConsumeForm(consumes: Consume[]): boolean {
+    for (const consume of consumes) {
+        if (consume.contentType?.startsWith('multipart/form-data') == true) {
+            return true;
+        }
+    }
+    return false;
+}
+
+export interface Consume {
+    contentType: string;
+}
+
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+
+export class JSONApiResponse<T> {
+    constructor(public raw: Response, private transformer: ResponseTransformer<T> = (jsonValue: any) => jsonValue) {}
+
+    async value(): Promise<T> {
+        return this.transformer(await this.raw.json());
+    }
+}
+
+export class VoidApiResponse {
+    constructor(public raw: Response) {}
+
+    async value(): Promise<void> {
+        return undefined;
+    }
+}
+
+export class BlobApiResponse {
+    constructor(public raw: Response) {}
+
+    async value(): Promise<Blob> {
+        return await this.raw.blob();
+    };
+}
+
+export class TextApiResponse {
+    constructor(public raw: Response) {}
+
+    async value(): Promise<string> {
+        return await this.raw.text();
+    };
+}

package/src/configuration.ts

@@ -1,32 +1,16 @@
-import { RawAxiosRequestConfig } from 'axios';
 import {
     Configuration as ClientConfig,
     ConfigurationParameters as ClientConfigParams,
-} from './client/configuration';
+} from './client/runtime';
 
-export interface ConfigurationParameters
-    extends Pick<ClientConfigParams, 'accessToken' | 'basePath'> {
-    /**
-     * Base options for Axios calls.
-     *
-     * @type {RawAxiosRequestConfig}
-     * @memberof ConfigurationParameters
-     */
-    baseOptions?: RawAxiosRequestConfig;
-
-    /**
-     * Enables the use of a custom Axios instance for all API requests by default, instead of the
-     * global Axios instance. This custom instance includes additional functionality to
-     * automatically retry requests on `429` and `502` status codes.
-     *
-     * Default: `true`.
-     */
-    useCustomAxios?: boolean;
+const SDK_VERSION = '4.0.0'; // WARNING: This value is updated automatically!
 
+export interface ConfigurationParameters
+    extends Pick<ClientConfigParams, 'accessToken' | 'basePath' | 'fetchApi' | 'headers' | 'middleware' | 'queryParamsStringify'> {
     /**
      * Specifies the maximum number of automatic HTTP retries for failed requests.
      *
-     * **Note:** This setting is only applicable when using a custom Axios instance.
+     * **Note:** This setting is only applicable when using a custom Fetch API instance.
      *
      * Default: `5`
      */
@@ -34,29 +18,38 @@ export interface ConfigurationParameters
 }
 
 export class Configuration extends ClientConfig {
-    protected readonly sdkVersion = '3.7.0'; // WARNING: This value is updated automatically!
-
-    public readonly useCustomAxios: boolean;
-    public readonly maxRetries: number;
+    readonly maxRetries: number;
 
     constructor(param: ConfigurationParameters = {}) {
-        super(param);
-        this.useCustomAxios = param.useCustomAxios ?? true;
-        this.maxRetries = param.maxRetries ?? 5;
+        super({
+            ...param,
+            headers: createHeaders(param.headers),
+        });
 
-        this.baseOptions = this.baseOptions ?? {};
-        this.baseOptions.headers = this.baseOptions.headers ?? {};
+        this.maxRetries = param.maxRetries ?? 5;
+    }
+}
 
-        const userAgent = `sd-sdk/typescript/${this.sdkVersion}`;
+function createHeaders(
+    headers?: ClientConfigParams['headers'],
+): Record<string, string> {
+    const result: Record<string, string> = {};
+    const normalizedHeaders = new Headers(headers);
+    const userAgent = `sd-sdk/typescript/${SDK_VERSION}`;
 
-        if (detectRuntime() === "node" && !this.baseOptions.headers['User-Agent']) {
-            // Overwrite User-Agent on Node.js applications.
-            this.baseOptions.headers['User-Agent'] = userAgent;
-        } else if (!this.baseOptions.headers['X-ShapeDiver-UserAgent']) {
-            // Set a custom User-Agent header on Browser applications.
-            this.baseOptions.headers['X-ShapeDiver-UserAgent'] = userAgent;
-        }
+    if (detectRuntime() === "node" && !normalizedHeaders.has('User-Agent')) {
+        // Overwrite User-Agent on Node.js applications.
+        normalizedHeaders.set('User-Agent', userAgent);
+    } else if (!normalizedHeaders.has('X-ShapeDiver-UserAgent')) {
+        // Set a custom User-Agent header on Browser applications.
+        normalizedHeaders.set('X-ShapeDiver-UserAgent', userAgent);
     }
+
+    normalizedHeaders.forEach((value, key) => {
+        result[key] = value;
+    });
+
+    return result;
 }
 
 function detectRuntime(): "node" | "browser" | "unknown" {

package/src/error.ts

@@ -16,7 +16,7 @@ export class SdGeometryError extends Error {
 }
 
 /**
- * This error builds on top of an Axios request error.
+ * This error builds on top of an Fetch request error.
  *
  * The request was made but no response was received.
  * @export
@@ -31,7 +31,7 @@ export class RequestError extends SdGeometryError {
 }
 
 /**
- * This error builds on top of an Axios response error.
+ * This error builds on top of an Fetch response error.
  *
  * The request was made and the server responded with a status code that falls out of the range of
  * 2xx.

package/src/index.ts

@@ -1,4 +1,5 @@
-export * from './client/api';
+export * from './client/apis';
+export * from './client/models';
 export * from './UtilsApi';
 export * from './configuration';
 export * from './error';

package/src/utils.ts

@@ -1,4 +1,7 @@
-import { AxiosError, AxiosPromise } from 'axios';
+import {
+    FetchError,
+    ResponseError as ClientResponseError,
+} from './client/runtime';
 import { RequestError, ResponseError } from './error';
 
 /** ShapeDiver error object structure. */
@@ -15,7 +18,7 @@ export function sleep(ms: number): Promise<void> {
 
 /**
  * Parse HTTP headers to extract size and filename information.
- * @param {Record<string, any>} headers The HTTP headers of a file-metadata response.
+ * @param headers The HTTP headers of a file-metadata response.
  * @return An object with 'size' and 'filename' properties.
  */
 export function extractFileInfo(headers: Record<string, any> | undefined): {
@@ -39,7 +42,7 @@ export function extractFileInfo(headers: Record<string, any> | undefined): {
 
 /**
  * Set content headers according to RFC 5987.
- * @param {string} filename The file name to use.
+ * @param filename The file name to use.
  * @return A content-disposition header string.
  */
 export function contentDispositionFromFilename(filename: string): string {
@@ -58,7 +61,7 @@ export function contentDispositionFromFilename(filename: string): string {
 /**
  * Extract and return the filename from a content-disposition HTTP header.
  * Decodes the `filename*` property if set.
- * @param {string} contentDisposition Content-Disposition header value.
+ * @param contentDisposition Content-Disposition header value.
  * @return The extracted filename.
  */
 export function filenameFromContentDisposition(contentDisposition: string): string | undefined {
@@ -90,7 +93,7 @@ export function filenameFromContentDisposition(contentDisposition: string): stri
  * @returns A promise that resolves to `true` if the API call resulted in a `200` HTTP status, and
  * `false` for a `404` HTTP error status. Any other error status will be propagated.
  */
-export async function exists(apiCall: () => AxiosPromise<unknown>): Promise<boolean> {
+export async function exists(apiCall: () => Promise<unknown>): Promise<boolean> {
     return apiCall()
         .then(() => true)
         .catch((error) => {
@@ -132,7 +135,7 @@ function isArrayBufferView(value: unknown): value is ArrayBufferView {
 }
 
 /**
- * Tries to extract an error object from various Axios response data types.
+ * Tries to extract an error object from various Fetch response data types.
  * @param data The data to extract from.
  * @returns The extracted error object, or undefined if none could be found.
  */
@@ -159,27 +162,52 @@ export async function tryExtractErrorObject(data: unknown): Promise<SdErrorObjec
 }
 
 /**
- * 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.
+ * Converts a Fetch response or generated Fetch error into a ShapeDiver error.
+ *
+ * Fetch resolves HTTP failures as `Response` objects and rejects only when the
+ * request cannot be completed. The generated runtime wraps those rejections in
+ * `FetchError`, which lets ordinary setup errors remain unchanged.
+ *
+ * @param error The response or error to convert.
  */
 export async function processError(
-    error: AxiosError | Error
+    error: Response | Error
 ): Promise<Error | RequestError | ResponseError> {
-    if ('response' in error) {
-        const err = error as AxiosError,
-            status = err.response!.status,
-            data = err.response!.data;
-
-        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');
-        }
-    } else if ('request' in error) {
-        return new RequestError(error.message);
-    } else {
-        return error;
+    if (error instanceof ClientResponseError) {
+        return processResponseError(error.response, error.message);
+    }
+
+    if (typeof Response !== 'undefined' && error instanceof Response) {
+        return processResponseError(
+            error,
+            error.statusText || 'Response returned an error code'
+        );
     }
+
+    if (error instanceof FetchError) {
+        return new RequestError(error.cause.message);
+    }
+
+    return error instanceof Error ? error : new Error(String(error));
+}
+
+/** Converts a non-success Fetch response into the SDK's public response error. */
+async function processResponseError(
+    response: Response,
+    fallbackMessage: string
+): Promise<ResponseError> {
+    const errorObj = await tryExtractErrorObject(await response.clone().text());
+
+    return errorObj
+        ? new ResponseError(
+              response.status,
+              errorObj.message,
+              errorObj.desc,
+              errorObj.error
+          )
+        : new ResponseError(
+              response.status,
+              fallbackMessage,
+              'No error description provided'
+          );
 }