@miso.ai/client-sdk-core 1.13.0 → 1.13.1-beta.1

package/dist/cjs/api/ask.js

@@ -65,11 +65,14 @@ class Ask extends _base.default {
   async searchAutocomplete(payload, options) {
     return this._run(NAME.SEARCH_AUTOCOMPLETE, payload, options);
   }
+  async querySuggestion(payload, options) {
+    return this._run(NAME.QUERY_SUGGESTION, payload, options);
+  }
 }
 exports.default = Ask;
 class Answer extends _iterable.IdBasedIterableApiStub {
   constructor(api, response, options = {}) {
-    super(api, '_questionGet', response.question_id, options);
+    super(api, '_questionGet', response.question_id, mergeCustomApiIterator(api, options));
     this._response = response;
   }
   get questionId() {
@@ -78,7 +81,7 @@ class Answer extends _iterable.IdBasedIterableApiStub {
 }
 class SearchResult extends _iterable.IdBasedIterableApiStub {
   constructor(api, response, options = {}) {
-    super(api, '_searchGet', response.question_id, options);
+    super(api, '_searchGet', response.question_id, mergeCustomApiIterator(api, options));
     (0, _commons.defineValues)(this, response);
     this._response = response;
   }
@@ -90,4 +93,10 @@ class SearchResult extends _iterable.IdBasedIterableApiStub {
 // helpers //
 function isId(value) {
   return typeof value === 'string' && value.charAt(0) !== '{';
+}
+function mergeCustomApiIterator(api, options) {
+  const customIterator = api.helpers._root._customApiIterator;
+  return (0, _commons.trimObj)(Object.assign({
+    customIterator
+  }, options));
 }

package/dist/cjs/api/helpers.js

@@ -6,35 +6,41 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../constants.js");
+const _excluded = ["method", "headers", "timeout"];
+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; }
 class ApiHelpers {
   constructor(client, root) {
     this._client = client;
     this._root = root;
     this._bulk = new _commons.Bulk(this._runBulkFetch.bind(this), client._error.bind(client));
   }
-  async fetch(url, payload, {
-    method = 'POST',
-    headers,
-    timeout
-  } = {}) {
+  async fetch(url, payload, _ref = {}) {
+    let {
+        method = 'POST',
+        headers,
+        timeout
+      } = _ref,
+      options = _objectWithoutPropertiesLoose(_ref, _excluded);
     const {
       apiKey,
       request = {}
     } = this._client.options;
     timeout = timeout || request.timeout;
 
-    // TODO: external abort signal
     // TODO: organize arguments
     const body = method !== 'GET' && payload != undefined ? JSON.stringify(payload) : undefined;
+
+    // TODO: merge signal from options if any
     const signal = timeout ? AbortSignal.timeout(timeout) : undefined;
-    const res = await (this._root._customFetch || window.fetch)(url, (0, _commons.trimObj)({
+    const res = await (this._root._customFetch || fetch)(url, (0, _commons.trimObj)(Object.assign({
       method,
       headers,
-      body,
       cache: 'no-cache',
-      mode: 'cors',
-      signal
-    }));
+      mode: 'cors'
+    }, options, {
+      signal,
+      body
+    })));
     const resBody = await res.json();
     if (res.status >= 400 || resBody.errors) {
       var err = new Error(resBody.message);
@@ -102,7 +108,10 @@ class ApiHelpers {
     if (method && method !== 'POST') {
       throw new Error(`Non-POST API is not supported in useBeacon mode: ${url}`);
     }
-    const successful = this._root._customSendBeacon ? this._root._customSendBeacon(url, JSON.stringify(payload)) : window.navigator.sendBeacon(url, JSON.stringify(payload));
+    if (!this._root._customSendBeacon && !navigator.sendBeacon) {
+      throw new Error(`Send beacon is not supported in this environment.`);
+    }
+    const successful = this._root._customSendBeacon ? this._root._customSendBeacon(url, JSON.stringify(payload)) : navigator.sendBeacon(url, JSON.stringify(payload));
     if (!successful) {
       throw new Error(`Send beacon unsuccessful: ${url}`);
     }
@@ -113,7 +122,7 @@ class ApiHelpers {
     } = this._client.options;
     const apiName = paths.filter(s => s).join('/');
     const url = `${this.getApiEndpoint(apiName)}/${apiName}`;
-    return `${url}?api_key=${window.encodeURIComponent(apiKey)}`;
+    return `${url}?api_key=${encodeURIComponent(apiKey)}`;
   }
   getApiEndpoint(apiName) {
     const {

package/dist/cjs/api/iterable.js

@@ -27,8 +27,11 @@ class IterableApiStub {
     } = {}) => {
       // TODO: pass signal
       const response = await this.get();
-      return [response, this._isFinished(response), this._revisionOf(response)];
+      return [response, isFinished(response), revisionOf(response)];
     };
+    if (typeof this._options.customIterator === 'function') {
+      return this._options.customIterator.call(this, fetch);
+    }
     let _this$_options = this._options,
       {
         pollingInterval: interval,
@@ -42,7 +45,7 @@ class IterableApiStub {
     const onResponse = (response, finished) => {
       if (finished) {
         stac.clear();
-      } else if (this._isUpdated(prevResponse, response)) {
+      } else if (isUpdated(prevResponse, response)) {
         stac.touch();
       }
       prevResponse = response;
@@ -53,15 +56,6 @@ class IterableApiStub {
       onResponse
     }, options))[Symbol.asyncIterator]();
   }
-  _isFinished(response) {
-    return !!(response && response.finished);
-  }
-  _isUpdated(previousResponse, newResponse) {
-    return !previousResponse || previousResponse.answer_stage !== newResponse.answer_stage || lengthOf(previousResponse.answer) !== lengthOf(newResponse.answer) || lengthOf(previousResponse.reasoning) !== lengthOf(newResponse.reasoning);
-  }
-  _revisionOf(response) {
-    return response && response.revision;
-  }
 }
 exports.IterableApiStub = IterableApiStub;
 class IdBasedIterableApiStub extends IterableApiStub {
@@ -76,6 +70,15 @@ class IdBasedIterableApiStub extends IterableApiStub {
   }
 }
 exports.IdBasedIterableApiStub = IdBasedIterableApiStub;
+function isFinished(response) {
+  return !!(response && response.finished);
+}
+function isUpdated(previousResponse, newResponse) {
+  return !previousResponse || previousResponse.answer_stage !== newResponse.answer_stage || lengthOf(previousResponse.answer) !== lengthOf(newResponse.answer) || lengthOf(previousResponse.reasoning) !== lengthOf(newResponse.reasoning);
+}
+function revisionOf(response) {
+  return response && response.revision;
+}
 function lengthOf(value = '') {
   return value.length;
 }

package/dist/cjs/client.js

@@ -11,11 +11,13 @@ var _context = _interopRequireDefault(require("./context.js"));
 var helpers = _interopRequireWildcard(require("./utils.js"));
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const {
-  currentScript
-} = document;
+const currentScript = _commons.isInBrowser ? document.currentScript : undefined;
 class MisoClient extends _commons.Component {
   static attach() {
+    if (typeof window === 'undefined') {
+      console.warn(`MisoClient cannot be attached in non-browser environment.`);
+      return;
+    }
     (window.MisoClients || (window.MisoClients = [])).push(MisoClient);
     if (window.MisoClient) {
       if (window.MisoClient !== MisoClient) {
@@ -62,6 +64,10 @@ class MisoClient extends _commons.Component {
     delete options.apiHost;
     return (0, _commons.trimObj)(options);
   }
+
+  /**
+   * Used by shopify plugin.
+   */
   _readConfigFromScriptUrl() {
     const url = currentScript.src || currentScript.href; // might be <link> as well
     const params = new URL(new Request(url).url).searchParams;

package/dist/cjs/plugin/analytics.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
-function _objectDestructuringEmpty(t) { if (null == t) throw new TypeError("Cannot destructure " + t); }
+function _objectDestructuringEmpty(t) { if (null == t) throw new TypeError("Cannot destructure " + t); } // [browser only]
 const PLUGIN_ID = 'std:analytics';
 class AnalyticsPlugin extends _commons.Component {
   static get id() {
@@ -25,8 +25,10 @@ class AnalyticsPlugin extends _commons.Component {
       //member.config(options);
     }
   }
-  install(MisoClient, context) {
-    context.addSubtree(this);
+  install(MisoClient, {
+    addSubtree
+  }) {
+    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?
@@ -136,6 +138,12 @@ class Analytics {
     this._loadingAt = undefined;
     this._readyAt = undefined;
     this.config();
+    this._engagedSeconds = 0;
+    this._engagementInterval = setInterval(() => {
+      if (this._plugin._engagement.engaged && this._readyAt) {
+        this._engagedSeconds += 1;
+      }
+    }, 1000);
   }
   _injectWorkflow(workflow) {
     this._listenToLiftcycleEvents(workflow);
@@ -163,6 +171,7 @@ class Analytics {
     this._startAt = Date.now();
     this._loadingAt = undefined;
     this._readyAt = undefined;
+    this._engagedSeconds = 0;
   }
   _handleLoading({
     session
@@ -190,7 +199,8 @@ class Analytics {
           analytics_timestamp: state.timestamp,
           user_engagement_time: state.userEngagementTime,
           user_idle_time: state.userIdleTime,
-          user_waiting_time: state.userWaitingTime
+          user_waiting_time: state.userWaitingTime,
+          user_engagement_time_v2: state.userEngagementTimeV2
         }
       }
     });
@@ -208,6 +218,7 @@ class Analytics {
     let userEngagementTime = 0,
       userIdleTime = 0,
       userWaitingTime = 0;
+    let userEngagementTimeV2 = this._engagedSeconds * 1000;
     if (loadingAt !== undefined) {
       userWaitingTime = currentTime - loadingAt;
     }
@@ -220,7 +231,8 @@ class Analytics {
       timestamp: currentTime,
       userWaitingTime,
       userEngagementTime,
-      userIdleTime
+      userIdleTime,
+      userEngagementTimeV2
     });
   }
   _syncEngagementState() {

package/dist/cjs/plugin/context.js

@@ -114,7 +114,7 @@ function getAutoAnonymousId() {
   // 1. Cache the value for the page
   // 2. Get and set the value from cookies/localStorage is possible
   // 3. In case cookies/localStorage are disabled, generate a new value for each page
-  return _pageBasedAutoAnonymousId || (_pageBasedAutoAnonymousId = (0, _commons.getOrComputeFromStorage)('miso_anonymous_id', _commons.uuidv4));
+  return _pageBasedAutoAnonymousId || (_pageBasedAutoAnonymousId = _commons.isInBrowser ? (0, _commons.getOrComputeFromStorage)('miso_anonymous_id', _commons.uuidv4) : (0, _commons.uuidv4)());
 }
 class ClientContext {
   constructor(plugin) {

package/dist/cjs/plugin/native-fetch.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _commons = require("@miso.ai/commons");
 const PLUGIN_ID = 'std:native-fetch';
 function isNativeFunction(fn) {
   return fn.toString().indexOf("[native code]") > -1;
@@ -11,6 +12,9 @@ function isNativeFunction(fn) {
 let _fetchSource;
 let _fetchError;
 const fetchFn = (() => {
+  if (!_commons.isInBrowser) {
+    return undefined;
+  }
   if (isNativeFunction(window.fetch)) {
     _fetchSource = 'original';
     return window.fetch;
@@ -32,6 +36,10 @@ class NativeFetchPlugin {
     return PLUGIN_ID;
   }
   install(MisoClient, context) {
+    if (!_commons.isInBrowser) {
+      MisoClient.debug(`<plugin:${PLUGIN_ID}>`, '[info]', `Not in browser, skipped`);
+      return;
+    }
     if (!fetchFn) {
       MisoClient.debug(`<plugin:${PLUGIN_ID}>`, '[error]', `Failed to obtain native fetch: ${_fetchError.message}`);
       return;

package/dist/cjs/plugin/page-info.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
+// [browser only]
+
 const ID = 'std:page-info';
 class PageInfoPlugin {
   static get id() {

package/dist/cjs/plugin/plugin-root.js

@@ -16,7 +16,6 @@ class PluginRoot extends _commons.Registry {
       keyName: 'id'
     });
     this._root = root;
-    this._currentScript = document.currentScript;
     this._events._replays.add('install').add('subtree');
     this._installed = {};
     this._installedResolutions = {};
@@ -86,6 +85,9 @@ class PluginRoot extends _commons.Registry {
     this._subtrees.push(component);
     this._events.emit('subtree', component);
   }
+  addExtensionPoints(obj) {
+    (0, _commons.defineValues)(this.context, obj);
+  }
   addPayloadPass(pass) {
     if (typeof pass !== 'function') {
       throw new Error(`Expect parameter to be a function: ${pass}`);
@@ -116,6 +118,12 @@ class PluginRoot extends _commons.Registry {
     }
     this._root._customSendBeacon = sendBeacon;
   }
+  setCustomApiIterator(customApiIterator) {
+    if (typeof customApiIterator !== 'function') {
+      throw new Error(`Expect parameter to be a function: ${customApiIterator}`);
+    }
+    this._root._customApiIterator = customApiIterator;
+  }
   onHubUpdate(callback) {
     if (typeof callback !== 'function') {
       throw new Error(`Expect parameter to be a function: ${callback}`);
@@ -199,7 +207,7 @@ class PluginRoot extends _commons.Registry {
     }
   }
   async _tryRegisterRemotely(id) {
-    if (id.startsWith('std:')) {
+    if (id.startsWith('std:') && _commons.isInBrowser) {
       try {
         await this._registerStdRemotely(id);
         return;
@@ -210,6 +218,11 @@ class PluginRoot extends _commons.Registry {
     // TODO: try as URL
     throw new Error(`Cannot register plugin remotely: ${id}`);
   }
+
+  /**
+   * [browser only]
+   * @param {string} id
+   */
   async _registerStdRemotely(id) {
     const {
       version
@@ -221,7 +234,7 @@ class PluginRoot extends _commons.Registry {
       // skip if already exists
       const script = document.createElement('script');
       script.async = true;
-      script.src = (0, _urls.getPluginScriptUrl)(id, version, this._currentScript);
+      script.src = (0, _urls.getPluginScriptUrl)(id, version);
       script.setAttribute('data-request', request);
       document.head.appendChild(script);
       // TODO: hook up error event
@@ -232,14 +245,15 @@ class PluginRoot extends _commons.Registry {
     !this.isRegistered(id) && this.register(Plugin);
   }
 }
+exports.default = PluginRoot;
+const PLUGIN_QUERY_METHODS = ['installed', 'registered', 'isInstalled', 'isRegistered', 'whenInstalled', 'whenRegistered'];
 
 /**
  * The interface of extended features only for plugin developers.
  */
-exports.default = PluginRoot;
 class PluginContext {
   constructor(root, classes) {
-    (0, _commons.delegateGetters)(this, root, ['getPluginClass', 'addSubtree', 'addPayloadPass', 'addHeadersPass', 'addUrlPass', 'setCustomFetch', 'setCustomSendBeacon', 'onHubUpdate', 'onHubEmit', 'whenInstalled', 'whenRegistered']);
+    (0, _commons.delegateGetters)(this, root, [...PLUGIN_QUERY_METHODS, 'getPluginClass', 'addSubtree', 'addExtensionPoints', 'addPayloadPass', 'addHeadersPass', 'addUrlPass', 'setCustomFetch', 'setCustomSendBeacon', 'setCustomApiIterator', 'onHubUpdate', 'onHubEmit']);
     (0, _commons.defineValues)(this, {
       classes
     });
@@ -251,6 +265,6 @@ class PluginContext {
  */
 class Plugins {
   constructor(root) {
-    (0, _commons.delegateGetters)(this, root, ['installed', 'registered', 'isInstalled', 'isRegistered', 'whenInstalled', 'whenRegistered', 'get', 'register', 'use', 'install']);
+    (0, _commons.delegateGetters)(this, root, [...PLUGIN_QUERY_METHODS, 'get', 'register', 'use', 'install']);
   }
 }

package/dist/cjs/plugin/urls.js

@@ -4,10 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getPluginScriptUrl = getPluginScriptUrl;
-function getPluginScriptUrl(id, version, currentScript) {
+var _commons = require("@miso.ai/commons");
+const currentScript = _commons.isInBrowser ? document.currentScript : undefined;
+function getPluginScriptUrl(id, version) {
   // TODO: look up by manifest
   const pkgName = id.slice(4);
   if (version === 'dev') {
+    if (!currentScript) {
+      throw new Error(`Cannot get plugin script URL for ${id}: no currentScript.`);
+    }
     const src = currentScript.src;
     const searchIndex = src.indexOf('?');
     const k = searchIndex < 0 ? src.length : searchIndex;

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';
+var _default = exports.default = '1.13.1-beta.1';

package/package.json

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

package/src/api/ask.js

@@ -1,4 +1,4 @@
-import { API, defineValues } from '@miso.ai/commons';
+import { API, defineValues, trimObj } from '@miso.ai/commons';
 import ApiBase from './base.js';
 import { IdBasedIterableApiStub } from './iterable.js';
 
@@ -60,12 +60,16 @@ export default class Ask extends ApiBase {
     return this._run(NAME.SEARCH_AUTOCOMPLETE, payload, options);
   }
 
+  async querySuggestion(payload, options) {
+    return this._run(NAME.QUERY_SUGGESTION, payload, options);
+  }
+
 }
 
 class Answer extends IdBasedIterableApiStub {
 
   constructor(api, response, options = {}) {
-    super(api, '_questionGet', response.question_id, options);
+    super(api, '_questionGet', response.question_id, mergeCustomApiIterator(api, options));
     this._response = response;
   }
 
@@ -78,7 +82,7 @@ class Answer extends IdBasedIterableApiStub {
 class SearchResult extends IdBasedIterableApiStub {
 
   constructor(api, response, options = {}) {
-    super(api, '_searchGet', response.question_id, options);
+    super(api, '_searchGet', response.question_id, mergeCustomApiIterator(api, options));
     defineValues(this, response);
     this._response = response;
   }
@@ -93,3 +97,11 @@ class SearchResult extends IdBasedIterableApiStub {
 function isId(value) {
   return typeof value === 'string' && value.charAt(0) !== '{';
 }
+
+function mergeCustomApiIterator(api, options) {
+  const customIterator = api.helpers._root._customApiIterator;
+  return trimObj({
+    customIterator,
+    ...options,
+  });
+}

package/src/api/helpers.js

@@ -13,23 +13,25 @@ export default class ApiHelpers {
     method = 'POST',
     headers,
     timeout,
+    ...options
   } = {}) {
     const { apiKey, request = {} } = this._client.options;
     timeout = timeout || request.timeout;
 
-    // TODO: external abort signal
     // TODO: organize arguments
     const body = method !== 'GET' && payload != undefined ? JSON.stringify(payload) : undefined;
 
+    // TODO: merge signal from options if any
     const signal = timeout ? AbortSignal.timeout(timeout) : undefined;
 
-    const res = await (this._root._customFetch || window.fetch)(url, trimObj({
+    const res = await (this._root._customFetch || fetch)(url, trimObj({
       method,
       headers,
-      body,
       cache: 'no-cache',
       mode: 'cors',
+      ...options,
       signal,
+      body,
     }));
 
     const resBody = await res.json();
@@ -78,9 +80,12 @@ export default class ApiHelpers {
     if (method && method !== 'POST') {
       throw new Error(`Non-POST API is not supported in useBeacon mode: ${url}`);
     }
+    if (!this._root._customSendBeacon && !navigator.sendBeacon) {
+      throw new Error(`Send beacon is not supported in this environment.`);
+    }
     const successful = this._root._customSendBeacon ?
       this._root._customSendBeacon(url, JSON.stringify(payload)) :
-      window.navigator.sendBeacon(url, JSON.stringify(payload));
+      navigator.sendBeacon(url, JSON.stringify(payload));
     if (!successful) {
       throw new Error(`Send beacon unsuccessful: ${url}`);
     }
@@ -90,7 +95,7 @@ export default class ApiHelpers {
     const { apiKey } = this._client.options;
     const apiName = paths.filter(s => s).join('/');
     const url = `${this.getApiEndpoint(apiName)}/${apiName}`;
-    return `${url}?api_key=${window.encodeURIComponent(apiKey)}`;
+    return `${url}?api_key=${encodeURIComponent(apiKey)}`;
   }
 
   getApiEndpoint(apiName) {

package/src/api/iterable.js

@@ -23,8 +23,13 @@ export class IterableApiStub {
     const fetch = async ({ signal } = {}) => {
       // TODO: pass signal
       const response = await this.get();
-      return [response, this._isFinished(response), this._revisionOf(response)];
+      return [response, isFinished(response), revisionOf(response)];
     };
+
+    if (typeof this._options.customIterator === 'function') {
+      return this._options.customIterator.call(this, fetch);
+    }
+
     let { pollingInterval: interval, signal, stallTimeout = 120000, ...options } = this._options;
     const stac = new StallTimeoutAbortController(stallTimeout);
     signal = signals.any(this._ac.signal, stac.signal, signal);
@@ -33,7 +38,7 @@ export class IterableApiStub {
     const onResponse = (response, finished) => {
       if (finished) {
         stac.clear();
-      } else if (this._isUpdated(prevResponse, response)) {
+      } else if (isUpdated(prevResponse, response)) {
         stac.touch();
       }
       prevResponse = response;
@@ -41,21 +46,6 @@ export class IterableApiStub {
     return polling(fetch, { interval, signal, onResponse, ...options })[Symbol.asyncIterator]();
   }
 
-  _isFinished(response) {
-    return !!(response && response.finished);
-  }
-
-  _isUpdated(previousResponse, newResponse) {
-    return !previousResponse ||
-      previousResponse.answer_stage !== newResponse.answer_stage ||
-      lengthOf(previousResponse.answer) !== lengthOf(newResponse.answer) ||
-      lengthOf(previousResponse.reasoning) !== lengthOf(newResponse.reasoning);
-  }
-
-  _revisionOf(response) {
-    return response && response.revision;
-  }
-
 }
 
 export class IdBasedIterableApiStub extends IterableApiStub {
@@ -73,6 +63,21 @@ export class IdBasedIterableApiStub extends IterableApiStub {
 
 }
 
+function isFinished(response) {
+  return !!(response && response.finished);
+}
+
+function isUpdated(previousResponse, newResponse) {
+  return !previousResponse ||
+    previousResponse.answer_stage !== newResponse.answer_stage ||
+    lengthOf(previousResponse.answer) !== lengthOf(newResponse.answer) ||
+    lengthOf(previousResponse.reasoning) !== lengthOf(newResponse.reasoning);
+}
+
+function revisionOf(response) {
+  return response && response.revision;
+}
+
 function lengthOf(value = '') {
   return value.length;
 }

package/src/client.js

@@ -1,14 +1,18 @@
-import { trimObj, Component, uuidv4, defineValues } from '@miso.ai/commons';
+import { trimObj, Component, uuidv4, defineValues, isInBrowser } from '@miso.ai/commons';
 import { root, register, init } from './root.js';
 import { Api } from './api/index.js';
 import Context from './context.js';
 import * as helpers from './utils.js';
 
-const { currentScript } = document;
+const currentScript = isInBrowser ? document.currentScript : undefined;
 
 class MisoClient extends Component {
 
   static attach() {
+    if (typeof window === 'undefined') {
+      console.warn(`MisoClient cannot be attached in non-browser environment.`);
+      return;
+    }
     (window.MisoClients || (window.MisoClients = [])).push(MisoClient);
     if (window.MisoClient) {
       if (window.MisoClient !== MisoClient) {
@@ -65,6 +69,9 @@ class MisoClient extends Component {
     return trimObj(options);
   }
 
+  /**
+   * Used by shopify plugin.
+   */
   _readConfigFromScriptUrl() {
     const url = currentScript.src || currentScript.href; // might be <link> as well
     const params = new URL(new Request(url).url).searchParams;

package/src/plugin/analytics.js

@@ -1,3 +1,5 @@
+// [browser only]
+
 import { Component, UserEngagementObserver, UserActivityObserver, Stopwatch, trimObj, mergeInteractions } from '@miso.ai/commons';
 
 const PLUGIN_ID = 'std:analytics';
@@ -24,8 +26,8 @@ export default class AnalyticsPlugin extends Component {
     }
   }
 
-  install(MisoClient, context) {
-    context.addSubtree(this);
+  install(MisoClient, { addSubtree }) {
+    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?
@@ -150,6 +152,13 @@ class Analytics {
     this._readyAt = undefined;
 
     this.config();
+
+    this._engagedSeconds = 0;
+    this._engagementInterval = setInterval(() => {
+      if (this._plugin._engagement.engaged && this._readyAt) {
+        this._engagedSeconds += 1;
+      }
+    }, 1000);
   }
 
   _injectWorkflow(workflow) {
@@ -183,6 +192,8 @@ class Analytics {
     this._startAt = Date.now();
     this._loadingAt = undefined;
     this._readyAt = undefined;
+
+    this._engagedSeconds = 0;
   }
 
   _handleLoading({ session } = {}) {
@@ -209,6 +220,7 @@ class Analytics {
           user_engagement_time: state.userEngagementTime,
           user_idle_time: state.userIdleTime,
           user_waiting_time: state.userWaitingTime,
+          user_engagement_time_v2: state.userEngagementTimeV2,
         },
       },
     });
@@ -229,6 +241,7 @@ class Analytics {
     const loadingAt = this._loadingAt;
     const readyAt = this._readyAt;
     let userEngagementTime = 0, userIdleTime = 0, userWaitingTime = 0;
+    let userEngagementTimeV2 = this._engagedSeconds * 1000;
 
     if (loadingAt !== undefined) {
       userWaitingTime = currentTime - loadingAt;
@@ -244,6 +257,7 @@ class Analytics {
       userWaitingTime,
       userEngagementTime,
       userIdleTime,
+      userEngagementTimeV2,
     });
   }
 

package/src/plugin/context.js

@@ -1,4 +1,4 @@
-import { API, uuidv4, Component, delegateProperties, getOrComputeFromStorage, mergeInteractions, mergeApiPayloads } from '@miso.ai/commons';
+import { API, uuidv4, Component, delegateProperties, getOrComputeFromStorage, mergeInteractions, mergeApiPayloads, isInBrowser } from '@miso.ai/commons';
 
 const { GROUP, NAME } = API;
 
@@ -73,7 +73,7 @@ function getAutoAnonymousId() {
   // 1. Cache the value for the page
   // 2. Get and set the value from cookies/localStorage is possible
   // 3. In case cookies/localStorage are disabled, generate a new value for each page
-  return _pageBasedAutoAnonymousId || (_pageBasedAutoAnonymousId = getOrComputeFromStorage('miso_anonymous_id', uuidv4));
+  return _pageBasedAutoAnonymousId || (_pageBasedAutoAnonymousId = isInBrowser ? getOrComputeFromStorage('miso_anonymous_id', uuidv4) : uuidv4());
 }
 
 class ClientContext {

package/src/plugin/native-fetch.js

@@ -1,3 +1,5 @@
+import { isInBrowser } from '@miso.ai/commons';
+
 const PLUGIN_ID = 'std:native-fetch';
 
 function isNativeFunction(fn) {
@@ -8,6 +10,9 @@ let _fetchSource;
 let _fetchError;
 
 const fetchFn = (() => {
+  if (!isInBrowser) {
+    return undefined;
+  }
   if (isNativeFunction(window.fetch)) {
     _fetchSource = 'original';
     return window.fetch;
@@ -32,6 +37,10 @@ export default class NativeFetchPlugin {
   }
 
   install(MisoClient, context) {
+    if (!isInBrowser) {
+      MisoClient.debug(`<plugin:${PLUGIN_ID}>`, '[info]', `Not in browser, skipped`);
+      return;
+    }
     if (!fetchFn) {
       MisoClient.debug(`<plugin:${PLUGIN_ID}>`, '[error]', `Failed to obtain native fetch: ${_fetchError.message}`);
       return;

package/src/plugin/page-info.js

@@ -1,3 +1,5 @@
+// [browser only]
+
 import { trimObj } from '@miso.ai/commons';
 
 const ID = 'std:page-info';

package/src/plugin/plugin-root.js

@@ -1,4 +1,4 @@
-import { delegateGetters, defineValues, Registry, Resolution, Resources } from '@miso.ai/commons';
+import { isInBrowser, delegateGetters, defineValues, Registry, Resolution, Resources } from '@miso.ai/commons';
 import classes from '../classes.js';
 import AnonymousPlugin from './anonymous.js';
 import { getPluginScriptUrl } from './urls.js';
@@ -11,7 +11,6 @@ export default class PluginRoot extends Registry {
       keyName: 'id',
     });
     this._root = root;
-    this._currentScript = document.currentScript;
     this._events._replays.add('install').add('subtree');
     this._installed = {};
     this._installedResolutions = {};
@@ -87,6 +86,10 @@ export default class PluginRoot extends Registry {
     this._events.emit('subtree', component);
   }
 
+  addExtensionPoints(obj) {
+    defineValues(this.context, obj);
+  }
+
   addPayloadPass(pass) {
     if (typeof pass !== 'function') {
       throw new Error(`Expect parameter to be a function: ${pass}`);
@@ -122,6 +125,13 @@ export default class PluginRoot extends Registry {
     this._root._customSendBeacon = sendBeacon;
   }
 
+  setCustomApiIterator(customApiIterator) {
+    if (typeof customApiIterator !== 'function') {
+      throw new Error(`Expect parameter to be a function: ${customApiIterator}`);
+    }
+    this._root._customApiIterator = customApiIterator;
+  }
+
   onHubUpdate(callback) {
     if (typeof callback !== 'function') {
       throw new Error(`Expect parameter to be a function: ${callback}`);
@@ -210,7 +220,7 @@ export default class PluginRoot extends Registry {
   }
 
   async _tryRegisterRemotely(id) {
-    if (id.startsWith('std:')) {
+    if (id.startsWith('std:') && isInBrowser) {
       try {
         await this._registerStdRemotely(id);
         return;
@@ -222,6 +232,10 @@ export default class PluginRoot extends Registry {
     throw new Error(`Cannot register plugin remotely: ${id}`);
   }
 
+  /**
+   * [browser only]
+   * @param {string} id
+   */
   async _registerStdRemotely(id) {
     const { version } = this._root;
     const request = version === 'dev' ? `plugin:${id}@dev:${this.MisoClient.uuid}` : `plugin:${id}@${version}`;
@@ -231,7 +245,7 @@ export default class PluginRoot extends Registry {
       // skip if already exists
       const script = document.createElement('script');
       script.async = true;
-      script.src = getPluginScriptUrl(id, version, this._currentScript);
+      script.src = getPluginScriptUrl(id, version);
       script.setAttribute('data-request', request);
       document.head.appendChild(script);
       // TODO: hook up error event
@@ -244,13 +258,30 @@ export default class PluginRoot extends Registry {
 
 }
 
+const PLUGIN_QUERY_METHODS = [
+  'installed', 'registered', 'isInstalled', 'isRegistered', 'whenInstalled', 'whenRegistered'
+];
+
 /**
  * The interface of extended features only for plugin developers.
  */
 class PluginContext {
 
   constructor(root, classes) {
-    delegateGetters(this, root, ['getPluginClass', 'addSubtree', 'addPayloadPass', 'addHeadersPass', 'addUrlPass', 'setCustomFetch', 'setCustomSendBeacon', 'onHubUpdate', 'onHubEmit', 'whenInstalled', 'whenRegistered']);
+    delegateGetters(this, root, [
+      ...PLUGIN_QUERY_METHODS,
+      'getPluginClass',
+      'addSubtree',
+      'addExtensionPoints',
+      'addPayloadPass',
+      'addHeadersPass',
+      'addUrlPass',
+      'setCustomFetch',
+      'setCustomSendBeacon',
+      'setCustomApiIterator',
+      'onHubUpdate',
+      'onHubEmit',
+    ]);
     defineValues(this, { classes });
   }
 
@@ -262,7 +293,13 @@ class PluginContext {
  class Plugins {
 
   constructor(root) {
-    delegateGetters(this, root, ['installed', 'registered', 'isInstalled', 'isRegistered', 'whenInstalled', 'whenRegistered', 'get', 'register', 'use', 'install']);
+    delegateGetters(this, root, [
+      ...PLUGIN_QUERY_METHODS,
+      'get',
+      'register',
+      'use',
+      'install',
+    ]);
   }
 
 }

package/src/plugin/urls.js

@@ -1,8 +1,15 @@
-export function getPluginScriptUrl(id, version, currentScript) {
+import { isInBrowser } from '@miso.ai/commons';
+
+const currentScript = isInBrowser ? document.currentScript : undefined;
+
+export function getPluginScriptUrl(id, version) {
   // TODO: look up by manifest
   const pkgName = id.slice(4);
   
   if (version === 'dev') {
+    if (!currentScript) {
+      throw new Error(`Cannot get plugin script URL for ${id}: no currentScript.`);
+    }
     const src = currentScript.src;
     const searchIndex = src.indexOf('?');
     const k = searchIndex < 0 ? src.length : searchIndex;

package/src/version.js

@@ -1 +1 @@
-export default '1.13.0';
+export default '1.13.1-beta.1';