wingbot 3.56.0 → 3.57.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.56.0",
+  "version": "3.57.0",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {
@@ -53,7 +53,7 @@
     "tsd-jsdoc": "^2.5.0"
   },
   "dependencies": {
-    "@amplitude/ua-parser-js": "^0.7.31",
+    "@amplitude/ua-parser-js": "^0.7.33",
     "deep-extend": "^0.6.0",
     "form-data": "^4.0.0",
     "graphql": "^15.8.0",

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

@@ -0,0 +1,38 @@
+/**
+ * @author wingbot.ai
+ */
+'use strict';
+
+const { compileWithState } = require('../../src/utils');
+
+function personaPlugin (params) {
+
+    function persona (req, res) {
+        let name = compileWithState(req, res, params.name).trim();
+        let img = compileWithState(req, res, params.img).trim();
+
+        if (!name && !img) {
+            res.setPersona(null);
+            return;
+        }
+
+        if (name) {
+            const foundPersona = res._findPersonaConfiguration(name) || {};
+            if (!img) {
+                img = foundPersona.profile_pic_url;
+            }
+            if (foundPersona.name) {
+                name = foundPersona.name;
+            }
+        }
+
+        res.setPersona({
+            ...(img ? { profile_pic_url: img } : {}),
+            ...(name ? { name } : {})
+        });
+    }
+
+    return persona;
+}
+
+module.exports = personaPlugin;

package/plugins/plugins.json

@@ -564,6 +564,29 @@
                     "description": "If API call fails"
                 }
             ]
