@docbrasil/api-systemmanager 1.1.30 → 1.1.32

package/api/ai.js

@@ -0,0 +1,97 @@
+import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+
+/**
+ * Class using AI
+ * @class
+ */
+class MyndAI {
+
+  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) {
+      throw 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(authorization) {
+    return {
+      headers: {
+        authorization,
+      }
+    };
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Create new document
+   * @param {object} params Object for add new document
+   * @param {string} params.model The model to use for the explain
+   * @param {object} params.context The context to apply to a prompt
+   * @param {string} params.text The text to add to the prompt
+   * @param {array<base64>} params.medias Medias to add to the case in base64 (PDF, Image, Video, Audio)
+   * @param {string} params.propmpt The actual prompt with context and text to apply to
+   * @return {Promise<object>} data
+   * @return {boolean} data.success true|false for success
+   * @return {object} data.result the result of the AI call
+   * @return {string} data.result.response The actual text response according the prompt
+   * @return {number} data.result.tokens The quantity of token used in this request
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const authorization = '...';
+   * const params = {
+   *  model: 'model-name',
+   *  context: { name: 'Some name' },
+   *  text: 'Say hello to the world',
+   *  medias: ['...'],
+   *  prompt: 'Write a story about {{name}} with the following theme: {{text}}',
+   * };
+   * const retData = await api.ai.explain(params, authorization);
+   */
+  async explain(params, authorization) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required().error(new Error('params is required')));
+      Joi.assert(params.propmpt, Joi.string().required().error(new Error('Provide a prompt')));
+
+      const apiCall = self._client
+          .post('/agents/explain', params, self._setHeader(authorization));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
+export default MyndAI;

package/api/user/notification.js

@@ -62,8 +62,10 @@ class Notification {
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to add a notification token
    * @param {object} params Params to add notification token
-   * @param {string} params.token The token
-   * @param {object} params.type The token type
+   * @param {obhect} params.token The token
+   * @param {object} params.token.value The token value
+   * @param {object} params.token.type The token type
+   * @param {object} params.token.data The extra data of a token, if there is.
    * @param {string} session Is token JWT of user NOT allow SU
    * @returns {promise<object>} data
    * @returns {boolean} data._id the id of the added token
@@ -74,21 +76,60 @@ class Notification {
    * const api = new API();
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
    * const params = {
-   *  token: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
-   *  type: 'FCM_WEB'
+   *  token: {
+   *    value: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
+   *    type: 'FCM_CAPACITOR'
+ *    }
    * };
    * const retData = await api.user.notification.addToken(params, session);
    */
   async addToken(params = {}, session) {
     const self = this;
 
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to get task');
+      Joi.assert(params.token, Joi.object().required(), 'Token information to add');
+      Joi.assert(params.token.value, Joi.string().required(), 'Token token value');
+      Joi.assert(params.token.type, Joi.string().required(), 'The type of the token');
+
+      const apiCall = self._client
+        .put(`/notifications/token`, params, self._setHeader(session));
+
+      const retData = self._returnData(await apiCall);
+      return retData;
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Method to remove a notification token
+   * @param {object} params Params to add notification token
+   * @param {obhect} params.token The token value
+   * @param {string} session Is token JWT of user NOT allow SU
+   * @returns {promise<object>} data
+   * @returns {boolean} data._id the id of the added token
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const params = {
+   *  token:'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2'
+   * };
+   * const retData = await api.user.notification.removeToken(params, session);
+   */
+  async removeToken(params = {}, session) {
+    const self = this;
+
     try {
       Joi.assert(params, Joi.object().required(), 'Params to get task');
       Joi.assert(params.token, Joi.string().required(), 'Token is required');
-      Joi.assert(params.type, Joi.string().required(), ' The token type');
 
       const apiCall = self._client
-        .put(`/users/notifications/token`, params, self._setHeader(session));
+          .delete(`/notifications/token/${params.token}`, self._setHeader(session));
 
       const retData = self._returnData(await apiCall);
       return retData;

package/dist/bundle.cjs

@@ -10384,8 +10384,10 @@ class Notification {
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Method to add a notification token
    * @param {object} params Params to add notification token
-   * @param {string} params.token The token
-   * @param {object} params.type The token type
+   * @param {obhect} params.token The token
+   * @param {object} params.token.value The token value
+   * @param {object} params.token.type The token type
+   * @param {object} params.token.data The extra data of a token, if there is.
    * @param {string} session Is token JWT of user NOT allow SU
    * @returns {promise<object>} data
    * @returns {boolean} data._id the id of the added token
@@ -10396,21 +10398,60 @@ class Notification {
    * const api = new API();
    * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
    * const params = {
-   *  token: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
-   *  type: 'FCM_WEB'
+   *  token: {
+   *    value: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
+   *    type: 'FCM_CAPACITOR'
+ *    }
    * };
    * const retData = await api.user.notification.addToken(params, session);
    */
   async addToken(params = {}, session) {
     const self = this;
 
+    try {
+      Joi__default["default"].assert(params, Joi__default["default"].object().required(), 'Params to get task');
+      Joi__default["default"].assert(params.token, Joi__default["default"].object().required(), 'Token information to add');
+      Joi__default["default"].assert(params.token.value, Joi__default["default"].string().required(), 'Token token value');
+      Joi__default["default"].assert(params.token.type, Joi__default["default"].string().required(), 'The type of the token');
+
+      const apiCall = self._client
+        .put(`/notifications/token`, params, self._setHeader(session));
+
+      const retData = self._returnData(await apiCall);
+      return retData;
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Method to remove a notification token
+   * @param {object} params Params to add notification token
+   * @param {obhect} params.token The token value
+   * @param {string} session Is token JWT of user NOT allow SU
+   * @returns {promise<object>} data
+   * @returns {boolean} data._id the id of the added token
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const params = {
+   *  token:'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2'
+   * };
+   * const retData = await api.user.notification.removeToken(params, session);
+   */
+  async removeToken(params = {}, session) {
+    const self = this;
+
     try {
       Joi__default["default"].assert(params, Joi__default["default"].object().required(), 'Params to get task');
       Joi__default["default"].assert(params.token, Joi__default["default"].string().required(), 'Token is required');
-      Joi__default["default"].assert(params.type, Joi__default["default"].string().required(), ' The token type');
 
       const apiCall = self._client
-        .put(`/users/notifications/token`, params, self._setHeader(session));
+          .delete(`/notifications/token/${params.token}`, self._setHeader(session));
 
       const retData = self._returnData(await apiCall);
       return retData;
@@ -13929,6 +13970,98 @@ class External {
 
 }
 
+/**
+ * Class using AI
+ * @class
+ */
+class MyndAI {
+
+  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 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(authorization) {
+    return {
+      headers: {
+        authorization,
+      }
+    };
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Create new document
+   * @param {object} params Object for add new document
+   * @param {string} params.model The model to use for the explain
+   * @param {object} params.context The context to apply to a prompt
+   * @param {string} params.text The text to add to the prompt
+   * @param {array<base64>} params.medias Medias to add to the case in base64 (PDF, Image, Video, Audio)
+   * @param {string} params.propmpt The actual prompt with context and text to apply to
+   * @return {Promise<object>} data
+   * @return {boolean} data.success true|false for success
+   * @return {object} data.result the result of the AI call
+   * @return {string} data.result.response The actual text response according the prompt
+   * @return {number} data.result.tokens The quantity of token used in this request
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const authorization = '...';
+   * const params = {
+   *  model: 'model-name',
+   *  context: { name: 'Some name' },
+   *  text: 'Say hello to the world',
+   *  medias: ['...'],
+   *  prompt: 'Write a story about {{name}} with the following theme: {{text}}',
+   * };
+   * const retData = await api.ai.explain(params, authorization);
+   */
+  async explain(params, authorization) {
+    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.propmpt, Joi__default["default"].string().required().error(new Error('Provide a prompt')));
+
+      const apiCall = self._client
+          .post('/agents/explain', params, self._setHeader(authorization));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
 /**
  * Class API
  */
@@ -14000,6 +14133,7 @@ class API {
     self.user = new Users({parent: self});
     self.admin = new Admin({parent: self});
     self.external = new External({parent: self});
+    self.ai = new MyndAI({parent: self});
   }
 }