@docbrasil/api-systemmanager 1.1.69 → 1.1.71

package/api/user/dashboard.js

@@ -123,6 +123,88 @@ class Chart {
   }
 }
 
+/**
+ * Class user access to reports
+ * @class
+ */
+class Report {
+  constructor(options) {
+    Joi.assert(options, Joi.object().required());
+    Joi.assert(options.parent, Joi.object().required());
+
+    const self = this;
+    self.parent = options.parent;
+    self._client = self.parent.dispatch.getClient();
+  }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description Get the return data and check for errors
+   * @param {object} retData Response HTTP
+   * @return {*}
+   * @private
+   */
+  _returnData(retData, def = {}) {
+    if (retData.status !== 200) {
+      return Boom.badRequest(_.get(retData, 'message', 'No error message reported!'))
+    } else {
+      return _.get(retData, 'data', def);
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Set header with new session
+   * @param {string} session Session, token JWT
+   * @return {object} header with new session
+   * @private
+   */
+  _setHeader(session) {
+    return {
+      headers: {
+        Authorization: session,
+      }
+    };
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the data for a report
+   * @param {object} params Params to get helps from topic
+   * @param {object} params.type Type of the report data
+   * @param {object} params.query The query if any (to search documents)
+   * @param {string} session Session, token JWT
+   * @returns {promise}
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  type: '[REPORTS] Myndie:vat_data',
+   *  query: { ... } // the last query to search documents
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.dashboard.report.getData(params, session);
+   */
+  async getData(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to helps from a topic');
+      Joi.assert(params.type, Joi.string().required(), 'Type of graph');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const { type, query = {} } = params;
+      const apiCall = self._client.post(`/organizations/dashboard/report/data/${type}`, query, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
 /**
  * Class user access to dashboards
  * @class
@@ -137,6 +219,7 @@ class Dashboard {
     self.parent = options.parent;
     self._client = self.parent.dispatch.getClient();
     self._chart = new Chart(options);
+    self._report = new Report(options);
   }
 
   /**
@@ -173,18 +256,21 @@ class Dashboard {
    * @author Augusto Pissarra <abernardo.br@gmail.com>
    * @description return the chart
    * @public
-   * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * await api.user.help.getTopics({}, session);
    */
     get chart() {
       const self = this;
       return self._chart;
   }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description return the report
+   * @public
+   */
+  get report() {
+    const self = this;
+    return self._report;
+  }
 }
 
 export default Dashboard;

package/api/user/document.js

@@ -238,6 +238,81 @@ class Documents {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Add multiple documents to a doc area under a doc type
+   * @param {object} params Object for adding documents
+   * @param {string} params.orgId Organization id (_id database)
+   * @param {string} params.userId User id (_id database)
+   * @param {string} params.docAreaName The name of the doc area
+   * @param {string} params.docTypeName The name of the doc type
+   * @param {array<object>} params.docs Array of documents to add
+   * @param {string} [params.docs.document=''] The url to the document on S3, an external URL or a base64 representation of the document
+   * @param {string} [params.docs.type=''] The mime type of the document
+   * @param {string} [params.docs.name=''] The name of the document
+   * @param {string} [params.docs.content=''] The content of the document
+   * @param {number} [params.docs.bytes=0] The bytes (in kb) of the document
+   * @param {string} [params.docs.urlType=''] The urlType of the document
+   * @param {string} [params.docs.description=''] The description of the document
+   * @param {string} [params.docs.category=''] The category of the document
+   * @param {array<string>} [params.docs.tags=[]] The tags of the document
+   * @param {object} [params.docs.docTypeFieldsData={}] The data related to this document
+   * @param {boolean} [params.docs.hasPhisicalStorage=false] The flag to define if the document has physical storage or not
+   * @param {string} [params.docs.boxId=''] The boxId if we define the document has physical storage
+   * @param {number} [params.docs.status] The document status
+   * @param {string} [params.docs.storageStatus=''] The storageStatus if we define the document has physical storage
+   * @param {string} session Session, token JWT
+   * @return {Promise<object>} The result of the operation
+   * @return {boolean} return.success True if the operation was successful
+   * @return {array<object>} return.added Array of added documents
+   * @return {array<object>} return.notAdded Array of documents that could not be added
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   orgId: '5df7f19618430c89a41a19d2',
+   *   userId: '5df7f19618430c89a41a19d3',
+   *   docAreaName: 'My Doc Area',
+   *   docTypeName: 'My Doc Type',
+   *   docs: [
+   *     {
+   *       document: 'https://s3.amazonaws.com/...',
+   *       type: 'application/pdf',
+   *       name: 'Document 1',
+   *       description: 'First document',
+   *       category: 'Category 1',
+   *       tags: ['tag1', 'tag2'],
+   *       docTypeFieldsData: { extraField: 'value' },
+   *       bytes: 12345
+   *     }
+   *   ]
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const result = await api.user.document.addDocuments(params, session);
+   */
+  async addDocuments(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required().error(new Error('params is required')));
+      Joi.assert(params.orgId, Joi.string().required().error(new Error('orgId is required')));
+      Joi.assert(params.userId, Joi.string().required().error(new Error('userId is required')));
+      Joi.assert(params.docAreaName, Joi.string().required().error(new Error('docAreaName is required')));
+      Joi.assert(params.docTypeName, Joi.string().required().error(new Error('docTypeName is required')));
+      Joi.assert(params.docs, Joi.array().required().error(new Error('docs is required')));
+      Joi.assert(session, Joi.string().required().error(new Error('session is required')));
+
+      const apiCall = self._client
+        .put('/organizations/documents', params, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Updates a document

package/dist/bundle.cjs

@@ -892,6 +892,81 @@ class Documents {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Add multiple documents to a doc area under a doc type
+   * @param {object} params Object for adding documents
+   * @param {string} params.orgId Organization id (_id database)
+   * @param {string} params.userId User id (_id database)
+   * @param {string} params.docAreaName The name of the doc area
+   * @param {string} params.docTypeName The name of the doc type
+   * @param {array<object>} params.docs Array of documents to add
+   * @param {string} [params.docs.document=''] The url to the document on S3, an external URL or a base64 representation of the document
+   * @param {string} [params.docs.type=''] The mime type of the document
+   * @param {string} [params.docs.name=''] The name of the document
+   * @param {string} [params.docs.content=''] The content of the document
+   * @param {number} [params.docs.bytes=0] The bytes (in kb) of the document
+   * @param {string} [params.docs.urlType=''] The urlType of the document
+   * @param {string} [params.docs.description=''] The description of the document
+   * @param {string} [params.docs.category=''] The category of the document
+   * @param {array<string>} [params.docs.tags=[]] The tags of the document
+   * @param {object} [params.docs.docTypeFieldsData={}] The data related to this document
+   * @param {boolean} [params.docs.hasPhisicalStorage=false] The flag to define if the document has physical storage or not
+   * @param {string} [params.docs.boxId=''] The boxId if we define the document has physical storage
+   * @param {number} [params.docs.status] The document status
+   * @param {string} [params.docs.storageStatus=''] The storageStatus if we define the document has physical storage
+   * @param {string} session Session, token JWT
+   * @return {Promise<object>} The result of the operation
+   * @return {boolean} return.success True if the operation was successful
+   * @return {array<object>} return.added Array of added documents
+   * @return {array<object>} return.notAdded Array of documents that could not be added
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   orgId: '5df7f19618430c89a41a19d2',
+   *   userId: '5df7f19618430c89a41a19d3',
+   *   docAreaName: 'My Doc Area',
+   *   docTypeName: 'My Doc Type',
+   *   docs: [
+   *     {
+   *       document: 'https://s3.amazonaws.com/...',
+   *       type: 'application/pdf',
+   *       name: 'Document 1',
+   *       description: 'First document',
+   *       category: 'Category 1',
+   *       tags: ['tag1', 'tag2'],
+   *       docTypeFieldsData: { extraField: 'value' },
+   *       bytes: 12345
+   *     }
+   *   ]
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const result = await api.user.document.addDocuments(params, session);
+   */
+  async addDocuments(params, session) {
+    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.orgId, Joi__default["default"].string().required().error(new Error('orgId is required')));
+      Joi__default["default"].assert(params.userId, Joi__default["default"].string().required().error(new Error('userId is required')));
+      Joi__default["default"].assert(params.docAreaName, Joi__default["default"].string().required().error(new Error('docAreaName is required')));
+      Joi__default["default"].assert(params.docTypeName, Joi__default["default"].string().required().error(new Error('docTypeName is required')));
+      Joi__default["default"].assert(params.docs, Joi__default["default"].array().required().error(new Error('docs is required')));
+      Joi__default["default"].assert(session, Joi__default["default"].string().required().error(new Error('session is required')));
+
+      const apiCall = self._client
+        .put('/organizations/documents', params, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Updates a document
@@ -11794,6 +11869,88 @@ class Chart {
   }
 }
 
+/**
+ * Class user access to reports
+ * @class
+ */
+class Report {
+  constructor(options) {
+    Joi__default["default"].assert(options, Joi__default["default"].object().required());
+    Joi__default["default"].assert(options.parent, Joi__default["default"].object().required());
+
+    const self = this;
+    self.parent = options.parent;
+    self._client = self.parent.dispatch.getClient();
+  }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description Get the return data and check for errors
+   * @param {object} retData Response HTTP
+   * @return {*}
+   * @private
+   */
+  _returnData(retData, def = {}) {
+    if (retData.status !== 200) {
+      return Boom__default["default"].badRequest(___default["default"].get(retData, 'message', 'No error message reported!'))
+    } else {
+      return ___default["default"].get(retData, 'data', def);
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Set header with new session
+   * @param {string} session Session, token JWT
+   * @return {object} header with new session
+   * @private
+   */
+  _setHeader(session) {
+    return {
+      headers: {
+        Authorization: session,
+      }
+    };
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the data for a report
+   * @param {object} params Params to get helps from topic
+   * @param {object} params.type Type of the report data
+   * @param {object} params.query The query if any (to search documents)
+   * @param {string} session Session, token JWT
+   * @returns {promise}
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  type: '[REPORTS] Myndie:vat_data',
+   *  query: { ... } // the last query to search documents
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.dashboard.report.getData(params, session);
+   */
+  async getData(params, session) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(params, Joi__default["default"].object().required(), 'Params to helps from a topic');
+      Joi__default["default"].assert(params.type, Joi__default["default"].string().required(), 'Type of graph');
+      Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token JWT');
+
+      const { type, query = {} } = params;
+      const apiCall = self._client.post(`/organizations/dashboard/report/data/${type}`, query, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
 /**
  * Class user access to dashboards
  * @class
@@ -11808,6 +11965,7 @@ class Dashboard {
     self.parent = options.parent;
     self._client = self.parent.dispatch.getClient();
     self._chart = new Chart(options);
+    self._report = new Report(options);
   }
 
   /**
@@ -11844,18 +12002,21 @@ class Dashboard {
    * @author Augusto Pissarra <abernardo.br@gmail.com>
    * @description return the chart
    * @public
-   * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * await api.user.help.getTopics({}, session);
    */
     get chart() {
       const self = this;
       return self._chart;
   }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description return the report
+   * @public
+   */
+  get report() {
+    const self = this;
+    return self._report;
+  }
 }
 
 /**