wingbot 3.74.8 → 3.75.9-alpha.1

package/src/Request.js

@@ -5,10 +5,9 @@
 
 const Ai = require('./Ai');
 const { tokenize, parseActionPayload } = require('./utils');
-const { quickReplyAction } = require('./utils/quickReplies');
 const { ResponseFlag } = require('./analytics/consts');
 const { getSetState } = require('./utils/getUpdate');
-const { vars, checkSetState } = require('./utils/stateVariables');
+const { vars } = require('./utils/stateVariables');
 const OrchestratorClient = require('./OrchestratorClient');
 const { cachedTranslatedCompilator, stateData } = require('./resolvers/utils');
 const {
@@ -19,8 +18,7 @@ const {
     FEATURE_TRACKING,
     getDefaultFeatureList
 } = require('./features');
-
-const BASE64_REGEX = /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/;
+const LLMDispatcher = require('./LLMDispatcher');
 
 const counter = {
     _t: 0,
@@ -39,6 +37,7 @@ function makeTimestamp () {
 }
 
 /** @typedef {import('./Router').BaseConfiguration} BaseConfiguration */
+/** @typedef {import('./LLMMockProvider').LLMMockResponse} LLMMockResponse */
 
 /**
  * @typedef {object} Entity
@@ -51,31 +50,31 @@ function makeTimestamp () {
 /**
  * @typedef {object} Intent
  * @prop {string} intent
- * @prop {number} score
+ * @prop {number} [score]
  * @prop {Entity[]} [entities]
  */
 
 /**
  * @typedef {object} Action
  * @prop {string} action
- * @prop {object} data
+ * @prop {object} [data]
  * @prop {object|null} [setState]
  */
 
 /**
  * @typedef {object} IntentAction
  * @prop {string} action
- * @prop {Intent} intent
- * @prop {number} sort
- * @prop {boolean} local
- * @prop {boolean} aboveConfidence
+ * @prop {Intent} [intent]
+ * @prop {number} [sort]
+ * @prop {boolean} [local]
+ * @prop {boolean} [aboveConfidence]
  * @prop {object} [data]
  * @prop {string|string[]} [match]
  * @prop {object} [setState]
  * @prop {boolean} [winner]
  * @prop {string|Function} [title]
  * @prop {boolean} [hasAiTitle]
- * @prop {object} meta
+ * @prop {object} [meta]
  * @prop {string} [meta.targetAppId]
  * @prop {string|null} [meta.targetAction]
  * @prop {string} [meta.resolverTag]
@@ -111,7 +110,7 @@ function makeTimestamp () {
 
 /**
  * @typedef {object} Attachment
- * @prop {'file'|'audio'|'video'|'image'} type
+ * @prop {'file'|'audio'|'video'|'image'|'location'} type
  * @prop {object} payload
  * @prop {string} payload.url
  */
@@ -135,7 +134,7 @@ class Request {
      * @param {*} event
      * @param {S} state
      * @param {string} pageId
-     * @param {Map} globalIntents
+     * @param {LLMDispatcher} [dispatcher]
      * @param {RequestOrchestratorOptions} [orchestratorOptions]
      * @param {C} [configuration]
      */
@@ -143,7 +142,7 @@ class Request {
         event,
         state,
         pageId,
-        globalIntents = new Map(),
+        dispatcher = new LLMDispatcher(Ai.ai),
         orchestratorOptions = {},
         // @ts-ignore
         configuration = {}
@@ -154,6 +153,9 @@ class Request {
 
         this._event = event;
 
+        /** @type {LLMDispatcher} */
+        this._dispatcher = dispatcher;
+
         /**
          * @enum {AiSetStateOption}
          */
@@ -165,8 +167,6 @@ class Request {
             EXCLUDE_WITHOUT_SET_ENTITIES: -3
         };
 
-        this.globalIntents = globalIntents;
-
         /**
          * @prop {object} params - plugin configuration
          */
@@ -174,13 +174,13 @@ class Request {
 
         this.message = event.message || null;
 
-        this._postback = event.postback || null;
+        this.postback = event.postback || null;
 
-        this._referral = (this._postback && this._postback.referral)
+        this.referral = (this.postback && this.postback.referral)
             || event.referral
             || null;
 
-        this._optin = event.optin || null;
+        this.optin = event.optin || null;
 
         /** @type {Attachment[]} */
         this.attachments = (event.message
@@ -236,18 +236,19 @@ class Request {
         this.intents = [];
 
         /**
-         * @type {Action}
-         * @private
+         * type {Action}
+         * private
          */
-        this._action = undefined;
+        // this._action = undefined;
 
+        /** @deprecated */
         this._winningIntent = null;
 
-        this._aiActions = null;
+        // this._aiActions = null;
 
-        this._quickReplyActions = null;
+        // this._quickReplyActions = null;
 
-        this._aiWinner = null;
+        // this._aiWinner = null;
 
         // protected for now, filled by AI
         this._anonymizedText = null;
@@ -290,6 +291,13 @@ class Request {
         this.configuration = configuration;
     }
 
+    /**
+     * @returns {LLMDispatcher}
+     */
+    get dispatcher () {
+        return this._dispatcher;
+    }
+
     get data () {
         // eslint-disable-next-line
         console.info('wingbot: req.data is deprecated, use req.event instead');
@@ -332,10 +340,9 @@ class Request {
      */
     aiActions (local = false) {
         if (local) {
-            return this._resolveQuickReplyActions();
+            return this._dispatcher.resolveQuickReplyActions();
         }
-        this.aiActionsWinner();
-        return this._aiActions;
+        return this._dispatcher.aiActions();
     }
 
     /**
@@ -347,14 +354,10 @@ class Request {
      * @returns {QuickReplyDisambiguation[]}
      */
     aiActionsForQuickReplies (limit = 5, aiActions = null, overrideAction = null) {
-        if (aiActions === null) {
-            this.aiActionsWinner();
-        }
-
         const text = this.text();
         const knownTexts = new Set();
 
-        return (aiActions || this._aiActions)
+        return (aiActions || this._dispatcher.aiActions())
             .filter((a) => a.title)
             .slice(0, limit)
             .map((a) => {
@@ -432,10 +435,9 @@ class Request {
     hasAiActionsForDisambiguation (minimum = 1, local = false) {
         let iterate;
         if (local) {
-            iterate = this._resolveQuickReplyActions();
+            iterate = this._dispatcher.resolveQuickReplyActions();
         } else {
-            this.aiActionsWinner();
-            iterate = this._aiActions;
+            iterate = this._dispatcher.aiActions();
         }
         return iterate
             .filter((a) => a.title)
@@ -638,6 +640,7 @@ class Request {
             return null;
         }
 
+        // @ts-ignore
         return location.payload.coordinates;
     }
 
@@ -695,7 +698,7 @@ class Request {
      * @returns {boolean}
      */
     isText () {
-        return (this._postback === null
+        return (this.postback === null
             && this.message !== null
             && !this.message.quick_reply
             && typeof this.message.text === 'string')
@@ -720,8 +723,10 @@ class Request {
             && this.attachments[0].type === 'image'
             && typeof this.attachments[0].payload === 'object'
             && this.attachments[0].payload !== null
+            // @ts-ignore
             && typeof this.attachments[0].payload.sticker_id !== 'undefined'
             && (includeToTextStickers
+                // @ts-ignore
                 || this._stickerIdToText(this.attachments[0].payload.sticker_id) === null);
     }
 
@@ -739,6 +744,7 @@ class Request {
             return '';
         }
 
+        // @ts-ignore
         return this._stickerIdToText(this.attachments[0].payload.sticker_id) || '';
     }
 
@@ -879,7 +885,7 @@ class Request {
         let shouldIncludeKeywords = includeKeywords;
 
         if (expected) {
-            const { action, data = {} } = expected;
+            const { action, data = {}, bounceAllowedTo } = expected;
 
             if (!data._expectedFallbackOccured || !justOnce) {
                 Object.assign(ret, {
@@ -888,7 +894,8 @@ class Request {
                         data: {
                             ...data,
                             _expectedFallbackOccured: true
-                        }
+                        },
+                        bounceAllowedTo
                     }
                 });
             } else if (justOnce) {
@@ -948,7 +955,7 @@ class Request {
      * @returns {boolean}
      */
     isPostBack () {
-        return this._postback !== null;
+        return this.postback !== null;
     }
 
     /**
@@ -957,7 +964,7 @@ class Request {
      * @returns {boolean}
      */
     isReferral () {
-        return this._referral !== null;
+        return this.referral !== null;
     }
 
     /**
@@ -966,7 +973,7 @@ class Request {
      * @returns {boolean}
      */
     isOptin () {
-        return this._optin !== null;
+        return this.optin !== null;
     }
 
     /**
@@ -978,14 +985,16 @@ class Request {
      */
     setAction (action, data = {}) {
         // fetch previous action
-        const previousAction = this._action;
+        const previousAction = this.dispatcher.action();
 
+        let act;
         if (typeof action === 'object' || typeof action === 'undefined') { // accepts also a null
-            this._action = action;
+            act = action;
         } else {
-            this._action = { action, data };
+            act = { action, data };
         }
 
+        this.dispatcher.overrideAction(act);
         return previousAction;
     }
 
@@ -1010,18 +1019,17 @@ class Request {
      * typeof res.actionData() === 'object';
      */
     action (getData = false) {
-        if (typeof this._action === 'undefined') {
-            this._action = this._resolveAction();
-        }
+        const action = this._dispatcher.action();
 
         if (getData) {
             // eslint-disable-next-line no-console
             console.info('wingbot: deprecated using req.action(true), use req.actionData() instead');
 
-            return this._action ? this._action.data : {};
+            // @ts-ignore
+            return action?.data || {};
         }
 
-        return this._action && this._action.action;
+        return action?.action || null;
     }
 
     /**
@@ -1030,10 +1038,8 @@ class Request {
      * @returns {object}
      */
     actionData () {
-        if (typeof this._action === 'undefined') {
-            this._action = this._resolveAction();
-        }
-        return this._action ? this._action.data : {};
+        const action = this._dispatcher.action();
+        return action?.data || {};
     }
 
     // eslint-disable-next-line jsdoc/require-param
@@ -1047,12 +1053,9 @@ class Request {
      * res.setState(req.getSetState());
      */
     getSetState (keysFromAi = this.AI_SETSTATE.INCLUDE, useState = null) {
-        if (typeof this._action === 'undefined') {
-            this._action = this._resolveAction();
-        }
+        const action = this._dispatcher.action();
 
-        let setState = (this._action && this._action.setState)
-            || this._event.setState;
+        let setState = action?.setState || this._event.setState;
 
         // orchestrators context updates
         if (this.event.set_context || this.event.context) {
@@ -1073,7 +1076,7 @@ class Request {
         }
 
         // @ts-ignore
-        const { _aiKeys: aiKeys = [] } = this._action || {};
+        const { _aiKeys: aiKeys = [] } = action || {};
 
         const ret = {};
 
@@ -1117,92 +1120,6 @@ class Request {
         return this.state._expectedConfidentInput === true;
     }
 
-    _resolveAction () {
-        let res = null;
-
-        if (this._referral !== null && this._referral.ref) {
-            res = parseActionPayload({ payload: this._referral.ref });
-        }
-
-        if (!res && this._postback !== null) {
-            res = parseActionPayload(this._postback);
-        }
-
-        if (!res && this._optin !== null && this._optin.ref) {
-            res = this._base64Ref(this._optin);
-        }
-
-        if (!res && this._optin !== null && this._optin.payload) {
-            res = parseActionPayload(this._optin);
-        }
-
-        if (!res && this.message !== null && this.message.quick_reply) {
-            res = parseActionPayload(this.message.quick_reply);
-        }
-
-        // @ts-ignore
-        if (!res && this.state._expectedKeywords) {
-            // @ts-ignore
-            res = this._actionByExpectedKeywords(this.state._expected);
-        }
-
-        // @ts-ignore
-        if (!res && this.state._expected) {
-            // @ts-ignore
-            res = parseActionPayload(this.state._expected);
-        }
-
-        if (res) {
-            // find global intent
-            let entitiesSetState = {};
-            let { setState = {} } = res;
-            for (const gi of this.globalIntents.values()) {
-                if (gi.action === res.action) {
-                    entitiesSetState = { ...gi.entitiesSetState };
-
-                    const values = Array.from(Object.values(entitiesSetState));
-
-                    for (const value of values) {
-                        if (typeof value === 'function') {
-                            Object.assign(entitiesSetState, value(stateData(this)));
-                        }
-                    }
-                }
-            }
-            const newState = {
-                ...entitiesSetState,
-                ...setState
-            };
-            checkSetState(setState, newState);
-            setState = newState;
-            const aiKeysSet = new Set([
-                ...(res._aiKeys || []),
-                ...Object.keys(entitiesSetState)
-            ]);
-            const aiKeys = Array.from(aiKeysSet)
-                .filter((k) => typeof setState[k] !== 'undefined' && k.startsWith('@'));
-
-            return {
-                ...res,
-                setState,
-                _aiKeys: aiKeys
-            };
-        }
-
-        if (this.isTextOrIntent()) {
-            const winner = this.aiActionsWinner();
-            if (winner) {
-                const _aiKeys = winner.setState ? Object.keys(winner.setState) : [];
-
-                res = {
-                    action: winner.action, data: {}, setState: winner.setState, _aiKeys
-                };
-            }
-        }
-
-        return res;
-    }
-
     /**
      * Returs action string, if there is an action detected by NLP
      *
@@ -1229,13 +1146,14 @@ class Request {
      *     res.setState({ email: req.text() });
      * });
      *
+     *
      */
     actionByAi () {
         const winner = this.aiActionsWinner();
         return winner ? winner.action : null;
     }
 
-    _getLocalPathRegexp () {
+    getLocalPathRegexp () {
         // @ts-ignore
         if (this.state._lastVisitedPath) {
             // @ts-ignore
@@ -1256,47 +1174,7 @@ class Request {
      * @returns {IntentAction|null}
      */
     aiActionsWinner () {
-        if (this._aiActions) {
-            return this._aiWinner;
-        }
-        if (!this.isTextOrIntent()) {
-            this._aiActions = [];
-            return null;
-        }
-
-        const aiActions = [];
-
-        // to match the local context intent
-        const localRegexToMatch = this._getLocalPathRegexp();
-
-        for (const gi of this.globalIntents.values()) {
-            const pathMatches = localRegexToMatch && localRegexToMatch.exec(gi.action);
-            if (gi.local && !pathMatches) {
-                continue;
-            }
-            const intent = gi.matcher(this, null, true);
-            if (intent !== null) {
-                const sort = intent.score + (pathMatches
-                    ? Ai.ai.localEnhancement
-                    : 0);
-                // console.log(sort, wi.intent);
-                aiActions.push({
-                    ...gi,
-                    intent,
-                    setState: intent.setState,
-                    aboveConfidence: intent.aboveConfidence,
-                    sort,
-                    winner: false
-                });
-            }
-        }
-
-        aiActions.sort((l, r) => r.sort - l.sort);
-        const winner = this._winner(aiActions);
-
-        this._aiActions = aiActions;
-        this._aiWinner = winner;
-        return winner;
+        return this._dispatcher.aiActionWinner();
     }
 
     _winner (aiActions) {
@@ -1323,7 +1201,7 @@ class Request {
             return null;
         }
 
-        const actions = this._resolveQuickReplyActions();
+        const actions = this._dispatcher.resolveQuickReplyActions();
 
         if (expected && Ai.ai.shouldDisambiguate(actions, true)) {
             return parseActionPayload(expected);
@@ -1337,23 +1215,6 @@ class Request {
         return parseActionPayload(payload);
     }
 
-    _resolveQuickReplyActions () {
-        if (this._quickReplyActions === null) {
-            // @ts-ignore
-            if (this.state._expectedKeywords) {
-                this._quickReplyActions = quickReplyAction(
-                    // @ts-ignore
-                    this.state._expectedKeywords,
-                    this,
-                    Ai.ai
-                );
-            } else {
-                this._quickReplyActions = [];
-            }
-        }
-        return this._quickReplyActions;
-    }
-
     /**
      * Returns action or data of postback
      * When `getData` is `true`, object will be returned. Otherwise string or null.
@@ -1366,26 +1227,10 @@ class Request {
      * typeof res.postBack(true) === 'object';
      */
     postBack (getData = false) {
-        if (this._postback === null) {
+        if (this.postback === null) {
             return null;
         }
-        return this._processPayload(this._postback, getData);
-    }
-
-    _base64Ref (object = {}) {
-        let process = {};
-
-        if (object && object.ref) {
-            let payload = object.ref;
-
-            if (typeof payload === 'string' && payload.match(BASE64_REGEX)) {
-                payload = Buffer.from(payload, 'base64').toString('utf8');
-            }
-
-            process = { payload };
-        }
-
-        return parseActionPayload(process);
+        return this._processPayload(this.postback, getData);
     }
 
     _processPayload (object = {}, getData = false) {
@@ -1419,15 +1264,11 @@ class Request {
             }
         }
 
-        const localRegexToMatch = this._getLocalPathRegexp();
-
         const entitySet = new Set();
 
-        for (const gi of this.globalIntents.values()) {
-            const pathMatches = localRegexToMatch && localRegexToMatch.exec(gi.action);
-            if (gi.local && !pathMatches) {
-                continue;
-            }
+        const iterator = this._dispatcher.globalIntentsAtPath();
+
+        for (const [gi] of iterator) {
             gi.usedEntities.forEach((e) => entitySet.add(e));
         }
 
@@ -1594,6 +1435,22 @@ It looks like the bot isn't connected to class BotApp or the Processor is used w
         return Request.addIntentToRequest(res, intent, [], score);
     }
 
+    /**
+     *
+     * @param {string} senderId
+     * @param {string} text
+     * @param {LLMMockResponse[]} [llmMocks]
+     * @param {number} [timestamp]
+     * @returns {object}
+     */
+    static llm (senderId, text, llmMocks, timestamp = makeTimestamp()) {
+        const res = Request.text(senderId, text, timestamp);
+
+        return Object.assign(res, {
+            llmMocks
+        });
+    }
+
     static intent (senderId, intent, score = 1, timestamp = makeTimestamp()) {
 
         return {