@shapediver/sdk.platform-api-sdk-v1 1.14.16

package/dist/api/SdPlatformSdkApi.d.ts

@@ -0,0 +1,63 @@
+import { RequestId } from "./SdPlatformRequestId";
+import { SdPlatformSdkConfig } from "./SdPlatformSdkConfig";
+export interface SdPlatformSdkRequestConfig {
+    /** Bearer token for "Authorization: Bearer {access_token}" header, takes precedence over basic_access_token */
+    access_token?: string | null;
+    /** Basic HTTP authentication token used for "Authorization: Basic {basic_access_token}" header, used by some webhooks */
+    basic_access_token?: string | null;
+    /** Client id to be set as X-ShapeDiver-Client header */
+    client_id?: string | null;
+    /** Username for basic HTTP authentication, takes precedence over basic_access_token */
+    username?: string | null | undefined;
+    /** Password for basic HTTP authentication, takes precedence over basic_access_token */
+    password?: string | null | undefined;
+}
+/**
+ * Event type for request start event callbacks.
+ */
+export interface SdPlatformRequestStartEvent {
+    /** Identifier for type of request */
+    readonly id: RequestId;
+    readonly requestParams: {
+        method?: string;
+        url?: string;
+        data?: any;
+    };
+}
+/**
+ * Event type for request finished event callbacks.
+ */
+export interface SdPlatformRequestFinishedEvent extends SdPlatformRequestStartEvent {
+    readonly response: {
+        status: number;
+        data: any;
+    };
+}
+/**
+ * Base API used by the authentication API and the ShapeDiver Platform resource APIs.
+ */
+export declare class SdPlatformSdkApi {
+    private __config;
+    private __onRequestStart;
+    private __onRequestFinished;
+    constructor(__config: SdPlatformSdkConfig);
+    private __toQueryString;
+    private __resolveRequest;
+    private __afterRequest;
+    private __fetch;
+    /**
+     * Register callbacks for request start events.
+     * @param cb
+     */
+    onRequestStart(cb: (event: SdPlatformRequestStartEvent) => void): void;
+    /**
+     * Register callbacks for request finished events.
+     * @param cb
+     */
+    onRequestFinished(cb: (event: SdPlatformRequestFinishedEvent) => void): void;
+    get<T>(id: RequestId, url: string, config: SdPlatformSdkRequestConfig, queryParams?: object): Promise<T>;
+    post<T>(id: RequestId, url: string, data: any, config: SdPlatformSdkRequestConfig): Promise<T>;
+    patch<T>(id: RequestId, url: string, data: any, config: SdPlatformSdkRequestConfig): Promise<T>;
+    delete<T>(id: RequestId, url: string, config: SdPlatformSdkRequestConfig): Promise<T>;
+}
+//# sourceMappingURL=SdPlatformSdkApi.d.ts.map

package/dist/api/SdPlatformSdkApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SdPlatformSdkApi.d.ts","sourceRoot":"","sources":["../../src/api/SdPlatformSdkApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAY5D,MAAM,WAAW,0BAA0B;IAEvC,+GAA+G;IAC/G,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,yHAAyH;IACzH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,uFAAuF;IACvF,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC,uFAAuF;IACvF,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAExC,qCAAqC;IACrC,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC;IACvB,QAAQ,CAAC,aAAa,EAAE;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,GAAG,CAAC;KACd,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,2BAA2B;IAE/E,QAAQ,CAAC,QAAQ,EAAE;QACf,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,GAAG,CAAC;KACb,CAAC;CACL;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAKb,OAAO,CAAC,QAAQ;IAH5B,OAAO,CAAC,gBAAgB,CAA2D;IACnF,OAAO,CAAC,mBAAmB,CAA8D;gBAErE,QAAQ,EAAE,mBAAmB;IAIjD,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,gBAAgB;IA0CxB,OAAO,CAAC,cAAc;YAyBR,OAAO;IA0CrB;;;OAGG;IACI,cAAc,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,2BAA2B,KAAK,IAAI,GAAG,IAAI;IAK7E;;;OAGG;IACI,iBAAiB,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,8BAA8B,KAAK,IAAI,GAAG,IAAI;IAKtE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,0BAA0B,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAexG,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,CAAC,CAAC;IAc9F,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,CAAC,CAAC;IAa/F,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,CAAC,CAAC;CAYrG"}

