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

package/dist/cjs/actor/data.js

@@ -5,8 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var fields = _interopRequireWildcard(require("./fields.js"));
+const _excluded = ["session"];
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+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; }
 class DataActor {
   constructor(hub, _ref) {
     let {
@@ -54,6 +56,13 @@ class DataActor {
     const {
       session
     } = this._hub.states;
+    const request = _objectWithoutPropertiesLoose(event, _excluded);
+
+    // emit response to update request
+    this._emitResponse({
+      session,
+      request
+    });
     try {
       const {
         signal
@@ -76,12 +85,14 @@ class DataActor {
           }
           this._emitResponse({
             session,
+            request,
             value
           });
         }
       } else {
         this._emitResponseWithSessionCheck({
           session,
+          request,
           value: response
         });
       }
@@ -89,6 +100,7 @@ class DataActor {
       this._error(error);
       this._emitResponseWithSessionCheck({
         session,
+        request,
         error
       });
     }

package/dist/cjs/actor/feedback.js

@@ -22,19 +22,32 @@ class FeedbackActor {
     if (!question_id) {
       return;
     }
-    this._hub.trigger(fields.interaction(), this._buildInteraction(question_id, state));
+    // TODO: ad-hoc
+    const {
+      request
+    } = data || {};
+    const {
+      payload
+    } = request || {};
+    const question_source = payload && payload._meta && payload._meta.question_source;
+    this._hub.trigger(fields.interaction(), this._buildInteraction(state, {
+      question_source
+    }));
   }
-  _buildInteraction(question_id, _ref) {
+  _buildInteraction(_ref, _ref2) {
     let {
       value,
       unselected
     } = _ref;
+    let {
+      question_source
+    } = _ref2;
     return {
       type: 'feedback',
       context: {
         custom_context: {
           result_type: 'answer',
-          question_id,
+          question_source,
           value: unselected ? 'unselected' : value
         }
       }

package/dist/cjs/actor/tracker.js

@@ -106,11 +106,11 @@ class Tracker {
     const state = this._getViewState();
     return state && state.meta && state.meta.miso_id || this._element && this._element.getAttribute('miso-id') || undefined;
   }
-  _getSessionMeta() {
+  _getRequestPayload() {
     const {
-      session
+      request
     } = this._getViewState() || {};
-    return session && session.meta;
+    return request && request.payload;
   }
   getState(productId) {
     return this._tracker.getState(productId);
@@ -118,12 +118,12 @@ 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();
+    const request = this._getRequestPayload();
     // TODO: should trigger 'tracker' and let workflow translate to interactions
     this._hub.trigger(fields.interaction(), (0, _utils.toInteraction)({
       property,
       misoId,
-      meta
+      request
     }, data));
   }
   _destroy() {

package/dist/cjs/actor/utils.js

@@ -17,7 +17,7 @@ function toInteraction(_ref, _ref2) {
   let {
     property,
     misoId,
-    meta
+    request
   } = _ref;
   let {
     event,
@@ -30,20 +30,24 @@ function toInteraction(_ref, _ref2) {
       api_ts = (0, _commons.uuidToTimestamp)(misoId);
     } catch (e) {}
   }
+  // TODO: ad-hoc
+  const question_source = request && request._meta && request._meta.question_source;
   const isProductType = isProduct(property);
   const product_ids = isProductType ? values.map(v => v.product_id).filter(v => v) : [];
   const items = isProductType ? undefined : values.map(v => v.text || v);
-  return (0, _commons.trimObj)({
+  const payload = (0, _commons.trimObj)({
     type: event === 'viewable' ? 'viewable_impression' : event,
     product_ids,
     miso_id: misoId,
     context: {
-      custom_context: (0, _commons.trimObj)(Object.assign({
+      custom_context: (0, _commons.trimObj)({
         api_ts,
         property,
         items,
-        trigger: manual ? 'manual' : 'auto'
-      }, meta))
+        trigger: manual ? 'manual' : 'auto',
+        question_source
+      })
     }
   });
+  return payload;
 }

package/dist/cjs/actor/view.js

@@ -116,6 +116,7 @@ class ViewActor {
       session,
       status,
       ongoing,
+      request,
       meta
     } = data;
     const active = session && session.active;
@@ -136,6 +137,7 @@ class ViewActor {
         session,
         status,
         ongoing,
+        request,
         meta
       }, state), options);
     };
@@ -155,6 +157,7 @@ class ViewActor {
       session,
       status,
       ongoing,
+      request,
       meta,
       error
     } = _ref;
@@ -168,6 +171,7 @@ class ViewActor {
       session,
       status,
       ongoing,
+      request,
       meta,
       error
     }));
@@ -178,14 +182,14 @@ class ViewActor {
       silent
     });
   }
-  _sliceData(data) {
-    const {
+  _sliceData(_ref2) {
+    let {
         value,
         error,
         status,
         meta
-      } = data,
-      rest = _objectWithoutPropertiesLoose(data, _excluded);
+      } = _ref2,
+      rest = _objectWithoutPropertiesLoose(_ref2, _excluded);
     const sliced = Object.assign({
       value: this.role === _constants.ROLE.ERROR ? error : value && value[this.role],
       status,

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.5-beta.0';
+var _default = exports.default = '1.9.5-beta.2';

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", "s"];
+const _excluded = ["q", "qs"];
 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({
@@ -118,7 +118,7 @@ class Ask extends _base.default {
     } = this._autoQuery = options;
     const searchParams = new URLSearchParams(window.location.search);
     const q = searchParams.get('q');
-    const s = searchParams.get('s');
+    const qs = searchParams.get('qs');
     const {
       layout
     } = this._views.get(_constants.ROLE.QUERY);
@@ -133,7 +133,7 @@ class Ask extends _base.default {
     if (q) {
       this.query({
         q,
-        s
+        qs
       });
     }
   }
@@ -141,7 +141,7 @@ class Ask extends _base.default {
     let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     let {
         q: question,
-        s: source
+        qs: questionSource
       } = _ref,
       payload = _objectWithoutPropertiesLoose(_ref, _excluded);
     payload = Object.assign({}, payload, {
@@ -150,8 +150,8 @@ class Ask extends _base.default {
     if (this.parentQuestionId) {
       payload.parent_question_id = this.parentQuestionId;
     }
-    if (source) {
-      (payload._meta || (payload._meta = {})).question_source = source;
+    if (questionSource) {
+      (payload._meta || (payload._meta = {})).question_source = questionSource;
     }
 
     // clear question id from previous session
@@ -163,8 +163,8 @@ class Ask extends _base.default {
     const {
       session
     } = this;
-    if (source) {
-      session.meta.question_source = source;
+    if (questionSource) {
+      session.meta.question_source = questionSource;
     }
     this._hub.update(_index.fields.request(), (0, _options.mergeApiOptions)(this._options.resolved.api, {
       payload,
@@ -317,7 +317,7 @@ class Ask extends _base.default {
       questionId = parentQuestionId;
       parentQuestionId = this.previous && this.previous.parentQuestionId;
       custom_context.property = 'suggested_followup_questions';
-      // TODO: question_source
+      custom_context.question_source = this.previous && this.previous.session.meta.question_source;
     }
     payload.context = Object.assign({}, context, {
       custom_context: (0, _commons.trimObj)(Object.assign({

package/dist/cjs/workflow/explore.js

@@ -139,7 +139,7 @@ class Explore extends _base.default {
     }
     const url = this._linkFn(text);
     if (this._productId) {
-      return `${url}&s=${encodeURIComponent(this._productId)}`;
+      return `${url}&qs=${encodeURIComponent(this._productId)}`;
     }
   }
 }

package/package.json

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

package/src/actor/data.js

@@ -47,6 +47,11 @@ export default class DataActor {
       return;
     }
     const { session } = this._hub.states;
+    const { session: _, ...request } = event;
+
+    // emit response to update request
+    this._emitResponse({ session, request });
+
     try {
       const { signal } = this._ac || {};
       const options = { ...event.options, signal };
@@ -59,14 +64,14 @@ export default class DataActor {
           if (!this._isCurrentSession(session)) {
             break;
           }
-          this._emitResponse({ session, value });
+          this._emitResponse({ session, request, value });
         }
       } else {
-        this._emitResponseWithSessionCheck({ session, value: response });
+        this._emitResponseWithSessionCheck({ session, request, value: response });
       }
     } catch(error) {
       this._error(error);
-      this._emitResponseWithSessionCheck({ session, error });
+      this._emitResponseWithSessionCheck({ session, request, error });
     }
   }
 

package/src/actor/feedback.js

@@ -15,16 +15,20 @@ export default class FeedbackActor {
     if (!question_id) {
       return;
     }
-    this._hub.trigger(fields.interaction(), this._buildInteraction(question_id, state));
+    // TODO: ad-hoc
+    const { request } = data || {};
+    const { payload } = request || {};
+    const question_source = payload && payload._meta && payload._meta.question_source;
+    this._hub.trigger(fields.interaction(), this._buildInteraction(state, { question_source }));
   }
 
-  _buildInteraction(question_id, { value, unselected }) {
+  _buildInteraction({ value, unselected }, { question_source }) {
     return {
       type: 'feedback',
       context: {
         custom_context: {
           result_type: 'answer',
-          question_id,
+          question_source,
           value: unselected ? 'unselected' : value,
         },
       },

package/src/actor/tracker.js

@@ -101,9 +101,9 @@ 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;
+  _getRequestPayload() {
+    const { request } = this._getViewState() || {};
+    return request && request.payload;
   }
 
   getState(productId) {
@@ -113,9 +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();
+    const request = this._getRequestPayload();
     // TODO: should trigger 'tracker' and let workflow translate to interactions
-    this._hub.trigger(fields.interaction(), toInteraction({ property, misoId, meta }, data));
+    this._hub.trigger(fields.interaction(), toInteraction({ property, misoId, request }, data));
   }
 
   _destroy() {

package/src/actor/utils.js

@@ -12,17 +12,19 @@ export function isProduct(property) {
   return PRODUCT_TYPED_PROPERTIES.has(property);
 }
 
-export function toInteraction({ property, misoId, meta }, { event, values, manual }) {
+export function toInteraction({ property, misoId, request }, { event, values, manual }) {
   let api_ts;
   if (misoId) {
     try {
       api_ts = uuidToTimestamp(misoId);
     } catch (e) {}
   }
+  // TODO: ad-hoc
+  const question_source = request && request._meta && request._meta.question_source;
   const isProductType = isProduct(property);
   const product_ids = isProductType ? values.map(v => v.product_id).filter(v => v) : [];
   const items = isProductType ? undefined : values.map(v => v.text || v);
-  return trimObj({
+  const payload = trimObj({
     type: event === 'viewable' ? 'viewable_impression' : event,
     product_ids,
     miso_id: misoId,
@@ -32,8 +34,9 @@ export function toInteraction({ property, misoId, meta }, { event, values, manua
         property,
         items,
         trigger: manual ? 'manual' : 'auto',
-        ...meta,
+        question_source,
       }),
     },
   });
+  return payload;
 }

package/src/actor/view.js

@@ -102,7 +102,7 @@ export default class ViewActor {
     this._data = data = this._sliceData(data || this._views._getData());
 
     // protocol: no reaction until session starts
-    const { session, status, ongoing, meta } = data;
+    const { session, status, ongoing, request, meta } = data;
     const active = session && session.active;
     if (!force && !active) {
       return;
@@ -115,7 +115,7 @@ export default class ViewActor {
 
     // render
     const notifyUpdate = (state = {}, options) => {
-      state !== false && this.updateState({ session, status, ongoing, meta, ...state }, options);
+      state !== false && this.updateState({ session, status, ongoing, request, meta, ...state }, options);
     };
     try {
       await this._layout.render(element, data, { notifyUpdate });
@@ -125,17 +125,16 @@ export default class ViewActor {
     }
   }
 
-  updateState({ session, status, ongoing, meta, error }, { silent = false } = {}) {
+  updateState({ session, status, ongoing, request, meta, error }, { silent = false } = {}) {
     if (error) {
       status = STATUS.ERRONEOUS;
     }
-    const state = this._state = Object.freeze(trimObj({ session, status, ongoing, meta, error }));
+    const state = this._state = Object.freeze(trimObj({ session, status, ongoing, request, meta, error }));
     const { role } = this;
     this.hub.update(fields.view(role), state, { silent });
   }
 
-  _sliceData(data) {
-    const { value, error, status, meta, ...rest } = data;
+  _sliceData({ value, error, status, meta, ...rest }) {
     const sliced = {
       value: this.role === ROLE.ERROR ? error : (value && value[this.role]),
       status,

package/src/version.js

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

package/src/workflow/ask.js

@@ -101,7 +101,7 @@ export default class Ask extends Workflow {
     const { setValue = true, focus = true } = this._autoQuery = options;
     const searchParams = new URLSearchParams(window.location.search);
     const q = searchParams.get('q');
-    const s = searchParams.get('s');
+    const qs = searchParams.get('qs');
     const { layout } = this._views.get(ROLE.QUERY);
     if (layout) {
       if (q && setValue) {
@@ -112,18 +112,18 @@ export default class Ask extends Workflow {
       }
     }
     if (q) {
-      this.query({ q, s });
+      this.query({ q, qs });
     }
   }
 
-  query({ q: question, s: source, ...payload } = {}) {
+  query({ q: question, qs: questionSource, ...payload } = {}) {
     payload = { ...payload, question };
 
     if (this.parentQuestionId) {
       payload.parent_question_id = this.parentQuestionId;
     }
-    if (source) {
-      (payload._meta || (payload._meta = {})).question_source = source;
+    if (questionSource) {
+      (payload._meta || (payload._meta = {})).question_source = questionSource;
     }
 
     // clear question id from previous session
@@ -135,8 +135,8 @@ export default class Ask extends Workflow {
     this.restart();
 
     const { session } = this;
-    if (source) {
-      session.meta.question_source = source;
+    if (questionSource) {
+      session.meta.question_source = questionSource;
     }
     this._hub.update(fields.request(), mergeApiOptions(this._options.resolved.api, { payload, session }));
 
@@ -251,7 +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
+      custom_context.question_source = this.previous && this.previous.session.meta.question_source;
     }
     payload.context = {
       ...context,

package/src/workflow/explore.js

@@ -121,7 +121,7 @@ export default class Explore extends Workflow {
     }
     const url = this._linkFn(text);
     if (this._productId) {
-      return `${url}&s=${encodeURIComponent(this._productId)}`;
+      return `${url}&qs=${encodeURIComponent(this._productId)}`;
     }
   }