wingbot 3.59.2 → 3.61.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.59.2",
+  "version": "3.61.0",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {
@@ -9,7 +9,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 90 --functions 89 --branches 80",
+    "test:coverage:threshold": "nyc check-coverage --lines 89 --functions 89 --branches 80",
     "test:backend": "mocha ./test",
     "test:lint": "eslint --ext .js src test *.js plugins"
   },

package/plugins/ai.wingbot.trackingEvent/plugin.js

@@ -1,10 +1,62 @@
+const { default: fetch } = require('node-fetch');
 const { compileWithState } = require('../../src/utils');
 
+function transformEvent (c, a, l, v, req, res) {
+    switch (c) {
+        case 'generate_lead':
+            return {
+                name: 'generate_lead',
+                params: {
+                    currency: l || 'USD',
+                    value: v
+                }
+            };
+        case 'view_item':
+            return {
+                name: 'view_item',
+                params: {
+                    currency: l || 'USD',
+                    value: v,
+                    items: [
+                        {
+                            item_name: res.currentAction(),
+                            item_category: a || ''
+                        }
+                    ]
+                }
+            };
+        case 'purchase':
+            return {
+                name: 'purchase',
+                params: {
+                    currency: l || 'USD',
+                    transaction_id: `${req.pageId}.${req.senderId}.${req.timestamp}`,
+                    value: v,
+                    items: [
+                        {
+                            item_name: res.currentAction(),
+                            item_category: a || ''
+                        }
+                    ]
+                }
+            };
+        case 'tutorial_begin':
+        case 'tutorial_complete':
+        case 'sign_up':
+        case 'share':
+            return {
+                name: c
+            };
+        default:
+            return null;
+    }
+}
+
 /**
  * @param {import('../../src/Request')} req
  * @param {import('../../src/Responder')} res
  */
