@docbrasil/api-systemmanager 1.1.55 → 1.1.57

package/api/dispatch.js

@@ -19,13 +19,15 @@ class Dispatch {
       withCredentials: true
     });
 
-    // Add request interceptor for offline handling
+    // Add request interceptor for offline handling.
     self._client.interceptors.request.use(
         async (config) => {
+          // If online or no cache is provided, proceed normally.
           if (self._isOnline() || !self._cache) {
             return config;
           }
 
+          // We're offline and caching is enabled – try to retrieve cached data.
           const cachedData = await self._getCache(config.url, {
             method: config.method,
             data: config.data,
@@ -34,54 +36,75 @@ class Dispatch {
           });
 
           if (cachedData) {
-            config.cached = true;
-            config.data = cachedData;
-            return config;
+            // Instead of returning the modified config (which would trigger a network call),
+            // return a rejected promise with a flag and a fake response.
+            return Promise.reject({
+              __fromCache: true,
+              response: {
+                data: cachedData,
+                status: 200,
+                statusText: 'OK',
+                headers: config.headers,
+                config: config,
+                request: {} // empty placeholder
+              }
+            });
           }
 
+          // No cached data found – signal an offline error.
           self.errorOffline();
-          throw new Error('Network error: No internet connection and no cached data available');
+          return Promise.reject(new Error('Network error: No internet connection and no cached data available'));
         },
         error => Promise.reject(error)
     );
 
-    // Add response interceptor to handle caching
+    // Add response interceptor to handle caching and to return a cached response when available.
     self._client.interceptors.response.use(
         async response => {
-          if (response.status === 200 && self._isOnline() && self._cache && !response.cached) {
-            await self._setCache(response.config.url, {
-              method: response.config.method,
-              data: response.config.data,
-              params: response.config.params,
-              headers: response.config.headers
-            }, response.data);
+          // If online, the response is OK, caching is enabled, and this wasn’t a cached response,
+          // then cache the new response data.
+          if (response.status === 200 && self._isOnline() && self._cache && !response.config.cached) {
+            await self._setCache(
+                response.config.url,
+                {
+                  method: response.config.method,
+                  data: response.config.data,
+                  params: response.config.params,
+                  headers: response.config.headers
+                },
+                response.data
+            );
           }
           return response;
         },
-        error => Promise.reject(error)
+        error => {
+          // If the error was generated because we had a cached response, then return that response.
+          if (error.__fromCache && error.response) {
+            return Promise.resolve(error.response);
+          }
+          return Promise.reject(error);
+        }
     );
   }
 
   /**
-   * @author Augusto Pissarra <abernardo.br@gmail.com>
-   * @description Get the return data and check for errors
-   * @param {object} retData Response HTTP
+   * @description Get the return data and check for errors.
+   * @param {object} retData Response HTTP.
+   * @param {*} [def={}] Default value to return if no data is found.
    * @return {*}
    * @private
    */
   _returnData(retData, def = {}) {
     if (retData.status !== 200) {
-      throw Boom.badRequest(_.get(retData, 'message', 'No error message reported!'))
-    } else {
-      return _.get(retData, 'data', def);
+      throw new Error(_.get(retData, 'message', 'No error message reported!'));
     }
+    return _.get(retData, 'data', def);
   }
 
   /**
-   * @author Myndware <augusto.pissarra@myndware.com>
-   * @description Set header with new session
-   * @param {string} session Session, token JWT
-   * @return {object} header with new session
+   * @description Set header with new session.
+   * @param {string} session Session token (JWT).
+   * @return {object} Header object with the new session.
    * @private
    */
   _setHeader(session) {
@@ -93,20 +116,20 @@ class Dispatch {
   }
 
   /**
-   * @description Check if the browser/client is currently online
-   * @return {boolean} True if online, false if offline
+   * @description Check if the browser/client is currently online.
+   * @return {boolean} True if online, false if offline.
    * @private
    */
   _isOnline() {
-    if(this._forceCache) return false;
+    if (this._forceCache) return false;
     return typeof navigator !== 'undefined' && navigator.onLine;
   }
 
   /**
-   * @description Get cached data for a specific request
-   * @param {string} url The request URL
-   * @param {object} options Request options including method, data, params, and headers
-   * @return {Promise<object|null>} Cached data or null if no cache exists
+   * @description Get cached data for a specific request.
+   * @param {string} url The request URL.
+   * @param {object} options Request options including method, data, params, and headers.
+   * @return {Promise<object|null>} Cached data or null if no cache exists.
    * @private
    */
   async _getCache(url, options) {
@@ -119,10 +142,10 @@ class Dispatch {
   }
 
   /**
-   * @description Set data in cache for a specific request
-   * @param {string} url The request URL
-   * @param {object} options Request options including method, data, params, and headers
-   * @param {object} data The data to cache
+   * @description Set data in cache for a specific request.
+   * @param {string} url The request URL.
+   * @param {object} options Request options including method, data, params, and headers.
+   * @param {object} data The data to cache.
    * @return {Promise<void>}
    * @private
    */
@@ -134,28 +157,28 @@ class Dispatch {
     }
   }
 
+  /**
+   * Called when no cache is available and the client is offline.
+   */
   errorOffline() {
-    this._cache.errorOffline();
+    if (this._cache && typeof this._cache.errorOffline === 'function') {
+      this._cache.errorOffline();
+    }
   }
 
   /**
-   * Get the URL context
-   * @param url {string} Full url
-   * @param session {session} Session, token JWT
-   * @return {Promise<object>} The full data context of the URL
+   * Get the URL context.
+   * @param {string} url Full URL.
+   * @param {string|null} [session=null] Session token (JWT).
+   * @return {Promise<object>} The full data context of the URL.
    * @public
    * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * const retContext = await api.dispatch.getContext('http://myndware.io/login/myorg);
-   *
    */
   async getContext(url, session = null) {
     Joi.assert(url, Joi.string().required());
 
-    if(url.includes('?')) {
+    // Append the json flag to the URL.
+    if (url.includes('?')) {
       url = `${url}&json=true`;
     } else {
       url = `${url}?json=true`;
@@ -168,24 +191,12 @@ class Dispatch {
   }
 
   /**
-   * @author Myndware <augusto.pissarra@myndware.com>
-   * @description Get client Axios
-   * @return {promise} return client axios
+   * @description Get the Axios client.
+   * @return {AxiosInstance} The Axios client.
    * @public
-   * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * await api.dispatch.getClient();
    */
   getClient() {
-    try {
-      const self = this;
-      return self._client;
-    } catch (ex) {
-      return ex;
-    }
+    return this._client;
   }
 }
 

package/dist/bundle.cjs

@@ -31,13 +31,15 @@ class Dispatch {
       withCredentials: true
     });
 
-    // Add request interceptor for offline handling
+    // Add request interceptor for offline handling.
     self._client.interceptors.request.use(
         async (config) => {
+          // If online or no cache is provided, proceed normally.
           if (self._isOnline() || !self._cache) {
             return config;
           }
 
+          // We're offline and caching is enabled – try to retrieve cached data.
           const cachedData = await self._getCache(config.url, {
             method: config.method,
             data: config.data,
@@ -46,54 +48,75 @@ class Dispatch {
           });
 
           if (cachedData) {
-            config.cached = true;
-            config.data = cachedData;
-            return config;
+            // Instead of returning the modified config (which would trigger a network call),
+            // return a rejected promise with a flag and a fake response.
+            return Promise.reject({
+              __fromCache: true,
+              response: {
+                data: cachedData,
+                status: 200,
+                statusText: 'OK',
+                headers: config.headers,
+                config: config,
+                request: {} // empty placeholder
+              }
+            });
           }
 
+          // No cached data found – signal an offline error.
           self.errorOffline();
-          throw new Error('Network error: No internet connection and no cached data available');
+          return Promise.reject(new Error('Network error: No internet connection and no cached data available'));
         },
         error => Promise.reject(error)
     );
 
-    // Add response interceptor to handle caching
+    // Add response interceptor to handle caching and to return a cached response when available.
     self._client.interceptors.response.use(
         async response => {
-          if (response.status === 200 && self._isOnline() && self._cache && !response.cached) {
-            await self._setCache(response.config.url, {
-              method: response.config.method,
-              data: response.config.data,
-              params: response.config.params,
-              headers: response.config.headers
-            }, response.data);
+          // If online, the response is OK, caching is enabled, and this wasn’t a cached response,
+          // then cache the new response data.
+          if (response.status === 200 && self._isOnline() && self._cache && !response.config.cached) {
+            await self._setCache(
+                response.config.url,
+                {
+                  method: response.config.method,
+                  data: response.config.data,
+                  params: response.config.params,
+                  headers: response.config.headers
+                },
+                response.data
+            );
           }
           return response;
         },
-        error => Promise.reject(error)
+        error => {
+          // If the error was generated because we had a cached response, then return that response.
+          if (error.__fromCache && error.response) {
+            return Promise.resolve(error.response);
+          }
+          return Promise.reject(error);
+        }
     );
   }
 
   /**
-   * @author Augusto Pissarra <abernardo.br@gmail.com>
-   * @description Get the return data and check for errors
-   * @param {object} retData Response HTTP
+   * @description Get the return data and check for errors.
+   * @param {object} retData Response HTTP.
+   * @param {*} [def={}] Default value to return if no data is found.
    * @return {*}
    * @private
    */
   _returnData(retData, def = {}) {
     if (retData.status !== 200) {
-      throw Boom.badRequest(___default["default"].get(retData, 'message', 'No error message reported!'))
-    } else {
-      return ___default["default"].get(retData, 'data', def);
+      throw new Error(___default["default"].get(retData, 'message', 'No error message reported!'));
     }
+    return ___default["default"].get(retData, 'data', def);
   }
 
   /**
-   * @author Myndware <augusto.pissarra@myndware.com>
-   * @description Set header with new session
-   * @param {string} session Session, token JWT
-   * @return {object} header with new session
+   * @description Set header with new session.
+   * @param {string} session Session token (JWT).
+   * @return {object} Header object with the new session.
    * @private
    */
   _setHeader(session) {
@@ -105,20 +128,20 @@ class Dispatch {
   }
 
   /**
-   * @description Check if the browser/client is currently online
-   * @return {boolean} True if online, false if offline
+   * @description Check if the browser/client is currently online.
+   * @return {boolean} True if online, false if offline.
    * @private
    */
   _isOnline() {
-    if(this._forceCache) return false;
+    if (this._forceCache) return false;
     return typeof navigator !== 'undefined' && navigator.onLine;
   }
 
   /**
-   * @description Get cached data for a specific request
-   * @param {string} url The request URL
-   * @param {object} options Request options including method, data, params, and headers
-   * @return {Promise<object|null>} Cached data or null if no cache exists
+   * @description Get cached data for a specific request.
+   * @param {string} url The request URL.
+   * @param {object} options Request options including method, data, params, and headers.
+   * @return {Promise<object|null>} Cached data or null if no cache exists.
    * @private
    */
   async _getCache(url, options) {
@@ -131,10 +154,10 @@ class Dispatch {
   }
 
   /**
-   * @description Set data in cache for a specific request
-   * @param {string} url The request URL
-   * @param {object} options Request options including method, data, params, and headers
-   * @param {object} data The data to cache
+   * @description Set data in cache for a specific request.
+   * @param {string} url The request URL.
+   * @param {object} options Request options including method, data, params, and headers.
+   * @param {object} data The data to cache.
    * @return {Promise<void>}
    * @private
    */
@@ -146,28 +169,28 @@ class Dispatch {
     }
   }
 
+  /**
+   * Called when no cache is available and the client is offline.
+   */
   errorOffline() {
-    this._cache.errorOffline();
+    if (this._cache && typeof this._cache.errorOffline === 'function') {
+      this._cache.errorOffline();
+    }
   }
 
   /**
-   * Get the URL context
-   * @param url {string} Full url
-   * @param session {session} Session, token JWT
-   * @return {Promise<object>} The full data context of the URL
+   * Get the URL context.
+   * @param {string} url Full URL.
+   * @param {string|null} [session=null] Session token (JWT).
+   * @return {Promise<object>} The full data context of the URL.
    * @public
    * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * const retContext = await api.dispatch.getContext('http://myndware.io/login/myorg);
-   *
    */
   async getContext(url, session = null) {
     Joi__default["default"].assert(url, Joi__default["default"].string().required());
 
-    if(url.includes('?')) {
+    // Append the json flag to the URL.
+    if (url.includes('?')) {
       url = `${url}&json=true`;
     } else {
       url = `${url}?json=true`;
@@ -180,24 +203,12 @@ class Dispatch {
   }
 
   /**
-   * @author Myndware <augusto.pissarra@myndware.com>
-   * @description Get client Axios
-   * @return {promise} return client axios
+   * @description Get the Axios client.
+   * @return {AxiosInstance} The Axios client.
    * @public
-   * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * await api.dispatch.getClient();
    */
   getClient() {
-    try {
-      const self = this;
-      return self._client;
-    } catch (ex) {
-      return ex;
-    }
+    return this._client;
   }
 }