package/dist/api/SdPlatformSdkConfig.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Configuration of an instance of the platform SDK.
+ */
+export declare class SdPlatformSdkConfig {
+    /** Client id to use */
+    clientId?: string | null | undefined;
+    /** Client secret to use */
+    clientSecret?: string | null | undefined;
+    /** Base URL of the ShapeDiver Platform Backend */
+    baseUrl?: string | null | undefined;
+    constructor(
+    /** Client id to use */
+    clientId?: string | null | undefined, 
+    /** Client secret to use */
+    clientSecret?: string | null | undefined, 
+    /** Base URL of the ShapeDiver Platform Backend */
+    baseUrl?: string | null | undefined);
+}
+//# sourceMappingURL=SdPlatformSdkConfig.d.ts.map

package/dist/api/SdPlatformSdkConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SdPlatformSdkConfig.d.ts","sourceRoot":"","sources":["../../src/api/SdPlatformSdkConfig.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,mBAAmB;IAGxB,uBAAuB;IAChB,QAAQ,CAAC;IAChB,2BAA2B;IACpB,YAAY,CAAC;IACpB,kDAAkD;IAC3C,OAAO,CAAC;;IALf,uBAAuB;IAChB,QAAQ,CAAC,2BAAe;IAC/B,2BAA2B;IACpB,YAAY,CAAC,2BAAe;IACnC,kDAAkD;IAC3C,OAAO,CAAC,2BAAc;CAGpC"}

package/dist/api/SdPlatformSdkErrorMapping.d.ts

@@ -0,0 +1,29 @@
+import { AxiosError } from "axios";
+import { SdPlatformError } from "../SdPlatformErrors";
+/**
+ * The OAuth error response, returned by server when oauth request fails
+ */
+export interface OAuthErrorResponse {
+    readonly error: string;
+    readonly error_description: string;
+    readonly error_uri?: string;
+}
+/**
+ * The Resource response error, returned by server when resource request fails.
+ */
+export interface ResourceResponseError {
+    readonly error: {
+        readonly message: string;
+        readonly description: string;
+        readonly href?: string;
+        readonly code: number;
+        readonly fields?: {
+            [key: string]: string[];
+        };
+    };
+}
+/**
+ * Maps the given error into a ShapeDiver API response error object.
+ */
+export declare function mapToApiError(error: Error | AxiosError): SdPlatformError;
+//# sourceMappingURL=SdPlatformSdkErrorMapping.d.ts.map

package/dist/api/SdPlatformSdkErrorMapping.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SdPlatformSdkErrorMapping.d.ts","sourceRoot":"","sources":["../../src/api/SdPlatformSdkErrorMapping.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AACzC,OAAO,EACH,eAAe,EAIlB,MAAM,qBAAqB,CAAA;AAE5B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,KAAK,EAAE;QACZ,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;SAAE,CAAA;KAChD,CAAC;CACL;AAUD;;GAEG;AACH,wBAAgB,aAAa,CAAE,KAAK,EAAE,KAAK,GAAG,UAAU,GAAG,eAAe,CAyCzE"}

package/dist/api/ShapeDiverSDKApi.d.ts

