@vulog/aima-client 1.0.7 → 1.0.9

package/dist/index.d.mts

@@ -9,6 +9,17 @@ type ClientOptions = {
     clientSecret: string;
     apiKey: string;
     secure?: boolean;
+    logCurl?: boolean;
+    logResponse?: boolean;
+    onRefreshToken?: (refreshToken: string) => void;
+    onLog?: (...args: any[]) => void;
+};
+type ClientError = {
+    formattedError: {
+        status: number;
+        data: any;
+    };
+    originalError: any;
 };
 type Client = AxiosInstance & {
     refreshToken?: string;
@@ -17,4 +28,4 @@ type Client = AxiosInstance & {
 
 declare const getClient: (options: ClientOptions) => Client;
 
-export { type ClientOptions, getClient };
+export { type Client, type ClientError, type ClientOptions, getClient };

package/dist/index.d.ts

@@ -9,6 +9,17 @@ type ClientOptions = {
     clientSecret: string;
     apiKey: string;
     secure?: boolean;
+    logCurl?: boolean;
+    logResponse?: boolean;
+    onRefreshToken?: (refreshToken: string) => void;
+    onLog?: (...args: any[]) => void;
+};
+type ClientError = {
+    formattedError: {
+        status: number;
+        data: any;
+    };
+    originalError: any;
 };
 type Client = AxiosInstance & {
     refreshToken?: string;
@@ -17,4 +28,4 @@ type Client = AxiosInstance & {
 
 declare const getClient: (options: ClientOptions) => Client;
 
-export { type ClientOptions, getClient };
+export { type Client, type ClientError, type ClientOptions, getClient };

package/dist/index.js

@@ -38,6 +38,81 @@ module.exports = __toCommonJS(src_exports);
 var import_axios = __toESM(require("axios"));
 var import_lodash = __toESM(require("lodash"));
 var import_lru_cache = require("lru-cache");
+
+// src/CurlHelper.ts
+var CurlHelper = class {
+  request;
+  constructor(config) {
+    this.request = config;
+  }
+  getHeaders() {
+    let { headers } = this.request;
+    let curlHeaders = "";
+    if (headers.hasOwnProperty("common")) {
+      headers = this.request.headers[this.request.method];
+    }
+    for (const property in this.request.headers) {
+      if (!["common", "delete", "get", "head", "patch", "post", "put"].includes(property)) {
+        headers[property] = this.request.headers[property];
+      }
+    }
+    for (const property in headers) {
+      if ({}.hasOwnProperty.call(headers, property)) {
+        const header = `${property}:${headers[property]}`;
+        curlHeaders = `${curlHeaders} -H '${header}'`;
+      }
+    }
+    return curlHeaders.trim();
+  }
+  getMethod() {
+    return `-X ${this.request.method.toUpperCase()}`;
+  }
+  getBody() {
+    if (typeof this.request.data !== "undefined" && this.request.data !== "" && this.request.data !== null && this.request.method.toUpperCase() !== "GET") {
+      const data = typeof this.request.data === "object" || Object.prototype.toString.call(this.request.data) === "[object Array]" ? JSON.stringify(this.request.data) : this.request.data;
+      return `--data '${data}'`.trim();
+    }
+    return "";
+  }
+  getUrl() {
+    if (this.request.baseURL) {
+      const baseUrl = this.request.baseURL;
+      const { url } = this.request;
+      const finalUrl = `${baseUrl}/${url}`;
+      return finalUrl.replace(/\/{2,}/g, "/").replace("http:/", "http://").replace("https:/", "https://");
+    }
+    return this.request.url;
+  }
+  getQueryString() {
+    if (this.request.paramsSerializer) {
+      const params2 = this.request.paramsSerializer(this.request.params);
+      if (!params2 || params2.length === 0) return "";
+      if (params2.startsWith("?")) return params2;
+      return `?${params2}`;
+    }
+    let params = "";
+    let i = 0;
+    for (const param in this.request.params) {
+      if ({}.hasOwnProperty.call(this.request.params, param)) {
+        params += i !== 0 ? `&${param}=${this.request.params[param]}` : `?${param}=${this.request.params[param]}`;
+        i += 1;
+      }
+    }
+    return params;
+  }
+  getBuiltURL() {
+    let url = this.getUrl();
+    if (this.getQueryString() !== "") {
+      url += this.getQueryString();
+    }
+    return url.trim();
+  }
+  generateCommand() {
+    return `curl ${this.getMethod()} "${this.getBuiltURL()}" ${this.getHeaders()} ${this.getBody()}`.trim().replace(/\s{2,}/g, " ");
+  }
+};
+
+// src/getClient.ts
 var clientCache = new import_lru_cache.LRUCache({ max: 100 });
 var formatError = (error) => {
   const { response: { status, data } = { status: 500 } } = error ?? {};
@@ -109,6 +184,7 @@ var getClient = (options) => {
     );
     client.defaults.headers.Authorization = `Bearer ${token.access_token}`;
     client.refreshToken = token.refresh_token;
+    options.onRefreshToken?.(token.refresh_token);
     return token.access_token;
   };
   client.signInWithPassword = async (username, password) => {
@@ -136,8 +212,24 @@ var getClient = (options) => {
     client.defaults.headers.Authorization = `Bearer ${token.access_token}`;
     client.refreshToken = token.refresh_token;
   };
+  if (options.logCurl) {
+    client.interceptors.request.use((request) => {
+      const curl = new CurlHelper(request).generateCommand();
+      if (options.onLog) options.onLog({ curl, message: "getClient > Curl command" });
+      else console.log({ curl, message: "getClient > Curl command" });
+      return request;
+    });
+  }
   client.interceptors.response.use(
-    (response) => response,
+    (response) => {
+      if (options.logResponse) {
+        const finalUrl = new CurlHelper(response.config).getBuiltURL();
+        const { data } = response;
+        if (options.onLog) options.onLog({ finalUrl, data, message: "getClient > Response" });
+        else console.log({ finalUrl, data, message: "getClient > Response" });
+      }
+      return response;
+    },
     (error) => {
       const { config, response: { status } = { status: 500 } } = error;
       const originalRequest = config;

package/dist/index.mjs

@@ -2,6 +2,81 @@
 import axios from "axios";
 import _ from "lodash";
 import { LRUCache } from "lru-cache";
+
+// src/CurlHelper.ts
+var CurlHelper = class {
+  request;
+  constructor(config) {
+    this.request = config;
+  }
+  getHeaders() {
+    let { headers } = this.request;
+    let curlHeaders = "";
+    if (headers.hasOwnProperty("common")) {
+      headers = this.request.headers[this.request.method];
+    }
+    for (const property in this.request.headers) {
+      if (!["common", "delete", "get", "head", "patch", "post", "put"].includes(property)) {
+        headers[property] = this.request.headers[property];
+      }
+    }
+    for (const property in headers) {
+      if ({}.hasOwnProperty.call(headers, property)) {
+        const header = `${property}:${headers[property]}`;
+        curlHeaders = `${curlHeaders} -H '${header}'`;
+      }
+    }
+    return curlHeaders.trim();
+  }
+  getMethod() {
+    return `-X ${this.request.method.toUpperCase()}`;
+  }
+  getBody() {
+    if (typeof this.request.data !== "undefined" && this.request.data !== "" && this.request.data !== null && this.request.method.toUpperCase() !== "GET") {
+      const data = typeof this.request.data === "object" || Object.prototype.toString.call(this.request.data) === "[object Array]" ? JSON.stringify(this.request.data) : this.request.data;
+      return `--data '${data}'`.trim();
+    }
+    return "";
+  }
+  getUrl() {
+    if (this.request.baseURL) {
+      const baseUrl = this.request.baseURL;
+      const { url } = this.request;
+      const finalUrl = `${baseUrl}/${url}`;
+      return finalUrl.replace(/\/{2,}/g, "/").replace("http:/", "http://").replace("https:/", "https://");
+    }
+    return this.request.url;
+  }
+  getQueryString() {
+    if (this.request.paramsSerializer) {
+      const params2 = this.request.paramsSerializer(this.request.params);
+      if (!params2 || params2.length === 0) return "";
+      if (params2.startsWith("?")) return params2;
+      return `?${params2}`;
+    }
+    let params = "";
+    let i = 0;
+    for (const param in this.request.params) {
+      if ({}.hasOwnProperty.call(this.request.params, param)) {
+        params += i !== 0 ? `&${param}=${this.request.params[param]}` : `?${param}=${this.request.params[param]}`;
+        i += 1;
+      }
+    }
+    return params;
+  }
+  getBuiltURL() {
+    let url = this.getUrl();
+    if (this.getQueryString() !== "") {
+      url += this.getQueryString();
+    }
+    return url.trim();
+  }
+  generateCommand() {
+    return `curl ${this.getMethod()} "${this.getBuiltURL()}" ${this.getHeaders()} ${this.getBody()}`.trim().replace(/\s{2,}/g, " ");
+  }
+};
+
+// src/getClient.ts
 var clientCache = new LRUCache({ max: 100 });
 var formatError = (error) => {
   const { response: { status, data } = { status: 500 } } = error ?? {};
@@ -73,6 +148,7 @@ var getClient = (options) => {
     );
     client.defaults.headers.Authorization = `Bearer ${token.access_token}`;
     client.refreshToken = token.refresh_token;
+    options.onRefreshToken?.(token.refresh_token);
     return token.access_token;
   };
   client.signInWithPassword = async (username, password) => {
@@ -100,8 +176,24 @@ var getClient = (options) => {
     client.defaults.headers.Authorization = `Bearer ${token.access_token}`;
     client.refreshToken = token.refresh_token;
   };
+  if (options.logCurl) {
+    client.interceptors.request.use((request) => {
+      const curl = new CurlHelper(request).generateCommand();
+      if (options.onLog) options.onLog({ curl, message: "getClient > Curl command" });
+      else console.log({ curl, message: "getClient > Curl command" });
+      return request;
+    });
+  }
   client.interceptors.response.use(
-    (response) => response,
+    (response) => {
+      if (options.logResponse) {
+        const finalUrl = new CurlHelper(response.config).getBuiltURL();
+        const { data } = response;
+        if (options.onLog) options.onLog({ finalUrl, data, message: "getClient > Response" });
+        else console.log({ finalUrl, data, message: "getClient > Response" });
+      }
+      return response;
+    },
     (error) => {
       const { config, response: { status } = { status: 500 } } = error;
       const originalRequest = config;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-client",
-    "version": "1.0.7",
+    "version": "1.0.9",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",

package/src/CurlHelper.ts

@@ -0,0 +1,108 @@
+export class CurlHelper {
+    private request: any;
+
+    constructor(config: any) {
+        this.request = config;
+    }
+
+    getHeaders() {
+        let { headers } = this.request;
+        let curlHeaders = '';
+
+        // get the headers concerning the appropriate method (defined in the global axios instance)
+        // eslint-disable-next-line no-prototype-builtins
+        if (headers.hasOwnProperty('common')) {
+            headers = this.request.headers[this.request.method];
+        }
+
+        // add any custom headers (defined upon calling methods like .get(), .post(), etc.)
+        // eslint-disable-next-line no-restricted-syntax
+        for (const property in this.request.headers) {
+            if (!['common', 'delete', 'get', 'head', 'patch', 'post', 'put'].includes(property)) {
+                headers[property] = this.request.headers[property];
+            }
+        }
+
+        // eslint-disable-next-line no-restricted-syntax
+        for (const property in headers) {
+            if ({}.hasOwnProperty.call(headers, property)) {
+                const header = `${property}:${headers[property]}`;
+                curlHeaders = `${curlHeaders} -H '${header}'`;
+            }
+        }
+
+        return curlHeaders.trim();
+    }
+
+    getMethod() {
+        return `-X ${this.request.method.toUpperCase()}`;
+    }
+
+    getBody() {
+        if (
+            typeof this.request.data !== 'undefined' &&
+            this.request.data !== '' &&
+            this.request.data !== null &&
+            this.request.method.toUpperCase() !== 'GET'
+        ) {
+            const data =
+                typeof this.request.data === 'object' ||
+                Object.prototype.toString.call(this.request.data) === '[object Array]'
+                    ? JSON.stringify(this.request.data)
+                    : this.request.data;
+            return `--data '${data}'`.trim();
+        }
+        return '';
+    }
+
+    getUrl() {
+        if (this.request.baseURL) {
+            const baseUrl = this.request.baseURL;
+            const { url } = this.request;
+            const finalUrl = `${baseUrl}/${url}`;
+            return finalUrl
+                .replace(/\/{2,}/g, '/')
+                .replace('http:/', 'http://')
+                .replace('https:/', 'https://');
+        }
+        return this.request.url;
+    }
+
+    getQueryString() {
+        if (this.request.paramsSerializer) {
+            const params = this.request.paramsSerializer(this.request.params);
+            if (!params || params.length === 0) return '';
+            if (params.startsWith('?')) return params;
+            return `?${params}`;
+        }
+        let params = '';
+        let i = 0;
+
+        // eslint-disable-next-line no-restricted-syntax
+        for (const param in this.request.params) {
+            if ({}.hasOwnProperty.call(this.request.params, param)) {
+                params +=
+                    i !== 0 ? `&${param}=${this.request.params[param]}` : `?${param}=${this.request.params[param]}`;
+                i += 1;
+            }
+        }
+
+        return params;
+    }
+
+    getBuiltURL() {
+        let url = this.getUrl();
+
+        if (this.getQueryString() !== '') {
+            url += this.getQueryString();
+        }
+
+        return url.trim();
+    }
+
+    generateCommand() {
+        return `curl ${this.getMethod()} "${this.getBuiltURL()}" ${this.getHeaders()} ${this.getBody()}`
+            .trim()
+            .replace(/\s{2,}/g, ' ');
+    }
+}

package/src/getClient.ts

@@ -2,6 +2,7 @@ import axios from 'axios';
 import _ from 'lodash';
 import { LRUCache } from 'lru-cache';
 
+import { CurlHelper } from './CurlHelper';
 import { Client, ClientError, ClientOptions } from './types';
 
 const clientCache = new LRUCache<
@@ -89,6 +90,7 @@ const getClient = (options: ClientOptions): Client => {
         );
         client.defaults.headers.Authorization = `Bearer ${token.access_token}`;
         client.refreshToken = token.refresh_token;
+        options.onRefreshToken?.(token.refresh_token);
         return token.access_token;
     };
 
@@ -119,8 +121,27 @@ const getClient = (options: ClientOptions): Client => {
         client.refreshToken = token.refresh_token;
     };
 
+    if (options.logCurl) {
+        client.interceptors.request.use((request) => {
+            const curl = new CurlHelper(request).generateCommand();
+            if (options.onLog) options.onLog({ curl, message: 'getClient > Curl command' });
+            // eslint-disable-next-line no-console
+            else console.log({ curl, message: 'getClient > Curl command' });
+            return request;
+        });
+    }
+
     client.interceptors.response.use(
-        (response) => response,
+        (response) => {
+            if (options.logResponse) {
+                const finalUrl = new CurlHelper(response.config).getBuiltURL();
+                const { data } = response;
+                if (options.onLog) options.onLog({ finalUrl, data, message: 'getClient > Response' });
+                // eslint-disable-next-line no-console
+                else console.log({ finalUrl, data, message: 'getClient > Response' });
+            }
+            return response;
+        },
         (error) => {
             const { config, response: { status } = { status: 500 } } = error;
             const originalRequest = config;

package/src/index.ts

@@ -1,4 +1,4 @@
 import getClient from './getClient';
-import { ClientOptions } from './types';
+import { ClientOptions, Client, ClientError } from './types';
 
-export { ClientOptions, getClient };
+export { ClientOptions, getClient, Client, ClientError };

package/src/types.ts

@@ -9,6 +9,10 @@ export type ClientOptions = {
     clientSecret: string;
     apiKey: string;
     secure?: boolean;
+    logCurl?: boolean;
+    logResponse?: boolean;
+    onRefreshToken?: (refreshToken: string) => void;
+    onLog?: (...args: any[]) => void;
 };
 
 export type ClientError = {