wingbot 3.52.5 → 3.53.0-alpha.1

package/package.json

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

package/plugins/ai.wingbot.clearMessageSequences/README.md

@@ -0,0 +1 @@
+> This plugin erases state of conversational sequences

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

@@ -0,0 +1,13 @@
+/**
+ * @param {import('../../src/Request')} req
+ * @param {import('../../src/Responder')} res
+ */
+module.exports = async (req, res) => {
+    [...Object.keys(req.state), ...Object.keys(res.newState)]
+        .forEach((key) => {
+            const match = key.match(/^(_~_R_|_R_)/);
+            if (match) {
+                res.setState({ [key]: null });
+            }
+        });
+};

package/plugins/ai.wingbot.regexp/README.md

@@ -1,9 +1 @@
-> This plugin helps you to drive user back to previous interaction.
-
-If the previous interaction exists and it's not a fallback or the same interaction, where the plugin is, the bot will go back and stops executing this interaction.
-
-If not, the bot will continue in execution of this interaction, so you can handle situation.
-
-It's useful to  it use **Show when there is a way back** condition, so you don't have to worry about handling the situation, when there's no way to go back.
-
-![go back condition](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.conditionIfGoBackPossible/back.png)
+> This plugin detects reqular expressions

package/plugins/plugins.json

@@ -446,6 +446,7 @@
             "availableSince": 3.39,
             "editable": false,
             "isFactory": true,
+            "category": "conversation",
             "inputs": [
                 {
                     "name": "skip",
@@ -470,6 +471,19 @@
             ],
             "items": [
             ]
+        },
+        {
+            "id": "ai.wingbot.clearMessageSequences",
+            "name": "Clear message sequences state",
+            "description": "Put it in a first interaction of the process, where would you like to have clear states of messages sequences",
+            "availableSince": 3.53,
+            "editable": true,
+            "isFactory": false,
+            "category": "conversation",
+            "inputs": [
+            ],
+            "items": [
+            ]
         }
     ],
     "categories": [

package/src/BuildRouter.js

@@ -26,6 +26,7 @@ const MESSAGE_RESOLVER_NAME = 'botbuild.message';
 
 /**
  * @typedef {object} Resolver
+ * @prop {string|number} [id] - only for text messages with random characters
  * @prop {string} type
  * @prop {object} params
  * @prop {string} [params.staticBlockId]
@@ -132,6 +133,7 @@ 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
  */
 
 /**
@@ -827,7 +829,8 @@ class BuildRouter extends Router {
                 isResponder,
                 expectedPath,
                 routeId: id,
-                configuration: this._configuration
+                configuration: this._configuration,
+                resolverId: resolver.id
             };
 
             const resFn = this._resolverFactory(resolver, context, buildInfo);

package/src/Plugins.js

@@ -76,6 +76,7 @@ class Plugins {
      * @param {object} [context]
      * @param {boolean} [context.isLastIndex]
      * @param {Router} [context.router]
+     * @param {object} [context.configuration]
      * @example
      *
      * const { Router } = require('wingbot');
@@ -99,7 +100,7 @@ class Plugins {
         name,
         paramsData = {},
         items = new Map(),
-        context = { isLastIndex: true }
+        context = { isLastIndex: true, configuration: {} }
     ) {
         let useItems = items;
 
@@ -119,7 +120,7 @@ class Plugins {
             .map(([k, e]) => ({ [k]: e }))
             .reduce(Object.assign, {});
 
-        const customFn = this.getPluginFactory(name, cleanParams);
+        const customFn = this.getPluginFactory(name, cleanParams, context.configuration);
         if (typeof customFn === 'object') {
             // this is an attached router
 

package/src/Processor.js

@@ -10,7 +10,7 @@ const Responder = require('./Responder');
 const Request = require('./Request');
 const Ai = require('./Ai');
 const ReturnSender = require('./ReturnSender');
-const { mergeState, isUserInteraction } = require('./utils/stateVariables');
+const { prepareState, mergeState, isUserInteraction } = require('./utils/stateVariables');
 
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').Intent} Intent */
 /** @typedef {import('./ReducerWrapper')} ReducerWrapper */
@@ -637,6 +637,8 @@ class Processor extends EventEmitter {
                 });
             }
 
