wingbot 3.30.2 → 3.31.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.30.2",
+  "version": "3.31.0",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {
@@ -53,6 +53,7 @@
     "tsd-jsdoc": "^2.5.0"
   },
   "dependencies": {
+    "form-data": "^4.0.0",
     "graphql": "^15.8.0",
     "jsonwebtoken": "^8.5.1",
     "node-fetch": "^2.6.7",

package/src/BotAppSender.js

@@ -5,6 +5,7 @@
 
 const jwt = require('jsonwebtoken');
 const { default: fetch, Headers } = require('node-fetch');
+const FormData = require('form-data');
 const crypto = require('crypto');
 const { Agent } = require('https');
 const { promisify } = require('util');
@@ -12,6 +13,7 @@ const ReturnSender = require('./ReturnSender');
 
 /** @typedef {import('./ReturnSender').ReturnSenderOptions} ReturnSenderOptions */
 /** @typedef {import('./ReturnSender').ChatLogStorage} ChatLogStorage */
+/** @typedef {import('./ReturnSender').UploadResult} UploadResult */
 
 /**
  * @typedef {object} TlsOptions
@@ -91,6 +93,38 @@ class BotAppSender extends ReturnSender {
         return this._agent;
     }
 
+    /**
+     *
+     * @param {Buffer} data
+     * @param {string} contentType
+     * @param {string} fileName
+     * @returns {Promise<UploadResult>}
+     */
+    async upload (data, contentType, fileName) {
+        const formData = new FormData();
+
+        const nonce = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER).toString(36).padEnd(11, '0');
+
+        formData.append('nonce', nonce);
+        formData.append('f0', data, { filename: fileName, contentType });
+
+        const [token, agent] = await Promise.all([
+            BotAppSender.signBody(nonce, this._secret, this._appId),
+            this._getAgent()
+        ]);
+
+        const headers = new Headers();
+
+        headers.set('Authorization', token);
+
+        const response = await this._fetch(this._apiUrl, {
+            headers, body: formData, agent, method: 'POST'
+        })
+            .then((r) => r.json());
+
+        return response;
+    }
+
     async _send (payload) {
         // attach sender
         if (typeof payload.sender === 'undefined') {

package/src/Responder.js

@@ -60,6 +60,8 @@ Object.freeze(ExpectedInput);
  * @prop {string} [voice]
  */
 
+/** @typedef {import('./ReturnSender').UploadResult} UploadResult */
+
 /**
  * Instance of responder is passed as second parameter of handler (res)
  *
@@ -537,6 +539,7 @@ class Responder {
             });
         } else {
             this._quickReplyCollector.push({
+                // @ts-ignore
                 action: this.toAbsoluteAction(action),
                 title,
                 data,
@@ -749,6 +752,30 @@ class Responder {
         return ret;
     }
 
+    /**
+     *
+     * @param {Buffer} data
+     * @param {string} contentType
+     * @param {string} fileName
+     * @returns {Promise<UploadResult>}
+     */
+    async upload (data, contentType, fileName) {
+        const result = await this._messageSender.upload(data, contentType, fileName);
+
+        if (!result.url) {
+            throw new Error(`Got no url on file upload ${fileName}. Probably a compatibility issue.`);
+        }
+
+        let [type] = contentType.split('/');
+
+        if (!['image', 'video', 'audio'].includes(type)) {
+            type = 'file';
+        }
+
+        this._attachment(result.url, type, true);
+        return result;
+    }
+
     /**
      * Sends image as response. Requires appUrl option to send images from server
      *

package/src/ReturnSender.js

@@ -23,6 +23,12 @@ const { FLAG_DO_NOT_LOG } = require('./flags');
  * @prop {textFilter} [confidentInputFilter] - filter for confident input (@CONFIDENT)
  */
 
+/**
+ * @typedef {object} UploadResult
+ * @prop {string} [url]
+ * @prop {string|number} [attachmentId]
+ */
+
 /**
  * Text filter function
  *
@@ -319,6 +325,17 @@ class ReturnSender {
         this._visitedInteractions.push(action);
     }
 
+    /**
+     *
+     * @param {Buffer} data
+     * @param {string} contentType
+     * @param {string} fileName
+     * @returns {Promise<UploadResult>}
+     */
+    async upload (data, contentType, fileName) { // eslint-disable-line no-unused-vars
+        throw new Error('#upload() not supported by this channel');
+    }
+
     send (payload) {
         if (this._finished) {
             throw new Error('Cannot send message after sender is finished');

package/src/resolvers/message.js

@@ -19,14 +19,17 @@ const {
     FEATURE_SSML, FEATURE_TEXT, FEATURE_VOICE
 } = require('../features');
 
+/** @typedef {import('../Responder').VoiceControl} VoiceControl */
+/** @typedef {import('./utils').Translations} Translations */
+/** @typedef {import('./utils').TextObject} TextObject */
 /**
  * Returns voice control props from params
  *
  * @param {any} params
  * @param {string} lang
- * @returns {null | import('../Responder').VoiceControl}
+ * @returns {null | VoiceControl}
  */
-function getVoiceControl (params, lang = null) {
+function getVoiceControlFromParams (params, lang = null) {
     const voiceControl = {};
 
     const voiceControlProps = ['speed', 'pitch', 'volume', 'voice', 'style', 'language'];
@@ -105,10 +108,10 @@ function parseReplies (replies, linksMap, allowForbiddenSnippetWords) {
 }
 
 /**
- * @param {import('./utils').Translations} text
+ * @param {Translations} text
  * @param {string[]} features
  * @param {string} lang
- * @returns {{translations: import('./utils').TextObject[],ssmlAlternatives:string[] | null}}
+ * @returns {{translations:TextObject[],ssmlAlternatives:string[] | null}}
  */
 function findSupportedMessages (text, features, lang = null) {
     let translations = getLanguageTextObjects(text, lang);
@@ -184,7 +187,6 @@ function message (params, {
         const data = stateData(req, res);
 
         // filter supported messages
-        /** @type {{translations:import('./utils').TextObject[],ssmlAlternatives:string[]}} */
         const supportedText = findSupportedMessages(
             params.text,
             req.features,
@@ -235,7 +237,7 @@ function message (params, {
         }
 
         // generate voice control
-        let voiceControl = getVoiceControl(params, data.lang);
+        let voiceControl = getVoiceControlFromParams(params, data.lang);
         if (supportedText.ssmlAlternatives) {
             // find SSML alternative
             const ssmlAlternativeTemplate = randomizedCompiler([{