wingbot 3.65.12 → 3.66.0

package/package.json

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

package/src/Ai.js

@@ -49,6 +49,8 @@ let uq = 1;
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').Phrases} Phrases */
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').EntityDetector} EntityDetector */
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').DetectorOptions} DetectorOptions */
+// eslint-disable-next-line max-len
+/** @typedef {import('./wingbot/CustomEntityDetectionModel').WordEntityDetector} WordEntityDetector */
 
 /** @typedef {[string,EntityDetector|RegExp,DetectorOptions]} DetectorArgs */
 
@@ -72,6 +74,12 @@ class Ai {
             systemEntities.map((a) => [a[0], a])
         );
 
+        /**
+         * @private
+         * @type {WordEntityDetector}
+         */
+        this._wordEntityDetector = null;
+
         /**
          * Upper threshold - for match method and for navigate method
          *
@@ -200,6 +208,7 @@ class Ai {
 
         this._keyworders.set(prefix, modelObj);
 
+        modelObj.wordEntityDetector = this._wordEntityDetector;
         for (const entityArgs of this._detectors.values()) {
             modelObj.setEntityDetector(...entityArgs);
         }
@@ -232,6 +241,19 @@ class Ai {
         return this;
     }
 
+    /**
+     *
+     * @param {WordEntityDetector} wordEntityDetector
+     */
+    setWordEntityDetector (wordEntityDetector) {
+        this._wordEntityDetector = wordEntityDetector;
+
+        for (const model of this._keyworders.values()) {
+            model.wordEntityDetector = wordEntityDetector;
+        }
+        return this;
+    }
+
     /**
      * Sets options to entity detector.
      * Useful for disabling anonymization of local system entities.

package/src/BotApp.js

@@ -16,7 +16,7 @@ const DEFAULT_API_URL = 'https://orchestrator-api.wingbot.ai';
 
 /** @typedef {import('./ReducerWrapper')} ReducerWrapper */
 /** @typedef {import('./Router')} Router */
-/** @typedef {import('./Processor').ProcessorOptions} ProcessorOptions */
+/** @typedef {import('./Processor').ProcessorOptions<Router>} ProcessorOptions */
 /** @typedef {import('./ReturnSender').ChatLogStorage} ChatLogStorage */
 /** @typedef {import('./Request')} Request */
 /** @typedef {import('./Responder')} Responder */