+            prepareState(state, fromEvent, state._snew);
+
             const features = [
                 ...(this.options.features || []),
                 ...req.features

package/src/Tester.js

@@ -18,6 +18,8 @@ const Router = require('./Router'); // eslint-disable-line no-unused-vars
 const ReducerWrapper = require('./ReducerWrapper'); // eslint-disable-line no-unused-vars
 const { FEATURE_TEXT } = require('./features');
 
+/** @typedef {import('./Processor').ProcessorOptions} ProcessorOptions */
+
 /**
  * Utility for testing requests
  *
@@ -31,7 +33,7 @@ class Tester {
      * @param {Router|ReducerWrapper} reducer
      * @param {string} [senderId=null]
      * @param {string} [pageId=null]
-     * @param {object} [processorOptions={}] - options for Processor
+     * @param {ProcessorOptions} [processorOptions={}] - options for Processor
      * @param {MemoryStateStorage} [storage] - place to override the storage
      *
      * @memberOf Tester
@@ -95,6 +97,7 @@ class Tester {
         this.processor = new Processor(reducer, ({
             stateStorage: this.storage,
             log,
+            // @ts-ignore
             loadUsers: false,
             ...processorOptions
         }));
@@ -168,10 +171,12 @@ class Tester {
     /**
      * Enable tester to expand random texts
      * It joins them into a single sting
+     *
+     * @param {boolean} [fixedIndex]
      */
-    setExpandRandomTexts () {
+    setExpandRandomTexts (fixedIndex) {
         Object.assign(this.testData, {
-            _expandRandomTexts: true
+            _expandRandomTexts: fixedIndex ? 1 : true
         });
     }
 
@@ -381,9 +386,20 @@ class Tester {
     stateContains (object, deep = false) {
         const { state } = this.getState();
 
+        const clean = Object.fromEntries(
+            Object.entries(object)
+                .filter(([k, v]) => {
+                    if (v === null || v === undefined) {
+                        assert.ok(state[k] === null || state[k] === undefined, `Expected state key '${k}' to be empty. Actual: ${JSON.stringify(state[k])}'`);
+                        return false;
+                    }
+                    return true;
+                })
+        );
+
         assert.deepEqual(
             state,
-            deep ? deepExtend({}, state, object) : { ...state, ...object },
+            deep ? deepExtend({}, state, clean) : { ...state, ...clean },
             'Conversation state equals'
         );
     }

package/src/resolvers/message.js

@@ -13,11 +13,13 @@ const {
     getLanguageText,
     getLanguageTextObjects,
     randomizedCompiler,
-    cachedTranslatedCompilator
+    cachedTranslatedCompilator,
+    renderMessageText
 } = require('./utils');
 const {
     FEATURE_SSML, FEATURE_TEXT, FEATURE_VOICE
 } = require('../features');
+const { vars, VAR_TYPES } = require('../utils/stateVariables');
 
 /** @typedef {import('../Responder').VoiceControl} VoiceControl */
 /** @typedef {import('./utils').Translations} Translations */
@@ -180,6 +182,89 @@ function findSupportedMessages (text, features, lang = null) {
     };
 }
 
+const MODE_RANDOM = 'r';
+const MODE_SEQUENCE = 's';
+const MODE_RANDOM_START_SEQUENCE = 'rs';
+
+const ALL_MODES = [MODE_RANDOM, MODE_SEQUENCE, MODE_RANDOM_START_SEQUENCE];
+
+function selectTranslation (resolverId, params, texts, data) {
+    const key = `_R_${resolverId}`;
+    let { lang, [key]: seqState } = data;
+
+    if (texts.length === 1) {
+        return [
+            renderMessageText(texts[0].t, data),
+            seqState && resolverId ? { [key]: null } : {}
+        ];
+    }
+
+    const { mode, persist = null } = params;
+
+    if ((!mode || mode === MODE_RANDOM) && data._expandRandomTexts === true) {
+        return [
+            texts.map((x) => renderMessageText(x.t, data))
+                .join('\n'),
+            {}
+        ];
+    }
+
+    if (!lang) {
+        const [firstText = { l: null }] = getLanguageTextObjects(params.text);
+        lang = firstText.l || 'X';
+    }
+
+    if (mode === MODE_RANDOM || !ALL_MODES.includes(mode)) {
+        const index = data._expandRandomTexts
+            ? 1
+            : Math.floor(Math.random() * texts.length);
+        return [
+            renderMessageText(texts[index].t, data),
+            seqState ? vars.clear(key) : {}
+        ];
+    }
+
+    if (!seqState
+        || seqState.l !== lang
+        || seqState.n > texts.length
+        || seqState.i >= texts.length) {
+
+        seqState = {
+            l: lang,
+            n: texts.length,
+            i: mode === MODE_SEQUENCE ? 0 : Math.floor(Math.random() * texts.length)
+        };
+
+        if (mode === MODE_RANDOM_START_SEQUENCE && data._expandRandomTexts) {
+            seqState.i = 1;
+        }
+    } else {
+        seqState = {
+            ...seqState,
+            i: (seqState.i + 1) % texts.length
+        };
+    }
+
+    let setState;
+
+    if (persist === VAR_TYPES.SESSION_CONTEXT) {
+        setState = vars.sessionContext(key, seqState);
+    } else if (persist === VAR_TYPES.SESSION_DIALOGUE_CONTEXT) {
+        setState = vars.sessionContext(key, seqState, null); // same as interaction
+    } else if (persist === VAR_TYPES.DIALOG_CONTEXT) {
+        setState = vars.dialogContext(key, seqState);
+    } else {
+        setState = {
+            [key]: seqState
+        };
+    }
+
+    return [
+        renderMessageText(texts[seqState.i].t, data),
+        setState
+    ];
+}
+
 /** @typedef {import('../BuildRouter').BotContext} BotContext */
 /** @typedef {import('../Router').Resolver} Resolver */
 
@@ -192,7 +277,7 @@ function findSupportedMessages (text, features, lang = null) {
 function message (params, context = {}) {
     const {
         // @ts-ignore
-        isLastIndex, isLastMessage, linksMap, configuration
+        isLastIndex, isLastMessage, linksMap, configuration, resolverId
     } = context;
     if (typeof params.text !== 'string' && !Array.isArray(params.text)) {
         throw new Error('Message should be a text!');
@@ -225,15 +310,14 @@ function message (params, context = {}) {
             data.lang
         );
 
-        // find random alternative
-        const textTemplate = randomizedCompiler([{
-            l: data.lang,
-            t: supportedText.translations.map((x) => x.t)
-        }]);
-
-        const text = textTemplate(data)
-            .trim();
+        const [text, seqState] = selectTranslation(
+            resolverId,
+            params,
+            supportedText.translations,
+            data
+        );
 
+        res.setState(seqState);
         res.setData({ $this: text });
         if (condition && !condition(req, res)) {
             res.setData({ $this: null });

package/src/resolvers/utils.js

@@ -145,6 +145,11 @@ function getLanguageTextObjects (translations, lang = null) {
         }));
 }
 
+function renderMessageText (fn, data) {
+    const renderer = fn === 'function' ? fn : hbs.compile(fn);
+    return renderer(data).trim();
+}
+
 function randomizedCompiler (text, lang) {
     const texts = getLanguageText(text, lang);
 
@@ -307,6 +312,7 @@ module.exports = {
     randomizedCompiler,
     getText,
     stateData,
+    renderMessageText,
 
     ASPECT_SQUARE,
     ASPECT_HORISONTAL,

package/src/utils/stateVariables.js

@@ -3,6 +3,8 @@
  */
 'use strict';
 
+const SESSION_DIALOGUE_CONTEXT = 'sd';
+const SESSION_CONTEXT = 's';
 const DIALOG_CONTEXT = 'd';
 const EXPIRES_AFTER = 't';
 
@@ -11,11 +13,27 @@ const EXPIRES_AFTER = 't';
 
 const VAR_TYPES = {
     DIALOG_CONTEXT,
-    EXPIRES_AFTER
+    EXPIRES_AFTER,
+    SESSION_DIALOGUE_CONTEXT,
+    SESSION_CONTEXT
 };
 
+const DIALOGUE_CONTEXT_TYPES = [DIALOG_CONTEXT, SESSION_DIALOGUE_CONTEXT];
+
 const vars = {
 
+    /**
+     * Clears variable with it's metadata
+     *
+     * @param {string} key
+     * @returns {object}
+     */
+    clear (key) {
+        return {
+            [key]: null
+        };
+    },
+
     /**
      * Sets variable, which will be removed, when user leaves the dialogue.
      * **Variable will be available at first interaction of next dialogue.**
@@ -39,6 +57,29 @@ const vars = {
         };
     },
 
+    /**
+     * Sets variable, which will be removed, when new session is created.
+     * **When `dialoguePath` argument is provided, the variable will NOT expire,
+     * when the new session will continue in the same dialogue**
+     *
+     * @param {string} key
+     * @param {*} value
+     * @param {string|boolean} [dialoguePath] - keeps context also within a dialogue
+     * @returns {object}
+     * @example
+     * const { vars } = require('wingbot');
+     * res.setState(vars.sessionContext('myKey', 'foovalue'))
+     */
+    sessionContext (key, value, dialoguePath = false) {
+        return {
+            [key]: value,
+            [`_~${key}`]: {
+                t: dialoguePath === false ? SESSION_CONTEXT : SESSION_DIALOGUE_CONTEXT,
+                ...(dialoguePath && { p: dialoguePath })
+            }
+        };
+    },
+
     /**
      * Sets variable, which will be removed after specified number of conversation turonovers
      *
@@ -98,7 +139,6 @@ function checkSetState (setState, newState) {
                 delete newState[metaKey]; // eslint-disable-line no-param-reassign
             }
         }
-
     }
 }
 
@@ -116,6 +156,42 @@ function isUserInteraction (req) {
             || req.isTextOrIntent());
 }
 
+function prepareState (state, firstInTurnover, sessionCreated) {
+    if (!sessionCreated) {
+        return;
+    }
+
+    // set right path, when path was set
+    // eslint-disable-next-line guard-for-in
+    for (const key in state) { // eslint-disable-line no-restricted-syntax
+        const match = key.match(/^_~(.+)$/);
+        if (!match) {
+            continue;
+        }
+        const value = state[key];
+        const [, referencedKey] = match;
+
+        if (value.t === SESSION_CONTEXT) {
+            delete state[key]; // eslint-disable-line no-param-reassign
+            delete state[referencedKey]; // eslint-disable-line no-param-reassign
+        }
+
+        if (value.t === SESSION_DIALOGUE_CONTEXT) {
+            if (value.p === state._lastVisitedPath) {
+                // context still matches - make it just DIALOGUE_CONTEXT
+                state[key] = { // eslint-disable-line no-param-reassign
+                    t: DIALOG_CONTEXT,
+                    p: value.p
+                };
+            } else {
+                delete state[key]; // eslint-disable-line no-param-reassign
+                delete state[referencedKey]; // eslint-disable-line no-param-reassign
+            }
+        }
+    }
+
+}
+
 /**
  *
  * @private
@@ -149,7 +225,7 @@ function mergeState (previousState, req, res, senderStateUpdate, firstInTurnover
             continue;
         }
         const value = res.newState[key];
-        if (value.t === DIALOG_CONTEXT && typeof value.p === 'undefined') {
+        if (DIALOGUE_CONTEXT_TYPES.includes(value.t) && typeof value.p === 'undefined') {
             Object.assign(value, { p: res.newState._lastVisitedPath });
         }
     }
@@ -176,6 +252,15 @@ function mergeState (previousState, req, res, senderStateUpdate, firstInTurnover
             continue;
         }
         switch (value.t) {
+            case SESSION_DIALOGUE_CONTEXT: {
+                if (!lastInTurnover || previousState._lastVisitedPath === undefined) {
+                    break;
+                }
+                if (value.p === true) {
+                    state[key].p = res.newState._lastVisitedPath;
+                }
+                break;
+            }
             case DIALOG_CONTEXT: {
                 // compare state
 
@@ -190,13 +275,13 @@ function mergeState (previousState, req, res, senderStateUpdate, firstInTurnover
                     delete state[referencedKey];
                 }
 
-                if (lastInTurnover
-                    && previousState._lastVisitedPath !== undefined
-                    && value.p !== res.newState._lastVisitedPath) {
+                // if (lastInTurnover
+                //     && previousState._lastVisitedPath !== undefined
+                //     && value.p !== res.newState._lastVisitedPath) {
 
-                    delete state[key];
-                    delete state[referencedKey];
-                }
+                //     delete state[key];
+                //     delete state[referencedKey];
+                // }
 
                 break;
             }
@@ -234,6 +319,7 @@ function mergeState (previousState, req, res, senderStateUpdate, firstInTurnover
 
 module.exports = {
     VAR_TYPES,
+    prepareState,
     mergeState,
     vars,
     checkSetState,