wingbot 3.67.30 → 3.68.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.67.30",
+  "version": "3.68.0-alpha.1",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "type": "commonjs",
@@ -16,7 +16,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/wingbotai/wingbot.git"
+    "url": "git+ssh://git@github.com/wingbotai/wingnpbot.git"
   },
   "keywords": [
     "Enterprise",

package/src/Responder.js

@@ -25,6 +25,8 @@ const EXCEPTION_HOPCOUNT_THRESHOLD = 5;
 
 /** @typedef {import('./Request')} Request */
 /** @typedef {import('./ReturnSender').UploadResult} UploadResult */
+/** @typedef {import('./ReturnSender').SendOptions} SendOptions */
+/** @typedef {import('./ReturnSender').TextFilter} TextFilter */
 /** @typedef {import('./analytics/consts').TrackingCategory} TrackingCategory */
 /** @typedef {import('./analytics/consts').TrackingType} TrackingType */
 /** @typedef {import('./transcript/transcriptFromHistory').Transcript} Transcript */
@@ -36,11 +38,19 @@ const EXCEPTION_HOPCOUNT_THRESHOLD = 5;
 const ExpectedInput = {
     TYPE_PASSWORD: 'password',
     TYPE_NONE: 'none',
-    TYPE_UPLOAD: 'upload'
+    TYPE_UPLOAD: 'upload',
+    TYPE_WEBVIEW: 'webview'
 };
 
 Object.freeze(ExpectedInput);
 
+/**
+ * @typedef {object} ExpectedInputOptions
+ * @prop {string} [url]
+ * @prop {string} [webview_height_ratio]
+ * @prop {string} [on_close_payload]
+ */
+
 /**
  * @typedef {object} QuickReply
  * @prop {string} title
@@ -200,6 +210,9 @@ class Responder {
         this._textResponses = [];
 
         this._typingSent = false;
+
+        /** @type {SendOptions} */
+        this._nextMessageSendOptions = null;
     }
 
     _findPersonaConfiguration (name) {
@@ -369,7 +382,12 @@ class Responder {
         }
         this.startedOutput = true;
         this._typingSent = data.sender_action === 'typing_on';
-        this._messageSender.send(data);
+        let opts;
+        if (!data.sender_action && this._nextMessageSendOptions) {
+            opts = this._nextMessageSendOptions;
+            this._nextMessageSendOptions = null;
+        }
+        this._messageSender.send(data, opts);
         return this;
     }
 