@@ -70,7 +70,7 @@ class BotApp {
 
     /**
      *
-     * @param {ReducerWrapper|Router} bot
+     * @param {Router} bot
      * @param {Options} options
      */
     constructor (bot, options) {

package/src/BuildRouter.js

@@ -119,6 +119,7 @@ const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
  * @prop {LinkTranslator} [linksTranslator] - function, that translates links globally
  * @prop {ConfigStorage} [configStorage] - function, that translates links globally
  * @prop {boolean} [allowForbiddenSnippetWords] - disable security rule
+ * @prop {Middleware} [defaultPlugin] - to be able to test configurations without plugins
  * @prop {RouteConfig[]} [routeConfigs] - list of disabled routes
  * @prop {C} [configuration] - context data
  * @prop {LinksMap} [linksMap]

package/src/Plugins.js

@@ -53,14 +53,16 @@ class Plugins {
         this._plugins = new Map();
     }
 
-    getPluginFactory (name, paramsData = {}, configuration = {}) {
+    getPluginFactory (name, paramsData = {}, configuration = {}, defaultPlugin = null) {
         let plugin;
         if (plugins.has(name)) {
             plugin = plugins.get(name);
-        } else if (!this._plugins.has(name)) {
-            throw new Error(`Unknown Plugin: ${name}. Ensure its registration.`);
-        } else {
+        } else if (this._plugins.has(name)) {
             plugin = this._plugins.get(name);
+        } else if (defaultPlugin) {
+            plugin = defaultPlugin;
+        } else {
+            throw new Error(`Unknown Plugin: ${name}. Ensure its registration.`);
         }
         if (plugin && plugin.pluginFactory) {
             return plugin.pluginFactory(paramsData, configuration);
@@ -79,6 +81,7 @@ class Plugins {
      * @param {boolean} [context.isLastIndex]
      * @param {Router} [context.router]
      * @param {object} [context.configuration]
+     * @param {Middleware} [context.defaultPlugin]
      * @example
      *
      * const { Router } = require('wingbot');
@@ -122,7 +125,13 @@ class Plugins {
             .map(([k, e]) => ({ [k]: e }))
             .reduce(Object.assign, {});
 
-        const customFn = this.getPluginFactory(name, cleanParams, context.configuration);
+        const customFn = this.getPluginFactory(
+            name,
+            cleanParams,
+            context.configuration,
+            context.defaultPlugin
+        );
+
         if (typeof customFn === 'object') {
             // this is an attached router
 

package/src/Processor.js

@@ -90,6 +90,7 @@ const { prepareState, mergeState, isUserInteraction } = require('./utils/stateVa
 
 /**
  *
+ * @template {ReducerWrapper|Router|BuildRouter} R
  * @typedef {object} ProcessorOptions
  * @prop {string} [appUrl] - url basepath for relative links
  * @prop {IStateStorage} [stateStorage] - chatbot state storage
@@ -109,6 +110,7 @@ const { prepareState, mergeState, isUserInteraction } = require('./utils/stateVa
  * @prop {string} [apiUrl] - Url for calling orchestrator API
  * @prop {Function} [fetch] - Fetch function for calling orchestrator API
  * @prop {number} [sessionDuration] - Session duration for analytic purposes
+ * @prop {Preloader<R>} [preloader]
  */
 
 /**
@@ -133,6 +135,14 @@ const { prepareState, mergeState, isUserInteraction } = require('./utils/stateVa
  * @prop {Function} getOrCreateAndLock
  */
 
+/**
+ * @template {ReducerWrapper|Router|BuildRouter} T
+ * @callback Preloader
+ * @param {T} router
+ * @param {Ai} ai
+ * @returns {Promise<void>}
+ */
+
 function NAME_FROM_STATE (state) {
     if (state.user && state.user.firstName) {
         return `${state.user.firstName} ${state.user.lastName}`;
@@ -161,6 +171,7 @@ function toBase (number) {
 /**
  * Messaging event processor
  *
+ * @template {ReducerWrapper|Router|BuildRouter} T
  * @class
  * @fires Processor#interaction
  */
@@ -169,8 +180,8 @@ class Processor extends EventEmitter {
     /**
      * Creates an instance of Processor
      *
-     * @param {ReducerWrapper|Router|BuildRouter} reducer
-     * @param {ProcessorOptions} [options] - processor options
+     * @param {T} reducer
+     * @param {ProcessorOptions<T>} [options] - processor options
      *
      * @memberOf Processor
      */
@@ -197,6 +208,8 @@ class Processor extends EventEmitter {
 
         Object.assign(this.options, options);
 
+        this._preloaders = options.preloader ? [options.preloader] : [];
+
         this.reducer = reducer;
 
         /**
@@ -319,15 +332,17 @@ class Processor extends EventEmitter {
     }
 
     async _preload () {
-        // @ts-ignore
-        if (this.reducer && typeof this.reducer.preload === 'function') {
+        return Promise.all([
             // @ts-ignore
-            return this.reducer.preload()
-                .catch((e) => this.options.log.error('preload error', e))
-                // mute log errors
-                .catch(() => {});
-        }
-        return Promise.resolve();
+            this.reducer && typeof this.reducer.preload === 'function'
+                // @ts-ignore
+                ? this.reducer.preload()
+                : Promise.resolve(),
+            ...this._preloaders
+                .map((preloader) => preloader(this.reducer, Ai.ai))
+        ]).catch((e) => this.options.log.error('preload error', e))
+            // mute log errors
+            .catch(() => {});
     }
 
     async processMessage (

package/src/Router.js

@@ -128,6 +128,15 @@ class Router extends ReducerWrapper {
         return this._configuration;
     }
 
+    /**
+     *
+     * @param {Partial<C>} c
+     * @returns {C}
+     */
+    updateConfiguration (c) {
+        return Object.assign(this._configuration, c);
+    }
+
     _normalizePath (path) {
         let normalizedPath;
 

package/src/utils/ai.js

@@ -0,0 +1,47 @@
+/**
+ * @author David Menger
+ */
+'use strict';
+
+function* iterateThroughWords (string, maxWordCount) {
+    const split = string.split(/\s/);
+
+    let start = 0;
+    for (let i = 0, w; i < split.length; i++) {
+        w = split[i];
+
+        if (!w) {
+            start++;
+            continue;
+        }
+
+        if (w.match(/@[A-Z0-9-]+/)) {
+            continue;
+        }
+
+        yield [w, start];
+
+        let multiW = w;
+        let subword;
+        for (let j = i + 1, k = 1; j < split.length && k < maxWordCount; j++) {
+            subword = split[j];
+            if (subword.match(/@[A-Z0-9-]+/)) {
+                break;
+            }
+            if (subword) {
+                k++;
+                multiW += ` ${subword}`;
+
+                yield [multiW, start];
+            } else {
+                multiW += ' ';
+            }
+        }
+
+        start += 1 + w.length;
+    }
+}
+
+module.exports = {
+    iterateThroughWords
+};

package/src/wingbot/CachedModel.js

@@ -65,7 +65,7 @@ class CachedModel extends CustomEntityDetectionModel {
             return this._cacheMap.get(text);
         }
 
-        const promise = this._queryModel(local.text)
+        const promise = this._queryModel(local.text, local.entities)
             .then((res) => {
                 // clean the cache
                 while (this._cache.length > this._cacheSize) {
@@ -156,9 +156,10 @@ class CachedModel extends CustomEntityDetectionModel {
     /**
      *
      * @param {string} text
+     * @param {Entity[]} entities
      * @returns {Promise<Intent[]|Result>}
      */
-    async _queryModel (text) { // eslint-disable-line no-unused-vars
+    async _queryModel (text, entities) { // eslint-disable-line no-unused-vars
         throw new Error('Not implemented!');
     }
 

package/src/wingbot/CustomEntityDetectionModel.js

@@ -4,6 +4,7 @@
 'use strict';
 
 const { replaceDiacritics } = require('../utils');
+const { iterateThroughWords } = require('../utils/ai');
 
 /**
  * @typedef {object} DetectedEntity
@@ -61,6 +62,13 @@ const { replaceDiacritics } = require('../utils');
  * @prop {boolean} [clearOverlaps] - let longer entities from NLP to replace entity
  */
 
+/**
+ * @callback WordEntityDetector
+ * @param {string} text
+ * @param {DetectedEntity[]} entities
+ * @param {number} startIndex
+ */
+
 /**
  * @typedef {object} Phrases
  * @prop {Map<string,string[]>} phrases
@@ -94,6 +102,16 @@ class CustomEntityDetectionModel {
          * @type {number}
          */
         this.phrasesCacheTime = 0;
+
+        /**
+         * @type {number}
+         */
+        this.maxWordCount = 0;
+
+        /**
+         * @type {WordEntityDetector}
+         */
+        this.wordEntityDetector = null;
     }
 
     /**
@@ -378,6 +396,13 @@ class CustomEntityDetectionModel {
      * @returns {Promise<DetectedEntity[]>}
      */
     async resolveEntities (text, singleEntity = null, expected = [], prevEnts = [], subWord = []) {
+        let entities = prevEnts.slice();
+        if (this.wordEntityDetector) {
+            for (const [s, startIndex] of iterateThroughWords(text, this.maxWordCount)) {
+                this.wordEntityDetector(s, entities, startIndex);
+            }
+        }
+
         // mark unknown dependencies as resolved
         const resolved = new Set(
             this.getDependentEntities(false)
@@ -385,7 +410,7 @@ class CustomEntityDetectionModel {
         );
 
         let missing = Array.from(this._entityDetectors.keys());
-        const entities = prevEnts.map((e) => {
+        entities = entities.map((e) => {
             if (typeof e.text === 'string') {
                 return e;
             }

package/src/wingbot/WingbotModel.js

@@ -1,6 +1,8 @@
 'use strict';
 
 const { default: fetch } = require('node-fetch');
+const { brotliCompress } = require('zlib');
+const { promisify } = require('util');
 const assert = require('assert');
 const CachedModel = require('./CachedModel');
 
@@ -59,6 +61,7 @@ class WingbotModel extends CachedModel {
         this._serviceUrl = options.serviceUrl || SERVICE_URL;
         this._trainingUrl = options.trainingUrl || TRAINING_URL;
         this._model = options.model;
+        this._brotli = promisify(brotliCompress);
     }
 
     async _getPhrases () {
@@ -84,9 +87,10 @@ class WingbotModel extends CachedModel {
     /**
      *
      * @param {string} text
+     * @param {Entity[]} entities
      * @returns {Promise<Result>}
      */
-    async _queryModel (text) {
+    async _queryModel (text, entities = null) {
         if ((text || '').trim().length === 0) {
             return [];
         }
@@ -96,6 +100,11 @@ class WingbotModel extends CachedModel {
             `matches=${encodeURIComponent(this._matches)}`
         ];
 
+        if (entities) {
+            const buf = await this._brotli(Buffer.from(JSON.stringify({ entities })));
+            qs.push(`meta=${encodeURIComponent(buf.toString('base64url'))}`);
+        }
+
         try {
             const res = await this._fetch(
                 `${this._serviceUrl}/${this._model}?${qs.join('&')}`,