wingbot 3.33.2 → 3.35.0

package/package.json

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

package/src/BotApp.js

@@ -46,6 +46,15 @@ const DEFAULT_API_URL = 'https://orchestrator-api.wingbot.ai';
  * @prop {object} headers
  */
 
+function defaultMsg (senderId, pageId) {
+    return {
+        sender: { id: senderId },
+        recipient: { id: pageId },
+        mid: null,
+        timestamp: Date.now()
+    };
+}
+
 /**
  * Adapter for Wingbot flight director
  *
@@ -239,32 +248,53 @@ class BotApp {
             };
         }
 
+        const sender = await this.createSender(senderId, pageId, message);
+        const res = await this._processor.processMessage(message, pageId, sender, { appId });
+        await this._processSenderResponses(sender, senderId, pageId, headers);
+
+        return {
+            status: res.status,
+            response_to_mid: message.mid,
+            messaging: []
+        };
+    }
+
+    /**
+     * Creates a Sender to be able, for example, to upload files
+     *
+     * @param {string} senderId
+     * @param {string} pageId
+     * @param {object} [message]
+     * @param {string|Promise<string>} [secret]
+     * @returns {Promise<BotAppSender>}
+     */
+    async createSender (
+        senderId,
+        pageId,
+        message = defaultMsg(senderId, pageId),
+        secret = this._secret
+    ) {
+        const useSecret = await Promise.resolve(secret);
+
+        const setResponseToMid = message.response_to_mid || message.mid;
+
         const options = {
             ...this._returnSenderOptions,
             apiUrl: this._apiUrl,
             pageId,
-            appId,
-            secret,
+            appId: this._appId,
+            secret: useSecret,
             mid: setResponseToMid,
             fetch: this._fetch,
             tls: this._tls
         };
 
-        const sender = new BotAppSender(options, senderId, message, this._senderLogger);
-        const res = await this._processor.processMessage(message, pageId, sender, { appId });
-        await this._processSenderResponses(sender, senderId, pageId, headers);
-
-        return {
-            status: res.status,
-            response_to_mid: message.mid,
-            messaging: []
-        };
+        return new BotAppSender(options, senderId, message, this._senderLogger);
     }
 
     /**
      * Compatibility method for Notification engine
      *
-     * @deprecated
      * @param {object} message - wingbot chat event
      * @param {string} senderId - chat event sender identifier
      * @param {string} pageId - channel/page identifier

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,38 @@
 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 ({ content, contentType }) {
+    return {
+        content: Buffer.from(content).toString('base64'),
+        content_type: contentType
+    };
+}
+
 /**
  * Helps with creating of button template
  * Instance of button template is returned by {Responder}
@@ -92,6 +124,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();
     }