wingbot 3.29.0 → 3.30.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.29.0",
+  "version": "3.30.0",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {
@@ -36,33 +36,28 @@
   },
   "homepage": "https://github.com/wingbot.ai/wingbot#readme",
   "devDependencies": {
-    "cpy-cli": "^3.1.1",
-    "eslint": "^7.12.1",
-    "eslint-config-airbnb": "^18.2.0",
-    "eslint-mocha": "^0.7.3",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jsdoc": "^30.7.7",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-mocha": "^8.0.0",
-    "eslint-plugin-react": "^7.21.5",
-    "gitbook-cli": "^2.3.2",
-    "graphql-markdown": "^5.2.0",
-    "graphql-tools": "^7.0.5",
-    "jsdoc-to-markdown": "^6.0.1",
-    "mocha": "^8.2.1",
-    "move-cli": "^1.2.1",
+    "cpy-cli": "^4.1.0",
+    "eslint": "^8.11.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jsdoc": "^38.0.4",
+    "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-mocha": "^10.0.3",
+    "eslint-plugin-react": "^7.29.4",
+    "graphql-markdown": "^6.0.0",
+    "jsdoc-to-markdown": "^7.1.1",
+    "mocha": "^9.2.2",
     "nyc": "^15.1.0",
     "rimraf": "^3.0.2",
-    "sinon": "^9.2.1",
+    "sinon": "^13.0.1",
     "tsd-jsdoc": "^2.5.0"
   },
   "dependencies": {
-    "graphql": "^15.4.0",
-    "graphql-mongodb-projection": "^1.1.1",
+    "graphql": "^15.8.0",
     "jsonwebtoken": "^8.5.1",
-    "node-fetch": "^2.6.1",
+    "node-fetch": "^2.6.7",
     "path-to-regexp": "^6.2.0",
-    "uuid": "^8.3.1",
+    "uuid": "^8.3.2",
     "webalize": "^0.1.0"
   },
   "optionalDependencies": {
@@ -71,4 +66,4 @@
     "request": "^2.88.0",
     "request-promise-native": "^1.0.7"
   }
-}
+}

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

@@ -3,7 +3,7 @@
  * @param {import('../../src/Responder')} res
  * @param {Function} postback
  */
