@unito/integrations-platform-client 1.1.2 → 1.1.4

package/README.md

@@ -1,7 +1,7 @@
 # Integrations Platform - Client
 
 This component is a JS client library to communicate with the Integrations Platform Server. It exposes a standard
-[`oazapfts`](https://www.npmjs.com/package/oazapfts) interface compiled with the `--optimistic` option.
+[`oazapfts`](https://www.npmjs.com/package/oazapfts) interface compiled without the `--optimistic` option.
 
 ## Getting started
 
@@ -14,13 +14,13 @@ npm install @unito/integrations-platform-client
 2. Use the library:
 
 ```typescript
-import IntegrationsPlatform from '@unito/integrations-platform-client';
+import * as IntegrationsPlatform from '@unito/integrations-platform-client';
 
 IntegrationsPlatform.defaults.baseUrl = 'http://enpoint.to.the.server';
 IntegrationsPlatform.defaults.headers = { Authorization: 'Bearer YOUR_TOKEN' };
 
 try {
-  await IntegrationsPlatform.getIntegrations();
+  IntegrationsPlatform.optimistic(IntegrationsPlatform.getIntegrations());
 } catch (err: unknown) {
   if (err instanceof IntegrationsPlatform.HttpError) {
     // Handle the error.
@@ -65,4 +65,3 @@ See `npm version help` for more information.
 By using the Integration Platform Client, you agree to be bound by our terms and conditions.
 Please ensure you have read and understood the Unito Software Development Kit Agreement before using the Platform Client.
 The full agreement can be found at [Unito SDK Agreement](https://unito.io/sdk-agreement/).
-

package/dist/src/addons.d.ts

@@ -40,6 +40,9 @@ export declare function isErrorResponse(object: unknown): object is ErrorRespons
  * @returns the response's data, typed, if it's a success
  */
 export declare function optimistic<T>(asyncResponse: Promise<Response<T> | ErrorResponse>): Promise<T>;
+/**
+ * Represents a successful response from the Integrations Platform Client.
+ */
 type Response<T> = ({
     status: 200;
 } | {
@@ -52,6 +55,9 @@ type Response<T> = ({
     data: T;
     headers: Headers;
 };
+/**
+ * Represents an error response from the Integrations Platform Client.
+ */
 type ErrorResponse = ({
     status: 400;
 } | {
@@ -66,6 +72,8 @@ type ErrorResponse = ({
     status: 410;
 } | {
     status: 422;
+} | {
+    status: 423;
 } | {
     status: 429;
 } | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integrations-platform-client",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "The Unito Integrations Platform Client",
   "type": "module",
   "types": "./dist/src/index.d.ts",