@docbrasil/api-systemmanager 1.1.72 → 1.1.75

package/docs/user_help.js.html

@@ -200,6 +200,43 @@ class Help {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get list of external URL help pages available for the logged user.
+   * Returns help pages where the user has permission based on their groups or user ID.
+   * @param {string} session Session, token JWT
+   * @returns {promise<Array>} Array of external URL help pages with permissions
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const externalUrls = await api.user.help.listExternalUrls(session);
+   * // Returns:
+   * // [
+   * //   {
+   * //     _id: '...',
+   * //     title: 'Help Page Title',
+   * //     permissions: ['VIEW', 'CREATE_EXTERNAL_URL'],
+   * //     showPoweredBy: true,
+   * //     showCreatedBy: false
+   * //   }
+   * // ]
+   */
+  async listExternalUrls(session) {
+    const self = this;
+
+    try {
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const apiCall = self._client.get('/help/external-urls', self._setHeader(session));
+      return self._returnData(await apiCall, []);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
 }
 
 export default Help;

package/docs/user_task.js.html

@@ -323,6 +323,226 @@ class Task {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Save task progress without completing it
+   * @param {object} params - Params to save task
+   * @param {string} params.processId - Process id (_id database)
+   * @param {string} params.taskId - Task id (_id database)
+   * @param {string} params.flowName - Flow name
+   * @param {string} params.orgId - Organization id (_id database)
+   * @param {array} params.formData - Form data to save
+   * @param {array=} params.selectedDocs - Selected documents
+   * @param {array=} params.selectedAssignees - Selected assignees
+   * @param {array=} params.selectedBoxes - Selected boxes
+   * @param {object=} params.advFormData - Advanced form data
+   * @param {object=} params.advFormSchema - Advanced form schema
+   * @param {string=} params.status - Task status (empty string for save)
+   * @param {number=} params.order - Task order
+   * @param {string=} params.title - Task title
+   * @param {array=} params.tags - Task tags
+   * @param {string=} params.dueDate - Due date ISO string
+   * @param {string} session - Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   processId: '5dadd01dc4af3941d42f8c5c',
+   *   taskId: '5df7f19618430c89a41a19d2',
+   *   flowName: 'simpleTask',
+   *   orgId: '55e4a3bd6be6b45210833fae',
+   *   formData: [{ name: 'Group', fields: [...] }],
+   *   selectedDocs: [],
+   *   selectedAssignees: [],
+   *   selectedBoxes: [],
+   *   advFormData: {},
+   *   advFormSchema: {},
+   *   status: '',
+   *   order: 0,
+   *   title: 'My Task',
+   *   tags: [],
+   *   dueDate: '2024-01-15T00:00:00Z'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.task.saveTask(params, session);
+   */
+  async saveTask(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.processId, Joi.string().required(), 'Process id (_id database)');
+      Joi.assert(params.taskId, Joi.string().required(), 'Task id (_id database)');
+      Joi.assert(params.flowName, Joi.string().required(), 'Flow name');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
+      Joi.assert(params.formData, Joi.array().required(), 'Form data to save');
+      Joi.assert(params.selectedDocs, Joi.array(), 'Selected documents');
+      Joi.assert(params.selectedAssignees, Joi.array(), 'Selected assignees');
+      Joi.assert(params.selectedBoxes, Joi.array(), 'Selected boxes');
+      Joi.assert(params.advFormData, Joi.object(), 'Advanced form data');
+      Joi.assert(params.advFormSchema, Joi.object(), 'Advanced form schema');
+      Joi.assert(params.status, Joi.string().allow(''), 'Task status');
+      Joi.assert(params.order, Joi.number(), 'Task order');
+      Joi.assert(params.title, Joi.string().allow(''), 'Task title');
+      Joi.assert(params.tags, Joi.array(), 'Task tags');
+      Joi.assert(params.dueDate, Joi.string(), 'Due date ISO string');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const {
+        processId,
+        taskId,
+        flowName,
+        orgId,
+        formData,
+        selectedDocs = [],
+        selectedAssignees = [],
+        selectedBoxes = [],
+        advFormData = {},
+        advFormSchema = {},
+        status = '',
+        order = 0,
+        title = '',
+        tags = [],
+        dueDate
+      } = params;
+
+      const body = {
+        formData,
+        selectedDocs,
+        selectedAssignees,
+        selectedBoxes,
+        advFormData,
+        advFormSchema,
+        status,
+        order,
+        title,
+        tags
+      };
+      if (dueDate) body.dueDate = dueDate;
+
+      const url = `organizations/${orgId}/adhoc/${processId}/save/${taskId}/${flowName}`;
+      const apiCall = self._client.put(url, body, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description End/complete a task and advance the workflow
+   * @param {object} params - Params to end task
+   * @param {string} params.processId - Process id (_id database)
+   * @param {string} params.taskId - Task id (_id database)
+   * @param {string} params.flowName - Flow name
+   * @param {string} params.orgId - Organization id (_id database)
+   * @param {array} params.formData - Form data to submit
+   * @param {array=} params.selectedDocs - Selected documents
+   * @param {array=} params.selectedAssignees - Selected assignees
+   * @param {array=} params.selectedBoxes - Selected boxes
+   * @param {object=} params.advFormData - Advanced form data
+   * @param {object=} params.advFormSchema - Advanced form schema
+   * @param {string=} params.status - Task status
+   * @param {number=} params.order - Task order
+   * @param {string=} params.title - Task title
+   * @param {array=} params.tags - Task tags
+   * @param {string=} params.dueDate - Due date ISO string
+   * @param {string} session - Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   processId: '5dadd01dc4af3941d42f8c5c',
+   *   taskId: '5df7f19618430c89a41a19d2',
+   *   flowName: 'simpleTask',
+   *   orgId: '55e4a3bd6be6b45210833fae',
+   *   formData: [{ name: 'Group', fields: [...] }],
+   *   selectedDocs: [],
+   *   selectedAssignees: [],
+   *   selectedBoxes: [],
+   *   advFormData: {},
+   *   advFormSchema: {},
+   *   status: '',
+   *   order: 0,
+   *   title: 'My Task',
+   *   tags: [],
+   *   dueDate: '2024-01-15T00:00:00Z'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.task.endTask(params, session);
+   */
+  async endTask(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.processId, Joi.string().required(), 'Process id (_id database)');
+      Joi.assert(params.taskId, Joi.string().required(), 'Task id (_id database)');
+      Joi.assert(params.flowName, Joi.string().required(), 'Flow name');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
+      Joi.assert(params.formData, Joi.array().required(), 'Form data to submit');
+      Joi.assert(params.selectedDocs, Joi.array(), 'Selected documents');
+      Joi.assert(params.selectedAssignees, Joi.array(), 'Selected assignees');
+      Joi.assert(params.selectedBoxes, Joi.array(), 'Selected boxes');
+      Joi.assert(params.advFormData, Joi.object(), 'Advanced form data');
+      Joi.assert(params.advFormSchema, Joi.object(), 'Advanced form schema');
+      Joi.assert(params.status, Joi.string().allow(''), 'Task status');
+      Joi.assert(params.order, Joi.number(), 'Task order');
+      Joi.assert(params.title, Joi.string().allow(''), 'Task title');
+      Joi.assert(params.tags, Joi.array(), 'Task tags');
+      Joi.assert(params.dueDate, Joi.string(), 'Due date ISO string');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const {
+        processId,
+        taskId,
+        flowName,
+        orgId,
+        formData,
+        selectedDocs = [],
+        selectedAssignees = [],
+        selectedBoxes = [],
+        advFormData = {},
+        advFormSchema = {},
+        status = '',
+        order = 0,
+        title = '',
+        tags = [],
+        dueDate
+      } = params;
+
+      const body = {
+        formData,
+        selectedDocs,
+        selectedAssignees,
+        selectedBoxes,
+        advFormData,
+        advFormSchema,
+        status,
+        order,
+        title,
+        tags
+      };
+      if (dueDate) body.dueDate = dueDate;
+
+      const url = `organizations/${orgId}/adhoc/${processId}/endprocess/${taskId}/${flowName}`;
+      const apiCall = self._client.put(url, body, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default Task;

package/package.json

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