@docbrasil/api-systemmanager 1.1.16 → 1.1.18

package/doc/api.md

@@ -1805,13 +1805,13 @@ Class for user registration in a user
 **Kind**: global class  
 
 * [Help](#Help)
-    * [.getTopics(session)](#Help+getTopics)
+    * [.getTopics(filter, session)](#Help+getTopics)
     * [.get(params, session)](#Help+get) ⇒ <code>promise</code>
 
 <a name="Help+getTopics"></a>
 
-### help.getTopics(session)
-get heps topics
+### help.getTopics(filter, session)
+get help topics for a user. Either by organizaiton product or by supplied filter. But always only the user language.
 
 **Kind**: instance method of [<code>Help</code>](#Help)  
 **Access**: public  
@@ -1819,6 +1819,7 @@ get heps topics
 
 | Param | Type | Description |
 | --- | --- | --- |
+| filter | <code>object</code> | a filter to apply. if empty, null or undefined, than we will bring the help topics by organizaiton product. |
 | session | <code>string</code> | JWT token |
 
 **Example**  
@@ -1826,7 +1827,7 @@ get heps topics
 const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-await api.user.help.getTopics(session);
+await api.user.help.getTopics({}, session);
 ```
 <a name="Help+get"></a>
 

package/docs/Help.html

@@ -402,7 +402,7 @@
         <p class="tag-source">
             <a href="user_help.js.html" class="button">View Source</a>
             <span>
-                <a href="user_help.js.html">user/help.js</a>, <a href="user_help.js.html#line94">line 94</a>
+                <a href="user_help.js.html">user/help.js</a>, <a href="user_help.js.html#line99">line 99</a>
             </span>
         </p>
     
@@ -479,7 +479,7 @@ await api.user.help.get(params, session);</code></pre>
         
         <span class="code-name">
             
-                getTopics<span class="signature">(session)</span><span class="type-signature"></span>
+                getTopics<span class="signature">(filter, session)</span><span class="type-signature"></span>
             
         </span>
     </h4>
@@ -488,7 +488,7 @@ await api.user.help.get(params, session);</code></pre>
     
     
     <div class="description">
-        get heps topics
+        get help topics for a user. Either by organizaiton product or by supplied filter. But always only the user language.
     </div>
     
 
@@ -524,6 +524,31 @@ await api.user.help.get(params, session);</code></pre>
         
 
             
+<tr class="deep-level-0">
+  
+      <td class="name"><code>filter</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">a filter to apply. if empty, null or undefined, than we will bring the help topics by organizaiton product.</td>
+</tr>
+
+
+        
+
+            
 <tr class="deep-level-0">
   
       <td class="name"><code>session</code></td>
@@ -597,7 +622,7 @@ await api.user.help.get(params, session);</code></pre>
         <p class="tag-source">
             <a href="user_help.js.html" class="button">View Source</a>
             <span>
-                <a href="user_help.js.html">user/help.js</a>, <a href="user_help.js.html#line63">line 63</a>
+                <a href="user_help.js.html">user/help.js</a>, <a href="user_help.js.html#line64">line 64</a>
             </span>
         </p>
     
@@ -629,7 +654,7 @@ await api.user.help.get(params, session);</code></pre>
         <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
 const api = new API();
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-await api.user.help.getTopics(session);</code></pre>
+await api.user.help.getTopics({}, session);</code></pre>
     
 
 

package/docs/user_document.js.html

@@ -880,8 +880,8 @@ class Documents {
       Joi.assert(session, Joi.string().required(), 'Session token JWT');
 
       const {query, orgId} = params;
-      const params = new URLSearchParams(query);
-      const queryString = params.toString();
+      const searchParams = new URLSearchParams(query);
+      const queryString = searchParams.toString();
       const apiCall = self._client.get(`/organizations/${orgId}/documents/search?${queryString}`, self._setHeader(session));
 
       return self._returnData(await apiCall);

package/docs/user_help.js.html

@@ -136,7 +136,8 @@ class Help {
 
   /**
    * @author Augusto Pissarra <abernardo.br@gmail.com>
-   * @description get heps topics
+   * @description get help topics for a user. Either by organizaiton product or by supplied filter. But always only the user language.
+   * @param {object} filter a filter to apply. if empty, null or undefined, than we will bring the help topics by organizaiton product.
    * @param {string} session JWT token
    * @public
    * @async
@@ -145,15 +146,19 @@ class Help {
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * await api.user.help.getTopics(session);
+   * await api.user.help.getTopics({}, session);
    */
-  async getTopics(session) {
+  async getTopics(filter = {}, session) {
     const self = this;
 
     try {
       Joi.assert(session, Joi.string().required(), 'SM session (JWT) to call API');
-
-      const apiCall = self._client.get('/help/topics', self._setHeader(session));
+      let query = '';
+      if(!_.isEmpty(filter)) {
+        const queryFilter = JSON.stringify(filter);
+        query = `?filter=${queryFilter.toString('base64')}`;
+      }
+      const apiCall = self._client.get(`/help/topics${query}`, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.16",
+  "version": "1.1.18",
   "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",

package/tests/test_querystring.js

@@ -0,0 +1,18 @@
+function doQuery(query) {
+    const searchParams = new URLSearchParams(query);
+    const queryString = searchParams.toString();
+    return queryString;
+}
+
+console.log(doQuery({
+    p: 200,
+    i: 1,
+    s: 'Mais recentes',
+    as: '',
+    m: 'w',
+    ai: '111',
+    di: '222',
+    ix: JSON.stringify([
+        ['extraUserid', '333', '=', 'text']
+    ])
+}));