@docbrasil/api-systemmanager 1.0.94 → 1.0.96

package/api/admin/form.js

@@ -1,151 +1,151 @@
-import _ from 'lodash';
-import Boom from '@hapi/boom';
-import Joi from 'joi';
-
-/**
- * Admin Class for forms, permission admin
- * @class
- */
-class AdminForm {
-
-  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 CloudBrasil <abernardo.br@gmail.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 CloudBrasil <abernardo.br@gmail.com>
-   * @description Get advance form by ID
-   * @param {object} params Params to find form by id
-   * @param {string} params.id Formulary Id (_id database)
-   * @param {string} params.orgId Organization Id (_id database)
-   * @param {string} session Session, token JWT
-   * @return {Promise}
-   * @public
-   * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * const params = {
-   *  id: '55e4a3bd6be6b45210833fae',
-   *  orgId: '5edd11c46b6ce9729c2c297c',
-   * };
-   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * await api.admin.form.findById(params, session);
-   */
-  async findById(params, session) {
-    const self = this;
-
-    try {
-      Joi.assert(params, Joi.object().required());
-      Joi.assert(params.id, Joi.string().required());
-      Joi.assert(params.orgId, Joi.string().required());
-      Joi.assert(session, Joi.string().required());
-
-      const {id, orgId} = params;
-      const apiCall = self._client.get(`/admin/organizations/${orgId}/orgforms/${id}/form`, self._setHeader(session));
-      return self._returnData(await apiCall);
-    } catch (ex) {
-      throw ex;
-    }
-  }
-
-   /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
-   * @description Request signed url url to put or get
-   * @param {object} params - Params to get form list
-   * @param {string} params.orgId - Organization id (_id database)
-   * @param {number} params.page=1 - Page of pagination
-   * @param {number} params.perPage=200 - Items per page
-   * @param {object} params.type=2 - Form type (1 to Business or 2 to Advanced)
-   * @param {object} params.project={_id: 1, name: 1} - Fields to project
-   * @param {object} params.sort={name: 1} - Sort fields
-   * @param {string} session - Session, token JWT
-   * @return {Promise}
-   * @public
-   * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * const params - {
-   *  orgId: '5dadd01dc4af3941d42f8c5c',
-   * };
-   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * await api.user.form.getFormList(params, session);
-   */
-  async getFormList(params, session) {
-    const self = this;
-
-    try {
-      Joi.assert(params, Joi.object().required(), 'Params to get form list');
-      Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
-      Joi.assert(params.page, Joi.number(), 'Page of pagination');
-      Joi.assert(params.perPage, Joi.number(), 'Items per page');
-      Joi.assert(params.type, Joi.number(), 'Form type (1 to Business or 2 to Advanced)');
-      Joi.assert(params.project, Joi.object(), 'Fields to project');
-      Joi.assert(params.sort, Joi.object(), 'Sort fields for');
-      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
-
-      const FORM_ADVANCED = 2;
-      const PROJECTION_DEFAULT = {_id: 1, name: 1};
-      const SORT_DEFAULT = {name: 1};
-
-      const {
-        orgId,
-        page = 1,
-        perPage = 200,
-        type = FORM_ADVANCED,
-        project = PROJECTION_DEFAULT,
-        sort = SORT_DEFAULT
-      } = params;
-
-      const payloadToSend = { orgId, type, $project: project, sort };
-
-      const apiCall = self._client
-        .post(`/admin/organizations/${orgId}/orgforms?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
-
-      return self._returnData(await apiCall);
-
-    } catch (ex) {
-      throw ex;
-    }
-  }
-}
-
-export default AdminForm;
+import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+
+/**
+ * Admin Class for forms, permission admin
+ * @class
+ */
+class AdminForm {
+
+  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 CloudBrasil <abernardo.br@gmail.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 CloudBrasil <abernardo.br@gmail.com>
+   * @description Get advance form by ID
+   * @param {object} params Params to find form by id
+   * @param {string} params.id Formulary Id (_id database)
+   * @param {string} params.orgId Organization Id (_id database)
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  id: '55e4a3bd6be6b45210833fae',
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.form.findById(params, session);
+   */
+  async findById(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.id, Joi.string().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const {id, orgId} = params;
+      const apiCall = self._client.get(`/admin/organizations/${orgId}/orgforms/${id}/form`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+   /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Request signed url url to put or get
+   * @param {object} params - Params to get form list
+   * @param {string} params.orgId - Organization id (_id database)
+   * @param {number} params.page=1 - Page of pagination
+   * @param {number} params.perPage=200 - Items per page
+   * @param {object} params.type=2 - Form type (1 to Business or 2 to Advanced)
+   * @param {object} params.project={_id: 1, name: 1} - Fields to project
+   * @param {object} params.sort={name: 1} - Sort fields
+   * @param {string} session - Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  orgId: '5dadd01dc4af3941d42f8c5c',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.form.getFormList(params, session);
+   */
+  async getFormList(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to get form list');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization id (_id database)');
+      Joi.assert(params.page, Joi.number(), 'Page of pagination');
+      Joi.assert(params.perPage, Joi.number(), 'Items per page');
+      Joi.assert(params.type, Joi.number(), 'Form type (1 to Business or 2 to Advanced)');
+      Joi.assert(params.project, Joi.object(), 'Fields to project');
+      Joi.assert(params.sort, Joi.object(), 'Sort fields for');
+      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
+
+      const FORM_ADVANCED = 2;
+      const PROJECTION_DEFAULT = {_id: 1, name: 1};
+      const SORT_DEFAULT = {name: 1};
+
+      const {
+        orgId,
+        page = 1,
+        perPage = 200,
+        type = FORM_ADVANCED,
+        project = PROJECTION_DEFAULT,
+        sort = SORT_DEFAULT
+      } = params;
+
+      const payloadToSend = { orgId, type, $project: project, sort };
+
+      const apiCall = self._client
+        .post(`/admin/organizations/${orgId}/orgforms?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
+export default AdminForm;

package/api/admin/index.js

@@ -1,46 +1,46 @@
-import Joi from 'joi';
-
-import AdminDocument from './document.js';
-import AdminForm from './form.js';
-import AdminNotification from './notification.js';
-import AdminList from './list.js';
-import AdminPlugin from './plugin.js';
-import AdminPolicy from './policy.js';
-import AdminTask from './task.js';
-import AdminUser from './user.js';
-import AdminProcesses from './processes.js';
-import AdminMessage from './message.js';
-import AdminDocTypes from './doctypes.js';
-import AdminOrganizations from './organization.js';
-
-/**
- * @class API request, admin permission level
- */
-class Admin {
-  /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
-   * @constructor
-   * @param {object} options Params of the constructor
-   * @param {object} options.parent This of the pararent
-   */
-  constructor(options) {
-    Joi.assert(options, Joi.object().required());
-    Joi.assert(options.parent, Joi.object().required());
-
-    const self = this;
-    self.doctypes = new AdminDocTypes(options);
-    self.document = new AdminDocument(options);
-    self.form = new AdminForm(options);
-    self.list = new AdminList(options);
-    self.message = new AdminMessage(options);
-    self.organizations = new AdminOrganizations(options);
-    self.notification = new AdminNotification(options);
-    self.plugin = new AdminPlugin(options);
-    self.policy = new AdminPolicy(options);
-    self.processes = new AdminProcesses(options);
-    self.task = new AdminTask(options);
-    self.user = new AdminUser(options);
-  }
-}
-
-export default Admin;
+import Joi from 'joi';
+
+import AdminDocument from './document.js';
+import AdminForm from './form.js';
+import AdminNotification from './notification.js';
+import AdminList from './list.js';
+import AdminPlugin from './plugin.js';
+import AdminPolicy from './policy.js';
+import AdminTask from './task.js';
+import AdminUser from './user.js';
+import AdminProcesses from './processes.js';
+import AdminMessage from './message.js';
+import AdminDocTypes from './doctypes.js';
+import AdminOrganizations from './organization.js';
+
+/**
+ * @class API request, admin permission level
+ */
+class Admin {
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @constructor
+   * @param {object} options Params of the constructor
+   * @param {object} options.parent This of the pararent
+   */
+  constructor(options) {
+    Joi.assert(options, Joi.object().required());
+    Joi.assert(options.parent, Joi.object().required());
+
+    const self = this;
+    self.doctypes = new AdminDocTypes(options);
+    self.document = new AdminDocument(options);
+    self.form = new AdminForm(options);
+    self.list = new AdminList(options);
+    self.message = new AdminMessage(options);
+    self.organizations = new AdminOrganizations(options);
+    self.notification = new AdminNotification(options);
+    self.plugin = new AdminPlugin(options);
+    self.policy = new AdminPolicy(options);
+    self.processes = new AdminProcesses(options);
+    self.task = new AdminTask(options);
+    self.user = new AdminUser(options);
+  }
+}
+
+export default Admin;

package/api/admin/list.js

@@ -1,133 +1,133 @@
-import _ from 'lodash';
-import Boom from '@hapi/boom';
-import Joi from 'joi';
-
-/**
- * Admin Class for lists, permission admin
- * @class
- */
-class AdminLists {
-
-  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 CloudBrasil <abernardo.br@gmail.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 CloudBrasil <abernardo.br@gmail.com>
-   * @description Get list by ID
-   * @param {object} params Params to find list by id
-   * @param {string} params.id List Id (_id database)
-   * @param {string} params.orgId Organization Id (_id database)
-   * @param {string} session Session, token JWT
-   * @return {Promise}
-   * @public
-   * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * const params = {
-   *  id: '55e4a3bd6be6b45210833fae',
-   *  orgId: '5edd11c46b6ce9729c2c297c',
-   * };
-   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * await api.admin.list.findById(params, session);
-   */
-  async findById(params, session) {
-    const self = this;
-
-    try {
-      Joi.assert(params, Joi.object().required());
-      Joi.assert(params.id, Joi.string().required());
-      Joi.assert(params.orgId, Joi.string().required());
-      Joi.assert(session, Joi.string().required());
-
-      const {id, orgId} = params;
-      const apiCall = self._client.get(`/admin/organizations/${orgId}/orgtags/${id}`, self._setHeader(session));
-      return self._returnData(await apiCall);
-    } catch (ex) {
-      throw ex;
-    }
-  }
-
-  /**
-   * @author CloudBrasil <abernardo.br@gmail.com>
-   * @description Get all lists
-   * @param {object} params={} Params to pagination and orgId
-   * @param {number} [params.page=0] Current page to pagination
-   * @param {number} [params.perPage=200] Qnt itens per page
-   * @param {string} params.orgId Organization Id (_id database)
-   * @param {string} session Session, token JWT
-   * @return {Promise}
-   * @public
-   * @async
-   * @example
-   *
-   * const API = require('@docbrasil/api-systemmanager');
-   * const api = new API();
-   * const params = {
-   *  orgId: '55e4a3bd6be6b45210833fae'
-   * };
-   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
-   * await api.admin.list.find(params, session);
-   */
-  async find(params = {}, session) {
-    const self = this;
-
-    try {
-
-      Joi.assert(params, Joi.object());
-      Joi.assert(params.page, Joi.number());
-      Joi.assert(params.perPage, Joi.number());
-      Joi.assert(params.orgId, Joi.string().required());
-      Joi.assert(session, Joi.string().required());
-
-      const orgId = _.get(params, 'orgId');
-      const page = _.get(params, 'page', 0);
-      const perPage = _.get(params, 'perPage', 200);
-      const apiCall = self._client
-        .post(`/admin/organizations/${orgId}/orgtags?page=${page}&perPage=${perPage}`, {}, self._setHeader(session));
-
-      return self._returnData(await apiCall);
-    } catch (ex) {
-      throw ex;
-    }
-  }
-}
-
-export default AdminLists;
+import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+
+/**
+ * Admin Class for lists, permission admin
+ * @class
+ */
+class AdminLists {
+
+  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 CloudBrasil <abernardo.br@gmail.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 CloudBrasil <abernardo.br@gmail.com>
+   * @description Get list by ID
+   * @param {object} params Params to find list by id
+   * @param {string} params.id List Id (_id database)
+   * @param {string} params.orgId Organization Id (_id database)
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  id: '55e4a3bd6be6b45210833fae',
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.list.findById(params, session);
+   */
+  async findById(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.id, Joi.string().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const {id, orgId} = params;
+      const apiCall = self._client.get(`/admin/organizations/${orgId}/orgtags/${id}`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Get all lists
+   * @param {object} params={} Params to pagination and orgId
+   * @param {number} [params.page=0] Current page to pagination
+   * @param {number} [params.perPage=200] Qnt itens per page
+   * @param {string} params.orgId Organization Id (_id database)
+   * @param {string} session Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  orgId: '55e4a3bd6be6b45210833fae'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.list.find(params, session);
+   */
+  async find(params = {}, session) {
+    const self = this;
+
+    try {
+
+      Joi.assert(params, Joi.object());
+      Joi.assert(params.page, Joi.number());
+      Joi.assert(params.perPage, Joi.number());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const orgId = _.get(params, 'orgId');
+      const page = _.get(params, 'page', 0);
+      const perPage = _.get(params, 'perPage', 200);
+      const apiCall = self._client
+        .post(`/admin/organizations/${orgId}/orgtags?page=${page}&perPage=${perPage}`, {}, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
+export default AdminLists;