wingbot 3.59.1 → 3.60.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.59.1",
+  "version": "3.60.0",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {

package/plugins/ai.wingbot.upload/plugin.js

@@ -0,0 +1,54 @@
+const Router = require('../../src/Router');
+
+/**
+ *
+ * @param {object} params
+ * @param {'any'|'image'|'audio'|'video'|'file'} params.type
+ * @param {string} params.variable
+ * @param {'array'|'string'} params.datatype
+ * @returns {import('../../src/Router').Middleware}
+ */
+module.exports = (params) => {
+
+    /**
+     * @param {import('../../src/Request')} req
+     * @param {import('../../src/Responder')} res
+     */
+    const uploadPlugin = async (req, res) => {
+        if (req.isAttachment()) {
+
+            const typeOk = (!params.type || params.type === 'any')
+                || req.attachments.every((a) => a.type === params.type);
+
+            if (!typeOk) {
+                await res.run('badType');
+                return Router.NEXT;
+            }
+
+            const varName = `${params.variable || 'uploadUrl'}`.trim();
+
+            if (params.datatype === 'array') {
+                const curr = req.state[varName] || [];
+                const urls = req.attachments.map((a) => a.payload.url)
+                    .filter((u) => !!u);
+
+                res.setState({
+                    [varName]: [...curr, ...urls]
+                });
+            } else {
+                const [first] = req.attachments;
+
+                res.setState({
+                    [varName]: first.payload.url || null
+                });
+            }
+            await res.run('success');
+
+        } else {
+            await res.run('noAttachment');
+        }
+        return Router.NEXT;
+    };
+
+    return uploadPlugin;
+};

package/plugins/plugins.json

@@ -609,6 +609,57 @@
             ],
             "items": [
             ]
+        },
+        {
+            "id": "ai.wingbot.upload",
+            "name": "Process upload",
+            "description": "Plugin is intended to be used in an interaction plugin",
+            "availableSince": 3.60,
+            "editable": false,
+            "isFactory": true,
+            "category": "detectors",
+            "inputs": [
+                {
+                    "name": "type",
+                    "label": "Allowed attachment type",
+                    "type": "select",
+                    "options": [
+                        { "value": "any", "label": "any attachment type" },
+                        { "value": "image", "label": "image" },
+                        { "value": "audio", "label": "audio" },
+                        { "value": "video", "label": "video" },
+                        { "value": "file", "label": "file" }
+                    ]
+                },
+                {
+                    "name": "variable",
+                    "label": "Variable name to set attachment URL(s)",
+                    "type": "text"
+                },
+                {
+                    "name": "datatype",
+                    "label": "Allowed attachment type",
+                    "type": "select",
+                    "options": [
+                        { "value": "string", "label": "string" },
+                        { "value": "array", "label": "array of strings" }
+                    ]
+                }
+            ],
+            "items": [
+                {
+                    "id": "noAttachment",
+                    "description": "No attachment uploaded"
+                },
+                {
+                    "id": "badType",
+                    "description": "Disallowed attachment type"
+                },
+                {
+                    "id": "success",
+                    "description": "Successfully uploaded"
+                }
+            ]
         }
     ],
     "categories": [

package/src/Processor.js

@@ -527,7 +527,14 @@ class Processor extends EventEmitter {
         }
     }
 
-    async _processMessage (message, pageId, messageSender, responderData, preloadPromise = null) {
+    async _processMessage (
+        message,
+        pageId,
+        messageSender,
+        responderData,
+        preloadPromise = null,
+        senderMeta = null
+    ) {
         let senderId = message.sender && message.sender.id;
         const fromEvent = !!preloadPromise;
 
@@ -663,7 +670,8 @@ class Processor extends EventEmitter {
                 token,
                 options,
                 responderData,
-                configuration
+                configuration,
+                senderMeta
             );
             const postBack = this._createPostBack(postbackAcumulator, req, res, features);
 
@@ -815,7 +823,8 @@ class Processor extends EventEmitter {
                 senderId,
                 pageId,
                 messageSender,
-                responderData
+                responderData,
+                res.senderMeta
             );
 
             await emitPromise; // probably has been resolved this time
@@ -906,7 +915,14 @@ class Processor extends EventEmitter {
         });
     }
 
-    _processPostbacks (postbackAcumulator, senderId, pageId, messageSender, responderData) {
+    _processPostbacks (
+        postbackAcumulator,
+        senderId,
+        pageId,
+        messageSender,
+        responderData,
+        senderMeta
+    ) {
         return postbackAcumulator.reduce((promise, postback) => promise
             .then(() => postback)
             .then(({ action, data = {}, features }) => {
@@ -917,7 +933,14 @@ class Processor extends EventEmitter {
                     request = Request.postBack(senderId, action, data);
                 }
                 Object.assign(request, { features });
-                return this._processMessage(request, pageId, messageSender, responderData);
+                return this._processMessage(
+                    request,
+                    pageId,
+                    messageSender,
+                    responderData,
+                    null,
+                    senderMeta
+                );
             }), Promise.resolve({}));
     }
 

package/src/Request.js

@@ -109,6 +109,13 @@ function makeTimestamp () {
  * @prop {number} score
  */
 
+/**
+ * @typedef {object} Attachment
+ * @prop {'file'|'audio'|'video'|'image'} type
+ * @prop {object} payload
+ * @prop {string} payload.url
+ */
+
 /**
  * @typedef {number} AiSetStateOption
  */
@@ -175,6 +182,7 @@ class Request {
 
         this._optin = event.optin || null;
 
+        /** @type {Attachment[]} */
         this.attachments = (event.message
             && (event.message.attachment
                 ? [event.message.attachment]

package/src/Responder.js

@@ -102,7 +102,8 @@ class Responder {
         token = null,
         options = {},
         data = {},
-        configuration = {}
+        configuration = {},
+        senderMeta = null
     ) {
         this._messageSender = messageSender;
         this._senderId = senderId;
@@ -190,7 +191,7 @@ class Responder {
         this._trackAsAction = null;
 
         // both vars are package protected
-        this._senderMeta = { flag: null };
+        this._senderMeta = senderMeta || { flag: null };
 
         this._persona = null;
 

package/src/Tester.js

@@ -143,6 +143,11 @@ class Tester {
          * @prop {string[]}
          */
         this.features = null;
+
+        /**
+         * @prop {string}
+         */
+        this.ATTACHMENT_MOCK_URL = 'http://mock.url/file.txt';
     }
 
     _actionHasGlobalIntent (action) {
@@ -415,6 +420,18 @@ class Tester {
         return this.processMessage(Request.text(this.senderId, text));
     }
 
+    /**
+     * Sends attachment
+     *
+     * @param {'image'|'audio'|'video'|'file'} type
+     * @param {string} [url]
+     * @returns {Promise}
+     * @memberOf Tester
+     */
+    attachment (type = 'file', url = this.ATTACHMENT_MOCK_URL) {
+        return this.processMessage(Request.fileAttachment(this.senderId, url, type));
+    }
+
     /**
      * Makes recognised AI intent request
      *