@miso.ai/client-sdk-ui 1.13.0-beta.5 → 1.13.0-beta.7

package/dist/cjs/actor/tracker.js

@@ -59,21 +59,6 @@ class Tracker {
       items: itemless ? undefined : items
     }, meta));
   }
-  submit({
-    value
-  }) {
-    this._syncSession();
-    this._sendToHub({
-      type: _constants.EVENT_TYPE.SUBMIT,
-      value
-    });
-  }
-  heartbeat() {
-    this._syncSession();
-    this._sendToHub({
-      type: _constants.EVENT_TYPE.HEARTBEAT
-    });
-  }
   _sendToHub(args) {
     this._hub.trigger(fields.tracker(), Object.freeze((0, _commons.trimObj)(Object.assign({
       role: this._role
@@ -110,7 +95,15 @@ class Tracker {
 }
 exports.default = Tracker;
 for (const type of _constants.PERFORMANCE_EVENT_TYPES) {
-  Tracker.prototype[type] = function (items, meta) {
+  Tracker.prototype[(0, _commons.snakeToLowerCamel)(type)] = function (items, meta) {
     this._trigger(type, items, meta);
   };
+}
+for (const type of _constants.DIRECT_TRACKING_EVENT_TYPES) {
+  Tracker.prototype[(0, _commons.snakeToLowerCamel)(type)] = function (args) {
+    this._syncSession();
+    this._sendToHub(Object.assign({}, args, {
+      type
+    }));
+  };
 }

package/dist/cjs/constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WORKFLOW_CONFIGURABLE = exports.TRACKING_STATUS = exports.TRACKING_EVENT_TYPES = exports.STATUS = exports.ROLE = exports.REQUEST_TYPE = exports.QUESTION_SOURCE = exports.PERFORMANCE_EVENT_TYPES = exports.EVENT_TYPE = exports.DEFAULT_UNIT_ID = exports.ATTR_DATA_MISO_UNIT_ID = exports.ATTR_DATA_MISO_PRODUCT_ID = void 0;
+exports.WORKFLOW_CONFIGURABLE = exports.TRACKING_STATUS = exports.TRACKING_EVENT_TYPES = exports.STATUS = exports.ROLE = exports.REQUEST_TYPE = exports.QUESTION_SOURCE = exports.PERFORMANCE_EVENT_TYPES = exports.EVENT_TYPE = exports.DIRECT_TRACKING_EVENT_TYPES = exports.DEFAULT_UNIT_ID = exports.ATTR_DATA_MISO_UNIT_ID = exports.ATTR_DATA_MISO_PRODUCT_ID = void 0;
 exports.isDataRole = isDataRole;
 exports.isPerformanceEventType = isPerformanceEventType;
 exports.isProductRole = isProductRole;
@@ -53,10 +53,12 @@ const EVENT_TYPE = exports.EVENT_TYPE = Object.freeze({
   CLICK: 'click',
   SUBMIT: 'submit',
   FEEDBACK: 'feedback',
-  HEARTBEAT: 'heartbeat'
+  HEARTBEAT: 'heartbeat',
+  GENERIC_CLICK: 'generic_click'
 });
 const TRACKING_EVENT_TYPES = exports.TRACKING_EVENT_TYPES = [EVENT_TYPE.IMPRESSION, EVENT_TYPE.VIEWABLE, EVENT_TYPE.CLICK, EVENT_TYPE.SUBMIT, EVENT_TYPE.FEEDBACK, EVENT_TYPE.HEARTBEAT];
 const PERFORMANCE_EVENT_TYPES = exports.PERFORMANCE_EVENT_TYPES = [EVENT_TYPE.IMPRESSION, EVENT_TYPE.VIEWABLE, EVENT_TYPE.CLICK];
+const DIRECT_TRACKING_EVENT_TYPES = exports.DIRECT_TRACKING_EVENT_TYPES = [EVENT_TYPE.SUBMIT, EVENT_TYPE.HEARTBEAT, EVENT_TYPE.GENERIC_CLICK];
 const PERFORMANCE_EVENT_TYPE_SET = new Set(PERFORMANCE_EVENT_TYPES);
 function isPerformanceEventType(type) {
   return PERFORMANCE_EVENT_TYPE_SET.has(type);

package/dist/cjs/plugin.js

@@ -166,7 +166,11 @@ class Ui {
     return this.recommendations.get(); // get default recommendation unit
   }
   get search() {
-    return this._search || (this._search = new _index.Search(this._plugin, this._client));
+    if (!this._search) {
+      this._search = new _index.Search(this._plugin, this._client);
+      this._client._events.emit('postworkflow', this._search);
+    }
+    return this._search;
   }
   get asks() {
     return this._asks || (this._asks = this._plugin._getAsks(this._client));
@@ -175,7 +179,11 @@ class Ui {
     return this.asks.root;
   }
   get hybridSearch() {
-    return this._hybridSearch || (this._hybridSearch = new _index.HybridSearch(this._plugin, this._client));
+    if (!this._hybridSearch) {
+      this._hybridSearch = new _index.HybridSearch(this._plugin, this._client);
+      this._client._events.emit('postworkflow', this._hybridSearch);
+    }
+    return this._hybridSearch;
   }
   get explores() {
     return this._explores || (this._explores = this._plugin._getExplores(this._client));

package/dist/cjs/version.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = exports.default = '1.13.0-beta.5';
+var _default = exports.default = '1.13.0-beta.7';

package/dist/cjs/workflow/asks.js

@@ -39,6 +39,7 @@ class Asks extends _context.default {
     this._byQid = new Map();
     this._byPqid = new Map();
     this._root = new _ask.default(this); // initialize with default workflow
+    client._events.emit('postworkflow', this._root);
     this._events.on('*', event => this._createNextIfNecessary(event));
     this._events.on('loading', event => this._setActive(event.workflow));
     this._events.on('destroy', () => this._requestEmitAfterDestroy());
@@ -73,6 +74,7 @@ class Asks extends _context.default {
     let workflow = this._byPqid.get(parentQuestionId);
     if (!workflow && autoCreate) {
       workflow = new _ask.default(this, parentQuestionId);
+      this._client._events.emit('postworkflow', workflow);
     }
     return workflow;
   }

package/dist/cjs/workflow/processors.js

@@ -35,7 +35,8 @@ exports.writeUnanswerableToMeta = writeUnanswerableToMeta;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../constants.js");
 var _index = require("../actor/index.js");
-const _excluded = ["qs"];
+const _excluded = ["qs"],
+  _excluded2 = ["role", "type", "items"];
 function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
 // role mappings //
 function mappingSortData(_, {
@@ -401,10 +402,11 @@ function carryOverQuestionIdToData(data, oldData) {
 // interactions //
 function buildBaseInteraction(args) {
   const {
-    role,
-    type,
-    items
-  } = args;
+      role,
+      type,
+      items
+    } = args,
+    rest = _objectWithoutPropertiesLoose(args, _excluded2);
   const payload = {
     type: type === 'viewable' ? 'viewable_impression' : type,
     context: {
@@ -433,6 +435,11 @@ function buildBaseInteraction(args) {
       payload.type = 'custom';
       payload.custom_action_name = 'heartbeat';
       break;
+    case _constants.EVENT_TYPE.GENERIC_CLICK:
+      payload.type = 'custom';
+      payload.custom_action_name = 'generic_click';
+      payload.context.custom_context.href = args.href;
+      break;
   }
   return (0, _commons.trimObj)(payload);
 }

package/dist/cjs/workflow/units.js

@@ -19,7 +19,7 @@ class UnitWorkflowContext extends _context.default {
     if (this._members.has(unitId)) {
       throw new Error(`Unit already exists: ${unitId}`);
     }
-    return this._create(unitId);
+    return this._createAndEmit(unitId);
   }
   has(unitId = _constants.DEFAULT_UNIT_ID) {
     return this._members.has(unitId);
@@ -28,7 +28,12 @@ class UnitWorkflowContext extends _context.default {
     if (typeof unitId !== 'string') {
       throw new Error(`Required unit ID to be a string: ${unitId}`);
     }
-    return this._members.get(unitId) || this._create(unitId);
+    return this._members.get(unitId) || this._createAndEmit(unitId);
+  }
+  _createAndEmit(unitId) {
+    const workflow = this._create(unitId);
+    this._client._events.emit('postworkflow', workflow);
+    return workflow;
   }
   _create(unitId) {
     throw new Error('Not implemented');

package/package.json

@@ -30,7 +30,7 @@
     "url": "https://github.com/MisoAI/miso-client-js-sdk/issues"
   },
   "dependencies": {
-    "@miso.ai/commons": "1.13.0-beta.5"
+    "@miso.ai/commons": "1.13.0-beta.7"
   },
-  "version": "1.13.0-beta.5"
+  "version": "1.13.0-beta.7"
 }

package/src/actor/feedback.js

@@ -9,7 +9,7 @@ export default class FeedbackActor {
       hub.on(fields.feedback(), state => this._trigger(state)),
     ];
   }
-  
+
   _trigger(state) {
     this._hub.trigger(fields.tracker(), {
       type: EVENT_TYPE.FEEDBACK,

package/src/actor/tracker.js

@@ -1,5 +1,5 @@
-import { asArray, trimObj } from '@miso.ai/commons';
-import { PERFORMANCE_EVENT_TYPES, TRACKING_STATUS, EVENT_TYPE, validateEventType } from '../constants.js';
+import { asArray, trimObj, snakeToLowerCamel } from '@miso.ai/commons';
+import { PERFORMANCE_EVENT_TYPES, DIRECT_TRACKING_EVENT_TYPES, TRACKING_STATUS, EVENT_TYPE, validateEventType } from '../constants.js';
 import * as fields from './fields.js';
 import States from '../util/states.js';
 
@@ -55,21 +55,6 @@ export default class Tracker {
     });
   }
 
-  submit({ value }) {
-    this._syncSession();
-    this._sendToHub({
-      type: EVENT_TYPE.SUBMIT,
-      value,
-    });
-  }
-
-  heartbeat() {
-    this._syncSession();
-    this._sendToHub({
-      type: EVENT_TYPE.HEARTBEAT,
-    });
-  }
-
   _sendToHub(args) {
     this._hub.trigger(fields.tracker(), Object.freeze(trimObj({ role: this._role, ...args })));
   }
@@ -106,7 +91,14 @@ export default class Tracker {
 }
 
 for (const type of PERFORMANCE_EVENT_TYPES) {
-  Tracker.prototype[type] = function(items, meta) {
+  Tracker.prototype[snakeToLowerCamel(type)] = function(items, meta) {
     this._trigger(type, items, meta);
   };
 }
+
+for (const type of DIRECT_TRACKING_EVENT_TYPES) {
+  Tracker.prototype[snakeToLowerCamel(type)] = function(args) {
+    this._syncSession();
+    this._sendToHub({ ...args, type });
+  };
+}

package/src/constants.js

@@ -72,6 +72,7 @@ export const EVENT_TYPE = Object.freeze({
   SUBMIT: 'submit',
   FEEDBACK: 'feedback',
   HEARTBEAT: 'heartbeat',
+  GENERIC_CLICK: 'generic_click',
 });
 
 export const TRACKING_EVENT_TYPES = [
@@ -89,6 +90,12 @@ export const PERFORMANCE_EVENT_TYPES = [
   EVENT_TYPE.CLICK,
 ];
 
+export const DIRECT_TRACKING_EVENT_TYPES = [
+  EVENT_TYPE.SUBMIT,
+  EVENT_TYPE.HEARTBEAT,
+  EVENT_TYPE.GENERIC_CLICK,
+];
+
 const PERFORMANCE_EVENT_TYPE_SET = new Set(PERFORMANCE_EVENT_TYPES);
 
 export function isPerformanceEventType(type) {

package/src/plugin.js

@@ -176,7 +176,11 @@ class Ui {
   }
 
   get search() {
-    return this._search || (this._search = new Search(this._plugin, this._client));
+    if (!this._search) {
+      this._search = new Search(this._plugin, this._client);
+      this._client._events.emit('postworkflow', this._search);
+    }
+    return this._search;
   }
 
   get asks() {
@@ -188,7 +192,11 @@ class Ui {
   }
 
   get hybridSearch() {
-    return this._hybridSearch || (this._hybridSearch = new HybridSearch(this._plugin, this._client));
+    if (!this._hybridSearch) {
+      this._hybridSearch = new HybridSearch(this._plugin, this._client);
+      this._client._events.emit('postworkflow', this._hybridSearch);
+    }
+    return this._hybridSearch;
   }
 
   get explores() {

package/src/version.js

@@ -1 +1 @@
-export default '1.13.0-beta.5';
+export default '1.13.0-beta.7';

package/src/workflow/asks.js

@@ -30,6 +30,8 @@ export default class Asks extends WorkflowContext {
     this._byQid = new Map();
     this._byPqid = new Map();
     this._root = new Ask(this); // initialize with default workflow
+    client._events.emit('postworkflow', this._root);
+
     this._events.on('*', event => this._createNextIfNecessary(event));
     this._events.on('loading', event => this._setActive(event.workflow));
     this._events.on('destroy', () => this._requestEmitAfterDestroy());
@@ -67,6 +69,7 @@ export default class Asks extends WorkflowContext {
     let workflow = this._byPqid.get(parentQuestionId);
     if (!workflow && autoCreate) {
       workflow = new Ask(this, parentQuestionId);
+      this._client._events.emit('postworkflow', workflow);
     }
     return workflow;
   }

package/src/workflow/processors.js

@@ -302,7 +302,7 @@ export function carryOverQuestionIdToData(data, oldData) {
 
 // interactions //
 export function buildBaseInteraction(args) {
-  const { role, type, items } = args;
+  const { role, type, items, ...rest } = args;
   const payload = {
     type: type === 'viewable' ? 'viewable_impression' : type,
     context: {
@@ -333,6 +333,11 @@ export function buildBaseInteraction(args) {
       payload.type = 'custom';
       payload.custom_action_name = 'heartbeat';
       break;
+    case EVENT_TYPE.GENERIC_CLICK:
+      payload.type = 'custom';
+      payload.custom_action_name = 'generic_click';
+      payload.context.custom_context.href = args.href;
+      break;
   }
 
   return trimObj(payload);

package/src/workflow/units.js

@@ -16,7 +16,7 @@ export default class UnitWorkflowContext extends WorkflowContext {
     if (this._members.has(unitId)) {
       throw new Error(`Unit already exists: ${unitId}`);
     }
-    return this._create(unitId);
+    return this._createAndEmit(unitId);
   }
 
   has(unitId = DEFAULT_UNIT_ID) {
@@ -27,7 +27,13 @@ export default class UnitWorkflowContext extends WorkflowContext {
     if (typeof unitId !== 'string') {
       throw new Error(`Required unit ID to be a string: ${unitId}`);
     }
-    return this._members.get(unitId) || this._create(unitId);
+    return this._members.get(unitId) || this._createAndEmit(unitId);
+  }
+
+  _createAndEmit(unitId) {
+    const workflow = this._create(unitId);
+    this._client._events.emit('postworkflow', workflow);
+    return workflow;
   }
 
   _create(unitId) {