wingbot 3.33.0 → 3.34.0-alpha.1

package/package.json

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

package/src/ConversationTester.js

@@ -603,19 +603,13 @@ class ConversationTester {
             } else {
                 const quickReplyRequired = action.match(/^>/);
                 const cleanAction = action.replace(/^>/, '');
-                let found;
 
                 // action in quick reply
                 if (action.match(/^>\//)) {
                     await t.quickReply(cleanAction);
-                    found = true;
+                } else if (quickReplyRequired) {
+                    await t.quickReplyText(cleanAction);
                 } else {
-                    found = await t.quickReplyText(cleanAction);
-                }
-
-                if (!found && quickReplyRequired) {
-                    throw new Error(`Quick reply "${action.replace(/^>/, '')}" was required, but has not been found`);
-                } else if (!found) {
                     await t.text(action);
                 }
             }

package/src/Tester.js

@@ -452,7 +452,7 @@ class Tester {
     }
 
     /**
-     * Send quick reply if text exactly matches, otherwise returns false
+     * Send quick reply if text exactly matches, otherwise throws exception
      *
      * @param {string} text
      * @returns {Promise<boolean>}
@@ -460,22 +460,38 @@ class Tester {
      * @memberOf Tester
      */
     async quickReplyText (text) {
+        let but = 'has not been found.';
 
         if (this.responses.length !== 0) {
-            const search = tokenize(text);
+            const normalize = (t) => `${t}`.toLocaleLowerCase().replace(/\s+/g, ' ').trim();
+            const normalizedText = normalize(text);
+            const search = tokenize(normalizedText);
             const last = this.responses[this.responses.length - 1];
             const quickReplys = asserts.getQuickReplies(last);
-            const res = quickReplys
+            let res = quickReplys
                 .filter(({ title = '', payload }) => title && payload && tokenize(title) === search);
 
-            if (res[0]) {
+            if (res.length > 1) {
+                res = res
+                    .filter(({ title = '' }) => normalize(title) === normalizedText);
+            }
+
+            if (res.length === 1) {
                 const { title, payload } = res[0];
                 await this.processMessage(Request.quickReplyText(this.senderId, title, payload));
                 return true;
             }
+
+            if (res.length > 1) {
+                but = 'found, but there are multiple occurences.';
+            }
+
+            but += quickReplys.length
+                ? ` (found: ${quickReplys.map((q) => q.title).filter((q) => !!q).join(', ')})`
+                : ' (no quick replies available)';
         }
 
-        return false;
+        throw new Error(`Quick reply "${text}" ${but}`);
     }
 
     /**

package/src/resolvers/utils.js

@@ -14,6 +14,7 @@ const TYPE_SHARE = 'element_share';
 const TYPE_URL = 'web_url';
 const TYPE_URL_WITH_EXT = 'web_url_extension';
 const TYPE_POSTBACK = 'postback';
+const TYPE_ATTACHMENT = 'attachment';
 
 const WEBVIEW_FULL = 'full';
 const WEBVIEW_TALL = 'tall';
@@ -227,10 +228,11 @@ function processButtons (
         editableCondition,
         setState
     }) => {
+
         if (hasCondition) {
             const condition = getCondition({
                 hasCondition, conditionFn, hasEditableCondition, editableCondition
-            }, context, 'Quick reply condition');
+            }, context, 'Button condition');
 
             if (!condition(req, res)) {
                 return;
@@ -244,7 +246,8 @@ function processButtons (
             url,
             webviewHeight = WEBVIEW_TALL,
             targetRouteId,
-            action
+            action,
+            payload
         } = btnAction;
 
         const isExtUrl = type === TYPE_URL_WITH_EXT;
@@ -273,6 +276,9 @@ function processButtons (
             case TYPE_SHARE:
                 elem.shareButton(btnTitleText);
                 break;
+            case TYPE_ATTACHMENT:
+                elem.attachmentButton(btnTitleText, payload);
+                break;
             default:
         }
     });

package/src/templates/ButtonTemplate.js

@@ -6,6 +6,46 @@
 const BaseTemplate = require('./BaseTemplate');
 const { makeAbsolute } = require('../utils');
 
+/**
+ * @typedef MarkdownPayload
+ * @prop {"text/markdown"} contentType
+ * @prop {string} content
+ */
+
+/**
+ * Designer payload type
+ *
+ * @typedef {MarkdownPayload} Payload
+ */
+
+/**
+ * @typedef EncodedPayload
+ * @prop {string} content
+ * @prop {"text/markdown"} content_type
+ */
+
+/**
+ * Encodes different types of payloads from designer snapshot to payload for chat
+ * Content is Base64 encoded.
+ *
+ * @param {Payload} payload
+ * @returns {EncodedPayload}
+ */
+function encodePayload (payload) {
+    const encodedPayload = {
+        content: payload.content,
+        content_type: payload.contentType
+    };
+
+    switch (payload.contentType) {
+        default:
+            encodedPayload.content = Buffer.from(payload.content).toString('base64');
+            break;
+    }
+
+    return encodedPayload;
+}
+
 /**
  * Helps with creating of button template
  * Instance of button template is returned by {Responder}
@@ -92,6 +132,31 @@ class ButtonTemplate extends BaseTemplate {
         return this;
     }
 
+    /**
+     * Adds button, which opens a popup with content on click.
+     *
+     * @param {string} title
+     * @param {Payload} payload
+     * @returns {this}
+     *
+     * @example
+     * res.button('text')
+     *  .attachmentButton('button title', {
+     *      content: '# Heading 1',
+     *      contentType: 'text/markdown'
+     *   })
+     *  .send();
+     *
+     */
+    attachmentButton (title, payload) {
+        this.buttons.push({
+            type: 'attachment',
+            title: this._t(title),
+            payload: encodePayload(payload)
+        });
+        return this;
+    }
+
     /**
      *
      * @returns {this}

package/src/wingbot/CustomEntityDetectionModel.js

@@ -468,6 +468,7 @@ class CustomEntityDetectionModel {
         return {
             text: cleanText,
             intents: [],
+            // @ts-ignore
             entities
         };
     }
@@ -615,6 +616,28 @@ class CustomEntityDetectionModel {
         return this;
     }
 
+    /**
+     * Sets options to entity detector.
+     * Useful for disabling anonymization of local system entities.
+     *
+     * @param {string} name
+     * @param {object} options
+     * @param {boolean} [options.anonymize]
+     * @returns {this}
+     * @example
+     *
+     * ai.register('wingbot-model-name')
+     *     .setDetectorOptions('phone', { anonymize: false })
+     *     .setDetectorOptions('email', { anonymize: false })
+     */
+    setDetectorOptions (name, options) {
+        if (!this._entityDetectors.has(name)) {
+            throw new Error('Can\'t set entity detector options. Entity "name" does not exist.');
+        }
+        Object.assign(this._entityDetectors.get(name), options);
+        return this;
+    }
+
     async getPhrases () {
         return this._getPhrases();
     }