+        },
+        {
+            "id": "ai.wingbot.persona",
+            "name": "Set persona",
+            "description": "Use this persona for following messages.",
+            "availableSince": 3.56,
+            "editable": false,
+            "isFactory": true,
+            "category": "conversation",
+            "inputs": [
+                {
+                    "name": "name",
+                    "label": "Persona name",
+                    "type": "text"
+                },
+                {
+                    "name": "img",
+                    "label": "Persona image",
+                    "type": "text"
+                }
+            ],
+            "items": [
+            ]
         }
     ],
     "categories": [

package/src/BuildRouter.js

@@ -17,10 +17,12 @@ const { shouldExecuteResolver } = require('./resolvers/resolverTags');
 
 const MESSAGE_RESOLVER_NAME = 'botbuild.message';
 
+/** @typedef {import('./Router').BaseConfiguration} BaseConfiguration */
+
 /**
  *
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @typedef {import('./Router').Middleware<S,C>} Middleware
  */
 
@@ -111,7 +113,7 @@ const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
  */
 
 /**
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @typedef {object} BotContext
  * @prop {LinkTranslator} [linksTranslator] - function, that translates links globally
  * @prop {ConfigStorage} [configStorage] - function, that translates links globally
@@ -133,14 +135,14 @@ const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
  * @prop {string} [staticBlockId]
  * @prop {Block[]} [blocks]
  * @prop {object} [BuildRouter]
- * @prop {string} [resolverId] - only for text messages with random characters
+ * @prop {string|number} [resolverId] - only for text messages with random characters
  */
 
 /**
  * Build bot from Wingbot configuration file or snapshot url
  *
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @class BuildRouter
  * @extends {Router<S,C>}
  */
@@ -182,7 +184,7 @@ class BuildRouter extends Router {
      * module.exports = bot;
      */
     constructor (block, plugins = new Plugins(), context = {}, fetchFn = fetch) {
-        super();
+        super(context.configuration);
 
         this._validateBlock(block);
 
@@ -191,10 +193,6 @@ class BuildRouter extends Router {
         /** @type {BotContext<C>} */
         this._context = context;
 
-        /** @type {C} */
-        // @ts-ignore
-        this._configuration = context.configuration || {};
-
         /** @type {LinksMap} */
         this._linksMap = new Map();
 
@@ -249,13 +247,6 @@ class BuildRouter extends Router {
         return this._botId;
     }
 
-    /**
-     * @returns {C}
-     */
-    get configuration () {
-        return this._configuration;
-    }
-
     _validateBlock (block, action = 'build') {
         // @ts-ignore
         assert.ok(block && typeof block === 'object', `Bot ${action} failed: expected the block to be an object, ${typeof block} given`);
@@ -650,14 +641,6 @@ class BuildRouter extends Router {
         });
     }
 
-    /**
-     *
-     * @returns {object}
-     */
-    getConfiguration () {
-        return this._configuration;
-    }
-
     /**
      *
      * @param {LinksMap} linksMap
@@ -911,7 +894,7 @@ class BuildRouter extends Router {
 }
 
 /**
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @param {Block[]} blocks - blocks list
  * @param {Plugins} [plugins]
  * @param {BotContext<C>} [context]

package/src/Plugins.js

@@ -10,16 +10,18 @@ const plugins = require('../plugins');
 const RouterWrap = require('./RouterWrap');
 const wrapPluginFunction = require('./utils/wrapPluginFunction');
 
+/** @typedef {import('./Router').BaseConfiguration} BaseConfiguration */
+
 /**
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @typedef {import('./Router').Middleware<S,C>} Middleware
  */
 
 /**
  *
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @callback Plugin
  * @param {Request<S,C>} req
  * @param {Responder} res
@@ -31,7 +33,7 @@ const wrapPluginFunction = require('./utils/wrapPluginFunction');
 /**
  *
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @callback PluginFactory
  * @param {object} params
  * @param {C} configuration

package/src/Processor.js

@@ -657,7 +657,14 @@ class Processor extends EventEmitter {
                 pageId
             };
 
-            res = new Responder(senderId, messageSender, token, options, responderData);
+            res = new Responder(
+                senderId,
+                messageSender,
+                token,
+                options,
+                responderData,
+                configuration
+            );
             const postBack = this._createPostBack(postbackAcumulator, req, res, features);
 
             let continueDispatching = true;

package/src/Request.js

@@ -38,6 +38,8 @@ function makeTimestamp () {
     return now;
 }
 
+/** @typedef {import('./Router').BaseConfiguration} BaseConfiguration */
+
 /**
  * @typedef {object} Entity
  * @prop {string} entity
@@ -117,7 +119,7 @@ function makeTimestamp () {
  * Instance of {Request} class is passed as first parameter of handler (req)
  *
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @class Request
  */
 class Request {

package/src/Responder.js

@@ -8,7 +8,7 @@ const ReceiptTemplate = require('./templates/ReceiptTemplate');
 const ButtonTemplate = require('./templates/ButtonTemplate');
 const GenericTemplate = require('./templates/GenericTemplate');
 const ListTemplate = require('./templates/ListTemplate');
-const { makeAbsolute, makeQuickReplies } = require('./utils');
+const { makeAbsolute, makeQuickReplies, tokenize } = require('./utils');
 const { ResponseFlag } = require('./analytics/consts');
 const { checkSetState } = require('./utils/stateVariables');
 const {
@@ -81,6 +81,14 @@ Object.freeze(ExpectedInput);
  * @returns {VoiceControl}
  */
 
+/**
+ * @typedef {object} Persona
+ * @prop {string} [profile_pic_url]
+ * @prop {string} [name]
+ */
+
+const PERSONA_DEFAULT = '_default';
+
 /**
  * Instance of responder is passed as second parameter of handler (res)
  *
@@ -88,11 +96,19 @@ Object.freeze(ExpectedInput);
  */
 class Responder {
 
-    constructor (senderId, messageSender, token = null, options = {}, data = {}) {
+    constructor (
+        senderId,
+        messageSender,
+        token = null,
+        options = {},
+        data = {},
+        configuration = {}
+    ) {
         this._messageSender = messageSender;
         this._senderId = senderId;
         this._pageId = options.pageId;
         this.token = token;
+        this._configuration = configuration;
 
         /**
          * The empty object, which is filled with res.setState() method
@@ -185,6 +201,21 @@ class Responder {
         this._typingSent = false;
     }
 
+    _findPersonaConfiguration (name) {
+        if (!name || !this._configuration.persona) {
+            return null;
+        }
+        if (!this._configuration._cachedPersonas) {
+            // eslint-disable-next-line no-param-reassign
+            this._configuration._cachedPersonas = new Map(
+                Object.entries(this._configuration.persona)
+                    .map(([k, v]) => [k === PERSONA_DEFAULT ? k : tokenize(k), v])
+            );
+        }
+        const nameKey = name === PERSONA_DEFAULT ? PERSONA_DEFAULT : tokenize(name);
+        return this._configuration._cachedPersonas.get(nameKey);
+    }
+
     /**
      *
      * Returns current conversation transcript
@@ -283,6 +314,7 @@ class Responder {
         if (!data || typeof data !== 'object') {
             throw new Error('Send method requires an object as first param');
         }
+        this.setPersona(PERSONA_DEFAULT);
         if (!data.recipient) {
             Object.assign(data, {
                 recipient: {
@@ -414,10 +446,23 @@ class Responder {
     /**
      * Tets the persona for following requests
      *
-     * @param {object|string|null} personaId
+     * @param {Persona|string|null} personaId
      * @returns {this}
      */
     setPersona (personaId = null) {
+        if (personaId === PERSONA_DEFAULT && this._persona) {
+            return this;
+        }
+        if (typeof personaId === 'string') {
+            const persona = this._findPersonaConfiguration(personaId);
+            if (persona) {
+                this._persona = persona;
+                return this;
+            }
+            if (personaId === PERSONA_DEFAULT) {
+                return this;
+            }
+        }
         this._persona = personaId;
         return this;
     }
@@ -1345,4 +1390,6 @@ Responder.TYPE_MESSAGE_TAG = TYPE_MESSAGE_TAG;
 Responder.TYPE_UPDATE = TYPE_UPDATE;
 Responder.TYPE_RESPONSE = TYPE_RESPONSE;
 
+Responder.PERSONA_DEFAULT = PERSONA_DEFAULT;
+
 module.exports = Responder;

package/src/Router.js

@@ -31,7 +31,7 @@ function defaultPathContext () {
 
 /**
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @callback Resolver processing function
  * @param {Request<S,C>} [req]
  * @param {Responder} [res]
@@ -41,7 +41,7 @@ function defaultPathContext () {
 
 /**
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @callback Reduce processing function
  * @param {Request<S,C>} [req]
  * @param {Responder} [res]
@@ -52,7 +52,7 @@ function defaultPathContext () {
 
 /**
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @typedef {object} IRouter
  * @prop {Reduce<S,C>} reduce
  */
@@ -69,28 +69,63 @@ function defaultPathContext () {
 /**
  *
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @typedef {Resolver<S,C>|RouteExp|IRouter} Middleware flow control statement or function
  */
 
+/**
+ * @typedef {import('./Responder').Persona} Persona
+ */
+
+/**
+ * @typedef {Object<string|'_default',PersonConfiguration>} PersonConfiguration
+ */
+
+/**
+ * @typedef {object} BaseConfiguration
+ * @prop {PersonConfiguration} [persona]
+ */
+
 /**
  * Cascading router
  *
  * @template {object} [S=object]
- * @template {object} [C=object]
+ * @template {BaseConfiguration} [C=object]
  * @class Router
  * @extends {ReducerWrapper}
  */
 class Router extends ReducerWrapper {
 
-    constructor () {
+    /**
+     * @param {C} [configuration]
+     */
+    constructor (configuration = null) {
         super();
 
+        /** @type {C} */
+        // @ts-ignore
+        this._configuration = configuration || {};
+
         this._routes = [];
 
         this.globalIntents = new Map();
     }
 
+    /**
+     * @returns {C}
+     */
+    get configuration () {
+        return this._configuration;
+    }
+
+    /**
+     *
+     * @returns {C}
+     */
+    getConfiguration () {
+        return this._configuration;
+    }
+
     _normalizePath (path) {
         let normalizedPath;
 

package/src/analytics/onInteractionHandler.js

@@ -470,7 +470,7 @@ function onInteractionHandler (
                     isGoto: false,
                     withUser,
                     ...langsExtension,
-                    ...(hasExtendedEvents ? {} : actionMeta)
+                    ...actionMeta
                 });
 
                 let prevAction = action;

package/src/testTools/AnyResponseAssert.js

@@ -22,7 +22,7 @@ class AnyResponseAssert {
     /**
      * Checks, that response contains a text
      *
-     * @param {string} search
+     * @param {string|object} search
      * @returns {this}
      *
      * @memberOf ResponseAssert

package/src/testTools/asserts.js

@@ -4,6 +4,7 @@
 'use strict';
 
 const assert = require('assert');
+const deepExtend = require('deep-extend');
 const { actionMatches, parseActionPayload } = require('../utils');
 
 /**
@@ -109,11 +110,26 @@ function searchMatchesText (search, text) {
  * Checks, that text contain a message
  *
  * @param {object} response
- * @param {string} search
+ * @param {string|object} search
  * @param {string|false} [message='Should contain a text'] - use false for no asserts
  * @returns {boolean}
  */
 function contains (response, search, message = 'Should contain a text') {
+    if (typeof search === 'object') {
+        try {
+            assert.deepEqual(
+                response,
+                deepExtend({}, response, search),
+                'Event contains'
+            );
+            return true;
+        } catch (e) {
+            if (message === false) {
+                return false;
+            }
+            throw e;
+        }
+    }
     const text = getText(response);
     const typeIsText = typeof text === 'string';
     if (message === false && !typeIsText) {
@@ -294,7 +310,7 @@ function buttonTemplate (response, search, count = null, message = 'Should conta
 
 /**
  *
- * @param {search} response
+ * @param {object} response
  * @param {string|false} message
  * @returns {false|object[]}
  */
@@ -315,7 +331,7 @@ function genericTemplateItems (response, message = 'Generic template should cont
 /**
  * Validates generic template
  *
- * @param {search} response
+ * @param {object} response
  * @param {number} [count]
  * @param {string|false} message
  * @returns {boolean}

package/src/utils/compileWithState.js

@@ -38,8 +38,14 @@ function compileWithState (req, res, template) {
     if (!template) {
         return '';
     }
+    if (typeof template !== 'string') {
+        return `${template}`;
+    }
+    if (!template.includes('{{')) {
+        return template;
+    }
     const data = stateData(req, res);
-    return handlebars.compile(`${template}`)(data);
+    return handlebars.compile(template)(data);
 }
 
 module.exports = compileWithState;