@flowcore/sdk 1.4.5 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.5.0](https://github.com/flowcore-io/flowcore-sdk/compare/v1.4.5...v1.5.0) (2024-12-19)
+
+
+### Features
+
+* add retry to client ([b202c56](https://github.com/flowcore-io/flowcore-sdk/commit/b202c5660f42a02bbd45db043d48713effe658a6))
+
+
+### Bug Fixes
+
+* update readme ([bf233bc](https://github.com/flowcore-io/flowcore-sdk/commit/bf233bc27b15892b5813c2121b7221d08c7b7d63))
+* update readme ([3ffbe49](https://github.com/flowcore-io/flowcore-sdk/commit/3ffbe499e6014e64a8c420eead2763539cb5412c))
+* use retryable status codes ([89a8919](https://github.com/flowcore-io/flowcore-sdk/commit/89a8919492c55614851779ff77ddc3f7fcde51e0))
+
 ## [1.4.5](https://github.com/flowcore-io/flowcore-sdk/compare/v1.4.4...v1.4.5) (2024-12-19)
 
 

package/README.md

@@ -32,6 +32,18 @@ const client = new FlowcoreClient({
   apiKey: "my-api-key",
 })
 
+// With retry
+// NOTE! When retry is not set it will default to 250ms delay and 3 max retries.
+//       To disable retry set retry to null.
+const client = new FlowcoreClient({
+  apiKeyId: "my-api-key-id",
+  apiKey: "my-api-key",
+  retry: {
+    delay: 100,
+    maxRetries: 5,
+  },
+})
+
 // Execute a command
 const command = new DataCoreFetchCommand({
   dataCoreId: "my-data-core-id",

package/esm/common/flowcore-client.d.ts

@@ -6,6 +6,10 @@ interface ClientOptionsBearer {
     getBearerToken: () => Promise<string | null> | string | null;
     apiKeyId?: never;
     apiKey?: never;
+    retry?: {
+        delay: number;
+        maxRetries: number;
+    } | null;
 }
 /**
  * The options for the api key
@@ -14,6 +18,10 @@ interface ClientOptionsApiKey {
     apiKeyId: string;
     apiKey: string;
     getBearerToken?: never;
+    retry?: {
+        delay: number;
+        maxRetries: number;
+    } | null;
 }
 /**
  * The options for the client
@@ -30,6 +38,10 @@ export declare class FlowcoreClient {
      * Get the auth header
      */
     private getAuthHeader;
+    /**
+     * Execute a command (inner method)
+     */
+    private innerExecute;
     /**
      * Execute a command
      */

package/esm/common/flowcore-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flowcore-client.d.ts","sourceRoot":"","sources":["../../src/common/flowcore-client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;GAEG;AACH,UAAU,mBAAmB;IAC3B,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAA;IAC5D,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,MAAM,CAAC,EAAE,KAAK,CAAA;CACf;AAED;;GAEG;AACH,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,KAAK,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,CAAA;AAErE;;GAEG;AACH,qBAAa,cAAc;IAEb,OAAO,CAAC,QAAQ,CAAC,OAAO;IADpC,OAAO,CAAC,IAAI,CAAqB;gBACJ,OAAO,EAAE,aAAa;IAUnD;;OAEG;YACW,aAAa;IAc3B;;OAEG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;CA+B/E"}
+{"version":3,"file":"flowcore-client.d.ts","sourceRoot":"","sources":["../../src/common/flowcore-client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAI3C;;GAEG;AACH,UAAU,mBAAmB;IAC3B,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAA;IAC5D,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;QACb,UAAU,EAAE,MAAM,CAAA;KACnB,GAAG,IAAI,CAAA;CACT;AAED;;GAEG;AACH,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,KAAK,CAAA;IACtB,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;QACb,UAAU,EAAE,MAAM,CAAA;KACnB,GAAG,IAAI,CAAA;CACT;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,CAAA;AAErE;;GAEG;AACH,qBAAa,cAAc;IAEb,OAAO,CAAC,QAAQ,CAAC,OAAO;IADpC,OAAO,CAAC,IAAI,CAAqB;gBACJ,OAAO,EAAE,aAAa;IAiBnD;;OAEG;YACW,aAAa;IAc3B;;OAEG;YACW,YAAY;IAyD1B;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;CAGzE"}

package/esm/common/flowcore-client.js

@@ -1,5 +1,6 @@
 import { ClientError } from "../exceptions/client-error.js";
 import { CommandError } from "../exceptions/command-error.js";
+const RETRYABLE_ERROR_CODES = [408, 429, 500, 502, 503, 504];
 /**
  * A base client for executing commands
  */
@@ -26,6 +27,12 @@ export class FlowcoreClient {
         else {
             throw new Error("Invalid client options");
         }
+        if (this.options.retry === undefined) {
+            this.options.retry = {
+                delay: 250,
+                maxRetries: 3,
+            };
+        }
     }
     /**
      * Get the auth header
@@ -44,23 +51,44 @@ export class FlowcoreClient {
         return null;
     }
     /**
-     * Execute a command
+     * Execute a command (inner method)
      */
-    async execute(command) {
+    async innerExecute(command, retryCount = 0) {
         const request = await command.getRequest(this);
         if (!request.allowedModes.includes(this.mode)) {
             throw new CommandError(command.constructor.name, `Not allowed in "${this.mode}" mode`);
         }
         const authHeader = await this.getAuthHeader();
-        const response = await fetch(request.baseUrl + request.path, {
-            method: request.method,
-            headers: {
-                ...request.headers,
-                ...(authHeader ? { Authorization: authHeader } : {}),
-            },
-            body: request.body,
-        });
+        let response;
+        try {
+            response = await fetch(request.baseUrl + request.path, {
+                method: request.method,
+                headers: {
+                    ...request.headers,
+                    ...(authHeader ? { Authorization: authHeader } : {}),
+                },
+                body: request.body,
+            });
+        }
+        catch (error) {
+            if (this.options.retry && retryCount < this.options.retry.maxRetries) {
+                const delay = this.options.retry.delay;
+                await new Promise((resolve) => setTimeout(resolve, delay));
+                return this.innerExecute(command, retryCount + 1);
+            }
+            const message = error instanceof Error ? error.message : "Unknown error";
+            throw new ClientError(`Failed to execute command: ${message}`, 0, {
+                command: command.constructor.name,
+                error: error,
+            });
+        }
         if (!response.ok) {
+            if (this.options.retry && RETRYABLE_ERROR_CODES.includes(response.status) &&
+                retryCount < this.options.retry.maxRetries) {
+                const delay = this.options.retry.delay;
+                await new Promise((resolve) => setTimeout(resolve, delay));
+                return this.innerExecute(command, retryCount + 1);
+            }
             const body = await response.json().catch(() => undefined);
             const commandName = command.constructor.name;
             throw new ClientError(`${commandName} failed with ${response.status}: ${response.statusText}`, response.status, body);
@@ -69,4 +97,10 @@ export class FlowcoreClient {
         const parsedBody = await request.parseResponse(body, this);
         return request.waitForResponse(this, parsedBody);
     }
+    /**
+     * Execute a command
+     */
+    execute(command) {
+        return this.innerExecute(command, 0);
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowcore/sdk",
-  "version": "1.4.5",
+  "version": "1.5.0",
   "description": "Flowcore SDK",
   "homepage": "https://github.com/flowcore-io/flowcore-sdk#readme",
   "repository": {

package/script/common/flowcore-client.d.ts

@@ -6,6 +6,10 @@ interface ClientOptionsBearer {
     getBearerToken: () => Promise<string | null> | string | null;
     apiKeyId?: never;
     apiKey?: never;
+    retry?: {
+        delay: number;
+        maxRetries: number;
+    } | null;
 }
 /**
  * The options for the api key
@@ -14,6 +18,10 @@ interface ClientOptionsApiKey {
     apiKeyId: string;
     apiKey: string;
     getBearerToken?: never;
+    retry?: {
+        delay: number;
+        maxRetries: number;
+    } | null;
 }
 /**
  * The options for the client
@@ -30,6 +38,10 @@ export declare class FlowcoreClient {
      * Get the auth header
      */
     private getAuthHeader;
+    /**
+     * Execute a command (inner method)
+     */
+    private innerExecute;
     /**
      * Execute a command
      */

package/script/common/flowcore-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flowcore-client.d.ts","sourceRoot":"","sources":["../../src/common/flowcore-client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;GAEG;AACH,UAAU,mBAAmB;IAC3B,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAA;IAC5D,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,MAAM,CAAC,EAAE,KAAK,CAAA;CACf;AAED;;GAEG;AACH,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,KAAK,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,CAAA;AAErE;;GAEG;AACH,qBAAa,cAAc;IAEb,OAAO,CAAC,QAAQ,CAAC,OAAO;IADpC,OAAO,CAAC,IAAI,CAAqB;gBACJ,OAAO,EAAE,aAAa;IAUnD;;OAEG;YACW,aAAa;IAc3B;;OAEG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;CA+B/E"}
+{"version":3,"file":"flowcore-client.d.ts","sourceRoot":"","sources":["../../src/common/flowcore-client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAI3C;;GAEG;AACH,UAAU,mBAAmB;IAC3B,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAA;IAC5D,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;QACb,UAAU,EAAE,MAAM,CAAA;KACnB,GAAG,IAAI,CAAA;CACT;AAED;;GAEG;AACH,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,KAAK,CAAA;IACtB,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;QACb,UAAU,EAAE,MAAM,CAAA;KACnB,GAAG,IAAI,CAAA;CACT;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,CAAA;AAErE;;GAEG;AACH,qBAAa,cAAc;IAEb,OAAO,CAAC,QAAQ,CAAC,OAAO;IADpC,OAAO,CAAC,IAAI,CAAqB;gBACJ,OAAO,EAAE,aAAa;IAiBnD;;OAEG;YACW,aAAa;IAc3B;;OAEG;YACW,YAAY;IAyD1B;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;CAGzE"}

package/script/common/flowcore-client.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowcoreClient = void 0;
 const client_error_js_1 = require("../exceptions/client-error.js");
 const command_error_js_1 = require("../exceptions/command-error.js");
+const RETRYABLE_ERROR_CODES = [408, 429, 500, 502, 503, 504];
 /**
  * A base client for executing commands
  */
@@ -29,6 +30,12 @@ class FlowcoreClient {
         else {
             throw new Error("Invalid client options");
         }
+        if (this.options.retry === undefined) {
+            this.options.retry = {
+                delay: 250,
+                maxRetries: 3,
+            };
+        }
     }
     /**
      * Get the auth header
@@ -47,23 +54,44 @@ class FlowcoreClient {
         return null;
     }
     /**
-     * Execute a command
+     * Execute a command (inner method)
      */
-    async execute(command) {
+    async innerExecute(command, retryCount = 0) {
         const request = await command.getRequest(this);
         if (!request.allowedModes.includes(this.mode)) {
             throw new command_error_js_1.CommandError(command.constructor.name, `Not allowed in "${this.mode}" mode`);
         }
         const authHeader = await this.getAuthHeader();
-        const response = await fetch(request.baseUrl + request.path, {
-            method: request.method,
-            headers: {
-                ...request.headers,
-                ...(authHeader ? { Authorization: authHeader } : {}),
-            },
-            body: request.body,
-        });
+        let response;
+        try {
+            response = await fetch(request.baseUrl + request.path, {
+                method: request.method,
+                headers: {
+                    ...request.headers,
+                    ...(authHeader ? { Authorization: authHeader } : {}),
+                },
+                body: request.body,
+            });
+        }
+        catch (error) {
+            if (this.options.retry && retryCount < this.options.retry.maxRetries) {
+                const delay = this.options.retry.delay;
+                await new Promise((resolve) => setTimeout(resolve, delay));
+                return this.innerExecute(command, retryCount + 1);
+            }
+            const message = error instanceof Error ? error.message : "Unknown error";
+            throw new client_error_js_1.ClientError(`Failed to execute command: ${message}`, 0, {
+                command: command.constructor.name,
+                error: error,
+            });
+        }
         if (!response.ok) {
+            if (this.options.retry && RETRYABLE_ERROR_CODES.includes(response.status) &&
+                retryCount < this.options.retry.maxRetries) {
+                const delay = this.options.retry.delay;
+                await new Promise((resolve) => setTimeout(resolve, delay));
+                return this.innerExecute(command, retryCount + 1);
+            }
             const body = await response.json().catch(() => undefined);
             const commandName = command.constructor.name;
             throw new client_error_js_1.ClientError(`${commandName} failed with ${response.status}: ${response.statusText}`, response.status, body);
@@ -72,5 +100,11 @@ class FlowcoreClient {
         const parsedBody = await request.parseResponse(body, this);
         return request.waitForResponse(this, parsedBody);
     }
+    /**
+     * Execute a command
+     */
+    execute(command) {
+        return this.innerExecute(command, 0);
+    }
 }
 exports.FlowcoreClient = FlowcoreClient;