@miso.ai/client-sdk-ui 1.13.0-beta.4 → 1.13.0-beta.6

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/defaults/hybrid-search/phrases.js

@@ -22,6 +22,6 @@ const keywords = exports.keywords = 'You searched for “${value}”';
 /**
  * The phrase to display <miso-total>
  */
-const total = exports.total = '${value} Results';
+const total = exports.total = '${value}';
 const showMore = exports.showMore = 'Show more';
 const showLess = exports.showLess = 'Show less';

package/dist/cjs/layout/text/text.js

@@ -11,9 +11,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 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; }
 const TYPE = 'text';
 const DEFAULT_CLASSNAME = 'miso-text';
-function root(layout, {
-  value
-}) {
+function root(layout, state) {
   const {
     className,
     role,
@@ -23,8 +21,13 @@ function root(layout, {
     }
   } = layout;
   const roleAttr = role ? `data-role="${role}"` : '';
-  const content = value !== undefined ? (0, _commons.escapeHtml)(getFormatFunction(layout)(value)) : '';
-  return raw ? content : `<${tag} class="${className}" ${roleAttr}>${content}</${tag}>`;
+  const text = layout.templates.content(layout, state);
+  return raw ? text : `<${tag} class="${className}" ${roleAttr}>${text}</${tag}>`;
+}
+function content(layout, {
+  value
+}) {
+  return value !== undefined ? (0, _commons.escapeHtml)(getFormatFunction(layout)(value)) : '';
 }
 function getFormatFunction(layout) {
   let {
@@ -55,7 +58,8 @@ function getFormatFunction(layout) {
   }
 }
 const DEFAULT_TEMPLATES = Object.freeze({
-  root
+  root,
+  content
 });
 class TextLayout extends _template.default {
   static get type() {

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.4';
+var _default = exports.default = '1.13.0-beta.6';

package/dist/cjs/workflow/explore.js

@@ -187,6 +187,7 @@ class Explore extends _unit.default {
     }));
   }
   _getSubmitUrl(args) {
+    // TODO: if trending_questions -> qs = '_trending'
     let url = _useLink.UseLinkMixin.prototype._getSubmitUrl.call(this, args);
     if (!args.generated || !this._productId) {
       return url;

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/search-based.js

@@ -22,6 +22,19 @@ const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAUL
     rows: DEFAULT_ROWS
   })
 }));
+function totalContent(layout, {
+  value
+}) {
+  if (value === undefined) {
+    return '';
+  }
+  const {
+    formatNumber
+  } = layout.templates.helpers;
+  const formatted = formatNumber(value);
+  const label = value === 1 ? 'result' : 'results';
+  return `${formatted} ${label}`;
+}
 const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LAYOUTS, {
   [_constants.ROLE.QUERY]: [_index2.SearchBoxLayout.type],
   [_constants.ROLE.PRODUCTS]: [_index2.ListLayout.type, {
@@ -33,7 +46,9 @@ const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LA
   }],
   [_constants.ROLE.TOTAL]: [_index2.TextLayout.type, {
     raw: true,
-    format: 'number'
+    templates: {
+      content: totalContent
+    }
   }],
   [_constants.ROLE.FACETS]: [_index2.FacetsLayout.type],
   [_constants.ROLE.SORT]: [_index2.SelectLayout.type],

package/package.json

@@ -16,7 +16,11 @@
     "build:cjs": "BABEL_ENV=cjs npx babel src --root-mode upward --out-dir dist/cjs",
     "build": "npm run build:clean && npm run build:cjs"
   },
-  "repository": "MisoAI/miso-client-js-sdk",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MisoAI/miso-client-js-sdk.git",
+    "directory": "packages/client-sdk-ui"
+  },
   "homepage": "https://misoai.github.io/miso-client-js-sdk/sdk",
   "license": "MIT",
   "contributors": [
@@ -26,7 +30,7 @@
     "url": "https://github.com/MisoAI/miso-client-js-sdk/issues"
   },
   "dependencies": {
-    "@miso.ai/commons": "1.13.0-beta.4"
+    "@miso.ai/commons": "1.13.0-beta.6"
   },
-  "version": "1.13.0-beta.4"
+  "version": "1.13.0-beta.6"
 }

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/defaults/hybrid-search/phrases.js

@@ -16,7 +16,7 @@ export const keywords = 'You searched for “${value}”';
 /**
  * The phrase to display <miso-total>
  */
-export const total = '${value} Results';
+export const total = '${value}';
 
 export const showMore = 'Show more';
 export const showLess = 'Show less';

package/src/layout/text/text.js

@@ -4,11 +4,15 @@ import TemplateBasedLayout from '../template.js';
 const TYPE = 'text';
 const DEFAULT_CLASSNAME = 'miso-text';
 
-function root(layout, { value }) {
+function root(layout, state) {
   const { className, role, options: { raw = false, tag } } = layout;
   const roleAttr = role ? `data-role="${role}"` : '';
-  const content = value !== undefined ? escapeHtml(getFormatFunction(layout)(value)) : '';
-  return raw ? content : `<${tag} class="${className}" ${roleAttr}>${content}</${tag}>`;
+  const text = layout.templates.content(layout, state);
+  return raw ? text : `<${tag} class="${className}" ${roleAttr}>${text}</${tag}>`;
+}
+
+function content(layout, { value }) {
+  return value !== undefined ? escapeHtml(getFormatFunction(layout)(value)) : '';
 }
 
 function getFormatFunction(layout) {
@@ -37,6 +41,7 @@ function getFormatFunction(layout) {
 
 const DEFAULT_TEMPLATES = Object.freeze({
   root,
+  content,
 });
 
 export default class TextLayout extends TemplateBasedLayout {

package/src/version.js

@@ -1 +1 @@
-export default '1.13.0-beta.4';
+export default '1.13.0-beta.6';

package/src/workflow/explore.js

@@ -170,6 +170,7 @@ export default class Explore extends UnitWorkflow {
   }
 
   _getSubmitUrl(args) {
+    // TODO: if trending_questions -> qs = '_trending'
     let url = UseLinkMixin.prototype._getSubmitUrl.call(this, args);
     if (!args.generated || !this._productId) {
       return url;

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/search-based.js

@@ -20,12 +20,22 @@ const DEFAULT_API_OPTIONS = Object.freeze({
   },
 });
 
+function totalContent(layout, { value }) {
+  if (value === undefined) {
+    return '';
+  }
+  const { formatNumber } = layout.templates.helpers;
+  const formatted = formatNumber(value);
+  const label = value === 1 ? 'result' : 'results';
+  return `${formatted} ${label}`;
+}
+
 const DEFAULT_LAYOUTS = Object.freeze({
   ...Workflow.DEFAULT_LAYOUTS,
   [ROLE.QUERY]: [SearchBoxLayout.type],
   [ROLE.PRODUCTS]: [ListLayout.type, { incremental: true, infiniteScroll: true }],
   [ROLE.KEYWORDS]: [TextLayout.type, { raw: true }],
-  [ROLE.TOTAL]: [TextLayout.type, { raw: true, format: 'number' }],
+  [ROLE.TOTAL]: [TextLayout.type, { raw: true, templates: { content: totalContent } }],
   [ROLE.FACETS]: [FacetsLayout.type],
   [ROLE.SORT]: [SelectLayout.type],
   [ROLE.MORE]: [MoreButtonLayout.type],