@miso.ai/client-sdk-core 1.13.0-beta.5 → 1.13.0-beta.6

package/dist/cjs/plugin/analytics.js

@@ -15,6 +15,7 @@ class AnalyticsPlugin extends _commons.Component {
     super('analytics');
     this._members = [];
     this._engagement = undefined;
+    this._activity = undefined;
   }
   config(options = {}) {
     this._options = options;
@@ -27,34 +28,94 @@ class AnalyticsPlugin extends _commons.Component {
   install(MisoClient, context) {
     context.addSubtree(this);
     this._engagement = new _commons.UserEngagementObserver(this._handleEngagement.bind(this));
+    this._activity = new _commons.UserActivityObserver(this._handleActivity.bind(this));
     // TODO: should we provide a way to stop the observer?
     window.addEventListener('beforeunload', this._handlePageExit.bind(this));
+    window.addEventListener('click', this._handleClick.bind(this, MisoClient));
     MisoClient.on('create', this._injectClient.bind(this));
   }
   _injectClient(client) {
     client.on('workflow', this._injectWorkflow.bind(this));
   }
   _injectWorkflow(workflow) {
-    if (!this._shallInjectWorkflow(workflow)) {
+    if (!shallApplyAnalytics(workflow)) {
       return;
     }
     workflow.analytics = new Analytics(this, workflow);
   }
-  _shallInjectWorkflow(workflow) {
-    return workflow._name === 'ask' && !workflow.previous || workflow._name === 'hybrid-search';
-  }
   _handleEngagement() {
     for (const member of this._members) {
       member._syncEngagementState();
     }
   }
+  _handleActivity(event) {
+    for (const member of this._members) {
+      member._sendHeartbeat();
+    }
+  }
   _handlePageExit() {
     for (const member of this._members) {
       member._sendHeartbeat();
     }
   }
+  _handleClick(MisoClient, event) {
+    // get the first client instance
+    const client = MisoClient.instances[0];
+    if (!client) {
+      return;
+    }
+    const workflow = getGenericClickWorkflow(this, event);
+    if (!workflow || !isDataReady(workflow)) {
+      return;
+    }
+    const href = getGenericClickHref(event);
+    if (!href) {
+      return;
+    }
+    workflow.trackers.container.genericClick({
+      href
+    });
+  }
 }
 exports.default = AnalyticsPlugin;
+function shallApplyAnalytics(workflow) {
+  return workflow._name === 'ask' && !workflow.previous || workflow._name === 'hybrid-search';
+}
+function getGenericClickWorkflow(plugin, event) {
+  // find the closet container
+  for (let element = event.target; element; element = element.parentElement) {
+    const {
+      role,
+      workflow
+    } = element;
+    if (role && !workflow) {
+      return undefined; // inside component, not a generic click
+    }
+    // if inside a container, we should use the container's workflow
+    if (workflow) {
+      return shallApplyAnalytics(workflow) ? workflow : undefined;
+    }
+  }
+
+  // fallback to default workflow
+  for (const member of plugin._members) {
+    const workflow = member._workflow;
+    if (shallApplyAnalytics(workflow)) {
+      return workflow;
+    }
+  }
+  return undefined;
+}
+function getGenericClickHref(event) {
+  const element = event.target.closest('[href]');
+  return element ? element.getAttribute('href') : undefined;
+}
+function isDataReady(workflow) {
+  const {
+    data = {}
+  } = workflow.states;
+  return data.status === 'ready';
+}
 function normalizeOptions(_ref = {}) {
   let options = Object.assign({}, (_objectDestructuringEmpty(_ref), _ref));
   return Object.assign({}, options);
@@ -169,5 +230,6 @@ class Analytics {
     } else {
       this._timer.stop();
     }
+    this._sendHeartbeat();
   }
 }

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.6';

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.6"
   },
-  "version": "1.13.0-beta.5"
+  "version": "1.13.0-beta.6"
 }

