@shapediver/sdk.platform-api-sdk-v1 2.12.2 → 2.12.8

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2021 ShapeDiver GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright 2021 ShapeDiver GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,61 +1,61 @@
-<p style="text-align: center">
-  <a href="https://www.shapediver.com/">
-    <img
-      alt="ShapeDiver"
-      src="https://sduse1-assets.shapediver.com/production/assets/img/apple-icon.png"
-    />
-  </a>
-</p>
-
-# ShapeDiver Platform SDK
-[ShapeDiver](https://www.shapediver.com/) is a cloud platform that provides the right tools and scalable infrastructure to help you transform your Grasshopper files into online applications. It allows you to share the power of Grasshopper and Parametric Design with partners, clients and other key stakeholders wherever they are.
-
-The **ShapeDiver Platform SDK** allows to access the functionality of the [ShapeDiver Platform](https://www.shapediver.com/app/) (or white labelled instances of it) by means of the [ShapeDiver Platform API](https://help.shapediver.com/doc/platform-backend).
-The SDK exposes all TypeScript-types describing request and response objects.
-
-The authentication system is based on **JWT tokens**, which the SDK allows you to request from the **ShapeDiver Platform** using the OAuth 2.0 functionality integrated with the [ShapeDiver Platform API](https://help.shapediver.com/doc/platform-backend). 
-
-## Usage
-
-* Add npm package:
-  ```sh
-  npm i @shapediver/sdk.platform-api-sdk-v1
-  ```
-* Import constructor function: 
-  ```javascript 
-  import { create } from '@shapediver/sdk.platform-api-sdk-v1';
-  ```
-  
-* Create and authorize client: 
-  ```javascript 
-  const client = create({clientId: "CLIENT_ID", baseUrl: "SHAPEDIVER_PLATFORM_API_ENDPOINT"});
-  await client.authorization.passwordGrant("USERNAME OR ACCESS KEY ID", "PASSWORD OR ACCESS KEY SECRET");
-  ```
-
-Whenever possible do not use your username and password for usage of the SDK. Instead log in to the [ShapeDiver Platform](https://www.shapediver.com/app/) and create an access key pair, consisting of an
-
-  * access key id (to be used instead of your username), and an
-  * access key secret (to be used instead of your password).
-
-Using access keys allows you to keep your application secure, because access keys
-
-  * can be limited in scope (e.g. they can be limited to be read only)
-  * can easily be revoked at any time
-  * can be time limited. 
-
-## Versioning
-We take care to provide backwards compatibility for older versions of the SDK and the API, but might introduce breaking changes in case of major version upgrades.
-New features of the SDK might be limited to newer versions of the API. We recommend always using the newest SDK version out there.
-
-## Support
-
-  * [Plaform Backend documentation](https://help.shapediver.com/doc/platform-backend)
-  * [ShapeDiver Help Center](https://help.shapediver.com)
-  * [Forum](https://forum.shapediver.com)
-
-If you have further questions, [reach out to us](https://www.shapediver.com/?open_contact=true).
-
-Find out more about ShapeDiver [right here](https://www.shapediver.com/)!
-
-## Licensing
-The ShapeDiver Platform SDK is released under the [MIT License](LICENSE).
+<p style="text-align: center">
+  <a href="https://www.shapediver.com/">
+    <img
+      alt="ShapeDiver"
+      src="https://sduse1-assets.shapediver.com/production/assets/img/apple-icon.png"
+    />
+  </a>
+</p>
+
+# ShapeDiver Platform SDK
+[ShapeDiver](https://www.shapediver.com/) is a cloud platform that provides the right tools and scalable infrastructure to help you transform your Grasshopper files into online applications. It allows you to share the power of Grasshopper and Parametric Design with partners, clients and other key stakeholders wherever they are.
+
+The **ShapeDiver Platform SDK** allows to access the functionality of the [ShapeDiver Platform](https://www.shapediver.com/app/) (or white labelled instances of it) by means of the [ShapeDiver Platform API](https://help.shapediver.com/doc/platform-backend).
+The SDK exposes all TypeScript-types describing request and response objects.
+
+The authentication system is based on **JWT tokens**, which the SDK allows you to request from the **ShapeDiver Platform** using the OAuth 2.0 functionality integrated with the [ShapeDiver Platform API](https://help.shapediver.com/doc/platform-backend). 
+
+## Usage
+
+* Add npm package:
+  ```sh
+  npm i @shapediver/sdk.platform-api-sdk-v1
+  ```
+* Import constructor function: 
+  ```javascript 
+  import { create } from '@shapediver/sdk.platform-api-sdk-v1';
+  ```
+  
+* Create and authorize client: 
+  ```javascript 
+  const client = create({clientId: "CLIENT_ID", baseUrl: "SHAPEDIVER_PLATFORM_API_ENDPOINT"});
+  await client.authorization.passwordGrant("USERNAME OR ACCESS KEY ID", "PASSWORD OR ACCESS KEY SECRET");
+  ```
+
+Whenever possible do not use your username and password for usage of the SDK. Instead log in to the [ShapeDiver Platform](https://www.shapediver.com/app/) and create an access key pair, consisting of an
+
+  * access key id (to be used instead of your username), and an
+  * access key secret (to be used instead of your password).
+
+Using access keys allows you to keep your application secure, because access keys
+
+  * can be limited in scope (e.g. they can be limited to be read only)
+  * can easily be revoked at any time
+  * can be time limited. 
+
+## Versioning
+We take care to provide backwards compatibility for older versions of the SDK and the API, but might introduce breaking changes in case of major version upgrades.
+New features of the SDK might be limited to newer versions of the API. We recommend always using the newest SDK version out there.
+
+## Support
+
+  * [Plaform Backend documentation](https://help.shapediver.com/doc/platform-backend)
+  * [ShapeDiver Help Center](https://help.shapediver.com)
+  * [Forum](https://forum.shapediver.com)
+
+If you have further questions, [reach out to us](https://www.shapediver.com/?open_contact=true).
+
+Find out more about ShapeDiver [right here](https://www.shapediver.com/)!
+
+## Licensing
+The ShapeDiver Platform SDK is released under the [MIT License](LICENSE).

package/dist/SdPlatformErrors.d.ts

@@ -1,135 +1,135 @@
-/**
- * Generic error
- */
-export declare class SdPlatformError extends Error {
-    constructor(message: string);
-}
-/**
- * Request error (request could not be sent etc)
- */
-export declare class SdPlatformRequestError extends SdPlatformError {
-    readonly desc: string;
-    constructor(message: string, desc: string);
-}
-/**
- * Generic response error
- */
-export declare abstract class SdPlatformResponseError extends SdPlatformError {
-    readonly http_status_code: number;
-    constructor(message: string, http_status_code: number);
-}
-/**
- * The server error which can just contain message and status code.
- */
-export declare class SdPlatformServerResponseError extends SdPlatformResponseError {
-}
-/**
- * Resource response error
- */
-export declare class SdPlatformResourceResponseError extends SdPlatformResponseError {
-    readonly error: string;
-    readonly error_description: string;
-    readonly error_uri?: string | undefined;
-    readonly code?: string | number | undefined;
-    constructor(message: string, http_status_code: number, error: string, error_description: string, error_uri?: string | undefined, code?: string | number | undefined);
-}
-/**
- * Not found error, returned with 404 status.
- */
-export declare class SdPlatformNotFoundResponseError extends SdPlatformResourceResponseError {
-}
-/**
- * Forbidden error, returned with 403 status.
- */
-export declare class SdPlatformForbiddenResponseError extends SdPlatformResourceResponseError {
-}
-/**
- * Unauthorized error, returned with 401 status.
- */
-export declare class SdPlatformUnauthorizedResponseError extends SdPlatformResourceResponseError {
-}
-export declare class SdPlatformValidationResponseError extends SdPlatformResourceResponseError {
-    readonly fields?: {
-        [key: string]: string[];
-    } | undefined;
-    constructor(message: string, http_status_code: number, error: string, error_description: string, error_uri?: string, code?: number | string, fields?: {
-        [key: string]: string[];
-    } | undefined);
-}
-/**
- * Authentication response error.
- * Follows principles of OAuth 2.0
- * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1
- */
-export declare class SdPlatformOAuthResponseError extends SdPlatformResponseError {
-    /**
-     * required error code
-     *
-     *   * invalid_request
-     *   * unauthorized_client
-     *   * access_denied
-     *   * unsupported_response_type
-     *   * invalid_scope
-     *   * server_error
-     *   * temporarily_unavailable
-     */
-    readonly error: string;
-    /** optional human-readable text providing additional information */
-    readonly error_description: string;
-    /** optional URI identifying a human-readable web page with
-     information about the error */
-    readonly error_uri?: string | undefined;
-    constructor(message: string, http_status_code: number, 
-    /**
-     * required error code
-     *
-     *   * invalid_request
-     *   * unauthorized_client
-     *   * access_denied
-     *   * unsupported_response_type
-     *   * invalid_scope
-     *   * server_error
-     *   * temporarily_unavailable
-     */
-    error: string, 
-    /** optional human-readable text providing additional information */
-    error_description: string, 
-    /** optional URI identifying a human-readable web page with
-     information about the error */
-    error_uri?: string | undefined);
-}
-/**
- * Authentication response error.
- * Follows principles of OAuth 2.0
- * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
- */
-export declare class SdPlatformInvalidRequestOAuthResponseError extends SdPlatformOAuthResponseError {
-}
-/**
- * Authentication response error.
- * Follows principles of OAuth 2.0
- * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
- */
-export declare class SdPlatformInvalidClientOAuthResponseError extends SdPlatformOAuthResponseError {
-}
-/**
- * Authentication response error.
- * Follows principles of OAuth 2.0
- * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
- */
-export declare class SdPlatformInvalidGrantOAuthResponseError extends SdPlatformOAuthResponseError {
-}
-/**
- * Authentication response error.
- * Follows principles of OAuth 2.0
- * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
- */
-export declare class SdPlatformUnauthorizedClientOAuthResponseError extends SdPlatformOAuthResponseError {
-}
-/**
- * Authentication response error.
- * Follows principles of OAuth 2.0
- * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
- */ export declare class SdPlatformUnsupportedGrantTypeClientOAuthResponseError extends SdPlatformOAuthResponseError {
-}
+/**
+ * Generic error
+ */
+export declare class SdPlatformError extends Error {
+    constructor(message: string);
+}
+/**
+ * Request error (request could not be sent etc)
+ */
+export declare class SdPlatformRequestError extends SdPlatformError {
+    readonly desc: string;
+    constructor(message: string, desc: string);
+}
+/**
+ * Generic response error
+ */
+export declare abstract class SdPlatformResponseError extends SdPlatformError {
+    readonly http_status_code: number;
+    constructor(message: string, http_status_code: number);
+}
+/**
+ * The server error which can just contain message and status code.
+ */
+export declare class SdPlatformServerResponseError extends SdPlatformResponseError {
+}
+/**
+ * Resource response error
+ */
+export declare class SdPlatformResourceResponseError extends SdPlatformResponseError {
+    readonly error: string;
+    readonly error_description: string;
+    readonly error_uri?: string | undefined;
+    readonly code?: string | number | undefined;
+    constructor(message: string, http_status_code: number, error: string, error_description: string, error_uri?: string | undefined, code?: string | number | undefined);
+}
+/**
+ * Not found error, returned with 404 status.
+ */
+export declare class SdPlatformNotFoundResponseError extends SdPlatformResourceResponseError {
+}
+/**
+ * Forbidden error, returned with 403 status.
+ */
+export declare class SdPlatformForbiddenResponseError extends SdPlatformResourceResponseError {
+}
+/**
+ * Unauthorized error, returned with 401 status.
+ */
+export declare class SdPlatformUnauthorizedResponseError extends SdPlatformResourceResponseError {
+}
+export declare class SdPlatformValidationResponseError extends SdPlatformResourceResponseError {
+    readonly fields?: {
+        [key: string]: string[];
+    } | undefined;
+    constructor(message: string, http_status_code: number, error: string, error_description: string, error_uri?: string, code?: number | string, fields?: {
+        [key: string]: string[];
+    } | undefined);
+}
+/**
+ * Authentication response error.
+ * Follows principles of OAuth 2.0
+ * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1
+ */
+export declare class SdPlatformOAuthResponseError extends SdPlatformResponseError {
+    /**
+     * required error code
+     *
+     *   * invalid_request
+     *   * unauthorized_client
+     *   * access_denied
+     *   * unsupported_response_type
+     *   * invalid_scope
+     *   * server_error
+     *   * temporarily_unavailable
+     */
+    readonly error: string;
+    /** optional human-readable text providing additional information */
+    readonly error_description: string;
+    /** optional URI identifying a human-readable web page with
+     information about the error */
+    readonly error_uri?: string | undefined;
+    constructor(message: string, http_status_code: number, 
+    /**
+     * required error code
+     *
+     *   * invalid_request
+     *   * unauthorized_client
+     *   * access_denied
+     *   * unsupported_response_type
+     *   * invalid_scope
+     *   * server_error
+     *   * temporarily_unavailable
+     */
+    error: string, 
+    /** optional human-readable text providing additional information */
+    error_description: string, 
+    /** optional URI identifying a human-readable web page with
+     information about the error */
+    error_uri?: string | undefined);
+}
+/**
+ * Authentication response error.
+ * Follows principles of OAuth 2.0
+ * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
+ */
+export declare class SdPlatformInvalidRequestOAuthResponseError extends SdPlatformOAuthResponseError {
+}
+/**
+ * Authentication response error.
+ * Follows principles of OAuth 2.0
+ * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
+ */
+export declare class SdPlatformInvalidClientOAuthResponseError extends SdPlatformOAuthResponseError {
+}
+/**
+ * Authentication response error.
+ * Follows principles of OAuth 2.0
+ * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
+ */
+export declare class SdPlatformInvalidGrantOAuthResponseError extends SdPlatformOAuthResponseError {
+}
+/**
+ * Authentication response error.
+ * Follows principles of OAuth 2.0
+ * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
+ */
+export declare class SdPlatformUnauthorizedClientOAuthResponseError extends SdPlatformOAuthResponseError {
+}
+/**
+ * Authentication response error.
+ * Follows principles of OAuth 2.0
+ * Please see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
+ */ export declare class SdPlatformUnsupportedGrantTypeClientOAuthResponseError extends SdPlatformOAuthResponseError {
+}
 //# sourceMappingURL=SdPlatformErrors.d.ts.map