@@ -0,0 +1,65 @@
+import { RequestId } from "../common/RequestId";
+import { ShapeDiverSDKConfig } from "../config/ShapeDiverSDKConfig";
+import { ShapeDiverSDKRequestConfig } from "./ShapeDiverSDKRequestConfig";
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+interface ErrorResponse {
+    readonly error: string;
+    readonly error_description: string;
+    readonly error_uri?: string;
+    readonly code?: number | string;
+    readonly http_status_code: number;
+}
+/**
+ * Comment by Alex:
+ * why do we need this mixed error type?
+ * we should rather keep the authentication API as separate as possible
+ * from the platform api, as these are really two different APIs, that
+ * might soon be using different endpoints
+ * also they have a different error response structure on purpose!!!
+ * --> the authentication API corresponds to oauth standard
+ * --> the platform API is specified by us
+ */
+declare class ResponseError implements ErrorResponse {
+    readonly http_status_code: number;
+    readonly error: string;
+    readonly error_description: string;
+    readonly error_uri?: string;
+    readonly code?: number | string;
+    readonly fields?: {
+        [key: string]: string[];
+    };
+    constructor(data: any, http_status_code: number);
+    get isResponseError(): boolean;
+}
+declare function isResponseError(response: any): response is ResponseError;
+declare type ID = RequestId | string;
+interface BeforeRequest {
+    readonly id: ID;
+    requestInit: AxiosRequestConfig;
+}
+interface RequestStartEvent {
+    readonly id: ID;
+    readonly requestParams: AxiosRequestConfig;
+}
+interface RequestFinishedEvent extends RequestStartEvent {
+    readonly response: AxiosResponse;
+}
+declare class ShapeDiverSDKApi {
+    private __config;
+    private __onRequestStart;
+    private __onRequestFinished;
+    private __beforeRequestPipe?;
+    constructor(__config: ShapeDiverSDKConfig);
+    private __toQueryString;
+    private __resolveRequest;
+    private __afterRequest;
+    private __fetch;
+    onRequestStart(cb: (event: RequestStartEvent) => void): void;
+    onRequestFinished(cb: (event: RequestFinishedEvent) => void): void;
+    beforeRequestPipe(cb: (request: BeforeRequest) => BeforeRequest): void;
+    get<T>(id: RequestId, url: string, config: ShapeDiverSDKRequestConfig, queryParams?: object): Promise<T>;
+    post<T>(id: RequestId, url: string, data: any, config: ShapeDiverSDKRequestConfig): Promise<T>;
+    patch<T>(id: RequestId, url: string, data: any, config: ShapeDiverSDKRequestConfig): Promise<T>;
+    delete<T>(id: RequestId, url: string, config: ShapeDiverSDKRequestConfig): Promise<T>;
+}
+export { ShapeDiverSDKApi, ResponseError, isResponseError, BeforeRequest, RequestStartEvent, RequestFinishedEvent };

package/dist/api/ShapeDiverSDKRequestConfig.d.ts

@@ -0,0 +1,7 @@
+export interface ShapeDiverSDKRequestConfig {
+    access_token?: string | null;
+    basic_access_token?: string | null;
+    client_id?: string | null;
+    username?: string | null | undefined;
+    password?: string | null | undefined;
+}

package/dist/auth/AuthServiceApi.d.ts

@@ -0,0 +1,34 @@
+import { ResponseError } from "../api/ShapeDiverSDKApi";
+import { ShapeDiverSDKContext, AuthData } from '../common/ShapeDiverSDKContext';
+import { AuthResponse } from "./models/AuthResponse";
+import { DeleteResponse } from "../resources/ResourcesApi";
+/**
+ * Class responsible for Authorization and Authentication calls
+ */
+declare class AuthServiceApi {
+    private __context;
+    private __api;
+    private __config;
+    private __authorizationData;
+    private __refreshTokenFailedEvents;
+    private __passwordGrantFailedEvents;
+    /** instance of token request which is used in order to not spam with token requests */
+    private __refreshTokenRequestMeta;
+    constructor(__context: ShapeDiverSDKContext);
+    private __resolveConfig;
+    private __request;
+    /**
+     * Set the expiration date of access token
+     * @param seconds
+     */
+    private setExpirationDate;
+    get authData(): AuthData;
+    onRefreshTokenRequestFailed(fn: (responseError: ResponseError) => void): void;
+    onPasswordGrantFailed(fn: (responseError: ResponseError) => void): void;
+    refreshToken(): Promise<AuthResponse>;
+    passwordGrant(username: string, password: string): Promise<AuthResponse>;
+    logout(): Promise<DeleteResponse>;
+    private __decodeToken;
+    private __cleanAuthData;
+}
+export { AuthServiceApi };

package/dist/auth/SdPlatformAuthServiceApi.d.ts

