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

package/src/client/base.ts

@@ -0,0 +1,86 @@
+/* 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.6.1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from './configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+
+export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration | undefined;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath ?? basePath;
+        }
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    constructor(public field: string, msg?: string) {
+        super(msg);
+        this.name = "RequiredError"
+    }
+}
+
+interface ServerMap {
+    [key: string]: {
+        url: string,
+        description: string,
+    }[];
+}
+
+/**
+ *
+ * @export
+ */
+export const operationServerMap: ServerMap = {
+}

package/src/client/common.ts

@@ -0,0 +1,150 @@
+/* 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.6.1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * 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) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @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'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+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 => 
+                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
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (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};
+        return axios.request<T, R>(axiosRequestArgs);
+    };
+}

package/src/client/configuration.ts

@@ -0,0 +1,110 @@
+/* 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.6.1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+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>);
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+
+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}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = param.baseOptions;
+        this.formDataCtor = param.formDataCtor;
+    }
+
+    /**
+     * 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.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}

package/src/client/index.ts

@@ -0,0 +1,18 @@
+/* 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.6.1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+

package/src/configuration.ts

@@ -0,0 +1,27 @@
+import {
+    Configuration as ClientConfig,
+    ConfigurationParameters as ClientConfigParams,
+} from './client/configuration';
+
+export interface ConfigurationParameters extends ClientConfigParams {}
+
+export class Configuration extends ClientConfig {
+    protected readonly sdkVersion = '2.0.0'; // WARNING: This value is updated automatically!
+
+    constructor(param: ConfigurationParameters = {}) {
+        super(param);
+
+        this.baseOptions = this.baseOptions ?? {};
+        this.baseOptions.headers = this.baseOptions.headers ?? {};
+
+        const userAgent = `sd-sdk/typescript/${this.sdkVersion}`;
+
+        if (typeof process === 'object' && !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;
+        }
+    }
+}

package/src/error.ts

@@ -0,0 +1,92 @@
+import { ResErrorType } from './client';
+
+/**
+ * Represents a generic (non-request and non-response) error.
+ *
+ * Something happened in setting up the request that triggered an Error.
+ * @export
+ * @class SdError
+ * @extends {Error}
+ */
+export class SdError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = 'SdError';
+    }
+}
+
+/**
+ * This error builds on top of an Axios request error.
+ *
+ * The request was made but no response was received.
+ * @export
+ * @class SdRequestError
+ * @extends {Error}
+ */
+export class SdRequestError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = 'SdRequestError';
+    }
+}
+
+/**
+ * This error builds on top of an Axios response 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}
+ */
+export class SdResponseError extends Error {
+    /** The HTTP status code from the server response. */
+    public readonly status: number;
+
+    /** The type of the error. */
+    public readonly type: ResErrorType;
+
+    /** General description of the error type. */
+    public readonly description: string;
+
+    constructor(status: number, message: string, desc: string, type?: string) {
+        super(message);
+        this.name = 'SdResponseError';
+        this.status = status;
+        this.description = desc;
+        this.type =
+            type && Object.values(ResErrorType).includes(type as ResErrorType)
+                ? (type as ResErrorType)
+                : ResErrorType.UNKNOWN;
+    }
+}
+
+/**
+ * @export
+ * @class IllegalArgumentError
+ * @extends {Error}
+ */
+export class IllegalArgumentError extends Error {
+    constructor(
+        public field: string,
+        msg?: string
+    ) {
+        super(msg);
+        this.name = 'IllegalArgumentError';
+    }
+}
+
+/**
+ * @export
+ * @class TimeoutError
+ * @extends {Error}
+ */
+export class TimeoutError extends Error {
+    constructor(
+        public field: string,
+        msg?: string
+    ) {
+        super(msg);
+        this.name = 'TimeoutError';
+    }
+}

package/src/index.ts

