wingbot 3.67.31 → 3.68.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.67.31",
+  "version": "3.68.0-alpha.2",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "type": "commonjs",
@@ -10,7 +10,7 @@
     "doc": "npm run doc:gql && node ./bin/makeApiDoc.js && cpy ./CHANGELOG.md ./doc && gitbook install ./doc && gitbook build ./doc && rimraf -rf ./docs && rimraf --rf ./doc/CHANGELOG.md && move-cli ./doc/_book ./docs",
     "test": "npm run test:lint && npm run test:coverage && npm run test:coverage:threshold",
     "test:coverage": "nyc --reporter=html mocha ./test && nyc report",
-    "test:coverage:threshold": "nyc check-coverage --lines 89 --functions 89 --branches 80",
+    "test:coverage:threshold": "nyc check-coverage --lines 89 --functions 88 --branches 80",
     "test:backend": "mocha ./test",
     "test:lint": "eslint --ext .js src test *.js plugins"
   },

package/src/Responder.js

@@ -38,11 +38,20 @@ 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} [onCloseAction]
+ * @prop {string} [onCloseActionData]
+ */
+
 /**
  * @typedef {object} QuickReply
  * @prop {string} title
@@ -891,15 +900,22 @@ 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 = {}) {
+        const { onCloseAction, onCloseActionData = {}, ...rest } = options;
+        if (onCloseAction) {
+            Object.assign(rest, {
+                on_close_payload: this._makePayload(onCloseAction, onCloseActionData)
+            });
+        }
         this._messageSender.send({
-            expectedIntentsAndEntities: [{ type }]
+            expectedIntentsAndEntities: [{ type, ...rest }]
         });
         return this;
     }
@@ -1054,16 +1070,20 @@ class Responder {
         return this.template({
             template_type: 'one_time_notif_req',
             title: this._t(title),
-            payload: JSON.stringify({
-                action: makeAbsolute(action, this.path),
-                data: {
-                    ...data,
-                    _ntfTag: tag
-                }
+            payload: this._makePayload(action, {
+                ...data,
+                _ntfTag: tag
             })
         });
     }
 
+    _makePayload (action, data) {
+        return JSON.stringify({
+            action: makeAbsolute(action, this.path),
+            data
+        });
+    }
+
     template (payload) {
         const messageData = {
             message: {

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.
      *