@docbrasil/api-systemmanager 1.0.105 → 1.0.107

package/api/external.js

@@ -124,6 +124,52 @@ class External {
     }
   }
 
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Handles the execution of an external form
+   * @param {string} authorization a legal authorization
+   * @param {object} params the parameters to handle the execution of an external form
+   * @param {array<object>} params.payload the payload of the external form. It should represent the form groups of the external form
+   * @param {string} params.payload.name the name of the group
+   * @param {array<object>} params.payload.fields the fields that belong to each group
+   * @param {*|{}} params.payload.fields.value besides all the data inside a field, it should have the value of the the field
+   * @returns {Promise<boolean>} true|false if success
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const authorization = '...';
+   * const params = {
+   *  payload: [
+   *      {
+   *          name: 'My Group One',
+   *          fields: [
+   *              {}
+   *          ]
+   *      }
+   *  ]
+   * };
+   * const success = await api.external.handle(params, authorization);
+   */
+  async handle(params, authorization) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required().error(new Error('params is required')));
+      Joi.assert(params.payload, Joi.array().required().error(new Error('form payload is required')));
+      Joi.assert(authorization, Joi.string().required().error(new Error('authorization is required')));
+
+      const apiCall = self._client
+          .put('/external/forms', params, self._setHeader(authorization));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
 }
 
 export default External;

package/api/user/process.js

@@ -186,6 +186,50 @@ class Process {
       throw ex;
     }
   }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Method to search processes
+   * @param {object} params Params to search processes
+   * @param {object} params.query Search process query
+   * @param {object} params.orgId Organization id (_id database)
+   * @param {string} session Session, token JWT
+   * @returns {promise} returned data from the search
+   * @returns {number} count the count of items searched
+   * @returns {array<object>} items the items returned from search
+   * @returns {number} page the page of the search (on pagination), zero indexed
+   * @returns {number} perPage how many items per page
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
+   *  orgId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retSearch = await api.user.process.find(params, session);
+   */
+  async find(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to search processes');
+      Joi.assert(params.query, Joi.object().required(), 'The query for the search');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const {query, orgId} = params;
+      const queryString = JSON.stringify(query);
+      const apiCall = self._client
+        .post(`/organizations/${orgId}/process/advsearch?query=${queryString}`, {}, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default Process;

package/api/user/task.js

@@ -124,6 +124,7 @@ class Task {
   async findByIdAndUpdate(params, session) {
     const self = this;
 
+
     try {
       Joi.assert(params, Joi.object().required());
       Joi.assert(params.userId, Joi.string().required(), 'User id (_id database)');

package/api/user/task_available.js

@@ -51,7 +51,7 @@ class TaskAvailable {
    * @author CloudBrasil <abernardo.br@gmail.com>
    * @description Method to find available tasks for a user
    * @param {object} params Params to get task
-   * @param {object} params.query Search process query
+   * @param {object} params.query Search available tasks query
    * @param {object} params.orgId Organization id (_id database)
    * @param {string} session Session, token JWT
    * @returns {promise} returned data from the search

package/dist/bundle.cjs

@@ -1687,6 +1687,50 @@ class Process {
       throw ex;
     }
   }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Method to search processes
+   * @param {object} params Params to search processes
+   * @param {object} params.query Search process query
+   * @param {object} params.orgId Organization id (_id database)
+   * @param {string} session Session, token JWT
+   * @returns {promise} returned data from the search
+   * @returns {number} count the count of items searched
+   * @returns {array<object>} items the items returned from search
+   * @returns {number} page the page of the search (on pagination), zero indexed
+   * @returns {number} perPage how many items per page
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  query: {"orgProcessId": {"value":"62c2d1cdfb5455c195d1baa1","oper":"=","type":"string"},"s":[{"historyBegin":{"order":"desc"}}],"i":1,"p":20},
+   *  orgId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retSearch = await api.user.process.find(params, session);
+   */
+  async find(params, session) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(params, Joi__default["default"].object().required(), 'Params to search processes');
+      Joi__default["default"].assert(params.query, Joi__default["default"].object().required(), 'The query for the search');
+      Joi__default["default"].assert(params.orgId, Joi__default["default"].string().required(), 'Organization id (_id database)');
+      Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token JWT');
+
+      const {query, orgId} = params;
+      const queryString = JSON.stringify(query);
+      const apiCall = self._client
+        .post(`/organizations/${orgId}/process/advsearch?query=${queryString}`, {}, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 /**
@@ -1738,7 +1782,7 @@ class TaskAvailable {
    * @author CloudBrasil <abernardo.br@gmail.com>
    * @description Method to find available tasks for a user
    * @param {object} params Params to get task
-   * @param {object} params.query Search process query
+   * @param {object} params.query Search available tasks query
    * @param {object} params.orgId Organization id (_id database)
    * @param {string} session Session, token JWT
    * @returns {promise} returned data from the search
@@ -1940,6 +1984,7 @@ class Task {
   async findByIdAndUpdate(params, session) {
     const self = this;
 
+
     try {
       Joi__default["default"].assert(params, Joi__default["default"].object().required());
       Joi__default["default"].assert(params.userId, Joi__default["default"].string().required(), 'User id (_id database)');
@@ -11700,6 +11745,52 @@ class External {
     }
   }
 
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Handles the execution of an external form
+   * @param {string} authorization a legal authorization
+   * @param {object} params the parameters to handle the execution of an external form
+   * @param {array<object>} params.payload the payload of the external form. It should represent the form groups of the external form
+   * @param {string} params.payload.name the name of the group
+   * @param {array<object>} params.payload.fields the fields that belong to each group
+   * @param {*|{}} params.payload.fields.value besides all the data inside a field, it should have the value of the the field
+   * @returns {Promise<boolean>} true|false if success
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const authorization = '...';
+   * const params = {
+   *  payload: [
+   *      {
+   *          name: 'My Group One',
+   *          fields: [
+   *              {}
+   *          ]
+   *      }
+   *  ]
+   * };
+   * const success = await api.external.handle(params, authorization);
+   */
+  async handle(params, authorization) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(params, Joi__default["default"].object().required().error(new Error('params is required')));
+      Joi__default["default"].assert(params.payload, Joi__default["default"].array().required().error(new Error('form payload is required')));
+      Joi__default["default"].assert(authorization, Joi__default["default"].string().required().error(new Error('authorization is required')));
+
+      const apiCall = self._client
+          .put('/external/forms', params, self._setHeader(authorization));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
 }
 
 /**