package/src/plugin/analytics.js

@@ -1,4 +1,4 @@
-import { Component, UserEngagementObserver, Stopwatch, trimObj, mergeInteractions } from '@miso.ai/commons';
+import { Component, UserEngagementObserver, UserActivityObserver, Stopwatch, trimObj, mergeInteractions } from '@miso.ai/commons';
 
 const PLUGIN_ID = 'std:analytics';
 
@@ -12,6 +12,7 @@ export default class AnalyticsPlugin extends Component {
     super('analytics');
     this._members = [];
     this._engagement = undefined;
+    this._activity = undefined;
   }
 
   config(options = {}) {
@@ -26,8 +27,10 @@ export default class AnalyticsPlugin extends Component {
   install(MisoClient, context) {
     context.addSubtree(this);
     this._engagement = new UserEngagementObserver(this._handleEngagement.bind(this));
+    this._activity = new UserActivityObserver(this._handleActivity.bind(this));
     // TODO: should we provide a way to stop the observer?
     window.addEventListener('beforeunload', this._handlePageExit.bind(this));
+    window.addEventListener('click', this._handleClick.bind(this, MisoClient));
     MisoClient.on('create', this._injectClient.bind(this));
   }
 
@@ -36,28 +39,85 @@ export default class AnalyticsPlugin extends Component {
   }
 
   _injectWorkflow(workflow) {
-    if (!this._shallInjectWorkflow(workflow)) {
+    if (!shallApplyAnalytics(workflow)) {
       return;
     }
     workflow.analytics = new Analytics(this, workflow);
   }
 
-  _shallInjectWorkflow(workflow) {
-    return (workflow._name === 'ask' && !workflow.previous) || workflow._name === 'hybrid-search';
-  }
-
   _handleEngagement() {
     for (const member of this._members) {
       member._syncEngagementState();
     }
   }
 
+  _handleActivity(event) {
+    for (const member of this._members) {
+      member._sendHeartbeat();
+    }
+  }
+
   _handlePageExit() {
     for (const member of this._members) {
       member._sendHeartbeat();
     }
   }
 
+  _handleClick(MisoClient, event) {
+    // get the first client instance
+    const client = MisoClient.instances[0];
+    if (!client) {
+      return;
+    }
+    const workflow = getGenericClickWorkflow(this, event);
+    if (!workflow || !isDataReady(workflow)) {
+      return;
+    }
+    const href = getGenericClickHref(event);
+    if (!href) {
+      return;
+    }
+    workflow.trackers.container.genericClick({ href });
+  }
+
+}
+
+function shallApplyAnalytics(workflow) {
+  return (workflow._name === 'ask' && !workflow.previous) || workflow._name === 'hybrid-search';
+}
+
+function getGenericClickWorkflow(plugin, event) {
+  // find the closet container
+  for (let element = event.target; element; element = element.parentElement) {
+    const { role, workflow } = element;
+    if (role && !workflow) {
+      return undefined; // inside component, not a generic click
+    }
+    // if inside a container, we should use the container's workflow
+    if (workflow) {
+      return shallApplyAnalytics(workflow) ? workflow : undefined;
+    }
+  }
+
+  // fallback to default workflow
+  for (const member of plugin._members) {
+    const workflow = member._workflow;
+    if (shallApplyAnalytics(workflow)) {
+      return workflow;
+    }
+  }
+
+  return undefined;
+}
+
+function getGenericClickHref(event) {
+  const element = event.target.closest('[href]');
+  return element ? element.getAttribute('href') : undefined;
+}
+
+function isDataReady(workflow) {
+  const { data = {} } = workflow.states;
+  return data.status === 'ready';
 }
 
 function normalizeOptions({ ...options } = {}) {
@@ -194,6 +254,8 @@ class Analytics {
     } else {
       this._timer.stop();
     }
+
+    this._sendHeartbeat();
   }
 
 }

package/src/version.js

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