@@ -1,17 +1,5 @@
-export * from "@shapediver/api.geometry-api-dto-v2";
-export {
-  ShapeDiverError,
-  ShapeDiverRequestError,
-  ShapeDiverSdkApiResponseType,
-  ShapeDiverSdkConfig,
-  ShapeDiverSdkConfigType,
-} from "@shapediver/sdk.geometry-api-sdk-core";
-export { ShapeDiverResponseError } from "./ShapeDiverErrors";
-export { ShapeDiverSdk, create } from "./ShapeDiverSdk";
-export { ShapeDiverResponseFileInfo } from "./resources/ShapeDiverFileApi";
-export {
-  isGBError,
-  isGBGenericError,
-  isGBRequestError,
-  isGBResponseError,
-} from "./utils/utils";
+export * from './client/api';
+export * from './UtilsApi';
+export * from './configuration';
+export * from './error';
+export * from './utils';

package/src/utils.ts

@@ -0,0 +1,126 @@
+import { AxiosError, AxiosPromise } from 'axios';
+import { SdError, SdRequestError, SdResponseError } from './error';
+
+/** Delays the response for the given number of milliseconds */
+export function sleep(ms: number): Promise<void> {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+/**
+ * Parse HTTP headers to extract size and filename information.
+ * @param {Record<string, any>} 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): {
+    size: number | undefined;
+    filename: string | undefined;
+} {
+    if (!headers) return { size: undefined, filename: undefined };
+
+    // Extract size from Content-Length header
+    const contentLength = headers['Content-Length'] || headers['content-length'];
+    const size = contentLength ? parseInt(contentLength) : undefined;
+
+    // Extract filename from Content-Disposition header
+    const contentDisposition = headers['Content-Disposition'] || headers['content-disposition'];
+    const filename = contentDisposition
+        ? filenameFromContentDisposition(contentDisposition)
+        : undefined;
+
+    return { size, filename };
+}
+
+/**
+ * Set content headers according to RFC 5987.
+ * @param {string} filename The file name to use.
+ * @return A content-disposition header string.
+ */
+export function contentDispositionFromFilename(filename: string): string {
+    // Normalize the filename to ASCII
+    const asciiName = filename.normalize('NFKD').replace(/[^\x00-\x7F]/g, ''); // Transliterates to ASCII
+    let header = `attachment; filename="${asciiName}"`;
+
+    if (asciiName !== filename) {
+        const quotedName = encodeURIComponent(filename);
+        header += `; filename*=UTF-8''${quotedName}`;
+    }
+
+    return header;
+}
+
+/**
+ * Extract and return the filename from a content-disposition HTTP header.
+ * Decodes the `filename*` property if set.
+ * @param {string} contentDisposition Content-Disposition header value.
+ * @return The extracted filename.
+ */
+export function filenameFromContentDisposition(contentDisposition: string): string | undefined {
+    let filename: string | undefined;
+    let filenameStar: string | undefined;
+
+    // Search for filename
+    const filenameMatch = contentDisposition.match(/filename="([^"]+)"/);
+    if (filenameMatch) filename = filenameMatch[1];
+
+    // Search for filename*
+    const filenameStarMatch = contentDisposition.match(/filename\*=([^'']+''|)?(.+)/);
+    if (filenameStarMatch) {
+        const encoding = filenameStarMatch[1] ? filenameStarMatch[1] : 'utf-8';
+        const encodedFilename = filenameStarMatch[2];
+        if (encoding.toLowerCase().startsWith('utf-8'))
+            filenameStar = decodeURIComponent(encodedFilename);
+    }
+
+    // Prefer filename* over filename
+    return filenameStar || filename;
+}
+
+/**
+ * Helper function to check if an API call succeeded. This is useful for `metadata` endpoints when
+ * we want to check if a resource exists or not.
+ *
+ * @param apiCall The API call to execute.
+ * @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> {
+    return apiCall()
+        .then(() => true)
+        .catch((error) => {
+            if (error.response?.status === 404) return false;
+            throw error;
+        });
+}
+
+/**
+ * Converts a generic Axios error into a more specific ShapeDiver error.
+ * @param error The Axios error to convert.
+ */
+export function processError(
+    error: AxiosError | Error
+): SdError | SdRequestError | SdResponseError {
+    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 SdResponseError(status, data.message, data.desc, data.error);
+        } else {
+            return new SdResponseError(status, err.message, 'No error description provided');
+        }
+    } else if ('request' in error) {
+        return new SdRequestError(error.message);
+    } else {
+        return new SdError(error.message);
+    }
+}

