@aloma.io/integration-sdk 3.8.6 → 3.8.7

package/build/controller/index.d.mts

@@ -3,7 +3,7 @@ export declare abstract class AbstractController {
     protected config: {
         [key: string]: any;
     };
-    protected client?: Fetcher;
+    protected client: any;
     protected start(): Promise<void>;
     protected stop(isShutdown?: boolean): Promise<void>;
     protected configQuery(arg: any): Promise<any>;
@@ -15,7 +15,7 @@ export declare abstract class AbstractController {
         baseUrl?: string;
         onResponse?: (response: any) => void;
         customize?: (request: any) => void;
-    }): Promise<any>;
+    }): Promise<Fetcher>;
     protected updateTask(name: string, data: any): Promise<string>;
     protected createBlob({ content, name, size, mimetype, meta, taskId, }: {
         content: string;

package/build/internal/fetcher/fetcher.d.mts

@@ -1,15 +1,44 @@
+/// <reference types="node" resolution-mode="require"/>
+/**
+ * http request fetcher
+ */
 export default class Fetcher {
-    retry: number;
-    baseUrl: any;
-    onResponse: any;
-    customize0: any;
-    constructor({ retry, baseUrl, onResponse, customize }: {
-        retry?: number | undefined;
-        baseUrl: any;
-        onResponse: any;
-        customize: any;
+    protected retry: number;
+    protected baseUrl: any;
+    protected onResponse: any;
+    protected customize0: any;
+    constructor({ retry, baseUrl, onResponse, customize }?: {
+        retry?: number;
+        baseUrl?: string;
+        onResponse?: (response: Response) => void;
+        customize?: (request: {
+            [key: string]: any;
+        }) => void;
     });
-    customize(options?: {}, args?: {}): Promise<void>;
-    onError(e: any, url: string, options: any, retries: number, args: any, rateLimit?: any): Promise<unknown>;
-    fetch(url: string, options: any, retries: number, args?: any): Promise<any>;
+    protected customize(options?: {}, args?: {}): Promise<void>;
+    protected onError(e: any, url: string, options: any, retries: number, args: any, rateLimit?: any): Promise<unknown>;
+    /**
+     * fetch data from a url
+     * @param url url to fetch
+     * @param options request options
+     * @param retries retries left for the request
+     * @param args optional args for customize()
+     * @returns
+     */
+    fetch(url: string, options?: {
+        /**
+         * request method like GET, POST, PUT, DELETE
+         */
+        method?: string;
+        /**
+         * request headers like Accept, Content-type
+         */
+        headers?: {
+            [key: string]: any;
+        };
+        /**
+         * request body like "hello world" or {hello: "world"}
+         */
+        body?: any;
+    }, retries?: number, args?: any): Promise<any>;
 }

package/build/internal/fetcher/fetcher.mjs

@@ -1,10 +1,13 @@
 import { unwrap } from "../util/index.mjs";
+/**
+ * http request fetcher
+ */
 export default class Fetcher {
     retry;
     baseUrl;
     onResponse;
     customize0;
-    constructor({ retry = 5, baseUrl, onResponse, customize }) {
+    constructor({ retry = 5, baseUrl, onResponse, customize } = {}) {
         this.retry = retry;
         this.baseUrl = baseUrl;
         this.onResponse = onResponse;
@@ -28,42 +31,51 @@ export default class Fetcher {
             }, rateLimit ? 10000 : 500);
         });
     }
+    /**
+     * fetch data from a url
+     * @param url url to fetch
+     * @param options request options
+     * @param retries retries left for the request
+     * @param args optional args for customize()
+     * @returns
+     */
     async fetch(url, options = {}, retries, args = {}) {
         var local = this, baseUrl = local.baseUrl;
+        const options0 = { ...options };
         if (retries == null)
             retries = local.retry;
         let theURL = !baseUrl
             ? url
             : `${baseUrl?.endsWith("/") ? baseUrl : baseUrl + "/"}${url}`.replace(/\/\/+/gi, "/");
         try {
-            options.url = url;
-            await local.customize(options, args);
-            url = options.url;
-            delete options.url;
+            options0.url = url;
+            await local.customize(options0, args);
+            url = options0.url;
+            delete options0.url;
             theURL = !baseUrl
                 ? url
                 : `${baseUrl?.endsWith("/") ? baseUrl : baseUrl + "/"}${url}`.replace(/\/\/+/gi, "/");
-            if (!options?.headers || !options?.headers?.Accept) {
-                options.headers = {
-                    ...options.headers,
+            if (!options0?.headers || !options0?.headers?.Accept) {
+                options0.headers = {
+                    ...options0.headers,
                     Accept: "application/json",
                 };
             }
-            if (!options?.headers || !options?.headers?.["Content-type"]) {
-                options.headers = {
-                    ...options.headers,
+            if (!options0?.headers || !options0?.headers?.["Content-type"]) {
+                options0.headers = {
+                    ...options0.headers,
                     "Content-type": "application/json",
                 };
             }
-            if (!(options?.method === "GET" || options?.method === "HEAD") &&
-                options?.body &&
-                !(typeof options.body === "string") &&
-                options?.headers?.["Content-type"] === "application/json") {
-                options.body = JSON.stringify(options.body);
+            if (!(options0?.method === "GET" || options0?.method === "HEAD") &&
+                options0?.body &&
+                !(typeof options0.body === "string") &&
+                options0?.headers?.["Content-type"] === "application/json") {
+                options0.body = JSON.stringify(options0.body);
             }
-            const timeout = Math.min(options?.timeout || 30 * 60 * 1000, 30 * 60 * 1000);
+            const timeout = Math.min(options0?.timeout || 30 * 60 * 1000, 30 * 60 * 1000);
             const ret = await fetch(theURL, {
-                ...options,
+                ...options0,
                 signal: AbortSignal.timeout(timeout),
             });
             const status = await ret.status;
@@ -79,12 +91,12 @@ export default class Fetcher {
             if (status === 204) {
                 return { ok: true };
             }
-            return unwrap(ret, options);
+            return unwrap(ret, options0);
         }
         catch (e) {
             // too many requests
             if (e.status === 429) {
-                return local.onError(e, url, options, retries, args, true);
+                return local.onError(e, url, options0, retries, args, true);
             }
             // bad request
             if (e.status === 400 || e.status === 422) {
@@ -94,7 +106,7 @@ export default class Fetcher {
             console.log(theURL, e);
             if (retries <= 0)
                 throw e;
-            return local.onError(e, url, options, retries, args);
+            return local.onError(e, url, options0, retries, args);
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aloma.io/integration-sdk",
-  "version": "3.8.6",
+  "version": "3.8.7",
   "description": "",
   "author": "aloma.io",
   "license": "Apache-2.0",

package/src/controller/index.mts

@@ -2,7 +2,7 @@ import Fetcher from "../internal/fetcher/fetcher.mjs";
 
 export abstract class AbstractController {
   protected config: {[key: string]: any} = {};
-  protected client?: Fetcher;
+  protected client: any;
 
   protected async start(): Promise<void> {}
 
@@ -36,7 +36,7 @@ export abstract class AbstractController {
     baseUrl?: string;
     onResponse?: (response: any) => void;
     customize?: (request: any) => void;
-  }): Promise<any> {
+  }): Promise<Fetcher> {
     throw new Error("not implemented");
   }
 

package/src/internal/fetcher/fetcher.mts

@@ -1,22 +1,25 @@
 import { unwrap } from "../util/index.mjs";
 
+/**
+ * http request fetcher
+ */
 export default class Fetcher {
-  retry: number;
-  baseUrl: any;
-  onResponse: any;
-  customize0: any;
-  constructor({ retry = 5, baseUrl, onResponse, customize }) {
+  protected retry: number;
+  protected baseUrl: any;
+  protected onResponse: any;
+  protected customize0: any;
+  constructor({ retry = 5, baseUrl, onResponse, customize }: {retry?: number; baseUrl?: string; onResponse?: (response: Response) => void; customize?: (request: {[key: string]: any}) => void} = {}) {
     this.retry = retry;
     this.baseUrl = baseUrl;
     this.onResponse = onResponse;
     if (customize) this.customize0 = customize;
   }
 
-  async customize(options = {}, args = {}) {
+  protected async customize(options = {}, args = {}) {
     if (this.customize0) await this.customize0(options, args);
   }
 
-  async onError(
+  protected async onError(
     e: any,
     url: string,
     options: any,
@@ -40,10 +43,33 @@ export default class Fetcher {
     });
   }
 
-  async fetch(url: string, options: any = {}, retries: number, args: any = {}) {
+  /**
+   * fetch data from a url
+   * @param url url to fetch
+   * @param options request options
+   * @param retries retries left for the request
+   * @param args optional args for customize()
+   * @returns
+   */
+  async fetch(url: string, options: {
+    /**
+     * request method like GET, POST, PUT, DELETE
+     */
+    method?: string;
+    /**
+     * request headers like Accept, Content-type
+     */
+    headers?: {[key: string]: any};
+    /**
+     * request body like "hello world" or {hello: "world"}
+     */
+    body?: any;
+  } = {}, retries?: number, args: any = {}) {
     var local = this,
       baseUrl = local.baseUrl;
 
+    const options0: any = {...options};
+
     if (retries == null) retries = local.retry;
 
     let theURL = !baseUrl
@@ -54,11 +80,11 @@ export default class Fetcher {
         );
 
     try {
-      options.url = url;
-      await local.customize(options, args);
+      options0.url = url;
+      await local.customize(options0, args);
 
-      url = options.url;
-      delete options.url;
+      url = options0.url;
+      delete options0.url;
 
       theURL = !baseUrl
         ? url
@@ -67,35 +93,35 @@ export default class Fetcher {
             "/",
           );
 
-      if (!options?.headers || !options?.headers?.Accept) {
-        options.headers = {
-          ...options.headers,
+      if (!options0?.headers || !options0?.headers?.Accept) {
+        options0.headers = {
+          ...options0.headers,
           Accept: "application/json",
         };
       }
 
-      if (!options?.headers || !options?.headers?.["Content-type"]) {
-        options.headers = {
-          ...options.headers,
+      if (!options0?.headers || !options0?.headers?.["Content-type"]) {
+        options0.headers = {
+          ...options0.headers,
           "Content-type": "application/json",
         };
       }
 
       if (
-        !(options?.method === "GET" || options?.method === "HEAD") &&
-        options?.body &&
-        !(typeof options.body === "string") &&
-        options?.headers?.["Content-type"] === "application/json"
+        !(options0?.method === "GET" || options0?.method === "HEAD") &&
+        options0?.body &&
+        !(typeof options0.body === "string") &&
+        options0?.headers?.["Content-type"] === "application/json"
       ) {
-        options.body = JSON.stringify(options.body);
+        options0.body = JSON.stringify(options0.body);
       }
 
       const timeout = Math.min(
-        options?.timeout || 30 * 60 * 1000,
+        options0?.timeout || 30 * 60 * 1000,
         30 * 60 * 1000,
       );
       const ret = await fetch(theURL, {
-        ...options,
+        ...options0,
         signal: AbortSignal.timeout(timeout),
       });
       const status = await ret.status;
@@ -116,11 +142,11 @@ export default class Fetcher {
         return { ok: true };
       }
 
-      return unwrap(ret, options);
+      return unwrap(ret, options0);
     } catch (e: any) {
       // too many requests
       if (e.status === 429) {
-        return local.onError(e, url, options, retries, args, true);
+        return local.onError(e, url, options0, retries, args, true);
       }
 
       // bad request
@@ -134,7 +160,7 @@ export default class Fetcher {
 
       if (retries <= 0) throw e;
 
-      return local.onError(e, url, options, retries, args);
+      return local.onError(e, url, options0, retries, args);
     }
   }
 }