@docbrasil/api-systemmanager 1.0.106 → 1.0.108

package/.github/workflows/static.yml

@@ -0,0 +1,43 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["develop"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload entire repository
+          path: '.'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

package/api/external.js

@@ -124,6 +124,47 @@ class External {
     }
   }
 
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Get an upload signed url, for many documents. So it will be possible to upload documents temporarily during the use of the external form
+   * @param {array<object>} docs the list of documents
+   * @param {string} docs.mime the mime type of the document
+   * @param {string} authorization a legal authorization
+   * @returns {Promise<array>} docs
+   * @returns {string}  docs.mime the original mime type of the document
+   * @returns {string} docs.signedUrl the signed url to upload the document
+   * @returns {string} docs.filename  the filename of the uploaded file
+   * @returns {string} docs.extension  the extension of the filename, obtained from the mime type
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const authorization = '...';
+   * const docs = [
+   *    {
+   *      mime: 'application/pdf'
+   *    }
+   * ];
+   * const retDocs = await api.external.getUploadDocumentsSignedUrl(docs, authorization);
+   */
+  async getUploadDocumentSignedUrl(docs, authorization) {
+    const self = this;
+
+    try {
+      Joi.assert(docs, Joi.string().array().error(new Error('docs is required')));
+      Joi.assert(authorization, Joi.string().required().error(new Error('authorization is required')));
+
+      const apiCall = self._client
+          .post(`/external/forms/upload/signedurls`, docs, self._setHeader(authorization));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   /**
    * @author CloudBrasil <abernardo.br@gmail.com>
    * @description Handles the execution of an external form

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,47 @@ class External {
     }
   }
 
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Get an upload signed url, for many documents. So it will be possible to upload documents temporarily during the use of the external form
+   * @param {array<object>} docs the list of documents
+   * @param {string} docs.mime the mime type of the document
+   * @param {string} authorization a legal authorization
+   * @returns {Promise<array>} docs
+   * @returns {string}  docs.mime the original mime type of the document
+   * @returns {string} docs.signedUrl the signed url to upload the document
+   * @returns {string} docs.filename  the filename of the uploaded file
+   * @returns {string} docs.extension  the extension of the filename, obtained from the mime type
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const authorization = '...';
+   * const docs = [
+   *    {
+   *      mime: 'application/pdf'
+   *    }
+   * ];
+   * const retDocs = await api.external.getUploadDocumentsSignedUrl(docs, authorization);
+   */
+  async getUploadDocumentSignedUrl(docs, authorization) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(docs, Joi__default["default"].string().array().error(new Error('docs is required')));
+      Joi__default["default"].assert(authorization, Joi__default["default"].string().required().error(new Error('authorization is required')));
+
+      const apiCall = self._client
+          .post(`/external/forms/upload/signedurls`, docs, self._setHeader(authorization));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   /**
    * @author CloudBrasil <abernardo.br@gmail.com>
    * @description Handles the execution of an external form