wingbot 3.36.1 → 3.37.1

package/.github/workflows/deploy.yml

@@ -5,15 +5,17 @@ on:
     branches:
       - master
       - production
+permissions:
+  contents: write
 jobs:
 
-  test:
-    name: test
+  test-and-build-gatsby:
+    name: test-and-deploy-documentation
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [14.x]
 
     steps:
 
@@ -27,10 +29,24 @@ jobs:
           cache: 'npm'
 
       - name: Npm install
-        run: npm install
+        run: npm install && cd documentation && npm install --legacy-peer-deps && cd ..
 
       - name: Test
         run: npm run test
+      
+      - name: Rewrite gatsby confing inside smoothdoc
+        run: cp documentation/smooth-doc-gatsby-config.js documentation/node_modules/smooth-doc/gatsby-config.js
+
+      - name: Generate mdx documentation files
+        run: node bin/makeApiDoc
+
+      - name: Build documentation website with gatsby
+        run: cd documentation && npm run build
+      
+      - name: Deploy documentation to github pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: documentation/public # The folder the action should deploy.
 
   # deploy:
   #   name: deploy

package/package.json

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

package/src/BotAppSender.js

@@ -117,7 +117,7 @@ class BotAppSender extends ReturnSender {
 
         headers.set('Authorization', token);
 
-        const response = await this._fetch(this._apiUrl, {
+        const response = await this._fetch(`${this._apiUrl}/${this._pageId}`, {
             headers, body: formData, agent, method: 'POST'
         })
             .then((r) => r.json());

package/src/BuildRouter.js

@@ -17,7 +17,12 @@ const { shouldExecuteResolver } = require('./resolvers/resolverTags');
 
 const MESSAGE_RESOLVER_NAME = 'botbuild.message';
 
-/** @typedef {import('./Router').Middleware} Middleware */
+/**
+ *
+ * @template {object} [S=object]
+ * @template {object} [C=object]
+ * @typedef {import('./Router').Middleware<S,C>} Middleware
+ */
 
 /**
  * @typedef {object} Resolver
@@ -89,8 +94,7 @@ const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
 /**
  * @typedef {object} RouteConfig
  * @prop {string} path
- * @prop {boolean} enabled
- * @prop {object} configuration
+ * @prop {boolean} [enabled]
  */
 
 /**
@@ -104,12 +108,13 @@ const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
  */
 
 /**
+ * @template {object} [C=object]
  * @typedef {object} BotContext
  * @prop {LinkTranslator} [linksTranslator] - function, that translates links globally
  * @prop {ConfigStorage} [configStorage] - function, that translates links globally
  * @prop {boolean} [allowForbiddenSnippetWords] - disable security rule
  * @prop {RouteConfig[]} [routeConfigs] - list of disabled routes
- * @prop {object} [configuration] - context data
+ * @prop {C} [configuration] - context data
  * @prop {LinksMap} [linksMap]
  * @prop {boolean} [isLastIndex]
  * @prop {boolean} [isLastMessage]
@@ -127,24 +132,13 @@ const DUMMY_ROUTE = { id: 0, path: null, resolvers: [] };
  * @prop {object} [BuildRouter]
  */
 
-function deepFreeze (object) {
-    const propNames = Object.getOwnPropertyNames(object);
-
-    for (const name of propNames) {
-        const value = object[name];
-
-        if (value && typeof value === 'object') {
-            deepFreeze(value);
-        }
-    }
-
-    return Object.freeze(object);
-}
-
 /**
  * Build bot from Wingbot configuration file or snapshot url
  *
+ * @template {object} [S=object]
+ * @template {object} [C=object]
  * @class BuildRouter
+ * @extends {Router<S,C>}
  */
 class BuildRouter extends Router {
 
@@ -159,7 +153,7 @@ class BuildRouter extends Router {
      * @param {ConfigStorage} [context.configStorage] - function, that translates links globally
      * @param {boolean} [context.allowForbiddenSnippetWords] - disable security rule
      * @param {RouteConfig[]} [context.routeConfigs] - list of disabled routes
-     * @param {object} [context.configuration]
+     * @param {C} [context.configuration]
      * @param {fetch} [fetchFn] - override a request function
      * @example
      *
@@ -190,9 +184,13 @@ class BuildRouter extends Router {
 
         this._plugins = plugins;
 
-        /** @type {BotContext} */
+        /** @type {BotContext<C>} */
         this._context = context;
 
+        /** @type {C} */
+        // @ts-ignore
+        this._configuration = context.configuration || {};
+
         /** @type {LinksMap} */
         this._linksMap = new Map();
 
@@ -239,6 +237,13 @@ class BuildRouter extends Router {
         }
     }
 
+    /**
+     * @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`);
@@ -554,7 +559,7 @@ class BuildRouter extends Router {
      * @param {RouteConfig} routeConfig
      */
     _enabledByRouteConfig (routeConfig) {
-        return !this._context.routeConfigs || (routeConfig && routeConfig.enabled);
+        return !this._context.routeConfigs || !routeConfig || routeConfig.enabled !== false;
     }
 
     _joinPaths (...args) {
@@ -567,7 +572,8 @@ class BuildRouter extends Router {
             : routePath;
 
         return joined
-            .replace(/^\/?|(_responder)?\/?$/g, '/');
+            .replace(/^\/?|(_responder)?\/?$/g, '/')
+            .replace(/\/\/+$/, '/');
     }
 
     /**
@@ -624,6 +630,7 @@ class BuildRouter extends Router {
         }
 
         const routePath = this._normalizeConfigPath(rPath, ctxPath);
+
         return routeConfigs.find((config) => {
             const configPath = this._normalizeConfigPath(config.path);
 
@@ -633,27 +640,10 @@ class BuildRouter extends Router {
 
     /**
      *
-     * @param {string} routePath
      * @returns {object}
      */
-    getConfiguration (routePath) {
-        const { path: ctxPath, routeConfigs, configuration = {} } = this._context;
-        if (!routeConfigs || !routePath) {
-            return deepFreeze(configuration);
-        }
-        const normalized = this._normalizeConfigPath(routePath, ctxPath);
-
-        const configs = routeConfigs
-            .filter((config) => {
-                const configPath = this._normalizeConfigPath(config.path);
-                return normalized.startsWith(configPath);
-            })
-            .sort((a, z) => a.path.length - z.path.length);
-
-        return deepFreeze(configs.reduce((cfg, config) => ({
-            ...cfg,
-            ...config.configuration
-        }), configuration));
+    getConfiguration () {
+        return this._configuration;
     }
 
     /**
@@ -683,7 +673,7 @@ class BuildRouter extends Router {
      *
      * @param {TransformedRoute} route
      * @param {boolean} nextRouteIsSameResponder
-     * @returns {Middleware[]}
+     * @returns {Middleware<S,C>[]}
      */
     _buildRouteHead (route, nextRouteIsSameResponder) {
         const resolvers = [];
@@ -798,24 +788,17 @@ class BuildRouter extends Router {
      * @param {Resolver[]} resolvers
      * @param {TransformedRoute} route
      * @param {*} buildInfo
-     * @returns {Middleware[]}
+     * @returns {Middleware<S,C>[]}
      */
     buildResolvers (resolvers, route = DUMMY_ROUTE, buildInfo = {}) {
         const {
             path: ctxPath, isFallback, isResponder, expectedPath, id
         } = route;
 
-        const routeConfig = this._getRouteConfig(route);
-        const routeConfigData = routeConfig && routeConfig.configuration;
-
         const lastMessageIndex = this._lastMessageIndex(resolvers);
         const lastIndex = resolvers.length - 1;
 
         return resolvers.map((resolver, i) => {
-            const configuration = deepFreeze({
-                ...this._context.configuration,
-                ...routeConfigData
-            });
 
             const context = {
                 ...this._context,
@@ -828,13 +811,16 @@ class BuildRouter extends Router {
                 isResponder,
                 expectedPath,
                 routeId: id,
-                configuration
+                configuration: this._configuration
             };
 
             const resFn = this._resolverFactory(resolver, context, buildInfo);
 
             // @ts-ignore
-            resFn.configuration = configuration;
+            if (typeof resFn.configuration === 'undefined') {
+                // @ts-ignore
+                resFn.configuration = this._configuration;
+            }
             return resFn;
         });
     }
@@ -842,9 +828,9 @@ class BuildRouter extends Router {
     /**
      *
      * @param {Resolver} resolver
-     * @param {BotContext} context
+     * @param {BotContext<C>} context
      * @param {*} buildInfo
-     * @returns {Middleware}
+     * @returns {Middleware<S,C>}
      */
     _resolverFactory (resolver, context, buildInfo) {
         const { type } = resolver;
@@ -906,9 +892,10 @@ class BuildRouter extends Router {
 }
 
 /**
+ * @template {object} [C=object]
  * @param {Block[]} blocks - blocks list
  * @param {Plugins} [plugins]
- * @param {BotContext} [context]
+ * @param {BotContext<C>} [context]
  */
 BuildRouter.fromData = function fromData (blocks, plugins = new Plugins(), context = {}) {
 

package/src/ConversationTester.js

@@ -69,11 +69,15 @@ const DEFAULT_TEXT_THRESHOLD = 0.8;
  * @prop {List[]} lists
  */
 
+/** @typedef {import('./ReducerWrapper')} ReducerWrapper */
+/** @typedef {import('./Router')} Router */
+/** @typedef {import('./BuildRouter')} BuildRouter */
+
 /**
  * Callback for getting a tester
  *
  * @callback testerFactory
- * @param {Router|ReducerWrapper} bot - the chatbot itself
+ * @param {Router|ReducerWrapper|BuildRouter} bot - the chatbot itself
  * @param {TestsGroup} test - the chatbot itself
  * @returns {Tester}
  */
@@ -90,6 +94,12 @@ const DEFAULT_TEXT_THRESHOLD = 0.8;
  * @prop {number} stepCount
  */
 
+/**
+ * @typedef {object} Logger
+ * @prop {Function} log
+ * @prop {Function} error
+ */
+
 /**
  * Automated Conversation tests runner
  */
@@ -109,6 +119,7 @@ class ConversationTester {
      * @param {number} [options.textCasesPerStep]
      * @param {number} [options.textCaseParallel]
      * @param {boolean} [options.allowEmptyResponse]
+     * @param {Logger} [options.log]
      * @param {testerFactory} [options.testerFactory]
      */
     constructor (testsSource, botFactory, options = {}) {
@@ -122,6 +133,7 @@ class ConversationTester {
         };
         this._output = '';
         this._cachedBot = null;
+        this._log = options.log || console;
     }
 
     /**
@@ -159,18 +171,21 @@ class ConversationTester {
             this._cachedBot = null;
         }
         this._output = '';
-        const testCases = await this._getTestCases(lang);
-        const groups = this._getGroups(testCases);
-        const testsGroups = this._getTestsGroups(groups, step);
-        const stepCount = Number.isInteger(step) ? groups.length : 1;
 
         const botconfig = validationRequestBody;
         let failed = 0;
         let passed = 0;
         let skipped = 0;
         let summaryOutput = '';
+        let stepCount = 0;
+        let testsGroups = [];
 
         try {
+            const testCases = await this._getTestCases(lang);
+            const groups = this._getGroups(testCases);
+            testsGroups = this._getTestsGroups(groups, step);
+            stepCount = Number.isInteger(step) ? groups.length : 1;
+
             const results = [];
             for (const testsGroup of testsGroups) {
                 let stepResult;
@@ -224,6 +239,7 @@ class ConversationTester {
             }
 
         } catch (e) {
+            this._log.error('#Tester failed', e, { output: this._output, passed });
             this._output += `\nBot test failed: ${e.message}\n`;
         }
         return {

package/src/Plugins.js

@@ -11,16 +11,39 @@ const RouterWrap = require('./RouterWrap');
 const wrapPluginFunction = require('./utils/wrapPluginFunction');
 
 /**
+ * @template {object} [S=object]
+ * @template {object} [C=object]
+ * @typedef {import('./Router').Middleware<S,C>} Middleware
+ */
+
+/**
+ *
+ * @template {object} [S=object]
+ * @template {object} [C=object]
  * @callback Plugin
- * @param {Request} req
+ * @param {Request<S,C>} req
  * @param {Responder} res
  * @param {Function} [postBack]
  * @param {{isLastIndex:boolean,path:string,expectedPath:string}} [context]
  * @param {object} [paramsData]
  */
 
+/**
+ *
+ * @template {object} [S=object]
+ * @template {object} [C=object]
+ * @callback PluginFactory
+ * @param {object} params
+ * @param {C} configuration
+ * @returns {Router<S,C>|Middleware<S,C>}
+ */
+
 /**
  * Custom code plugins for BuildRouter and wingbot.ai
+ *
+ * @template {object} [S=object]
+ * @template {object} C=Object
+ * @class Plugins
  */
 class Plugins {
 
@@ -28,7 +51,7 @@ class Plugins {
         this._plugins = new Map();
     }
 
-    getPluginFactory (name, paramsData = {}) {
+    getPluginFactory (name, paramsData = {}, configuration = {}) {
         let plugin;
         if (plugins.has(name)) {
             plugin = plugins.get(name);
@@ -38,7 +61,7 @@ class Plugins {
             plugin = this._plugins.get(name);
         }
         if (plugin && plugin.pluginFactory) {
-            return plugin.pluginFactory(paramsData);
+            return plugin.pluginFactory(paramsData, configuration);
         }
         return plugin;
     }
@@ -115,8 +138,8 @@ class Plugins {
     /**
      * Register plugin
      *
-     * @param {string|Plugins} name - plugin name or plugins object to include
-     * @param {Plugin|Router} [plugin] - plugin - optional when including plugin object
+     * @param {string|Plugins<S,C>} name - plugin name or plugins object to include
+     * @param {Plugin<S,C>|Router<S,C>} [plugin] - plugin - optional when including plugin object
      */
     register (name, plugin) {
         if (typeof name === 'string') {
@@ -137,7 +160,7 @@ class Plugins {
      * Register plugin factory
      *
      * @param {string} name - plugin name or plugins object to include
-     * @param {Function} pluginFactory - function, which returns a plugin
+     * @param {PluginFactory<S,C>} pluginFactory - function, which returns a plugin
      */
     registerFactory (name, pluginFactory) {
         if (typeof pluginFactory !== 'function') {

package/src/Processor.js

@@ -499,6 +499,11 @@ class Processor extends EventEmitter {
 
             // prepare request and responder
             let { state } = stateObject;
+            let configuration = {};
+            if ('getConfiguration' in this.reducer) {
+                configuration = this.reducer.getConfiguration();
+            }
+
             // @ts-ignore
             req = new Request(
                 message,
@@ -511,7 +516,8 @@ class Processor extends EventEmitter {
                     secret: this.options.secret,
                     fetch: this.options.fetch,
                     appId: responderData.appId
-                }
+                },
+                configuration
             );
 
             const features = [
@@ -549,11 +555,6 @@ class Processor extends EventEmitter {
                 res.setBookmark(aByAi);
             }
 
-            if ('getConfiguration' in this.reducer) {
-                const configuration = this.reducer.getConfiguration(state._lastAction);
-                req.configuration = Object.freeze(configuration);
-            }
-
             // process setState
             const setState = req.getSetState(req.AI_SETSTATE.EXCLUDE_WITH_SET_ENTITIES);
             await Ai.ai.processSetStateEntities(req, setState);

package/src/Request.js

@@ -116,18 +116,29 @@ function makeTimestamp () {
 /**
  * Instance of {Request} class is passed as first parameter of handler (req)
  *
- * @class
+ * @template {object} [S=object]
+ * @template {object} [C=object]
+ * @class Request
  */
 class Request {
 
     /**
      * @param {*} event
-     * @param {*} state
+     * @param {S} state
      * @param {string} pageId
      * @param {Map} globalIntents
      * @param {RequestOrchestratorOptions} [orchestratorOptions]
+     * @param {C} [configuration]
      */
-    constructor (event, state, pageId, globalIntents = new Map(), orchestratorOptions = {}) {
+    constructor (
+        event,
+        state,
+        pageId,
+        globalIntents = new Map(),
+        orchestratorOptions = {},
+        // @ts-ignore
+        configuration = {}
+    ) {
         this.campaign = event.campaign || null;
 
         this.taskId = event.taskId || null;
@@ -188,7 +199,7 @@ class Request {
         this.pageId = pageId;
 
         /**
-         * @prop {object} state current state of the conversation
+         * @type {S} current state of the conversation
          */
         this.state = state;
 
@@ -265,8 +276,8 @@ class Request {
          */
         this.FEATURE_TRACKING = FEATURE_TRACKING;
 
-        /** @type {object} */
-        this.configuration = Object.freeze({});
+        /** @type {C} */
+        this.configuration = configuration;
     }
 
     get data () {

package/src/Router.js

@@ -15,8 +15,11 @@ function defaultPathContext () {
 }
 
 /**
+ *
+ * @template {object} [S=object]
+ * @template {object} [C=object]
  * @callback Resolver processing function
- * @param {Request} [req]
+ * @param {Request<S,C>} [req]
  * @param {Responder} [res]
  * @param {Function} [postBack]
  */
@@ -32,12 +35,21 @@ function defaultPathContext () {
  */
 
 /**
- * @typedef {Resolver|string|RegExp|IRouter|BotPath} Middleware flow control statement or function
+ * @typedef {string|RegExp|BotPath} RouteExp
+ */
+
+/**
+ *
+ * @template {object} [S=object]
+ * @template {object} [C=object]
+ * @typedef {Resolver<S,C>|RouteExp|IRouter} Middleware flow control statement or function
  */
 
 /**
  * Cascading router
  *
+ * @template {object} [S=object]
+ * @template {object} [C=object]
  * @class Router
  * @extends {ReducerWrapper}
  */
@@ -67,7 +79,7 @@ class Router extends ReducerWrapper {
     /**
      * Appends middleware, action handler or another router
      *
-     * @param {...Middleware|Middleware[]} resolvers - list of resolvers
+     * @param {...Middleware<S,C>|Middleware<S,C>[]} resolvers - list of resolvers
      * @returns {this}
      *
      * @example

package/src/graphApi/conversationTestApi.js

@@ -11,6 +11,8 @@ const ConversationTester = require('../ConversationTester');
  * @prop {Function} getTestCases
  */
 
+/** @typedef {import('../ConversationTester').Logger} Logger */
+
 /**
  * Returns API for conversations testing
  *
@@ -26,6 +28,8 @@ const ConversationTester = require('../ConversationTester');
  * @param {number} [options.textCasesPerStep]
  * @param {number} [options.textCaseParallel]
  * @param {boolean} [options.allowEmptyResponse]
+ * @param {Logger} [options.log]
+ *
  * @param {string[]|Function} [acl] - limit api to array of groups or use auth function
  */
 function conversationTestApi (testsSource, botFactory, options, acl) {