@@ -881,15 +899,16 @@ class Responder {
     /**
      *
      * @param {ExpectedInput} type
+     * @param {ExpectedInputOptions} [options]
      * @returns {this}
      * @example
      * bot.use((req, res) => {
      *     res.expectedInput(res.ExpectedInputTypes.TYPE_PASSWORD)
      * });
      */
-    expectedInput (type) {
+    expectedInput (type, options = {}) {
         this._messageSender.send({
-            expectedIntentsAndEntities: [{ type }]
+            expectedIntentsAndEntities: [{ type, ...options }]
         });
         return this;
     }
@@ -1311,6 +1330,17 @@ class Responder {
         );
     }
 
+    /**
+     * Set next message as confident
+     *
+     * @param {TextFilter} anonymizer
+     */
+    nextOutputConfident (anonymizer) {
+        this._nextMessageSendOptions = {
+            anonymizer
+        };
+    }
+
     /**
      * Override action tracking
      *

package/src/ReturnSender.js

@@ -32,9 +32,9 @@ const extractText = require('./transcript/extractText');
 /**
  * @typedef {object} ReturnSenderOptions
  * @prop {boolean} [dontWaitForDeferredOps]
- * @prop {textFilter} [textFilter] - filter for saving the texts
+ * @prop {TextFilter} [textFilter] - filter for saving the texts
  * @prop {boolean} [logStandbyEvents] - log the standby events
- * @prop {textFilter} [confidentInputFilter] - filter for confident input (@CONFIDENT)
+ * @prop {TextFilter} [confidentInputFilter] - filter for confident input (@CONFIDENT)
  */
 
 /**
@@ -53,11 +53,17 @@ const extractText = require('./transcript/extractText');
  * @prop {Function} error
  */
 
+/**
+ * @typedef {object} SendOptions
+ * @prop {TextFilter} [anonymizer]
+ */
+
 /**
  * Text filter function
  *
- * @callback textFilter
+ * @callback TextFilter
  * @param {string} text - input text
+ * @param {'text'|'title'|'url'|'content'} key
  * @returns {string} - filtered text
  */
 
@@ -73,10 +79,11 @@ class ReturnSender {
     constructor (options, senderId, incommingMessage, logger = null) {
         this._queue = [];
 
-        /**
-         * @type {object[]}
-         */
+        /**  @type {object[]} */
         this.responses = [];
+
+        /** @type {SendOptions[]} */
+        this._responseOptions = [];
         this._results = [];
 
         this._promise = null;
@@ -131,7 +138,7 @@ class ReturnSender {
          * For example to remove any confidential data
          *
          * @param {string} text
-         * @type {textFilter}
+         * @type {TextFilter}
          */
         this.textFilter = options.textFilter || ((text) => text);
 
@@ -227,7 +234,7 @@ class ReturnSender {
             : this.textFilter;
 
         return [
-            filter(text).trim()
+            filter(text, null).trim()
         ];
     }
 
@@ -240,7 +247,7 @@ class ReturnSender {
             : this.textFilter;
 
         return this._responseTexts
-            .map((t) => filter(t))
+            .map((t) => filter(t, null))
             .filter((t) => t && `${t}`.trim());
     }
 
@@ -300,11 +307,18 @@ class ReturnSender {
         return new Promise((r) => setTimeout(r, nextWait));
     }
 
-    _filterMessage (payload, confidentInput = false, req = null) {
+    _filterMessage (payload, confidentInput = null, req = null) {
 
-        const filter = confidentInput
-            ? this.confidentInputFilter
-            : this.textFilter;
+        let filter;
+        const processButtons = typeof confidentInput === 'function';
+
+        if (processButtons) {
+            filter = confidentInput;
+        } else if (confidentInput) {
+            filter = this.confidentInputFilter;
+        } else {
+            filter = this.textFilter;
+        }
 
         let { message } = payload;
 
@@ -314,7 +328,7 @@ class ReturnSender {
                 text: message.text ? message.text : message.voice.ssml,
                 voice: {
                     ...message.voice,
-                    ssml: filter(message.voice.ssml)
+                    ssml: filter(message.voice.ssml, 'ssml')
                 }
             };
         }
@@ -331,7 +345,7 @@ class ReturnSender {
                 ...payload,
                 message: {
                     ...message,
-                    text: filter(text)
+                    text: filter(text, 'text')
                 }
             };
         }
@@ -342,6 +356,8 @@ class ReturnSender {
             && message.attachment.payload
             && message.attachment.payload.text) {
 
+            const { payload: p } = message.attachment;
+
             return {
                 ...payload,
                 message: {
@@ -349,8 +365,46 @@ class ReturnSender {
                     attachment: {
                         ...message.attachment,
                         payload: {
-                            ...message.attachment.payload,
-                            text: filter(message.attachment.payload.text)
+                            ...p,
+                            text: filter(p.text, 'text'),
+                            ...(processButtons && Array.isArray(p.buttons)
+                                ? {
+                                    buttons: p.buttons.map((btn) => {
+                                        switch (btn.type) {
+                                            case 'attachment':
+                                                return {
+                                                    ...btn,
+                                                    title: filter(btn.title, 'title'),
+                                                    ...(btn.payload && btn.payload.content
+                                                        ? {
+                                                            payload: {
+                                                                ...btn.payload,
+                                                                content: filter(btn.payload.content, 'content')
+                                                            }
+                                                        }
+                                                        : {}
+                                                    )
+                                                };
+                                            case 'web_url':
+                                                return {
+                                                    ...btn,
+                                                    url: filter(btn.url, 'url'),
+                                                    title: filter(btn.title, 'title')
+                                                };
+
+                                            case 'postback':
+                                                return {
+                                                    ...btn,
+                                                    title: filter(btn.title, 'title')
+                                                };
+
+                                            default:
+                                                return btn;
+                                        }
+                                    })
+                                }
+                                : {}
+                            )
                         }
                     }
                 }
@@ -363,10 +417,11 @@ class ReturnSender {
     async _work () {
         this._isWorking = true;
         let payload;
+        let options;
         let req;
         let previousResponse = null;
         while (this._queue.length > 0) {
-            payload = this._queue.shift();
+            ({ payload, options } = this._queue.shift());
 
             let lastInQueueForNow = this._queue.length === 0;
             if (this._queue.length === 0 && this._sendLastMessageWithFinish) {
@@ -392,6 +447,7 @@ class ReturnSender {
             } else {
                 await this._enrichPayload(payload, req, lastInQueueForNow);
                 this.responses.push(payload);
+                this._responseOptions.push(options);
                 previousResponse = await this._send(payload);
                 this._results.push(previousResponse);
             }
@@ -487,7 +543,13 @@ class ReturnSender {
         return false;
     }
 
-    send (payload) {
+    /**
+     *
+     * @param {object} payload
+     * @param {SendOptions} options
+     * @returns {void}
+     */
+    send (payload, options = {}) {
         if (this._finished) {
             throw new Error('Cannot send message after sender is finished');
         }
@@ -510,17 +572,17 @@ class ReturnSender {
         if (payload.set_context
             && !this._isVisibleMessage(payload, false)
             && lastInQueue
-            && this._isVisibleMessage(lastInQueue)) {
+            && this._isVisibleMessage(lastInQueue.payload)) {
 
             const { set_context: setContext, ...rest } = payload;
 
             Object.assign(
-                lastInQueue,
+                lastInQueue.payload,
                 rest,
-                lastInQueue,
+                lastInQueue.payload,
                 {
                     set_context: {
-                        ...lastInQueue.set_context,
+                        ...lastInQueue.payload.set_context,
                         ...setContext
                     }
                 }
@@ -532,7 +594,7 @@ class ReturnSender {
         if (text) {
             this._responseTexts.push(text);
         }
-        this._queue.push(payload);
+        this._queue.push({ payload, options });
         this._gotAnotherEvent();
 
         if (this._catchedBeforeFinish) {
@@ -620,7 +682,7 @@ class ReturnSender {
             let text = req.text();
 
             if (text) {
-                text = this.textFilter(text);
+                text = this.textFilter(text, null);
             }
 
             const expected = req.expected();
@@ -675,7 +737,10 @@ class ReturnSender {
         }
 
         try {
-            const sent = this.responses.map((s) => this._filterMessage(s));
+            const sent = this.responses.map((s, i) => {
+                const opts = this._responseOptions[i];
+                return this._filterMessage(s, opts.anonymizer);
+            });
             const processedEvent = req
                 ? req.event
                 : this._incommingMessage;

package/src/graphApi/conversationsApi.js

@@ -33,7 +33,7 @@ const { apiTextOutputFilter, mapObject, defaultMapperFactory } = require('../uti
 /**
  * Function for filtration of string output
  *
- * @callback textFilter
+ * @callback TextFilter
  * @param {string} value
  * @param {string} key
  * @returns {any}
@@ -48,7 +48,7 @@ const { apiTextOutputFilter, mapObject, defaultMapperFactory } = require('../uti
  * @param {Notifications} notifications
  * @param {string[]|Function} [acl] - limit api to array of groups or use auth function
  * @param {object} options
- * @param {textFilter} [options.stateTextFilter] - optional funcion for filtering data in states
+ * @param {TextFilter} [options.stateTextFilter] - optional funcion for filtering data in states
  * @param {Mapper} [options.mapper] - mapper for state values
  * @returns {ConversationsAPI}
  * @example

package/src/templates/ButtonTemplate.js

@@ -83,18 +83,35 @@ class ButtonTemplate extends BaseTemplate {
      * @param {string} linkUrl - button url
      * @param {boolean} hasExtension - includes token in url
      * @param {string} [webviewHeight=null] - compact|tall|full
+     * @param {string} [onCloseAction] - close action for webview
+     * @param {object} [onCloseData] - data
      * @returns {this}
      *
      * @memberOf ButtonTemplate
      */
-    urlButton (title, linkUrl, hasExtension = false, webviewHeight = null) {
-        this.buttons.push({
+    urlButton (
+        title,
+        linkUrl,
+        hasExtension = false,
+        webviewHeight = null,
+        onCloseAction = null,
+        onCloseData = {}
+    ) {
+        const btn = {
             type: 'web_url',
             title: this._t(title),
             url: this._makeExtensionUrl(linkUrl, hasExtension),
             webview_height_ratio: webviewHeight || (hasExtension ? 'tall' : 'full'),
             messenger_extensions: hasExtension
-        });
+        };
+        // on_close_payload
+        if (onCloseAction) {
+            Object.assign(btn, {
+                on_close_payload: this._createPayload(onCloseAction, onCloseData)
+            });
+        }
+
+        this.buttons.push(btn);
         return this;
     }
 
@@ -110,23 +127,27 @@ class ButtonTemplate extends BaseTemplate {
      * @memberOf ButtonTemplate
      */
     postBackButton (title, action, data = {}, setState = null) {
-        const hasSetState = setState && Object.keys(setState).length !== 0;
-
         this.buttons.push({
             type: 'postback',
             title: this._t(title),
-            payload: JSON.stringify({
-                action: makeAbsolute(action, this.context.path),
-                data: {
-                    _ca: this.context.currentAction,
-                    ...data
-                },
-                ...(hasSetState ? { setState } : {})
-            })
+            payload: this._createPayload(action, data, setState)
         });
         return this;
     }
 
+    _createPayload (action, data, setState = null) {
+        const hasSetState = setState && Object.keys(setState).length !== 0;
+
+        return JSON.stringify({
+            action: makeAbsolute(action, this.context.path),
+            data: {
+                _ca: this.context.currentAction,
+                ...data
+            },
+            ...(hasSetState ? { setState } : {})
+        });
+    }
+
     /**
      * Adds button, which opens a popup with content on click.
      *