@arrowsphere/api-client 3.180.0-rc.fdi.10 → 3.180.0-rc.fdi.11

package/build/axiosSingleton.d.ts

@@ -5,18 +5,56 @@ export declare type AxiosSingletonConfiguration = {
 export declare class AxiosSingleton {
     private static _axiosInstance;
     private static _isLogging;
+    /**
+     * Get the singleton instance of Axios.
+     * @param configuration - Configuration object for AxiosSingleton.
+     *
+     * @returns The Axios instance.
+     */
     static getInstance(configuration?: AxiosSingletonConfiguration): AxiosInstance;
+    /**
+     * Initialize the request interceptor.
+     */
     private static _initializedRequestInterceptor;
+    /**
+     * Initialize the response interceptor.
+     */
     private static _initializedResponseInterceptor;
     /**
-     * @param request - Axios Request
-     * @param isLogging - Must log
+     * Handle the request before it is sent.
+     *
+     * @param request - The Axios request configuration.
+     * @param isLogging - Whether logging is enabled.
+     *
+     * @returns The modified request configuration.
      */
     private static _handleRequest;
     /**
-     * @param response - Axios Response
-     * @param isLogging - Must log
+     * Handle the response after it is received.
+     *
+     * @param response - The Axios response.
+     * @param isLogging - Whether logging is enabled.
+     *
+     * @returns The modified response.
      */
     private static _handleResponse;
+    /**
+     * Clean the response log by removing sensitive information.
+     *
+     * @param response - The Axios response.
+     *
+     * @returns The sanitized response.
+     */
+    private static cleanResponseLog;
+    /**
+     * Sanitize an object by obfuscating sensitive fields.
+     * This function is recursive and supports circular references using WeakMap.
+     *
+     * @param obj - The object to sanitize.
+     * @param fieldsToObfuscate - List of keys whose values should be replaced with '***'. Defaults to ["authorization", "x-api-key", "password", "token"].
+     * @param seen - Internal map to track processed objects and prevent infinite loops. Defaults to new WeakMap().
+     *
+     * @returns A new sanitized object with sensitive data obfuscated or removed.
+     */
     private static sanitizeObject;
 }

package/build/axiosSingleton.js

@@ -14,6 +14,12 @@ var DefaultObfuscateFields;
     DefaultObfuscateFields["OLD_PASSWORD"] = "oldPassword";
 })(DefaultObfuscateFields || (DefaultObfuscateFields = {}));
 class AxiosSingleton {
+    /**
+     * Get the singleton instance of Axios.
+     * @param configuration - Configuration object for AxiosSingleton.
+     *
+     * @returns The Axios instance.
+     */
     static getInstance(configuration = {}) {
         this._isLogging = !!configuration.isLogging;
         if (!AxiosSingleton._axiosInstance) {
@@ -24,15 +30,25 @@ class AxiosSingleton {
         }
         return AxiosSingleton._axiosInstance;
     }
+    /**
+     * Initialize the request interceptor.
+     */
     static _initializedRequestInterceptor() {
         this._axiosInstance.interceptors.request.use((req) => this._handleRequest(req, this._isLogging));
     }
+    /**
+     * Initialize the response interceptor.
+     */
     static _initializedResponseInterceptor() {
         this._axiosInstance.interceptors.response.use((req) => this._handleResponse(req, this._isLogging));
     }
     /**
-     * @param request - Axios Request
-     * @param isLogging - Must log
+     * Handle the request before it is sent.
+     *
+     * @param request - The Axios request configuration.
+     * @param isLogging - Whether logging is enabled.
+     *
+     * @returns The modified request configuration.
      */
     static _handleRequest(request, isLogging = false) {
         if (isLogging) {
@@ -41,15 +57,40 @@ class AxiosSingleton {
         return request;
     }
     /**
-     * @param response - Axios Response
-     * @param isLogging - Must log
+     * Handle the response after it is received.
+     *
+     * @param response - The Axios response.
+     * @param isLogging - Whether logging is enabled.
+     *
+     * @returns The modified response.
      */
     static _handleResponse(response, isLogging = false) {
         if (isLogging) {
-            console.info('AXIOS - Response : ', AxiosSingleton.sanitizeObject(response));
+            console.info('AXIOS - Response : ', AxiosSingleton.cleanResponseLog(response));
         }
         return response;
     }
+    /**
+     * Clean the response log by removing sensitive information.
+     *
+     * @param response - The Axios response.
+     *
+     * @returns The sanitized response.
+     */
+    static cleanResponseLog(response) {
+        delete response.request;
+        return AxiosSingleton.sanitizeObject(response);
+    }
+    /**
+     * Sanitize an object by obfuscating sensitive fields.
+     * This function is recursive and supports circular references using WeakMap.
+     *
+     * @param obj - The object to sanitize.
+     * @param fieldsToObfuscate - List of keys whose values should be replaced with '***'. Defaults to ["authorization", "x-api-key", "password", "token"].
+     * @param seen - Internal map to track processed objects and prevent infinite loops. Defaults to new WeakMap().
+     *
+     * @returns A new sanitized object with sensitive data obfuscated or removed.
+     */
     static sanitizeObject(obj, fieldsToObfuscate = [
         DefaultObfuscateFields.API_KEY,
         DefaultObfuscateFields.PASSWORD,

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "3.180.0-rc.fdi.10",
+  "version": "3.180.0-rc.fdi.11",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",