@docbrasil/api-systemmanager 1.1.62 → 1.1.64

package/doc/api.md

@@ -2260,6 +2260,7 @@ Class for task, permission user
 
 * [Kanban](#Kanban)
     * [.get(params, session)](#Kanban+get) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>Array</code> \| <code>string</code> \| <code>string</code> \| <code>boolean</code> \| <code>Array</code> \| <code>Array</code>
+    * [.update(params, session)](#Kanban+update) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
     * [.updateTaskOrder(params, session)](#Kanban+updateTaskOrder) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
     * [.updateTasksOrder(params, session)](#Kanban+updateTasksOrder) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
     * [.updateTaskStatus(params, session)](#Kanban+updateTaskStatus) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
@@ -2321,6 +2322,52 @@ Expected response structure:
   ]
 }
 ```
+<a name="Kanban+update"></a>
+
+### kanban.update(params, session) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
+Updates the tasks order and status
+
+**Kind**: instance method of [<code>Kanban</code>](#Kanban)  
+**Returns**: <code>promise</code> - Promise that resolves to operation status<code>Object</code> - returns.data - The response data containing:<code>boolean</code> - returns.data.success - Indicates if the operation was successful<code>string</code> - [returns.data.error] - Error message if operation failed  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>Object</code> | Parameters object |
+| params.orgId | <code>string</code> | Organization id (_id database) |
+| params.tasks | <code>Array</code> | Array of task objects containing taskId and order |
+| params.tasks[].taskId | <code>string</code> | The unique identifier of the task to update |
+| params.tasks[].order | <code>number</code> | The new order position for the task |
+| params.tasks[].status | <code>string</code> | The status of the task |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  orgId: '55e4a3bd6be6b45210833fae',
+  tasks: [
+    { taskId: '507f1f77bcf86cd799439011', order: 0, status: '507f1f77bcf86cd799439012' },
+    { taskId: '507f1f77bcf86cd799439012', order: 1, status: '507f1f77bcf86cd799439012' },
+    { taskId: '507f1f77bcf86cd799439013', order: 0, status: '507f1f77bcf86cd799439013' }
+  ]
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const result = await api.user.kanban.updateTasksOrder(params, session);
+
+Expected response structure (success):
+{
+  success: true
+}
+
+Expected response structure (error):
+{
+  success: false,
+  error: "One or more tasks not found"
+}
+```
 <a name="Kanban+updateTaskOrder"></a>
 
 ### kanban.updateTaskOrder(params, session) ⇒ <code>promise</code> \| <code>Object</code> \| <code>boolean</code> \| <code>string</code>
@@ -2547,7 +2594,7 @@ Updates the status list order for a specific flow in an organization process on
 | params | <code>Object</code> | Parameters object |
 | params.orgId | <code>string</code> | Organization id (_id database) |
 | params.orgProcessName | <code>string</code> | The name of the organization process |
-| params.flowName | <code>string</code> | The name of the organization process step flowName |
+| params.flowId | <code>string</code> | The id of the organization process step flowId |
 | params.statusList | <code>Array</code> | The status list with new order |
 | params.statusList[ | <code>Object</code> | Status object configuration |
 | params.statusList[].value | <code>string</code> | The title of the status |
@@ -2562,7 +2609,7 @@ const api = new API();
 const params = {
   orgId: '55e4a3bd6be6b45210833fae',
   orgProcessName: 'employee-onboarding',
-  flowName: 'approval-flow',
+  flowId: 'Task_16888el',
   statusList: [
     { value: 'Pending', expanded: true, color: '#FF6B6B' },
     { value: 'In Progress', expanded: true, color: '#4ECDC4' },

package/docs/Kanban.html

@@ -448,7 +448,7 @@
         <p class="tag-source">
             <a href="user_kanban.js.html" class="button">View Source</a>
             <span>
-                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line351">line 351</a>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line415">line 415</a>
             </span>
         </p>
     
@@ -1273,7 +1273,7 @@ Expected response structure:
         <p class="tag-source">
             <a href="user_kanban.js.html" class="button">View Source</a>
             <span>
-                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line411">line 411</a>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line475">line 475</a>
             </span>
         </p>
     
@@ -1404,6 +1404,416 @@ Expected response structure (error):
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="update">
+        <a class="href-link" href="#update">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                update<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise|Object|boolean|string}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Updates the tasks order and status
+    </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">Parameters object</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>orgId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Organization id (_id database)</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>tasks</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">Array</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Array of task objects containing taskId and order</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>tasks[].taskId</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The unique identifier of the task to update</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>tasks[].order</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">number</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The new order position for the task</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>tasks[].status</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">The status of the task</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_kanban.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line173">line 173</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='param-desc column is-7'>Promise that resolves to operation status</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">promise</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>returns.data - The response data containing:</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">Object</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>returns.data.success - Indicates if the operation was successful</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">boolean</code>
+
+
+    </div>
+    
+</div>
+
+                
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>[returns.data.error] - Error message if operation failed</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">string</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: '55e4a3bd6be6b45210833fae',
+  tasks: [
+    { taskId: '507f1f77bcf86cd799439011', order: 0, status: '507f1f77bcf86cd799439012' },
+    { taskId: '507f1f77bcf86cd799439012', order: 1, status: '507f1f77bcf86cd799439012' },
+    { taskId: '507f1f77bcf86cd799439013', order: 0, status: '507f1f77bcf86cd799439013' }
+  ]
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const result = await api.user.kanban.updateTasksOrder(params, session);
+
+Expected response structure (success):
+{
+  success: true
+}
+
+Expected response structure (error):
+{
+  success: false,
+  error: "One or more tasks not found"
+}</code></pre>
+    
+
+
 </div>
             
                 <div class="member">
@@ -1538,7 +1948,7 @@ Expected response structure (error):
     
 <tr class="deep-level-1">
   
-      <td class="name"><code>flowName</code></td>
+      <td class="name"><code>flowId</code></td>
   
 
   <td class="type">
@@ -1554,7 +1964,7 @@ Expected response structure (error):
 
   
 
-  <td class="description last">The name of the organization process step flowName</td>
+  <td class="description last">The id of the organization process step flowId</td>
 </tr>
 
   
@@ -1751,7 +2161,7 @@ Expected response structure (error):
         <p class="tag-source">
             <a href="user_kanban.js.html" class="button">View Source</a>
             <span>
-                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line484">line 484</a>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line548">line 548</a>
             </span>
         </p>
     
@@ -1864,7 +2274,7 @@ const api = new API();
 const params = {
   orgId: '55e4a3bd6be6b45210833fae',
   orgProcessName: 'employee-onboarding',
-  flowName: 'approval-flow',
+  flowId: 'Task_16888el',
   statusList: [
     { value: 'Pending', expanded: true, color: '#FF6B6B' },
     { value: 'In Progress', expanded: true, color: '#4ECDC4' },
@@ -2118,7 +2528,7 @@ Expected response structure (error):
         <p class="tag-source">
             <a href="user_kanban.js.html" class="button">View Source</a>
             <span>
-                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line168">line 168</a>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line232">line 232</a>
             </span>
         </p>
     
@@ -2479,7 +2889,7 @@ Expected response structure (error):
         <p class="tag-source">
             <a href="user_kanban.js.html" class="button">View Source</a>
             <span>
-                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line291">line 291</a>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line355">line 355</a>
             </span>
         </p>
     
@@ -2863,7 +3273,7 @@ Expected response structure (error):
         <p class="tag-source">
             <a href="user_kanban.js.html" class="button">View Source</a>
             <span>
-                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line232">line 232</a>
+                <a href="user_kanban.js.html">user/kanban.js</a>, <a href="user_kanban.js.html#line296">line 296</a>
             </span>
         </p>
     

package/docs/user_kanban.js.html

@@ -204,7 +204,7 @@ class Kanban {
 
       const { orgId, orgProcessName, flowId } = params;
 
-      // Build API endpoint with flowName as part of the path
+      // Build API endpoint with flowId as part of the path
       const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${flowId}`;
 
       const apiCall = self._client
@@ -216,6 +216,70 @@ class Kanban {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Updates the tasks order and status
+   * @param {Object} params - Parameters object
+   * @param {string} params.orgId - Organization id (_id database)
+   * @param {Array} params.tasks - Array of task objects containing taskId and order
+   * @param {string} params.tasks[].taskId - The unique identifier of the task to update
+   * @param {number} params.tasks[].order - The new order position for the task
+   * @param {string} params.tasks[].status - The status of the task
+   * @param {string} session - Session, token JWT
+   * @returns {promise} Promise that resolves to operation status
+   * @returns {Object} returns.data - The response data containing:
+   * @returns {boolean} returns.data.success - Indicates if the operation was successful
+   * @returns {string} [returns.data.error] - Error message if operation failed
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   orgId: '55e4a3bd6be6b45210833fae',
+   *   tasks: [
+   *     { taskId: '507f1f77bcf86cd799439011', order: 0, status: '507f1f77bcf86cd799439012' },
+   *     { taskId: '507f1f77bcf86cd799439012', order: 1, status: '507f1f77bcf86cd799439012' },
+   *     { taskId: '507f1f77bcf86cd799439013', order: 0, status: '507f1f77bcf86cd799439013' }
+   *   ]
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const result = await api.user.kanban.updateTasksOrder(params, session);
+   *
+   * Expected response structure (success):
+   * {
+   *   success: true
+   * }
+   *
+   * Expected response structure (error):
+   * {
+   *   success: false,
+   *   error: "One or more tasks not found"
+   * }
+   */
+  async update(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to update tasks order');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
+      Joi.assert(params.tasks, Joi.array().required(), 'Array of task objects containing taskId and order');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const { orgId, tasks } = params;
+
+      // Build API endpoint for updating multiple tasks order
+      const endpoint = `/organization/${orgId}/kanban/tasks`;
+
+      const apiCall = self._client
+          .put(endpoint, { tasks }, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Updates the order of a task in its status column on the Kanban board
@@ -527,7 +591,7 @@ class Kanban {
    * @param {Object} params - Parameters object
    * @param {string} params.orgId - Organization id (_id database)
    * @param {string} params.orgProcessName - The name of the organization process
-   * @param {string} params.flowName - The name of the organization process step flowName
+   * @param {string} params.flowId - The id of the organization process step flowId
    * @param {Array} params.statusList - The status list with new order
    * @param {Object} params.statusList[] - Status object configuration
    * @param {string} params.statusList[].value - The title of the status
@@ -546,7 +610,7 @@ class Kanban {
    * const params = {
    *   orgId: '55e4a3bd6be6b45210833fae',
    *   orgProcessName: 'employee-onboarding',
-   *   flowName: 'approval-flow',
+   *   flowId: 'Task_16888el',
    *   statusList: [
    *     { value: 'Pending', expanded: true, color: '#FF6B6B' },
    *     { value: 'In Progress', expanded: true, color: '#4ECDC4' },
@@ -575,14 +639,14 @@ class Kanban {
       Joi.assert(params, Joi.object().required(), 'Params to update status list');
       Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
       Joi.assert(params.orgProcessName, Joi.string().required(), 'The name of the organization process');
-      Joi.assert(params.flowName, Joi.string().required(), 'The name of the organization process step flowName');
+      Joi.assert(params.flowId, Joi.string().required(), 'The id of the organization process step flowId');
       Joi.assert(params.statusList, Joi.array().required(), 'The status list with new order');
       Joi.assert(session, Joi.string().required(), 'Session token JWT');
 
-      const { orgId, orgProcessName, flowName, statusList } = params;
+      const { orgId, orgProcessName, flowId, statusList } = params;
 
       // Build API endpoint for updating status list
-      const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${flowName}`;
+      const endpoint = `/organization/${orgId}/kanban/${orgProcessName}/flow/${flowId}`;
 
       const apiCall = self._client
           .put(endpoint, { statusList }, self._setHeader(session));

package/package.json

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