@docbrasil/api-systemmanager 1.0.99 → 1.0.101

package/api/external.js

@@ -39,10 +39,10 @@ class External {
    * @return {object} header with new session
    * @private
    */
-  _setHeader(session) {
+  _setHeader(responseToken) {
     return {
       headers: {
-        authorization: session,
+        responseToken,
       }
     };
   }
@@ -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
@@ -60,7 +65,7 @@ class External {
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
    * const params = {
-   *  id: 'cloundbrasil'
+   *  id: '611e679741cc63168c26d7ee'
    * };
    * const retForm = await api.external.context(params);
    */
@@ -81,6 +86,46 @@ class External {
     }
   }
 
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Get an upload signed url, so it will be possible to upload documents temporarily during the use of the external form
+   * @param {object} doc the document we are doing the upload to the temporary area
+   * @param {string} doc.mime the mime type of the document
+   * @param {string} responseToken a legal responseToken
+   * @returns {Promise<object>} doc
+   * @returns {string}  doc.mime the original mime type of the document
+   * @returns {string} doc.signedUrl the signed url to upload the document
+   * @returns {string} doc.filename  the filename of the uploaded file
+   * @returns {string} doc.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 responseToken = '...';
+   * const doc = {
+   *  mime: 'application/pdf'
+   * };
+   * const retDoc = await api.external.getUploadDocumentSignedUrl(doc, responseToken);
+   */
+  async getUploadDocumentSignedUrl(doc, responseToken) {
+    const self = this;
+
+    try {
+      Joi.assert(doc, Joi.object().required().error(new Error('doc is required')));
+      Joi.assert(doc.mime, Joi.string().required().error(new Error('mime type is required')));
+      Joi.assert(responseToken, Joi.string().required().error(new Error('responseToken is required')));
+
+      const apiCall = self._client
+          .post('/external/forms/upload/signedurl', { doc }, self._setHeader(responseToken));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
 }
 
 export default External;

package/dist/bundle.cjs

@@ -11615,10 +11615,10 @@ class External {
    * @return {object} header with new session
    * @private
    */
-  _setHeader(session) {
+  _setHeader(responseToken) {
     return {
       headers: {
-        authorization: session,
+        responseToken,
       }
     };
   }
@@ -11628,7 +11628,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
@@ -11636,7 +11641,7 @@ class External {
    * const API = require('@docbrasil/api-systemmanager');
    * const api = new API();
    * const params = {
-   *  id: 'cloundbrasil'
+   *  id: '611e679741cc63168c26d7ee'
    * };
    * const retForm = await api.external.context(params);
    */
@@ -11657,6 +11662,46 @@ class External {
     }
   }
 
+  /**
+   * @author CloudBrasil <abernardo.br@gmail.com>
+   * @description Get an upload signed url, so it will be possible to upload documents temporarily during the use of the external form
+   * @param {object} doc the document we are doing the upload to the temporary area
+   * @param {string} doc.mime the mime type of the document
+   * @param {string} responseToken a legal responseToken
+   * @returns {Promise<object>} doc
+   * @returns {string}  doc.mime the original mime type of the document
+   * @returns {string} doc.signedUrl the signed url to upload the document
+   * @returns {string} doc.filename  the filename of the uploaded file
+   * @returns {string} doc.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 responseToken = '...';
+   * const doc = {
+   *  mime: 'application/pdf'
+   * };
+   * const retDoc = await api.external.getUploadDocumentSignedUrl(doc, responseToken);
+   */
+  async getUploadDocumentSignedUrl(doc, responseToken) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(doc, Joi__default["default"].object().required().error(new Error('doc is required')));
+      Joi__default["default"].assert(doc.mime, Joi__default["default"].string().required().error(new Error('mime type is required')));
+      Joi__default["default"].assert(responseToken, Joi__default["default"].string().required().error(new Error('responseToken is required')));
+
+      const apiCall = self._client
+          .post('/external/forms/upload/signedurl', { doc }, self._setHeader(responseToken));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
 }
 
 /**