@docbrasil/api-systemmanager 1.1.50 → 1.1.52

package/doc/api.md

@@ -1374,6 +1374,7 @@ Class for Applications, permission user
 * [Application](#Application)
     * [.list(params, session)](#Application+list) ⇒ <code>promise</code>
     * [.changeApplication(params, session)](#Application+changeApplication) ⇒ <code>promise</code>
+    * [.getCache(params, session)](#Application+getCache) ⇒ <code>promise</code>
 
 <a name="Application+list"></a>
 
@@ -1425,6 +1426,33 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.user.application.changeApplication(params, session);
 ```
+<a name="Application+getCache"></a>
+
+### application.getCache(params, session) ⇒ <code>promise</code>
+Gets the application and pages to start the cache process
+
+**Kind**: instance method of [<code>Application</code>](#Application)  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> |  |
+| params.orgId | <code>object</code> | the orgId of this application |
+| params.appId | <code>object</code> | the application id |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ orgId: '55e4a3bd6be6b45210833f78',
+ appId: '55e4a3bd6be6b45210833fae',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.application.getCache(params, session);
+```
 <a name="Chart"></a>
 
 ## Chart

package/docs/Application.html

@@ -464,6 +464,276 @@ await api.user.application.changeApplication(params, session);</code></pre>
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="getCache">
+        <a class="href-link" href="#getCache">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                getCache<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Gets the application and pages to start the cache process
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>Name</th>
+            
+
+            <th>Type</th>
+
+            
+
+            
+
+            <th class="last">Description</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>params</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last"></td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>orgId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">the orgId of this application</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>appId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">the application id</td>
+</tr>
+
+  
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>session</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Session, token JWT</td>
+</tr>
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+        <p class="tag-source">
+            <a href="user_application.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_application.js.html">user/application.js</a>, <a href="user_application.js.html#line144">line 144</a>
+            </span>
+        </p>
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>Returns:</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">promise</code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ orgId: '55e4a3bd6be6b45210833f78',
+ appId: '55e4a3bd6be6b45210833fae',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.application.getCache(params, session);</code></pre>
+    
+
+
 </div>
             
                 <div class="member">

package/docs/Dispatch.html

@@ -300,7 +300,7 @@
         <p class="tag-source">
             <a href="dispatch.js.html" class="button">View Source</a>
             <span>
-                <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line91">line 91</a>
+                <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line196">line 196</a>
             </span>
         </p>
     
@@ -523,7 +523,7 @@ await api.dispatch.getClient();</code></pre>
         <p class="tag-source">
             <a href="dispatch.js.html" class="button">View Source</a>
             <span>
-                <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line64">line 64</a>
+                <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line169">line 169</a>
             </span>
         </p>
     

package/docs/dispatch.js.html

@@ -93,15 +93,74 @@ import Axios from 'axios';
  * @class Api dispatch manager
  */
 class Dispatch {
-
   constructor(options) {
-
     Joi.assert(options, Joi.object().required());
     Joi.assert(options.parent, Joi.object().required());
 
     const self = this;
+    self._cache = options.parent.options.cache;
+    self._forceCache = options.parent.options.forceCache;
     self.parent = options.parent;
     self._client = Axios.create({baseURL: self.parent.options.uri, withCredentials: true});
+
+    // Add request interceptor for offline handling
+    self._client.interceptors.request.use(
+        async (config) => {
+          if (self._isOnline() || !self._cache) {
+            return config;
+          }
+
+          const cachedData = await self._getCache(config.url, {
+            method: config.method,
+            data: config.data,
+            params: config.params,
+            headers: config.headers
+          });
+
+          if (cachedData) {
+            // Cancel the actual request and return cached data
+            const dummyResponse = {
+              status: 200,
+              data: cachedData,
+              headers: {},
+              config,
+              cached: true
+            };
+
+            // Throwing a special error that includes our cached response
+            throw {
+              __CACHE_HIT__: true,
+              response: dummyResponse
+            };
+          }
+
+          self.errorOffline();
+          throw new Error('Network error: No internet connection and no cached data available');
+        },
+        error => Promise.reject(error)
+    );
+
+    // Add response interceptor to handle cache hits and cache successful responses
+    self._client.interceptors.response.use(
+        async response => {
+          // Cache successful responses when online
+          if (response.status === 200 && self._isOnline() && self._cache) {
+            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 => {
+          if (error.__CACHE_HIT__) {
+            return error.response;
+          }
+          return Promise.reject(error);
+        }
+    );
   }
 
   /**
@@ -134,6 +193,52 @@ class Dispatch {
     };
   }
 
+  /**
+   * @description Check if the browser/client is currently online
+   * @return {boolean} True if online, false if offline
+   * @private
+   */
+  _isOnline() {
+    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
+   * @private
+   */
+  async _getCache(url, options) {
+    try {
+      return await this._cache.getCache(url, options);
+    } catch (error) {
+      console.warn('Cache retrieval failed:', error);
+      return null;
+    }
+  }
+
+  /**
+   * @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
+   */
+  async _setCache(url, options, data) {
+    try {
+      await this._cache.setCache(url, options, data);
+    } catch (error) {
+      console.warn('Cache storage failed:', error);
+    }
+  }
+
+  errorOffline() {
+    this._cache.errorOffline();
+  }
+
   /**
    * Get the URL context
    * @param url {string} Full url
@@ -159,8 +264,8 @@ class Dispatch {
 
     const self = this;
     const header = session ? self._setHeader(session) : {};
-    const apiCall = self._client.get(url, header);
-    return self._returnData(await apiCall);
+    const apiCall = await self._client.get(url, header);
+    return self._returnData(apiCall);
   }
 
   /**

package/docs/user_application.js.html

@@ -207,6 +207,45 @@ class Application {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Gets the application and pages to start the cache process
+   * @param {object} params
+   * @param {object} params.orgId the orgId of this application
+   * @param {object} params.appId the application id
+   * @param {string} session Session, token JWT
+   * @returns {promise}
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  orgId: '55e4a3bd6be6b45210833f78',
+   *  appId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.application.getCache(params, session);
+   */
+  async getCache(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to get task');
+      Joi.assert(params.orgId, Joi.string().required(), 'The organizations id');
+      Joi.assert(params.appId, Joi.string().required(), 'The application id');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const { orgId, appId} = params;
+      const apiCall = self._client
+          .get(`/organizations/${orgId}/applications/${appId}/cache`, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default Application;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.50",
+  "version": "1.1.52",
   "scripts": {
     "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
     "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",