@docbrasil/api-systemmanager 1.0.98 → 1.0.100

package/api/external.js

@@ -52,7 +52,12 @@ class External {
    * @description Create new document
    * @param {object} params Object for add new document
    * @param {string} params.id Organization form id
-   * @return {Promise<object>}
+   * @return {Promise<object>} data
+   * @return {string} _id the id of the form
+   * @return {string} orgId the organization id of the form
+   * @return {string} responseToken the unique token registered internally by the system for all the next calls to the external form APIs
+   *      The responseToken is unique and is ONLY valid for this session.
+   * @return {array<object>} groups the form groups to render
    * @public
    * @async
    * @example
@@ -83,4 +88,4 @@ class External {
 
 }
 
-export default Documents;
+export default External;

package/dist/bundle.cjs

@@ -559,7 +559,7 @@ class Users$1 {
  * Class for documents, permission user
  * @class
  */
-class Documents$1 {
+class Documents {
 
   constructor(options) {
     Joi__default["default"].assert(options, Joi__default["default"].object().required());
@@ -9481,7 +9481,7 @@ class Users {
     Joi__default["default"].assert(options.parent, Joi__default["default"].object().required());
 
     const self = this;
-    self.document = new Documents$1(options);
+    self.document = new Documents(options);
     self.datasource = new Datasource(options);
     self.organization = new Organization$1(options);
     self.process = new Process(options);
@@ -11578,7 +11578,91 @@ class Admin {
   }
 }
 
-var External = Documents;
+/**
+ * Class for documents, permission user
+ * @class
+ */
+class External {
+
+  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) {
+      throw Boom__default["default"].badRequest(___default["default"].get(retData, 'message', 'No error message reported!'))
+    } else {
+      return ___default["default"].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 Create new document
+   * @param {object} params Object for add new document
+   * @param {string} params.id Organization form id
+   * @return {Promise<object>} data
+   * @return {string} _id the id of the form
+   * @return {string} orgId the organization id of the form
+   * @return {string} responseToken the unique token registered internally by the system for all the next calls to the external form APIs
+   *      The responseToken is unique and is ONLY valid for this session.
+   * @return {array<object>} groups the form groups to render
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  id: 'cloundbrasil'
+   * };
+   * const retForm = await api.external.context(params);
+   */
+  async context(params) {
+    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.id, Joi__default["default"].string().required().error(new Error('organization form id is required')));
+
+      const { id } = params;
+      const apiCall = self._client
+          .get(`/component/external/forms/${id}`);
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+}
 
 /**
  * Class API