-function trackingEvent (req, res) {
+async function trackingEvent (req, res) {
     const {
         category = '',
         action = '',
@@ -13,12 +65,53 @@ function trackingEvent (req, res) {
         type
     } = req.params;
 
-    const c = compileWithState(req, res, category);
-    const a = compileWithState(req, res, action);
-    const l = compileWithState(req, res, label);
+    const c = compileWithState(req, res, category).trim();
+    const a = compileWithState(req, res, action).trim();
+    const l = compileWithState(req, res, label).trim();
     const v = parseFloat(compileWithState(req, res, value)
         .replace(/[^0-9.]+/, '')) || 0;
 
+    const {
+        '§gi': clientId,
+        '§gc': gclid
+    } = req.state;
+
+    const {
+        gaMeasurementId,
+        gaApiSecret
+    } = req.configuration;
+
+    if (clientId && gaMeasurementId && gaApiSecret) {
+
+        const ev = transformEvent(c, a, l, v, req, res);
+
+        const body = {
+            client_id: clientId,
+            timestamp_micros: req.timestamp * 1000,
+            non_personalized_ads: false,
+            ...(a ? {
+                user_properties: {
+                    [a]: {
+                        value: v || 1
+                    }
+                }
+            } : {}),
+            events: ev ? [ev] : []
+        };
+
+        const params = {
+            method: 'POST',
+            body: JSON.stringify(body)
+        };
+
+        try {
+            await fetch(`https://www.google-analytics.com/mp/collect?api_secret=${encodeURIComponent(gaApiSecret)}&measurement_id=${encodeURIComponent(gaMeasurementId)}`, params);
+        } catch (e) {
+            // eslint-disable-next-line no-console
+            console.error('GA FAILED', e, body);
+        }
+    }
+
     res.trackEvent(type || 'report', c, a, l, v);
 }
 

package/plugins/ai.wingbot.upload/plugin.js

@@ -0,0 +1,54 @@
+const Router = require('../../src/Router');
+
+/**
+ *
+ * @param {object} params
+ * @param {'any'|'image'|'audio'|'video'|'file'} params.type
+ * @param {string} params.variable
+ * @param {'array'|'string'} params.datatype
+ * @returns {import('../../src/Router').Middleware}
+ */
+module.exports = (params) => {
+
+    /**
+     * @param {import('../../src/Request')} req
+     * @param {import('../../src/Responder')} res
+     */
+    const uploadPlugin = async (req, res) => {
+        if (req.isAttachment()) {
+
+            const typeOk = (!params.type || params.type === 'any')
+                || req.attachments.every((a) => a.type === params.type);
+
+            if (!typeOk) {
+                await res.run('badType');
+                return Router.NEXT;
+            }
+
+            const varName = `${params.variable || 'uploadUrl'}`.trim();
+
+            if (params.datatype === 'array') {
+                const curr = req.state[varName] || [];
+                const urls = req.attachments.map((a) => a.payload.url)
+                    .filter((u) => !!u);
+
+                res.setState({
+                    [varName]: [...curr, ...urls]
+                });
+            } else {
+                const [first] = req.attachments;
+
+                res.setState({
+                    [varName]: first.payload.url || null
+                });
+            }
+            await res.run('success');
+
+        } else {
+            await res.run('noAttachment');
+        }
+        return Router.NEXT;
+    };
+
+    return uploadPlugin;
+};

package/plugins/plugins.json

@@ -162,17 +162,17 @@
                 {
                     "name": "category",
                     "type": "text",
-                    "label": "Event category"
+                    "label": "Event category (generate_lead,view_item,purchase,tutorial_begin,tutorial_complete,sign_up,share)"
                 },
                 {
                     "name": "action",
                     "type": "text",
-                    "label": "Event action"
+                    "label": "Event action (item category)"
                 },
                 {
                     "name": "label",
                     "type": "text",
-                    "label": "Event label"
+                    "label": "Event label (currency)"
                 },
                 {
                     "name": "value",
@@ -609,6 +609,57 @@
             ],
             "items": [
             ]
+        },
+        {
+            "id": "ai.wingbot.upload",
+            "name": "Process upload",
+            "description": "Plugin is intended to be used in an interaction plugin",
+            "availableSince": 3.60,
+            "editable": false,
+            "isFactory": true,
+            "category": "detectors",
+            "inputs": [
+                {
+                    "name": "type",
+                    "label": "Allowed attachment type",
+                    "type": "select",
+                    "options": [
+                        { "value": "any", "label": "any attachment type" },
+                        { "value": "image", "label": "image" },
+                        { "value": "audio", "label": "audio" },
+                        { "value": "video", "label": "video" },
+                        { "value": "file", "label": "file" }
+                    ]
+                },
+                {
+                    "name": "variable",
+                    "label": "Variable name to set attachment URL(s)",
+                    "type": "text"
+                },
+                {
+                    "name": "datatype",
+                    "label": "Allowed attachment type",
+                    "type": "select",
+                    "options": [
+                        { "value": "string", "label": "string" },
+                        { "value": "array", "label": "array of strings" }
+                    ]
+                }
+            ],
+            "items": [
+                {
+                    "id": "noAttachment",
+                    "description": "No attachment uploaded"
+                },
+                {
+                    "id": "badType",
+                    "description": "Disallowed attachment type"
+                },
+                {
+                    "id": "success",
+                    "description": "Successfully uploaded"
+                }
+            ]
         }
     ],
     "categories": [

package/src/Request.js

@@ -109,6 +109,13 @@ function makeTimestamp () {
  * @prop {number} score
  */
 
+/**
+ * @typedef {object} Attachment
+ * @prop {'file'|'audio'|'video'|'image'} type
+ * @prop {object} payload
+ * @prop {string} payload.url
+ */
+
 /**
  * @typedef {number} AiSetStateOption
  */
@@ -175,6 +182,7 @@ class Request {
 
         this._optin = event.optin || null;
 
+        /** @type {Attachment[]} */
         this.attachments = (event.message
             && (event.message.attachment
                 ? [event.message.attachment]

package/src/Tester.js

@@ -143,6 +143,11 @@ class Tester {
          * @prop {string[]}
          */
         this.features = null;
+
+        /**
+         * @prop {string}
+         */
+        this.ATTACHMENT_MOCK_URL = 'http://mock.url/file.txt';
     }
 
     _actionHasGlobalIntent (action) {
@@ -415,6 +420,18 @@ class Tester {
         return this.processMessage(Request.text(this.senderId, text));
     }
 
+    /**
+     * Sends attachment
+     *
+     * @param {'image'|'audio'|'video'|'file'} type
+     * @param {string} [url]
+     * @returns {Promise}
+     * @memberOf Tester
+     */
+    attachment (type = 'file', url = this.ATTACHMENT_MOCK_URL) {
+        return this.processMessage(Request.fileAttachment(this.senderId, url, type));
+    }
+
     /**
      * Makes recognised AI intent request
      *