@miso.ai/client-sdk-ui 1.11.5-beta.3 → 1.11.5-beta.5

package/dist/cjs/actor/view.js

@@ -231,13 +231,14 @@ class ViewActor {
     for (const {
       role
     } of element.components) {
-      // not a data role -> nonempty
+      // not a data role -> irrelevant
       if (!(0, _constants.isDataRole)(role)) {
-        return false;
+        continue;
       }
       let sliced = value && value[role];
       if (role === _constants.ROLE.QUERY_SUGGESTIONS) {
         // special case: query suggestions -> look up value from hub
+        // TODO: adhoc
         const data = this.hub.states[fields.suggestions()];
         sliced = data && data.value;
       }

package/dist/cjs/layout/list/gallery.js

@@ -146,7 +146,7 @@ class GalleryLayout extends _collection.default {
     const {
       itemSizes
     } = this._galleryContext;
-    const values = this._writeItemSizes(this._getItems(state), itemSizes);
+    const values = this._writeItemSizes(this._getItems(state) || [], itemSizes);
     listElement.innerHTML = this.templates.items(this, state, values);
   }
   _appendItems(listElement, _ref5) {
@@ -160,13 +160,12 @@ class GalleryLayout extends _collection.default {
     this._syncItemSizes(listElement);
     // append new items
     const offset = listElement.children.length;
-    const values = this._writeItemSizes(this._getItems(state).slice(offset), itemSizes, offset);
+    const values = this._writeItemSizes((this._getItems(state) || []).slice(offset), itemSizes, offset);
     listElement.insertAdjacentHTML('beforeend', this.templates.items(this, state, values, {
       offset
     }));
   }
-  _writeItemSizes() {
-    let values = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  _writeItemSizes(values) {
     let [large = 0, medium = 0] = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
     let offset = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
     let omitted = 0;

package/dist/cjs/version.js

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

package/dist/cjs/workflow/answer-based.js

@@ -14,8 +14,7 @@ var _index4 = require("./options/index.js");
 var _processors = require("./processors.js");
 var _useLink = require("./use-link.js");
 var _trackers = require("../util/trackers.js");
-const _excluded = ["setValue", "focus", "param", "sourceParam"],
-  _excluded2 = ["event"];
+const _excluded = ["event"];
 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 DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_API_OPTIONS, {
@@ -84,22 +83,6 @@ const ROLES_OPTIONS = (0, _index4.mergeRolesOptions)(_base.default.ROLES_OPTIONS
   main: _constants.ROLE.ANSWER,
   members: Object.keys(DEFAULT_LAYOUTS)
 });
-function normalizeAutoQueryOptions() {
-  let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let {
-      setValue = true,
-      focus = true,
-      param = 'q',
-      sourceParam = 'qs'
-    } = _ref,
-    options = _objectWithoutPropertiesLoose(_ref, _excluded);
-  return Object.assign({
-    setValue,
-    focus,
-    param,
-    sourceParam
-  }, options);
-}
 class AnswerBasedWorkflow extends _base.default {
   // constructor //
   _initProperties(args) {
@@ -170,32 +153,7 @@ class AnswerBasedWorkflow extends _base.default {
   // query //
   autoQuery() {
     let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    const {
-      setValue,
-      focus,
-      param,
-      sourceParam
-    } = this._autoQuery = normalizeAutoQueryOptions(options);
-    const searchParams = new URLSearchParams(window.location.search);
-    const q = searchParams.get(param);
-    const qs = searchParams.get(sourceParam);
-    const {
-      layout
-    } = this._views.get(_constants.ROLE.QUERY);
-    if (layout) {
-      if (q && setValue) {
-        layout.value = q;
-      }
-      if (!q && focus) {
-        layout.focus();
-      }
-    }
-    if (q) {
-      this.query({
-        q,
-        qs
-      });
-    }
+    _index4.autoQuery.call(this, options);
   }
   query(args) {
     // TODO: also accept "question", "questionSource"?
@@ -228,9 +186,20 @@ class AnswerBasedWorkflow extends _base.default {
   _buildPayload() {
     throw new Error(`Not implemented`);
   }
+  _writeWikiLinkTemplateToPayload(payload) {
+    if (!this._autoQuery || !this._autoQuery.param || this._autoQuery.param === _index4.DEFAULT_AUTO_QUERY_PARAM) {
+      return payload;
+    }
+    return Object.assign({}, payload, {
+      wiki_link_template: `?${this._autoQuery.param}=%s`
+    });
+  }
 
   // data //
   _updateData(data) {
+    // capture question ID and register at context
+    this._writeQuestionIdFromData(data);
+
     // if it's the head response, write question id and return
     if (data.value && !data.value.answer_stage) {
       this._handleHeadResponse(data);
@@ -241,51 +210,49 @@ class AnswerBasedWorkflow extends _base.default {
     // update URL if autoQuery.updateUrl is not false
     this._updateUrlIfNecessary(data);
   }
-  _handleHeadResponse(data) {
-    // capture question ID and register at context
-    this._writeQuestionIdFromData(data);
-  }
+  _handleHeadResponse(data) {}
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
     data = (0, _index3.processData)(data);
     data = (0, _processors.writeAnswerStageToMeta)(data);
     return data;
   }
-  _writeQuestionIdFromData(_ref2) {
+  _writeQuestionIdFromData(_ref) {
     let {
       value
-    } = _ref2;
-    if (!value) {
-      return;
-    }
-    const {
-      question_id: questionId
-    } = value;
-    this._writeQuestionId(questionId);
+    } = _ref;
+    value && this._writeQuestionId(value.question_id);
   }
-  _updateUrlIfNecessary(_ref3) {
+  _updateUrlIfNecessary(_ref2) {
     let {
       value,
       request
-    } = _ref3;
-    if (!value || !this._autoQuery || this._autoQuery.updateUrl === false) {
-      // explicitly false
+    } = _ref2;
+    if (!this._autoQuery || !this._autoQuery.updateUrl) {
       return;
     }
     const {
-      param
+      param,
+      sourceParam
     } = this._autoQuery;
-    const {
-      question
-    } = value;
-    const organic = request && request.payload && request.payload._meta && request.payload._meta.question_source === _constants.ORGANIC_QUESTION_SOURCE;
+    const question = value && value.question || request && request.payload && request.payload.question;
+    const questionSource = request && request.payload && request.payload._meta && request.payload._meta.question_source;
+    if (!question) {
+      return; // at initial phase
+    }
     const url = new URL(window.location);
     const currentQuestion = url.searchParams.get(param);
-    // TODO: review this, handle &qs=
-    if (question !== currentQuestion && (!organic || this._autoQuery.updateUrl === true)) {
-      url.searchParams.set(param, question);
-      window.history.replaceState({}, '', url);
+    const currentQuestionSource = url.searchParams.get(sourceParam) || _constants.ORGANIC_QUESTION_SOURCE;
+    if (question === currentQuestion && questionSource === currentQuestionSource) {
+      return;
+    }
+    url.searchParams.set(param, question);
+    if (questionSource === _constants.ORGANIC_QUESTION_SOURCE) {
+      url.searchParams.delete(sourceParam);
+    } else {
+      url.searchParams.set(sourceParam, questionSource);
     }
+    window.history.replaceState({}, '', url);
   }
 
   // interactions //
@@ -293,6 +260,7 @@ class AnswerBasedWorkflow extends _base.default {
     payload = super._defaultProcessInteraction(payload, args);
     payload = this._writeAskPropertiesToInteraction(payload, args);
     payload = this._writeAnswerClickInteraction(payload, args);
+    payload = (0, _processors.writeEventTargetToInteraction)(payload, args);
     return payload;
   }
   _writeAskPropertiesToInteraction() {
@@ -338,11 +306,11 @@ class AnswerBasedWorkflow extends _base.default {
   }
 
   // handlers //
-  _onCitationClick(_ref4) {
+  _onCitationClick(_ref3) {
     let {
       index,
       event
-    } = _ref4;
+    } = _ref3;
     if ((0, _trackers.isTracked)(event)) {
       return;
     }
@@ -359,13 +327,17 @@ class AnswerBasedWorkflow extends _base.default {
     }
     // TODO: should we track impression as well?
     (0, _trackers.markAsTracked)(event);
-    this._views.trackers.sources.click([source.product_id]);
+    // distinguish from regular sources element click
+    // TODO
+    this._views.trackers.sources.click([source.product_id], {
+      event_target: 'citation-link'
+    });
   }
-  _onAnswerLinkClick(_ref5) {
+  _onAnswerLinkClick(_ref4) {
     let {
         event
-      } = _ref5,
-      item = _objectWithoutPropertiesLoose(_ref5, _excluded2);
+      } = _ref4,
+      item = _objectWithoutPropertiesLoose(_ref4, _excluded);
     if ((0, _trackers.isTracked)(event)) {
       return;
     }

package/dist/cjs/workflow/ask.js

@@ -134,18 +134,20 @@ class Ask extends _answerBased.default {
         q,
         qs
       } = _ref,
-      payload = _objectWithoutPropertiesLoose(_ref, _excluded);
+      options = _objectWithoutPropertiesLoose(_ref, _excluded);
     const {
       parentQuestionId
     } = this;
-    return (0, _commons.trimObj)(Object.assign({}, payload, {
+    let payload = (0, _commons.trimObj)(Object.assign({}, options, {
       question: q,
       // question, not q
       parent_question_id: parentQuestionId,
-      _meta: Object.assign({}, payload._meta, {
+      _meta: Object.assign({}, options._meta, {
         question_source: qs || _constants.ORGANIC_QUESTION_SOURCE // might be null, not undefined
       })
     }));
+    payload = this._writeWikiLinkTemplateToPayload(payload);
+    return payload;
   }
 
   // interactions //

package/dist/cjs/workflow/base.js

@@ -20,17 +20,19 @@ function injectLogger(hub, callback) {
     trigger
   } = hub;
   hub.update = (name, state, options) => {
+    const result = update.call(hub, name, state, options);
     if (!options || !options.silent) {
       callback('update', name, state, options);
     }
-    return update.call(hub, name, state, options);
+    return result;
   };
   hub.trigger = function () {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
+    const result = trigger.apply(hub, args);
     callback('trigger', ...args);
-    return trigger.apply(hub, args);
+    return result;
   };
   return hub;
 }

package/dist/cjs/workflow/hybrid-search-answer.js

@@ -48,6 +48,7 @@ class HybridSearchAnswer extends _answerBased.default {
   // query //
   _buildPayload(payload) {
     payload = this._writeQuestionSourceToPayload(payload);
+    payload = this._writeWikiLinkTemplateToPayload(payload);
     payload = this._superworkflow._results._writeFiltersToPayload(payload);
     return payload;
   }
@@ -68,6 +69,7 @@ class HybridSearchAnswer extends _answerBased.default {
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
     data = (0, _processors.writeKeywordsToData)(data);
+    data = (0, _processors.writeMisoIdFromSession)(data);
     return data;
   }
   _updateDataInHub(data) {
@@ -82,6 +84,8 @@ class HybridSearchAnswer extends _answerBased.default {
   }
   _handleHeadResponse(data) {
     super._handleHeadResponse(data);
+    // keep track of miso_id in session
+    (0, _processors.writeMisoIdToSession)(data);
     // share the search results with its sibling
     this._dispatchDataToSibling(data);
   }
@@ -91,6 +95,14 @@ class HybridSearchAnswer extends _answerBased.default {
     }));
   }
 
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    return this._superworkflow._defaultProcessInteraction(payload, args);
+  }
+  _defaultProcessInteraction0(payload, args) {
+    return super._defaultProcessInteraction(payload, args);
+  }
+
   // destroy //
   _destroy(options) {
     this._destroyAutocomplete();

package/dist/cjs/workflow/hybrid-search-results.js

@@ -8,6 +8,7 @@ var _commons = require("@miso.ai/commons");
 var _searchBased = _interopRequireDefault(require("./search-based.js"));
 var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
+var _processors = require("./processors.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // we want to override members, not adding to it
 const ROLES_OPTIONS = Object.assign({}, _searchBased.default.ROLES_OPTIONS, {
@@ -66,6 +67,21 @@ class HybridSearchResults extends _searchBased.default {
       }))
     });
   }
+
+  // data //
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
+    (0, _processors.writeMisoIdToSession)(data);
+    return data;
+  }
+
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    return this._superworkflow._defaultProcessInteraction(payload, args);
+  }
+  _defaultProcessInteraction0(payload, args) {
+    return super._defaultProcessInteraction(payload, args);
+  }
 }
 exports.default = HybridSearchResults;
 Object.assign(HybridSearchResults, {

package/dist/cjs/workflow/hybrid-search.js

@@ -81,14 +81,7 @@ class HybridSearch extends _base.default {
     }
   }
   _initActors() {
-    const hub = this._hub;
-    const client = this._client;
-    const options = this._options;
     this._views = new _hybridSearchViews.default(this);
-    this._interactions = new _index.InteractionsActor(hub, {
-      client,
-      options
-    });
   }
   _initSession() {
     this._results._sessions.restart();
@@ -128,7 +121,9 @@ class HybridSearch extends _base.default {
 
   // interactions //
   _defaultProcessInteraction(payload, args) {
-    return this._answer._defaultProcessInteraction(payload, args);
+    payload = this._answer._defaultProcessInteraction0(payload, args);
+    payload = this._results._defaultProcessInteraction0(payload, args);
+    return payload;
   }
 
   // destroy //

package/dist/cjs/workflow/options/auto-query.js

@@ -0,0 +1,62 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DEFAULT_AUTO_QUERY_SOURCE_PARAM = exports.DEFAULT_AUTO_QUERY_PARAM = void 0;
+exports.autoQuery = autoQuery;
+exports.normalizeAutoQueryOptions = normalizeAutoQueryOptions;
+var _commons = require("@miso.ai/commons");
+var _constants = require("../../constants.js");
+const _excluded = ["setValue", "focus", "updateUrl", "param", "sourceParam"];
+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 DEFAULT_AUTO_QUERY_PARAM = exports.DEFAULT_AUTO_QUERY_PARAM = 'q';
+const DEFAULT_AUTO_QUERY_SOURCE_PARAM = exports.DEFAULT_AUTO_QUERY_SOURCE_PARAM = 'qs';
+function normalizeAutoQueryOptions() {
+  let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let {
+      setValue = true,
+      focus = true,
+      updateUrl = true,
+      param = DEFAULT_AUTO_QUERY_PARAM,
+      sourceParam = DEFAULT_AUTO_QUERY_SOURCE_PARAM
+    } = _ref,
+    options = _objectWithoutPropertiesLoose(_ref, _excluded);
+  return Object.assign({
+    setValue,
+    focus,
+    updateUrl,
+    param,
+    sourceParam
+  }, options);
+}
+function autoQuery() {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  // TODO: support getting value from URL path
+  const {
+    setValue,
+    focus,
+    param,
+    sourceParam
+  } = this._autoQuery = normalizeAutoQueryOptions(options);
+  const searchParams = new URLSearchParams(window.location.search);
+  const q = searchParams.get(param);
+  const qs = searchParams.get(sourceParam) || undefined;
+  const {
+    layout
+  } = this._views.get(_constants.ROLE.QUERY);
+  if (layout) {
+    if (q && setValue) {
+      layout.value = q;
+    }
+    if (!q && focus) {
+      layout.focus();
+    }
+  }
+  if (q) {
+    this.query((0, _commons.trimObj)({
+      q,
+      qs
+    }));
+  }
+}

package/dist/cjs/workflow/options/index.js

@@ -112,4 +112,15 @@ Object.keys(_configurable).forEach(function (key) {
       return _configurable[key];
     }
   });
+});
+var _autoQuery = require("./auto-query.js");
+Object.keys(_autoQuery).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _autoQuery[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _autoQuery[key];
+    }
+  });
 });

package/dist/cjs/workflow/processors.js

@@ -12,9 +12,12 @@ exports.retainFacetCountsInData = retainFacetCountsInData;
 exports.writeAffiliationInfoToInteraction = writeAffiliationInfoToInteraction;
 exports.writeAnswerStageToMeta = writeAnswerStageToMeta;
 exports.writeDataStatus = writeDataStatus;
+exports.writeEventTargetToInteraction = writeEventTargetToInteraction;
 exports.writeExhaustionToData = writeExhaustionToData;
 exports.writeKeywordsToData = writeKeywordsToData;
+exports.writeMisoIdFromSession = writeMisoIdFromSession;
 exports.writeMisoIdToMeta = writeMisoIdToMeta;
+exports.writeMisoIdToSession = writeMisoIdToSession;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../constants.js");
 var _index = require("../actor/index.js");
@@ -97,6 +100,44 @@ function writeMisoIdToMeta(data) {
     })
   });
 }
+function writeMisoIdToSession(data) {
+  const {
+    session,
+    value
+  } = data;
+  if (!session || !value) {
+    return;
+  }
+  const {
+    miso_id
+  } = value;
+  if (!miso_id) {
+    return;
+  }
+  session.meta.miso_id = miso_id;
+}
+function writeMisoIdFromSession(data) {
+  const {
+    session,
+    value
+  } = data;
+  if (!session || !value) {
+    return data;
+  }
+  const {
+    meta: {
+      miso_id
+    } = {}
+  } = session;
+  if (!miso_id) {
+    return data;
+  }
+  return Object.assign({}, data, {
+    meta: Object.assign({}, data.meta, {
+      miso_id
+    })
+  });
+}
 function writeKeywordsToData(data) {
   const {
     request,
@@ -282,6 +323,21 @@ function writeAffiliationInfoToInteraction(payload, args) {
     }
   });
 }
+function writeEventTargetToInteraction(payload) {
+  let {
+    event_target
+  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  if (!event_target) {
+    return payload;
+  }
+  return mergeInteraction(payload, {
+    context: {
+      custom_context: {
+        event_target
+      }
+    }
+  });
+}
 function mergeInteraction() {
   let base = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   let patch = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};

package/dist/cjs/workflow/search-based.js

@@ -80,6 +80,10 @@ class SearchBasedWorkflow extends _base.default {
   }
 
   // query //
+  autoQuery() {
+    let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    _index3.autoQuery.call(this, options);
+  }
   query(args) {
     if (!args.q) {
       throw new Error(`q is required in query() call`);

package/dist/cjs/workflow/search.js

@@ -49,31 +49,6 @@ class Search extends _searchBased.default {
     super._initProperties(args);
     this._initAutocomplete(args);
   }
-  autoQuery() {
-    let {
-      setValue = true,
-      focus = true,
-      param = 'q'
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    // TODO: align implementation with AnswerBasedWorkflow
-    const q = new URLSearchParams(window.location.search).get(param);
-    const {
-      layout
-    } = this._views.get(_constants.ROLE.QUERY);
-    if (layout) {
-      if (q && setValue) {
-        layout.value = q;
-      }
-      if (!q && focus) {
-        layout.focus();
-      }
-    }
-    if (q) {
-      this.query({
-        q
-      });
-    }
-  }
   notifyViewUpdate() {
     let role = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _constants.ROLE.PRODUCTS;
     for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {

package/package.json

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

package/src/actor/view.js

@@ -185,13 +185,14 @@ export default class ViewActor {
     }
     // iterate over all member components' roles
     for (const { role } of element.components) {
-      // not a data role -> nonempty
+      // not a data role -> irrelevant
       if (!isDataRole(role)) {
-        return false;
+        continue;
       }
       let sliced = value && value[role];
       if (role === ROLE.QUERY_SUGGESTIONS) {
         // special case: query suggestions -> look up value from hub
+        // TODO: adhoc
         const data = this.hub.states[fields.suggestions()];
         sliced = data && data.value;
       }

package/src/layout/list/gallery.js

@@ -127,7 +127,7 @@ export default class GalleryLayout extends CollectionLayout {
 
   _updateItems(listElement, { state }) {
     const { itemSizes } = this._galleryContext;
-    const values = this._writeItemSizes(this._getItems(state), itemSizes);
+    const values = this._writeItemSizes(this._getItems(state) || [], itemSizes);
     listElement.innerHTML = this.templates.items(this, state, values);
   }
 
@@ -137,11 +137,11 @@ export default class GalleryLayout extends CollectionLayout {
     this._syncItemSizes(listElement);
     // append new items
     const offset = listElement.children.length;
-    const values = this._writeItemSizes(this._getItems(state).slice(offset), itemSizes, offset);
+    const values = this._writeItemSizes((this._getItems(state) || []).slice(offset), itemSizes, offset);
     listElement.insertAdjacentHTML('beforeend', this.templates.items(this, state, values, { offset }));
   }
 
-  _writeItemSizes(values = [], [large = 0, medium = 0] = [], offset = 0) {
+  _writeItemSizes(values, [large = 0, medium = 0] = [], offset = 0) {
     let omitted = 0;
     if (offset > 0) {
       omitted = Math.min(offset, large);

package/src/version.js

@@ -1 +1 @@
-export default '1.11.5-beta.3';
+export default '1.11.5-beta.5';

package/src/workflow/answer-based.js

@@ -2,10 +2,10 @@ import { API } from '@miso.ai/commons';
 import Workflow from './base.js';
 import { fields, FeedbackActor } from '../actor/index.js';
 import { ROLE, STATUS, ORGANIC_QUESTION_SOURCE } from '../constants.js';
-import { SearchBoxLayout, TextLayout, ListLayout, CarouselLayout, GalleryLayout, TypewriterLayout, FeedbackLayout, AffiliationLayout } from '../layout/index.js';
+import { SearchBoxLayout, TextLayout, ListLayout, GalleryLayout, TypewriterLayout, FeedbackLayout, AffiliationLayout } from '../layout/index.js';
 import { processData as processAffiliationData } from '../affiliation/index.js';
-import { mergeRolesOptions, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
-import { writeAnswerStageToMeta, mergeInteraction } from './processors.js';
+import { mergeRolesOptions, autoQuery as autoQueryFn, DEFAULT_AUTO_QUERY_PARAM, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
+import { writeAnswerStageToMeta, writeEventTargetToInteraction, mergeInteraction } from './processors.js';
 import { enableUseLink } from './use-link.js';
 import { isTracked, markAsTracked } from '../util/trackers.js';
 
@@ -67,10 +67,6 @@ const ROLES_OPTIONS = mergeRolesOptions(Workflow.ROLES_OPTIONS, {
   members: Object.keys(DEFAULT_LAYOUTS),
 });
 
-function normalizeAutoQueryOptions({ setValue = true, focus = true, param = 'q', sourceParam = 'qs', ...options } = {}) {
-  return { setValue, focus, param, sourceParam, ...options };
-}
-
 export default class AnswerBasedWorkflow extends Workflow {
 
   // constructor //
@@ -146,22 +142,7 @@ export default class AnswerBasedWorkflow extends Workflow {
 
   // query //
   autoQuery(options = {}) {
-    const { setValue, focus, param, sourceParam } = this._autoQuery = normalizeAutoQueryOptions(options);
-    const searchParams = new URLSearchParams(window.location.search);
-    const q = searchParams.get(param);
-    const qs = searchParams.get(sourceParam);
-    const { layout } = this._views.get(ROLE.QUERY);
-    if (layout) {
-      if (q && setValue) {
-        layout.value = q;
-      }
-      if (!q && focus) {
-        layout.focus();
-      }
-    }
-    if (q) {
-      this.query({ q, qs });
-    }
+    autoQueryFn.call(this, options);
   }
 
   query(args) {
@@ -196,8 +177,21 @@ export default class AnswerBasedWorkflow extends Workflow {
     throw new Error(`Not implemented`);
   }
 
+  _writeWikiLinkTemplateToPayload(payload) {
+    if (!this._autoQuery || !this._autoQuery.param || this._autoQuery.param === DEFAULT_AUTO_QUERY_PARAM) {
+      return payload;
+    }
+    return {
+      ...payload,
+      wiki_link_template: `?${this._autoQuery.param}=%s`,
+    };
+  }
+
   // data //
   _updateData(data) {
+    // capture question ID and register at context
+    this._writeQuestionIdFromData(data);
+
     // if it's the head response, write question id and return
     if (data.value && !data.value.answer_stage) {
       this._handleHeadResponse(data);
@@ -209,10 +203,7 @@ export default class AnswerBasedWorkflow extends Workflow {
     this._updateUrlIfNecessary(data);
   }
 
-  _handleHeadResponse(data) {
-    // capture question ID and register at context
-    this._writeQuestionIdFromData(data);
-  }
+  _handleHeadResponse(data) {}
 
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
@@ -222,28 +213,34 @@ export default class AnswerBasedWorkflow extends Workflow {
   }
 
   _writeQuestionIdFromData({ value }) {
-    if (!value) {
-      return;
-    }
-    const { question_id: questionId } = value;
-    this._writeQuestionId(questionId);
+    value && this._writeQuestionId(value.question_id);
   }
 
   _updateUrlIfNecessary({ value, request }) {
-    if (!value || !this._autoQuery || this._autoQuery.updateUrl === false) { // explicitly false
+    if (!this._autoQuery || !this._autoQuery.updateUrl) {
       return;
     }
-    const { param } = this._autoQuery;
-    const { question } = value;
-    const organic = request && request.payload && request.payload._meta && request.payload._meta.question_source === ORGANIC_QUESTION_SOURCE;
+    const { param, sourceParam } = this._autoQuery;
+    const question = (value && value.question) || (request && request.payload && request.payload.question);
+    const questionSource = request && request.payload && request.payload._meta && request.payload._meta.question_source;
+
+    if (!question) {
+      return; // at initial phase
+    }
 
     const url = new URL(window.location);
     const currentQuestion = url.searchParams.get(param);
-    // TODO: review this, handle &qs=
-    if (question !== currentQuestion && (!organic || this._autoQuery.updateUrl === true)) {
-      url.searchParams.set(param, question);
-      window.history.replaceState({}, '', url);
+    const currentQuestionSource = url.searchParams.get(sourceParam) || ORGANIC_QUESTION_SOURCE;
+    if (question === currentQuestion && questionSource === currentQuestionSource) {
+      return;
+    }
+    url.searchParams.set(param, question);
+    if (questionSource === ORGANIC_QUESTION_SOURCE) {
+      url.searchParams.delete(sourceParam);
+    } else {
+      url.searchParams.set(sourceParam, questionSource);
     }
+    window.history.replaceState({}, '', url);
   }
 
   // interactions //
@@ -251,6 +248,7 @@ export default class AnswerBasedWorkflow extends Workflow {
     payload = super._defaultProcessInteraction(payload, args);
     payload = this._writeAskPropertiesToInteraction(payload, args);
     payload = this._writeAnswerClickInteraction(payload, args);
+    payload = writeEventTargetToInteraction(payload, args);
     return payload;
   }
 
@@ -304,7 +302,9 @@ export default class AnswerBasedWorkflow extends Workflow {
     }
     // TODO: should we track impression as well?
     markAsTracked(event);
-    this._views.trackers.sources.click([source.product_id]);
+    // distinguish from regular sources element click
+    // TODO
+    this._views.trackers.sources.click([source.product_id], { event_target: 'citation-link' });
   }
 
   _onAnswerLinkClick({ event, ...item }) {

package/src/workflow/ask.js

@@ -115,17 +115,19 @@ export default class Ask extends AnswerBasedWorkflow {
   }
 
   // query //
-  _buildPayload({ q, qs, ...payload } = {}) {
+  _buildPayload({ q, qs, ...options } = {}) {
     const { parentQuestionId } = this;
-    return trimObj({
-      ...payload,
+    let payload = trimObj({
+      ...options,
       question: q, // question, not q
       parent_question_id: parentQuestionId,
       _meta: {
-        ...payload._meta,
+        ...options._meta,
         question_source: qs || ORGANIC_QUESTION_SOURCE, // might be null, not undefined
       },
     });
+    payload = this._writeWikiLinkTemplateToPayload(payload);
+    return payload;
   }
 
   // interactions //

package/src/workflow/base.js

@@ -10,14 +10,16 @@ import { getRevision, writeDataStatus, writeMisoIdToMeta, buildBaseInteraction,
 function injectLogger(hub, callback) {
   const { update, trigger } = hub;
   hub.update = (name, state, options) => {
+    const result = update.call(hub, name, state, options);
     if (!options || !options.silent) {
       callback('update', name, state, options);
     }
-    return update.call(hub, name, state, options);
+    return result;
   }
   hub.trigger = (...args) => {
+    const result = trigger.apply(hub, args);
     callback('trigger', ...args);
-    return trigger.apply(hub, args);
+    return result;
   }
   return hub;
 }

package/src/workflow/hybrid-search-answer.js

@@ -1,7 +1,7 @@
 import AnswerBasedWorkflow from './answer-based.js';
 import { ROLE, STATUS, ORGANIC_QUESTION_SOURCE } from '../constants.js';
 import { mergeRolesOptions } from './options/index.js';
-import { writeKeywordsToData } from './processors.js';
+import { writeKeywordsToData, writeMisoIdToSession, writeMisoIdFromSession } from './processors.js';
 import { makeAutocompletable } from './autocompletable.js';
 
 const ROLES_OPTIONS = mergeRolesOptions(AnswerBasedWorkflow.ROLES_OPTIONS, {
@@ -44,6 +44,7 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
   // query //
   _buildPayload(payload) {
     payload = this._writeQuestionSourceToPayload(payload);
+    payload = this._writeWikiLinkTemplateToPayload(payload);
     payload = this._superworkflow._results._writeFiltersToPayload(payload);
     return payload;
   }
@@ -62,6 +63,7 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
     data = writeKeywordsToData(data);
+    data = writeMisoIdFromSession(data);
     return data;
   }
 
@@ -78,6 +80,8 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
 
   _handleHeadResponse(data) {
     super._handleHeadResponse(data);
+    // keep track of miso_id in session
+    writeMisoIdToSession(data);
     // share the search results with its sibling
     this._dispatchDataToSibling(data);
   }
@@ -86,6 +90,15 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
     this._resultsSession && this._superworkflow._results.updateData({ ...data, session: this._resultsSession });
   }
 
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    return this._superworkflow._defaultProcessInteraction(payload, args);
+  }
+
+  _defaultProcessInteraction0(payload, args) {
+    return super._defaultProcessInteraction(payload, args);
+  }
+
   // destroy //
   _destroy(options) {
     this._destroyAutocomplete();

package/src/workflow/hybrid-search-results.js

@@ -2,6 +2,7 @@ import { trimObj } from '@miso.ai/commons';
 import SearchBasedWorkflow from './search-based.js';
 import { fields } from '../actor/index.js';
 import { ROLE } from '../constants.js';
+import { writeMisoIdToSession } from './processors.js';
 
 // we want to override members, not adding to it
 const ROLES_OPTIONS = {
@@ -69,6 +70,22 @@ export default class HybridSearchResults extends SearchBasedWorkflow {
     };
   }
 
+  // data //
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
+    writeMisoIdToSession(data);
+    return data;
+  }
+
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    return this._superworkflow._defaultProcessInteraction(payload, args);
+  }
+
+  _defaultProcessInteraction0(payload, args) {
+    return super._defaultProcessInteraction(payload, args);
+  }
+
 }
 
 Object.assign(HybridSearchResults, {

package/src/workflow/hybrid-search.js

@@ -98,12 +98,7 @@ export default class HybridSearch extends Workflow {
   }
 
   _initActors() {
-    const hub = this._hub;
-    const client = this._client;
-    const options = this._options;
-
     this._views = new HybridSearchViewsActor(this);
-    this._interactions = new InteractionsActor(hub, { client, options });
   }
 
   _initSession() {
@@ -149,7 +144,9 @@ export default class HybridSearch extends Workflow {
 
   // interactions //
   _defaultProcessInteraction(payload, args) {
-    return this._answer._defaultProcessInteraction(payload, args);
+    payload = this._answer._defaultProcessInteraction0(payload, args);
+    payload = this._results._defaultProcessInteraction0(payload, args);
+    return payload;
   }
 
   // destroy //

package/src/workflow/options/auto-query.js

@@ -0,0 +1,29 @@
+import { trimObj } from '@miso.ai/commons';
+import { ROLE } from '../../constants.js';
+
+export const DEFAULT_AUTO_QUERY_PARAM = 'q';
+export const DEFAULT_AUTO_QUERY_SOURCE_PARAM = 'qs';
+
+export function normalizeAutoQueryOptions({ setValue = true, focus = true, updateUrl = true, param = DEFAULT_AUTO_QUERY_PARAM, sourceParam = DEFAULT_AUTO_QUERY_SOURCE_PARAM, ...options } = {}) {
+  return { setValue, focus, updateUrl, param, sourceParam, ...options };
+}
+
+export function autoQuery(options = {}) {
+  // TODO: support getting value from URL path
+  const { setValue, focus, param, sourceParam } = this._autoQuery = normalizeAutoQueryOptions(options);
+  const searchParams = new URLSearchParams(window.location.search);
+  const q = searchParams.get(param);
+  const qs = searchParams.get(sourceParam) || undefined;
+  const { layout } = this._views.get(ROLE.QUERY);
+  if (layout) {
+    if (q && setValue) {
+      layout.value = q;
+    }
+    if (!q && focus) {
+      layout.focus();
+    }
+  }
+  if (q) {
+    this.query(trimObj({ q, qs }));
+  }
+}

package/src/workflow/options/index.js

@@ -8,3 +8,4 @@ export * from './filters.js';
 export * from './pagination.js';
 export * from './options.js';
 export * from './configurable.js';
+export * from './auto-query.js';

package/src/workflow/processors.js

@@ -68,6 +68,36 @@ export function writeMisoIdToMeta(data) {
   };
 }
 
+export function writeMisoIdToSession(data) {
+  const { session, value } = data;
+  if (!session || !value) {
+    return;
+  }
+  const { miso_id } = value;
+  if (!miso_id) {
+    return;
+  }
+  session.meta.miso_id = miso_id;
+}
+
+export function writeMisoIdFromSession(data) {
+  const { session, value } = data;
+  if (!session || !value) {
+    return data;
+  }
+  const { meta: { miso_id } = {} } = session;
+  if (!miso_id) {
+    return data;
+  }
+  return {
+    ...data,
+    meta: {
+      ...data.meta,
+      miso_id,
+    },
+  };
+}
+
 export function writeKeywordsToData(data) {
   const { request, value } = data;
   // we still want the value in loading status
@@ -230,6 +260,19 @@ export function writeAffiliationInfoToInteraction(payload, args) {
   });
 }
 
+export function writeEventTargetToInteraction(payload, { event_target } = {}) {
+  if (!event_target) {
+    return payload;
+  }
+  return mergeInteraction(payload, {
+    context: {
+      custom_context: {
+        event_target,
+      },
+    },
+  });
+}
+
 export function mergeInteraction(base = {}, patch = {}) {
   return trimObj({
     ...base,

package/src/workflow/search-based.js

@@ -4,7 +4,7 @@ import { fields } from '../actor/index.js';
 import { STATUS, ROLE, WORKFLOW_CONFIGURABLE } from '../constants.js';
 import { SearchBoxLayout, ListLayout, TextLayout, FacetsLayout, SelectLayout, MoreButtonLayout } from '../layout/index.js';
 import { mappingSortData, writeKeywordsToData, retainFacetCountsInData, writeExhaustionToData, concatItemsFromMoreResponse } from './processors.js';
-import { mergeRolesOptions, makeConfigurable, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
+import { mergeRolesOptions, autoQuery as autoQueryFn, makeConfigurable, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
 
 const DEFAULT_ROWS = 10;
 const DEFAULT_PAGE_LIMIT = 10;
@@ -87,6 +87,10 @@ export default class SearchBasedWorkflow extends Workflow {
   }
 
   // query //
+  autoQuery(options = {}) {
+    autoQueryFn.call(this, options);
+  }
+
   query(args) {
     if (!args.q) {
       throw new Error(`q is required in query() call`);

package/src/workflow/search.js

@@ -57,23 +57,6 @@ export default class Search extends SearchBasedWorkflow {
     this._initAutocomplete(args);
   }
 
-  autoQuery({ setValue = true, focus = true, param = 'q' } = {}) {
-    // TODO: align implementation with AnswerBasedWorkflow
-    const q = new URLSearchParams(window.location.search).get(param);
-    const { layout } = this._views.get(ROLE.QUERY);
-    if (layout) {
-      if (q && setValue) {
-        layout.value = q;
-      }
-      if (!q && focus) {
-        layout.focus();
-      }
-    }
-    if (q) {
-      this.query({ q });
-    }
-  }
-
   notifyViewUpdate(role = ROLE.PRODUCTS, ...args) {
     super.notifyViewUpdate(role, ...args);
     return this;