@@ -0,0 +1,59 @@
+import { SdPlatformSdkContext, SdPlatformAuthenticationStatus } from '../SdPlatformSdkContext';
+import { SdPlatformResponseError } from "../SdPlatformErrors";
+import { SdPlatformAuthResponse, SdPlatformAuthLogoutResponse } from "@shapediver/api.platform-api-dto-v1";
+/**
+ * Authentication service for ShapeDiver Platform.
+ */
+export declare class SdPlatformAuthServiceApi {
+    private __context;
+    private __api;
+    private __config;
+    private __refreshTokenFailedEvents;
+    private __passwordGrantFailedEvents;
+    /** instance of token request which is used in order to not spam with token requests */
+    private __refreshTokenRequestMeta;
+    constructor(__context: SdPlatformSdkContext);
+    private __resolveConfig;
+    private __request;
+    /**
+     * Convert "expires_in" number of seconds to an absolute expiration date.
+     * @param seconds
+     */
+    private convertToExpirationDate;
+    /**
+     * Set details of access token in context.
+     * @param data auth response
+     */
+    private setAccessTokenDetails;
+    get authData(): SdPlatformAuthenticationStatus;
+    /**
+     * Register callbacks for "refresh_token" grant failed events.
+     * @param fn
+     */
+    onRefreshTokenRequestFailed(fn: (responseError: SdPlatformResponseError) => void): void;
+    /**
+     * Register callbacks for "password" grant failed events.
+     * @param fn
+     */
+    onPasswordGrantFailed(fn: (responseError: SdPlatformResponseError) => void): void;
+    /**
+     * Try to get a fresh access token using the current refresh token. OAuth 2.0 "refresh_token" grant.
+     * @returns
+     */
+    refreshToken(): Promise<SdPlatformAuthResponse>;
+    /**
+     * Authenticate using credentials. OAuth 2.0 "password" grant.
+     * @param username
+     * @param password
+     * @returns
+     */
+    passwordGrant(username: string, password: string): Promise<SdPlatformAuthResponse>;
+    /**
+     * Clean the authentication data, unset the "refresh_token" cookie.
+     * @returns
+     */
+    logout(): Promise<SdPlatformAuthLogoutResponse>;
+    private __decodeToken;
+    private __cleanAuthData;
+}
+//# sourceMappingURL=SdPlatformAuthServiceApi.d.ts.map

package/dist/auth/SdPlatformAuthServiceApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SdPlatformAuthServiceApi.d.ts","sourceRoot":"","sources":["../../src/auth/SdPlatformAuthServiceApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAA4D,8BAA8B,EAAE,MAAM,yBAAyB,CAAC;AAEzJ,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAkD,4BAA4B,EAAE,MAAM,qCAAqC,CAAA;AAmB1J;;GAEG;AACH,qBAAa,wBAAwB;IAarB,OAAO,CAAC,SAAS;IAX7B,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,QAAQ,CAAsB;IACtC,OAAO,CAAC,0BAA0B,CAA+D;IACjG,OAAO,CAAC,2BAA2B,CAA+D;IAElG,uFAAuF;IACvF,OAAO,CAAC,yBAAyB,CAG/B;gBAEkB,SAAS,EAAE,oBAAoB;IAMnD,OAAO,CAAC,eAAe;YAKT,SAAS;IAKvB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAO/B;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAsB7B,IAAW,QAAQ,IAAI,8BAA8B,CAGpD;IAED;;;OAGG;IACI,2BAA2B,CAAC,EAAE,EAAE,CAAC,aAAa,EAAE,uBAAuB,KAAK,IAAI,GAAG,IAAI;IAK9F;;;OAGG;IACI,qBAAqB,CAAC,EAAE,EAAE,CAAC,aAAa,EAAE,uBAAuB,KAAK,IAAI,GAAG,IAAI;IAKxF;;;OAGG;IACU,YAAY,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAyC5D;;;;;OAKG;IACU,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA2B/F;;;OAGG;IACI,MAAM,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAStD,OAAO,CAAC,aAAa;IAKrB,OAAO,CAAC,eAAe;CAI1B"}

package/dist/auth/models/AuthRequest.d.ts

@@ -0,0 +1,12 @@
+declare enum GrantType {
+    Password = "password",
+    RefreshToken = "refresh_token"
+}
+interface AuthRequest {
+    grant_type: GrantType;
+    client_id?: string | null;
+    client_secret?: string | null;
+    username?: string | null;
+    password?: string | null;
+}
+export { GrantType, AuthRequest };

package/dist/auth/models/AuthResponse.d.ts

@@ -0,0 +1,8 @@
+interface AuthResponse {
+    access_token?: string;
+    refresh_token?: string;
+    expires_in?: number;
+    token_type?: string;
+    scope?: string;
+}
+export { AuthResponse };

package/dist/auth/models/ShapeDiverAuthRequest.d.ts

@@ -0,0 +1,12 @@
+declare enum GrantType {
+    Password = "password",
+    RefreshToken = "refresh_token"
+}
+interface ShapeDiverAuthRequest {
+    grant_type: GrantType;
+    client_id?: string;
+    client_secret?: string;
+    username?: string;
+    password?: string;
+}
+export { GrantType, ShapeDiverAuthRequest };