@miso.ai/client-sdk-ui 1.9.4 → 1.9.5-beta.0

package/dist/cjs/actor/sessions.js

@@ -50,7 +50,8 @@ class SessionMaker {
     return Object.freeze({
       active: false,
       uuid: (0, _commons.uuidv4)(),
-      index: this._sessionIndex++
+      index: this._sessionIndex++,
+      meta: {}
     });
   }
 }

package/dist/cjs/actor/tracker.js

@@ -106,16 +106,24 @@ class Tracker {
     const state = this._getViewState();
     return state && state.meta && state.meta.miso_id || this._element && this._element.getAttribute('miso-id') || undefined;
   }
+  _getSessionMeta() {
+    const {
+      session
+    } = this._getViewState() || {};
+    return session && session.meta;
+  }
   getState(productId) {
     return this._tracker.getState(productId);
   }
   _handleEvent(data) {
     const property = this._role === 'results' ? 'products' : this._role; // TODO: ad-hoc, see #83
     const misoId = this._getMisoId();
+    const meta = this._getSessionMeta();
     // TODO: should trigger 'tracker' and let workflow translate to interactions
     this._hub.trigger(fields.interaction(), (0, _utils.toInteraction)({
       property,
-      misoId
+      misoId,
+      meta
     }, data));
   }
   _destroy() {

package/dist/cjs/actor/utils.js

@@ -16,7 +16,8 @@ function isProduct(property) {
 function toInteraction(_ref, _ref2) {
   let {
     property,
-    misoId
+    misoId,
+    meta
   } = _ref;
   let {
     event,
@@ -37,12 +38,12 @@ function toInteraction(_ref, _ref2) {
     product_ids,
     miso_id: misoId,
     context: {
-      custom_context: (0, _commons.trimObj)({
+      custom_context: (0, _commons.trimObj)(Object.assign({
         api_ts,
         property,
         items,
         trigger: manual ? 'manual' : 'auto'
-      })
+      }, meta))
     }
   });
 }

package/dist/cjs/version.js

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

package/dist/cjs/workflow/ask.js

@@ -10,7 +10,7 @@ var _options = require("./options.js");
 var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
 var _index2 = require("../layout/index.js");
-const _excluded = ["q"];
+const _excluded = ["q", "s"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 const DEFAULT_API_OPTIONS = Object.freeze({
@@ -116,7 +116,9 @@ class Ask extends _base.default {
       setValue = true,
       focus = true
     } = this._autoQuery = options;
-    const q = new URLSearchParams(window.location.search).get('q');
+    const searchParams = new URLSearchParams(window.location.search);
+    const q = searchParams.get('q');
+    const s = searchParams.get('s');
     const {
       layout
     } = this._views.get(_constants.ROLE.QUERY);
@@ -130,14 +132,16 @@ class Ask extends _base.default {
     }
     if (q) {
       this.query({
-        q
+        q,
+        s
       });
     }
   }
   query() {
     let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     let {
-        q: question
+        q: question,
+        s: source
       } = _ref,
       payload = _objectWithoutPropertiesLoose(_ref, _excluded);
     payload = Object.assign({}, payload, {
@@ -146,6 +150,9 @@ class Ask extends _base.default {
     if (this.parentQuestionId) {
       payload.parent_question_id = this.parentQuestionId;
     }
+    if (source) {
+      (payload._meta || (payload._meta = {})).question_source = source;
+    }
 
     // clear question id from previous session
     if (this._questionId) {
@@ -156,6 +163,9 @@ class Ask extends _base.default {
     const {
       session
     } = this;
+    if (source) {
+      session.meta.question_source = source;
+    }
     this._hub.update(_index.fields.request(), (0, _options.mergeApiOptions)(this._options.resolved.api, {
       payload,
       session
@@ -204,6 +214,7 @@ class Ask extends _base.default {
     if (this._autoQuery && this._autoQuery.updateUrl !== false) {
       const url = new URL(window.location);
       const currentQuestion = url.searchParams.get('q');
+      // TODO: review this, handle &s=
       if (question !== currentQuestion && (currentQuestion || this._autoQuery.updateUrl === true)) {
         url.searchParams.set('q', question);
         window.history.replaceState({}, '', url);
@@ -306,6 +317,7 @@ class Ask extends _base.default {
       questionId = parentQuestionId;
       parentQuestionId = this.previous && this.previous.parentQuestionId;
       custom_context.property = 'suggested_followup_questions';
+      // TODO: question_source
     }
     payload.context = Object.assign({}, context, {
       custom_context: (0, _commons.trimObj)(Object.assign({

package/dist/cjs/workflow/explore.js

@@ -52,6 +52,15 @@ class Explore extends _base.default {
       product_id: value
     });
   }
+  useApi(options) {
+    const {
+      product_id
+    } = options;
+    if (product_id) {
+      this._productId = product_id;
+    }
+    return super.useApi(options);
+  }
   useLink(fn) {
     if (typeof fn !== 'function' && fn !== false) {
       throw new Error('useLink(fn) expects fn to be a function or false');
@@ -95,7 +104,7 @@ class Explore extends _base.default {
     // patch value with links
     const related_questions = value.related_questions.map(this._linkFn ? text => ({
       text,
-      url: this._linkFn(text)
+      url: this._getAnswersUrl(text)
     }) : text => ({
       text
     }));
@@ -121,8 +130,17 @@ class Explore extends _base.default {
     if (!this._linkFn) {
       return;
     }
-    const url = this._linkFn(q);
+    const url = this._getAnswersUrl(q);
     window.open(url, '_blank');
   }
+  _getAnswersUrl(text) {
+    if (!this._linkFn) {
+      return;
+    }
+    const url = this._linkFn(text);
+    if (this._productId) {
+      return `${url}&s=${encodeURIComponent(this._productId)}`;
+    }
+  }
 }
 exports.default = Explore;

package/dist/cjs/workflow/options.js

@@ -135,9 +135,20 @@ function mergeApiOptions() {
     return false;
   }
   return mergeOptions(optionsList, (merged, options) => Object.assign(merged, Object.assign({}, options, {
-    payload: Object.assign({}, merged.payload, options.payload)
+    payload: mergeApiPayloads(merged.payload, options.payload)
   })));
 }
+function mergeApiPayloads(base, overrides) {
+  return Object.assign({}, base, overrides, mergeObjectValueIfPresent('_meta', base, overrides));
+}
+function mergeObjectValueIfPresent(key, base, overrides) {
+  const baseValue = base && base[key];
+  const overridesValue = overrides && overrides[key];
+  const value = baseValue ? overridesValue ? Object.assign({}, baseValue, overridesValue) : baseValue : overridesValue;
+  return value !== undefined ? {
+    [key]: value
+  } : {};
+}
 function mergeLayoutsOptions() {
   for (var _len2 = arguments.length, optionsList = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
     optionsList[_key2] = arguments[_key2];

package/package.json

@@ -26,7 +26,7 @@
     "url": "https://github.com/MisoAI/miso-client-js-sdk/issues"
   },
   "dependencies": {
-    "@miso.ai/commons": "1.9.4"
+    "@miso.ai/commons": "1.9.5-beta.0"
   },
-  "version": "1.9.4"
+  "version": "1.9.5-beta.0"
 }

package/src/actor/sessions.js

@@ -41,6 +41,7 @@ export default class SessionMaker {
       active: false,
       uuid: uuidv4(),
       index: this._sessionIndex++,
+      meta: {},
     });
   }
 

package/src/actor/tracker.js

@@ -101,6 +101,11 @@ export default class Tracker {
     return (state && state.meta && state.meta.miso_id) || (this._element && this._element.getAttribute('miso-id')) || undefined;
   }
 
+  _getSessionMeta() {
+    const { session } = this._getViewState() || {};
+    return session && session.meta;
+  }
+
   getState(productId) {
     return this._tracker.getState(productId);
   }
@@ -108,8 +113,9 @@ export default class Tracker {
   _handleEvent(data) {
     const property = this._role === 'results' ? 'products' : this._role; // TODO: ad-hoc, see #83
     const misoId = this._getMisoId();
+    const meta = this._getSessionMeta();
     // TODO: should trigger 'tracker' and let workflow translate to interactions
-    this._hub.trigger(fields.interaction(), toInteraction({ property, misoId }, data));
+    this._hub.trigger(fields.interaction(), toInteraction({ property, misoId, meta }, data));
   }
 
   _destroy() {

package/src/actor/utils.js

@@ -12,7 +12,7 @@ export function isProduct(property) {
   return PRODUCT_TYPED_PROPERTIES.has(property);
 }
 
-export function toInteraction({ property, misoId }, { event, values, manual }) {
+export function toInteraction({ property, misoId, meta }, { event, values, manual }) {
   let api_ts;
   if (misoId) {
     try {
@@ -32,6 +32,7 @@ export function toInteraction({ property, misoId }, { event, values, manual }) {
         property,
         items,
         trigger: manual ? 'manual' : 'auto',
+        ...meta,
       }),
     },
   });

package/src/version.js

@@ -1 +1 @@
-export default '1.9.4';
+export default '1.9.5-beta.0';

package/src/workflow/ask.js

@@ -99,7 +99,9 @@ export default class Ask extends Workflow {
   // lifecycle //
   autoQuery(options = {}) {
     const { setValue = true, focus = true } = this._autoQuery = options;
-    const q = new URLSearchParams(window.location.search).get('q');
+    const searchParams = new URLSearchParams(window.location.search);
+    const q = searchParams.get('q');
+    const s = searchParams.get('s');
     const { layout } = this._views.get(ROLE.QUERY);
     if (layout) {
       if (q && setValue) {
@@ -110,15 +112,19 @@ export default class Ask extends Workflow {
       }
     }
     if (q) {
-      this.query({ q });
+      this.query({ q, s });
     }
   }
 
-  query({ q: question, ...payload } = {}) {
+  query({ q: question, s: source, ...payload } = {}) {
     payload = { ...payload, question };
+
     if (this.parentQuestionId) {
       payload.parent_question_id = this.parentQuestionId;
     }
+    if (source) {
+      (payload._meta || (payload._meta = {})).question_source = source;
+    }
 
     // clear question id from previous session
     if (this._questionId) {
@@ -129,6 +135,9 @@ export default class Ask extends Workflow {
     this.restart();
 
     const { session } = this;
+    if (source) {
+      session.meta.question_source = source;
+    }
     this._hub.update(fields.request(), mergeApiOptions(this._options.resolved.api, { payload, session }));
 
     return this;
@@ -164,6 +173,7 @@ export default class Ask extends Workflow {
     if (this._autoQuery && this._autoQuery.updateUrl !== false) {
       const url = new URL(window.location);
       const currentQuestion = url.searchParams.get('q');
+      // TODO: review this, handle &s=
       if (question !== currentQuestion && (currentQuestion || this._autoQuery.updateUrl === true)) {
         url.searchParams.set('q', question);
         window.history.replaceState({}, '', url);
@@ -241,6 +251,7 @@ export default class Ask extends Workflow {
       questionId = parentQuestionId;
       parentQuestionId = this.previous && this.previous.parentQuestionId;
       custom_context.property = 'suggested_followup_questions';
+      // TODO: question_source
     }
     payload.context = {
       ...context,

package/src/workflow/explore.js

@@ -52,6 +52,14 @@ export default class Explore extends Workflow {
     });
   }
 
+  useApi(options) {
+    const { product_id } = options;
+    if (product_id) {
+      this._productId = product_id;
+    }
+    return super.useApi(options);
+  }
+
   useLink(fn) {
     if (typeof fn !== 'function' && fn !== false) {
       throw new Error('useLink(fn) expects fn to be a function or false');
@@ -85,7 +93,7 @@ export default class Explore extends Workflow {
       return data;
     }
     // patch value with links
-    const related_questions = value.related_questions.map(this._linkFn ? (text => ({ text, url: this._linkFn(text) })) : (text => ({ text })));
+    const related_questions = value.related_questions.map(this._linkFn ? (text => ({ text, url: this._getAnswersUrl(text) })) : (text => ({ text })));
     return {
       ...data,
       value: {
@@ -103,8 +111,18 @@ export default class Explore extends Workflow {
     if (!this._linkFn) {
       return;
     }
-    const url = this._linkFn(q);
+    const url = this._getAnswersUrl(q);
     window.open(url, '_blank');
   }
 
+  _getAnswersUrl(text) {
+    if (!this._linkFn) {
+      return;
+    }
+    const url = this._linkFn(text);
+    if (this._productId) {
+      return `${url}&s=${encodeURIComponent(this._productId)}`;
+    }
+  }
+
 }

package/src/workflow/options.js

@@ -106,13 +106,25 @@ export function mergeApiOptions(...optionsList) {
   }
   return mergeOptions(optionsList, (merged, options) => Object.assign(merged, {
     ...options,
-    payload: {
-      ...merged.payload,
-      ...options.payload,
-    },
+    payload: mergeApiPayloads(merged.payload, options.payload),
   }));
 }
 
+function mergeApiPayloads(base, overrides) {
+  return {
+    ...base,
+    ...overrides,
+    ...mergeObjectValueIfPresent('_meta', base, overrides),
+  };
+}
+
+function mergeObjectValueIfPresent(key, base, overrides) {
+  const baseValue = base && base[key];
+  const overridesValue = overrides && overrides[key];
+  const value = baseValue ? (overridesValue ? { ...baseValue, ...overridesValue } : baseValue) : overridesValue;
+  return value !== undefined ? { [key]: value } : {};
+}
+
 export function mergeLayoutsOptions(...optionsList) {
   if (optionsList[optionsList.length - 1] === false) {
     return false;