@docbrasil/api-systemmanager 1.1.26 → 1.1.28

package/docs/user_dashboard.js.html

@@ -168,6 +168,46 @@ class Chart {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the question data from a chart data
+   * @param {object} params Params to get helps from topic
+   * @param {object} params.orgId The organization id of the question
+   * @param {object} params.processId The process id of the question
+   * @param {object} params.path The path of the question so we can retrieve it
+   * @param {string} session Session, token JWT
+   * @returns {promise} data the question data
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  orgId: '637e7523f555fabdfb1ed7b6',
+   *  processId: '123e7523f555fabdfb1ed7c6',
+   *  path: 'Checklist.Group Name.Field Name'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.dashboard.chart.getQuestion(params, session);
+   */
+  async getQuestion(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to helps from a topic');
+      Joi.assert(params.orgId, Joi.string().required(), 'The organization id of the question');
+      Joi.assert(params.processId, Joi.string().required(), 'The process id of the question');
+      Joi.assert(params.path, Joi.string().required(), 'The path of the field of the question');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const apiCall = self._client.post(`/organizations/dashboard/chart/question/data`, params, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 /**
@@ -234,7 +274,7 @@ class Dashboard {
   }
 }
 
-export default Help;
+export default Dashboard;
 </code></pre>
         </article>
     </section>

package/docs/user_document.js.html

@@ -889,6 +889,181 @@ class Documents {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Method to export excel for all pages
+   * @param {object} params Params to export excel for all pages
+   * @param {object} params.query Export excel for all pages query
+   * @param {object} params.orgId Organization id (_id database)
+   * @param {string} session Session, token JWT
+   * @returns {promise} returned data from the export excel for all pages
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  query: {p: 20, i: 1, s: 'Mais recentes', as: '', m: 'w', ai: '57e6a3bd6be6b45210833fae'},
+   *  orgId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retSearch = await api.user.document.exportExcelForAllPages(params, session);
+   */
+  async exportExcelForAllPages(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to export excel for all pages');
+      Joi.assert(params.query, Joi.object().required(), 'The query for the export excel for all pages');
+      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 searchParams = new URLSearchParams(query);
+      const queryString = searchParams.toString();
+      const apiCall = self._client.get(`/organizations/${orgId}/documents/export/excel?${queryString}`, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Method to export Wms Excel for all pages
+   * @param {object} params Params to export Wms Excel for all pages
+   * @param {object} params.query export Wms Excel for all pages query
+   * @param {object} params.orgId Organization id (_id database)
+   * @param {string} session Session, token JWT
+   * @returns {promise} returned data from the export Wms Excel for all pages
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  query: {p: 20, i: 1, s: 'Mais recentes', as: '', m: 'w', ai: '57e6a3bd6be6b45210833fae'},
+   *  orgId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retSearch = await api.user.document.exportWmsExcelForAllPages(params, session);
+   */
+    async exportWmsExcelForAllPages(params, session) {
+      const self = this;
+
+      try {
+        Joi.assert(params, Joi.object().required(), 'Params to export Wms Excel for all pages');
+        Joi.assert(params.query, Joi.object().required(), 'The query for the export Wms Excel for all pages');
+        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 searchParams = new URLSearchParams(query);
+        const queryString = searchParams.toString();
+        const apiCall = self._client.get(`/organizations/${orgId}/documents/wms/export/excel?${queryString}`, self._setHeader(session));
+
+        return self._returnData(await apiCall);
+      } catch (ex) {
+        throw ex;
+      }
+    }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Method to perform download complete for all pages
+   * @param {object} params Params to perform download complete for all pages
+   * @param {object} params.data data to be send to download
+   * @param {object} params.query perform download complete for all pages query
+   * @param {object} params.orgId Organization id (_id database)
+   * @param {string} session Session, token JWT
+   * @returns {promise} returned data from the perform download complete for all pages
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  query: {p: 20, i: 1, s: 'Mais recentes', as: '', m: 'w', ai: '57e6a3bd6be6b45210833fae'},
+   *  orgId: '55e4a3bd6be6b45210833fae',
+   *  data: {
+   *    destAws = {
+            destAwsKey: '',
+            destAwsSecret: '',
+            destAwsBucket: '',
+            destAwsRegion: ''
+        },
+        maxFileSize: ''
+   *  }
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retSearch = await api.user.document.performDownloadComplete(params, session);
+   */
+  async performDownloadComplete(params, session) {
+    const self = this;
+
+    Joi.assert(params, Joi.object().required(), 'Params to perform download complete for all pages');
+    Joi.assert(params.data, Joi.object().required(), 'The data for the perform download complete for all pages');
+    Joi.assert(params.query, Joi.object().required(), 'The query for the perform download complete for all pages');
+    Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
+    Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+    try {
+      const {query, orgId, data} = params;
+      const searchParams = new URLSearchParams(query);
+      const queryString = searchParams.toString();
+
+      const apiCall = self._client.post(`/organizations/${orgId}/documents/download/attachments?${queryString}`, data, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Method to search documents direct on MongoDB (use carefully and only in cases you need to access direct data
+   * @param {object} params Params to search the documents
+   * @param {object} params.query Search documents 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} took the number of documents taken
+   * @returns {number} totalCount the total count of all documents
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  query: {p: 20, i: 1, s: 'Mais recentes', as: '', m: 'w', ai: '57e6a3bd6be6b45210833fae'},
+   *  orgId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const retSearch = await api.user.document.searchDocumentsMongo(params, session);
+   */
+  async searchDocumentsMongo(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to search the documents');
+      Joi.assert(params.query, Joi.object().required(), 'The query for the search documents');
+      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 searchParams = new URLSearchParams(query);
+      const queryString = searchParams.toString();
+      const apiCall = self._client.get(`/organizations/${orgId}/documents/search/direct?${queryString}`, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default Documents;

package/package.json

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

@@ -1,11 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
-	<name>api-systemmanager</name>
-	<comment></comment>
-	<projects>
-	</projects>
-	<buildSpec>
-	</buildSpec>
-	<natures>
-	</natures>
-</projectDescription>