package/dist/ShapeDiverErrors.d.ts

@@ -1,10 +0,0 @@
-import { ShapeDiverResponseError as ShapeDiverResponseErrorDto, ShapeDiverResponseErrorType } from "@shapediver/api.geometry-api-dto-v2";
-import { ShapeDiverError, ShapeDiverErrorType, ShapeDiverResponseError as ShapeDiverResponseErrorCore } from "@shapediver/sdk.geometry-api-sdk-core";
-export declare class ShapeDiverResponseError extends ShapeDiverError implements ShapeDiverResponseErrorDto {
-    readonly errorType: ShapeDiverErrorType;
-    readonly status: number;
-    readonly error: ShapeDiverResponseErrorType;
-    readonly desc: string;
-    constructor(e: ShapeDiverResponseErrorCore);
-}
-//# sourceMappingURL=ShapeDiverErrors.d.ts.map

package/dist/ShapeDiverErrors.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ShapeDiverErrors.d.ts","sourceRoot":"","sources":["../src/ShapeDiverErrors.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,IAAI,0BAA0B,EACrD,2BAA2B,EAC5B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,uBAAuB,IAAI,2BAA2B,EACvD,MAAM,uCAAuC,CAAC;AAG/C,qBAAa,uBACX,SAAQ,eACR,YAAW,0BAA0B;IAErC,SAAgB,SAAS,EAAE,mBAAmB,CAAgC;IAE9E,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,KAAK,EAAE,2BAA2B,CAAC;IACnD,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEjB,CAAC,EAAE,2BAA2B;CAY3C"}

package/dist/ShapeDiverErrors.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShapeDiverResponseError = void 0;
-const api_geometry_api_dto_v2_1 = require("@shapediver/api.geometry-api-dto-v2");
-const sdk_geometry_api_sdk_core_1 = require("@shapediver/sdk.geometry-api-sdk-core");
-class ShapeDiverResponseError extends sdk_geometry_api_sdk_core_1.ShapeDiverError {
-    constructor(e) {
-        super(e.message);
-        this.errorType = sdk_geometry_api_sdk_core_1.ShapeDiverErrorType.Response;
-        this.status = e.status;
-        this.desc = e.desc;
-        this.error = Object.values(api_geometry_api_dto_v2_1.ShapeDiverResponseErrorType).includes(e.error)
-            ? e.error
-            : api_geometry_api_dto_v2_1.ShapeDiverResponseErrorType.UNKNOWN;
-    }
-}
-exports.ShapeDiverResponseError = ShapeDiverResponseError;
-//# sourceMappingURL=ShapeDiverErrors.js.map

package/dist/ShapeDiverErrors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ShapeDiverErrors.js","sourceRoot":"","sources":["../src/ShapeDiverErrors.ts"],"names":[],"mappings":";;;AAAA,iFAG6C;AAC7C,qFAI+C;AAG/C,MAAa,uBACX,SAAQ,2CAAe;IASvB,YAAY,CAA8B;QACxC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAPH,cAAS,GAAwB,+CAAmB,CAAC,QAAQ,CAAC;QAS5E,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;QAEnB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,qDAA2B,CAAC,CAAC,QAAQ,CAC9D,CAAC,CAAC,KAAY,CACf;YACC,CAAC,CAAE,CAAC,CAAC,KAAqC;YAC1C,CAAC,CAAC,qDAA2B,CAAC,OAAO,CAAC;IAC1C,CAAC;CACF;AAtBD,0DAsBC"}