-module.exports = (req, res, postback) => {
+module.exports = function (req, res, postback) {
     if (req.state.beforeLastInteraction
         && !req.state.beforeLastInteraction.match(/\/\*$/)
         && req.state.beforeLastInteraction !== res.currentAction()) {

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

@@ -3,7 +3,7 @@
  * @param {import('../../src/Responder')} res
  * @param {Function} postback
  */
-module.exports = (req, res, postback) => {
+module.exports = function (req, res, postback) {
     let { breadcrumbs = [] } = req.state;
     let shift = req.state.breadcrumbAction === req.state._lastAction
         ? 2

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

@@ -3,7 +3,7 @@
  * @param {import('../../src/Responder')} res
  * @param {Function} postback
  */
-module.exports = (req, res, postback) => {
+module.exports = function (req, res, postback) {
     let { jumpPluginStack = [] } = {
         ...req.state,
         ...res.newState

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

@@ -3,7 +3,7 @@
  * @param {import('../../src/Responder')} res
  * @param {Function} postback
  */
-module.exports = (req, res, postback) => {
+module.exports = function (req, res, postback) {
     const {
         whereToJump,
         whereToJumpBack

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

@@ -2,4 +2,6 @@
  * @param {import('../../src/Request')} req
  * @param {import('../../src/Responder')} res
  */
-module.exports = (req, res) => null;
+module.exports = function (req, res) {
+    return null;
+};

package/src/Ai.js

@@ -64,6 +64,20 @@ class Ai {
          */
         this.threshold = 0.3;
 
+        /**
+         * Upper limit for NLP resolving of STT alternatives
+         *
+         * @type {number}
+         */
+        this.sttMaxAlternatives = 3;
+
+        /**
+         * Minimal score to consider text as recognized well
+         *
+         * @type {number}
+         */
+        this.sttScoreThreshold = 0;
+
         /**
          * The logger (console by default)
          *
@@ -581,35 +595,61 @@ class Ai {
             }
         }
 
+        const texts = req.textAlternatives()
+            .filter((alt) => alt.score >= this.sttScoreThreshold)
+            .slice(0, this.sttMaxAlternatives);
+
+        const altMax = Math.max(0, ...texts.map((t) => t.score));
+        const altKoef = (1 - this.confidence);
+
         const results = await Promise.all(
-            req.textAlternatives()
-                .map(({ text, score }) => model
-                    .resolve(this.textFilter(text), req)
-                    .then((res) => ({
-                        ...res,
-                        _altScore: score
-                    })))
+            texts.map(({ text, score }) => model
+                .resolve(this.textFilter(text), req)
+                .then((res) => ({
+                    ...res,
+                    intents: res.intents
+                        .map((i) => ({
+                            ...i,
+                            score: i.score - (altKoef * (altMax - score))
+                        }))
+                        .sort(({ score: a }, { score: z }) => z - a)
+                })))
         );
 
         results.sort(({
-            intents: aIntents = [], _altScore: aAlt
+            intents: [aIntent = { score: 0 }]
         }, {
-            intents: zIntents = [], _altScore: zAlt
-        }) => {
-            const [{ score: aScore = 0 } = {}] = aIntents;
-            const [{ score: zScore = 0 } = {}] = zIntents;
+            intents: [zIntent = { score: 0 }]
+        }) => zIntent.score - aIntent.score);
 
-            const a = aAlt * aScore;
-            const z = zAlt * zScore;
+        const [winner = { intents: [], entities: [] }, ...others] = results;
 
-            if (a === z) {
-                return zAlt - aAlt;
-            }
+        if (others.length === 0) {
+            return winner;
+        }
 
-            return z - a;
+        const { intents } = winner;
+
+        const known = new Set(intents.map((i) => i.intent));
+
+        others.forEach((other) => {
+            intents.push(
+                ...other.intents.filter(({ score, intent }) => {
+                    if (score >= this.confidence || known.has(intent)) {
+                        return false;
+                    }
+                    known.add(intent);
+                    return true;
+                })
+            );
         });
 
-        return results[0];
+        intents.sort(({ score: a }, { score: z }) => z - a);
+
+        return {
+            ...winner,
+            intents
+        };
     }
 
     /**

package/src/AiMatching.js

@@ -53,12 +53,16 @@ const COMPARE = {
  * @param {Entity[]} [entities]
  */
 
+/**
+ * @typedef {string|number|Function} Comparable
+ */
+
 /**
  * @typedef {object} EntityExpression
  * @prop {string} entity - the requested entity
  * @prop {boolean} [optional] - the match is optional
  * @prop {Compare} [op] - comparison operation
- * @prop {(string|number|Function)[]} [compare] - value to compare
+ * @prop {Comparable[]} [compare] - value to compare
  */
 
 /**
@@ -578,10 +582,12 @@ class AiMatching {
                         score: 1
                     };
 
-                    matching = this
-                        ._entityIsMatching(
-                            wanted.op, wanted.compare, requestEntity.value, requestState
-                        );
+                    matching = this._entityIsMatching(
+                        wanted.op,
+                        wanted.compare,
+                        requestEntity.value,
+                        requestState
+                    );
                 }
             } else if (!entityExists) {
                 matching = this

package/src/BotApp.js

@@ -87,14 +87,12 @@ class BotApp {
         this._senderLogger = chatLogStorage;
         this._verify = promisify(jwt.verify);
 
-        this._processor = new Processor(
-            bot, {
-                ...processorOptions,
-                secret,
-                fetch: this._fetch,
-                apiUrl: gqlApiUrl
-            }
-        );
+        this._processor = new Processor(bot, {
+            ...processorOptions,
+            secret,
+            fetch: this._fetch,
+            apiUrl: gqlApiUrl
+        });
 
         this._processor.plugin(BotApp.plugin());
         this._preferSynchronousResponse = preferSynchronousResponse;
@@ -191,7 +189,13 @@ class BotApp {
     }
 
     async _processIncommingMessage (
-        message, senderId, pageId, appId, secret, sync = false, headers = {}
+        message,
+        senderId,
+        pageId,
+        appId,
+        secret,
+        sync = false,
+        headers = {}
     ) {
         const { mid = null } = message;
 
@@ -386,7 +390,13 @@ class BotApp {
 
                     for (const message of messaging) {
                         const res = await this._processIncommingMessage(
-                            message, senderId, pageId, appId, secret, sync, headers
+                            message,
+                            senderId,
+                            pageId,
+                            appId,
+                            secret,
+                            sync,
+                            headers
                         );
 
                         responses.push(res);

package/src/ConversationTester.js

@@ -305,9 +305,8 @@ class ConversationTester {
         return testCases
             // @ts-ignore
             .reduce(
-                (map, testCase) => map.set(
-                    testCase.list, [...(map.get(testCase.list) || []), testCase]
-                ),
+                (map, testCase) => map
+                    .set(testCase.list, [...(map.get(testCase.list) || []), testCase]),
                 new Map()
             );
     }

package/src/OrchestratorClient.js

@@ -77,11 +77,9 @@ class OrchestratorClient {
      */
     async addConversationTokenToUrl (url, expirationInSeconds, tokenName = 'wbchtoken') {
         const { conversationToken } = await this.getConversationToken(expirationInSeconds);
-        return withParams(
-            url, {
-                query: { [tokenName]: conversationToken }
-            }
-        );
+        return withParams(url, {
+            query: { [tokenName]: conversationToken }
+        });
     }
 
     /**

package/src/Processor.js

@@ -100,7 +100,7 @@ const { mergeState } = require('./utils/stateVariables');
  * @prop {string|null} [meta.targetAction]
  */
 
-const NAME_FROM_STATE = (state) => {
+function NAME_FROM_STATE (state) {
     if (state.user && state.user.firstName) {
         return `${state.user.firstName} ${state.user.lastName}`;
     }
@@ -108,7 +108,7 @@ const NAME_FROM_STATE = (state) => {
         return `${state.user.name}`;
     }
     return null;
-};
+}
 
 /**
  * Messaging event processor

package/src/Request.js

@@ -742,18 +742,36 @@ class Request {
         if (!this.message || typeof this.message.text !== 'string') {
             return [];
         }
-        const { text, alternatives = [] } = this.message;
+        const { text: messageText, alternatives = [] } = this.message;
+
+        const unique = new Set();
+        let max = 0;
+
+        const sorted = alternatives
+            .slice()
+            .map(({ text, score = 1 }) => ({ text, score }))
+            .sort(({ score: a }, { score: z }) => z - a)
+            .filter((a) => {
+                const norm = tokenize(a.text);
+                if (unique.has(norm) || !a.text) {
+                    return false;
+                }
+                max = Math.max(max, a.score);
+                unique.add(norm);
+                return true;
+            });
 
-        if (alternatives.some((a) => a.text === text)) {
-            return alternatives;
+        const normalized = tokenize(messageText);
+
+        if (unique.has(normalized)) {
+            return sorted;
         }
 
+        max = max ? Math.min(1, max + 0.1) : 1;
+
         return [
-            {
-                text: this.message.text,
-                score: 1
-            },
-            ...alternatives
+            { text: messageText, score: max },
+            ...sorted
         ];
     }
 
@@ -1268,7 +1286,9 @@ class Request {
         if (this._quickReplyActions === null) {
             if (this.state._expectedKeywords) {
                 this._quickReplyActions = quickReplyAction(
-                    this.state._expectedKeywords, this, Ai.ai
+                    this.state._expectedKeywords,
+                    this,
+                    Ai.ai
                 );
             } else {
                 this._quickReplyActions = [];

package/src/graphApi/schema.gql

@@ -13,6 +13,7 @@ type Tags {
 type Subscribtion {
     pageId: String
     senderId: String
+    meta: String
 }
 
 type Subscribtions {

package/src/notifications/Notifications.js

@@ -103,6 +103,28 @@ const DEFAULT_CAMPAIGN_DATA = {
  * @prop {number} slideRound
  */
 
+/**
+ * @typedef {object} Subscription
+ * @prop {string} senderId
+ * @prop {string} pageId
+ * @prop {string} [meta]
+ */
+
+/**
+ * @callback PreprocessSubscriptions
+ * @param {Subscription[]} subscriptions
+ * @param {string} pageId
+ * @returns {Promise<Subscription[]>|Subscription[]}
+ */
+
+/**
+ * @callback PreprocessSubscribers
+ * @param {string[]} senderIds
+ * @param {string} pageId
+ * @param {string} tag
+ * @returns {Promise<string[]>|string[]} list of senderIds
+ */
+
 /**
  * Experimental notifications service
  *
@@ -121,7 +143,8 @@ class Notifications extends EventEmitter {
      * @param {console} [options.log] - logger
      * @param {number} [options.default24Clearance] - use this clearance to ensure delivery in 24h
      * @param {string} [options.allAudienceTag] - tag to mark all users
-     * @param {Function} [options.preprocessSubscribers] - to preprocess GQL api given senderIds
+     * @param {PreprocessSubscribers} [options.preprocessSubscribers] - preprocess senderIds import
+     * @param {PreprocessSubscriptions} [options.preprocessSubscriptions]
      */
     constructor (notificationStorage = new NotificationsStorage(), options = {}) {
         super();
@@ -138,6 +161,7 @@ class Notifications extends EventEmitter {
         this._lts = new Map();
 
         this._preprocessSubscribers = options.preprocessSubscribers;
+        this._preprocessSubscriptions = options.preprocessSubscriptions;
     }
 
     /**
@@ -150,7 +174,8 @@ class Notifications extends EventEmitter {
      */
     api (acl = null) {
         const options = {
-            preprocessSubscribers: this._preprocessSubscribers
+            preprocessSubscribers: this._preprocessSubscribers,
+            preprocessSubscriptions: this._preprocessSubscriptions
         };
         return api(this._storage, this, acl, options);
     }
@@ -344,7 +369,10 @@ class Notifications extends EventEmitter {
 
         await Promise.all(tasks
             .map((task) => this._messageDeliveryByMid(
-                task.campaignId, eventType, senderId, pageId
+                task.campaignId,
+                eventType,
+                senderId,
+                pageId
             )));
 
         return {

package/src/notifications/api/notificationsApiFactory.js

@@ -3,9 +3,41 @@
  */
 'use strict';
 
-const { infoToProjection } = require('graphql-mongodb-projection');
 const apiAuthorizer = require('../../graphApi/apiAuthorizer');
 
+/**
+ *
+ * @param {*} info
+ * @returns {object}
+ */
+
+function getFields (info) {
+    if (info.fieldNodes) {
+        const fieldNodes = info.fieldNodes.filter((k) => k.kind === 'Field');
+
+        if (fieldNodes.length !== 1) {
+            return {};
+        }
+
+        return getFields(fieldNodes[0]);
+    }
+
+    const nodes = info.selectionSet ? info.selectionSet.selections : info.fieldNodes;
+
+    if (!info.selectionSet) {
+        return true;
+    }
+
+    return nodes.reduce((o, fieldInfo) => {
+        if (fieldInfo.kind !== 'Field' || !fieldInfo.name || !fieldInfo.name.value) {
+            return o;
+        }
+        return Object.assign(o, {
+            [fieldInfo.name.value]: getFields(fieldInfo)
+        });
+    }, {});
+}
+
 function notificationsApiFactory (storage, notifications, acl, options = {}) {
     return {
         async campaigns (args, ctx) {
@@ -87,9 +119,8 @@ function notificationsApiFactory (storage, notifications, acl, options = {}) {
                 };
             }
 
-            const data = await storage.getUnsuccessfulSubscribersByCampaign(
-                campaignId, sentWithoutReaction, pageId
-            );
+            const data = await storage
+                .getUnsuccessfulSubscribersByCampaign(campaignId, sentWithoutReaction, pageId);
 
             return {
                 data,
@@ -115,7 +146,7 @@ function notificationsApiFactory (storage, notifications, acl, options = {}) {
                 return null;
             }
 
-            const fields = infoToProjection(info);
+            const fields = getFields(info);
 
             const {
                 include,
@@ -132,7 +163,15 @@ function notificationsApiFactory (storage, notifications, acl, options = {}) {
             }
 
             if (fields.data) {
-                const res = storage.getSubscribtions(include, exclude, limit, pageId, lastKey);
+                const res = await storage
+                    .getSubscribtions(include, exclude, limit, pageId, lastKey);
+
+                if (fields.data.meta && typeof options.preprocessSubscriptions === 'function') {
+                    res.data = await Promise.resolve(
+                        options.preprocessSubscriptions(res.data, pageId)
+                    );
+                }
+
                 return Object.assign(res, { count });
             }
 
@@ -159,8 +198,12 @@ function notificationsApiFactory (storage, notifications, acl, options = {}) {
                 );
             }
 
-            for (const senderId of senderIds) {
-                await storage.subscribe(`${senderId}`, pageId, tag);
+            // make it little bit faster
+            while (senderIds.length > 0) {
+                await Promise.all(
+                    senderIds.splice(0, 5)
+                        .map((senderId) => storage.subscribe(`${senderId}`, pageId, tag))
+                );
             }
 
             return true;

package/src/resolvers/media.js

@@ -7,9 +7,11 @@ const Router = require('../Router');
 const getCondition = require('../utils/getCondition');
 const { stateData, cachedTranslatedCompilator } = require('./utils');
 
-function media (params,
+function media (
+    params,
     // @ts-ignore
-    { isLastIndex } = {}) {
+    { isLastIndex } = {}
+) {
     const { type, url } = params;
 
     const urlString = url || '';

package/src/resolvers/utils.js

@@ -202,18 +202,21 @@ function getText (text, state) {
     return renderer(state);
 }
 
+// eslint-disable-next-line no-unused-vars
+const DEFAULT_LINK_TRANSLATOR = (senderId, defaultText, urlText, isExtUrl, reqState) => urlText;
+
 function processButtons (
     buttons,
     state,
     elem,
     linksMap,
     senderId,
-    // eslint-disable-next-line no-unused-vars
-    linksTranslator = (sndr, defaultText, urlText, isExtUrl, reqState) => urlText,
+    linksTranslator,
     allowForbiddenSnippetWords,
     req,
     res
 ) {
+    const translateLinks = linksTranslator || DEFAULT_LINK_TRANSLATOR;
 
     buttons.forEach(({
         title: btnTitle,
@@ -251,7 +254,7 @@ function processButtons (
             case TYPE_URL_WITH_EXT: {
                 const hasExtention = type === TYPE_URL_WITH_EXT;
                 let urlText = getText(url, state);
-                urlText = linksTranslator(senderId, defaultText, urlText, isExtUrl, state);
+                urlText = translateLinks(senderId, defaultText, urlText, isExtUrl, state);
                 elem.urlButton(btnTitleText, urlText, hasExtention, webviewHeight);
                 break;
             }

package/src/tools/MemoryBotConfigStorage.js

@@ -22,7 +22,7 @@ class MemoryBotConfigStorage {
      * @param {Function|string[]} [acl] - acl configuration
      * @returns {{updateBot:Function}}
      */
-    api (onUpdate = () => Promise.resolve(), acl) {
+    api (onUpdate = () => Promise.resolve(), acl = []) {
         const storage = this;
         return {
             async updateBot (args, ctx) {

package/src/utils/customCondition.js

@@ -42,7 +42,7 @@ const isSimpleWord = (string) => {
 const isStringNumber = (string) => {
     if (typeof string !== 'string') return false;
     if (string.length === 0) return false;
-    return !!new RegExp(/^([0-9]*[, ]{0,1})*[., ]{0,1}[0-9]*$/)
+    return !!/^([0-9]*[, ]{0,1})*[., ]{0,1}[0-9]*$/
         .test((string).replace(/\s+/g, ''));
 };
 
@@ -55,7 +55,7 @@ const stringToNumber = (string) => {
     if (typeof string !== 'string') return string;
     if (!isStringNumber(string)) throw new Error('String not a number');
     let trimmed;
-    if (new RegExp(/^[^,.]+,[^,.]+$/).test(string)) {
+    if (/^[^,.]+,[^,.]+$/.test(string)) {
         trimmed = string.replace(',', '.');
     } else {
         trimmed = string.replace(/(\s|,)+/g, '').replace(',', '.');

package/src/utils/getUpdate.js

@@ -88,8 +88,10 @@ function toArray (previousValue) {
 const ENTITY_HBS_REGEXP = /^\s*\{\{\[?@([^@[\]{}\s]+)(\])?\}\}\s*$/;
 const VARIABLE_HBS_REGEXP = /^\s*\{\{\[?([^@[\]{}\s]+)\]?\}\}\s*$/;
 
-function getSetState (setState = {}, req, res = null, useState = null) {
-
+function getSetState (setState, req, res = null, useState = null) {
+    if (!setState) {
+        return {};
+    }
     const keys = Object.keys(setState)
         .filter((k) => k !== '_');
 

package/src/utils/quickReplies.js

@@ -32,7 +32,12 @@ const { checkSetState } = require('./stateVariables');
  * @returns {ExpectedKeyword}
  */
 function makeExpectedKeyword (
-    action, title, matcher = null, payloadData = {}, setState = null, aiTitle = null
+    action,
+    title,
+    matcher = null,
+    payloadData = {},
+    setState = null,
+    aiTitle = null
 ) {
     let match = null;
 
@@ -226,7 +231,12 @@ function makeQuickReplies (replies, path = '', translate = (w) => w, quickReplyC
             const translatedTitle = translate(title);
             const translatedAiTitle = typeof aiTitle === 'string' ? translate(aiTitle) : aiTitle;
             const expect = makeExpectedKeyword(
-                absoluteAction, translatedTitle, match, data, setState, translatedAiTitle
+                absoluteAction,
+                translatedTitle,
+                match,
+                data,
+                setState,
+                translatedAiTitle
             );
             expectedKeywords.push(expect);