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

package/dist/cjs/actor/index.js

@@ -33,6 +33,12 @@ Object.defineProperty(exports, "SessionMaker", {
     return _sessions.default;
   }
 });
+Object.defineProperty(exports, "TrackersActor", {
+  enumerable: true,
+  get: function () {
+    return _trackers.default;
+  }
+});
 Object.defineProperty(exports, "ViewsActor", {
   enumerable: true,
   get: function () {
@@ -47,6 +53,7 @@ var _sessions = _interopRequireDefault(require("./sessions.js"));
 var _data = _interopRequireDefault(require("./data.js"));
 var _views = _interopRequireDefault(require("./views.js"));
 var _feedback = _interopRequireDefault(require("./feedback.js"));
+var _trackers = _interopRequireDefault(require("./trackers.js"));
 var _interactions = _interopRequireDefault(require("./interactions.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 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); }

package/dist/cjs/actor/tracker.js

@@ -36,7 +36,7 @@ class Tracker {
     const {
       options
     } = this;
-    if (!options) {
+    if (!options || options.active === false) {
       return;
     }
     this._syncSession();

package/dist/cjs/actor/trackers.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _constants = require("../constants.js");
+var _tracker = _interopRequireDefault(require("./tracker.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class TrackersActor {
+  constructor(hub, {
+    options
+  }) {
+    this._hub = hub;
+    this._options = options;
+    this._trackers = {};
+  }
+  get(role) {
+    if (!this._trackers[role]) {
+      const itemless = role === _constants.ROLE.CONTAINER;
+      this._trackers[role] = new _tracker.default({
+        hub: this._hub,
+        role,
+        itemless,
+        options: () => this._getTrackerOptions(role)
+      });
+    }
+    return this._trackers[role];
+  }
+  _getTrackerOptions(role) {
+    const allTrackerOptions = this._options.resolved.trackers;
+    return allTrackerOptions && allTrackerOptions[role] || {
+      active: false
+    };
+  }
+}
+exports.default = TrackersActor;

package/dist/cjs/constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WORKFLOW_CONFIGURABLE = exports.TRACKING_STATUS = exports.TRACKING_EVENT_TYPES = exports.STATUS = exports.ROLE = exports.QUESTION_SOURCE = exports.PERFORMANCE_EVENT_TYPES = exports.EVENT_TYPE = exports.DEFAULT_UNIT_ID = exports.ATTR_DATA_MISO_UNIT_ID = exports.ATTR_DATA_MISO_PRODUCT_ID = void 0;
+exports.WORKFLOW_CONFIGURABLE = exports.TRACKING_STATUS = exports.TRACKING_EVENT_TYPES = exports.STATUS = exports.ROLE = exports.REQUEST_TYPE = exports.QUESTION_SOURCE = exports.PERFORMANCE_EVENT_TYPES = exports.EVENT_TYPE = exports.DEFAULT_UNIT_ID = exports.ATTR_DATA_MISO_UNIT_ID = exports.ATTR_DATA_MISO_PRODUCT_ID = void 0;
 exports.isDataRole = isDataRole;
 exports.isPerformanceEventType = isPerformanceEventType;
 exports.isProductRole = isProductRole;
@@ -100,4 +100,9 @@ const WORKFLOW_CONFIGURABLE = exports.WORKFLOW_CONFIGURABLE = Object.freeze({
   FILTERS: 'filters',
   PAGINATION: 'pagination',
   TEMPLATES: 'templates'
+});
+const REQUEST_TYPE = exports.REQUEST_TYPE = Object.freeze({
+  QUERY: 'query',
+  REFINE: 'refine',
+  MORE: 'more'
 });

package/dist/cjs/version.js

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

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

@@ -236,7 +236,7 @@ class AnswerBasedWorkflow extends _base.default {
       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;
+    const questionSource = request && request.payload && request.payload.metadata && request.payload.metadata.question_source;
     if (!question) {
       return; // at initial phase
     }
@@ -263,10 +263,34 @@ class AnswerBasedWorkflow extends _base.default {
     payload = (0, _processors.writeEventTargetToInteraction)(payload, args);
     return payload;
   }
+  _writeRequestInfoToInteraction(payload, args) {
+    const {
+      data
+    } = args;
+    if (!data) {
+      return payload;
+    }
+    const requestPayload = data.request && data.request.payload;
+    if (!requestPayload) {
+      return payload;
+    }
+    const {
+      question,
+      fq
+    } = requestPayload;
+    return (0, _commons.mergeInteractions)(payload, {
+      context: {
+        custom_context: {
+          question,
+          fq
+        }
+      }
+    });
+  }
   _writeAskPropertiesToInteraction(payload = {}, args) {
     const question_source = this._getQuestionSourceFromViewState(args);
     const question_id = this.questionId;
-    return (0, _processors.mergeInteraction)(payload, {
+    return (0, _commons.mergeInteractions)(payload, {
       context: {
         custom_context: {
           question_source,
@@ -282,7 +306,7 @@ class AnswerBasedWorkflow extends _base.default {
     const {
       items = []
     } = args;
-    return (0, _processors.mergeInteraction)(payload, {
+    return (0, _commons.mergeInteractions)(payload, {
       context: {
         custom_context: {
           urls: items.map(item => item.url),
@@ -300,7 +324,7 @@ class AnswerBasedWorkflow extends _base.default {
     const {
       payload
     } = request || {};
-    return payload && payload._meta && payload._meta.question_source || undefined;
+    return payload && payload.metadata && payload.metadata.question_source || undefined;
   }
 
   // handlers //

package/dist/cjs/workflow/ask.js

@@ -9,8 +9,8 @@ var _answerBased = _interopRequireDefault(require("./answer-based.js"));
 var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
 var _index2 = require("../layout/index.js");
-var _processors = require("./processors.js");
 var _index3 = require("./options/index.js");
+var _processors = require("./processors.js");
 var _templates = require("../defaults/ask/templates.js");
 const _excluded = ["q", "qs", "questionId"];
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
@@ -147,7 +147,7 @@ class Ask extends _answerBased.default {
       question: q,
       // question, not q
       parent_question_id: parentQuestionId,
-      _meta: Object.assign({}, options._meta, {
+      metadata: Object.assign({}, options.metadata, {
         question_source: qs || _constants.QUESTION_SOURCE.ORGANIC // might be null, not undefined
       })
     }));
@@ -202,7 +202,7 @@ class Ask extends _answerBased.default {
       question_id = this.questionId;
       question_source = this._getQuestionSourceFromViewState(args);
     }
-    return (0, _processors.mergeInteraction)(payload, {
+    return (0, _commons.mergeInteractions)(payload, {
       context: {
         custom_context: {
           property,

package/dist/cjs/workflow/base.js

@@ -82,6 +82,7 @@ class Workflow extends _commons.Component {
       options,
       workflow: this
     });
+    //this._trackers = new TrackersActor(hub, { options });
     this._interactions = new _index.InteractionsActor(hub, {
       client,
       options
@@ -280,7 +281,10 @@ class Workflow extends _commons.Component {
     return this._views.trackers;
   }
   _onTracker(args) {
-    const payload = this._buildInteraction(args);
+    const data = this._hub.states[_index.fields.data()];
+    const payload = this._buildInteraction(Object.assign({}, args, {
+      data
+    }));
     this._sendInteraction(payload);
   }
   _buildInteraction(args) {
@@ -295,7 +299,9 @@ class Workflow extends _commons.Component {
     return payload;
   }
   _defaultProcessInteraction(payload, args) {
+    payload = (0, _processors.writeRequestMetadataToInteraction)(payload, args);
     payload = this._writeApiInfoToInteraction(payload, args);
+    payload = this._writeRequestInfoToInteraction(payload, args);
     payload = this._writeMisoIdToInteraction(payload, args);
     payload = (0, _processors.writeAffiliationInfoToInteraction)(payload, args);
     return payload;
@@ -305,7 +311,7 @@ class Workflow extends _commons.Component {
       group,
       name
     } = this._options.resolved.api;
-    return (0, _processors.mergeInteraction)(payload, {
+    return (0, _commons.mergeInteractions)(payload, {
       context: {
         custom_context: {
           api_group: group,
@@ -314,11 +320,14 @@ class Workflow extends _commons.Component {
       }
     });
   }
+  _writeRequestInfoToInteraction(payload, args) {
+    return payload;
+  }
   _writeMisoIdToInteraction(payload, args) {
     // TODO: ad-hoc, try to pass info from tracker
     const state = this._hub.states[_index.fields.view(args.role)] || {};
     const miso_id = state.meta && state.meta.miso_id || undefined;
-    return miso_id ? (0, _processors.mergeInteraction)(payload, {
+    return miso_id ? (0, _commons.mergeInteractions)(payload, {
       miso_id
     }) : payload;
   }

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

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _commons = require("@miso.ai/commons");
 var _answerBased = _interopRequireDefault(require("./answer-based.js"));
 var _constants = require("../constants.js");
 var _index = require("./options/index.js");
@@ -59,10 +60,10 @@ class HybridSearchAnswer extends _answerBased.default {
         qs
       } = _ref,
       payload = _objectWithoutPropertiesLoose(_ref, _excluded);
-    return Object.assign({}, payload, {
-      _meta: Object.assign({}, payload._meta, {
+    return (0, _commons.mergeApiPayloads)(payload, {
+      metadata: {
         question_source: qs || _constants.QUESTION_SOURCE.ORGANIC // might be null, not undefined
-      })
+      }
     });
   }
 

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

@@ -43,15 +43,13 @@ class HybridSearchResults extends _searchBased.default {
     // get stored query from sibling
     return this._superworkflow._answer._hub.states[_index.fields.query()];
   }
-  _buildPayload(payload) {
+  _buildPayload(payload, type) {
+    payload = super._buildPayload(payload, type);
     // borrow the work from the sibling
     payload = this._superworkflow._answer._writeQuestionSourceToPayload(payload);
-    payload = this._writeFiltersToPayload(payload);
-    payload = this._writePageInfoToPayload(payload);
     payload = this._writeQuestionIdToPayload(payload);
-    return Object.assign({}, payload, {
-      answer: false
-    });
+    payload = (0, _processors.disableAnswerForNonQueryRequest)(payload, type);
+    return payload;
   }
   _buildOrderBy(sort) {
     if (!sort) {
@@ -61,10 +59,10 @@ class HybridSearchResults extends _searchBased.default {
     return sort.field;
   }
   _writeQuestionIdToPayload(payload) {
-    return Object.assign({}, payload, {
-      _meta: (0, _commons.trimObj)(Object.assign({}, payload._meta, {
+    return (0, _commons.mergeApiPayloads)(payload, {
+      metadata: {
         question_id: this._superworkflow._answer.questionId
-      }))
+      }
     });
   }
 

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

@@ -36,17 +36,6 @@ function mergeApiOptions(...optionsList) {
     return false;
   }
   return (0, _utils.mergeOptions)(optionsList, (merged, options) => Object.assign(merged, Object.assign({}, options, {
-    payload: mergeApiPayloads(merged.payload, options.payload)
+    payload: (0, _commons.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
-  } : {};
 }

package/dist/cjs/workflow/processors.js

@@ -5,13 +5,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.buildBaseInteraction = buildBaseInteraction;
 exports.concatItemsFromMoreResponse = concatItemsFromMoreResponse;
+exports.disableAnswerForNonQueryRequest = disableAnswerForNonQueryRequest;
 exports.getRevision = getRevision;
 exports.mappingAnswerData = mappingAnswerData;
 exports.mappingFollowUpQuestionsData = mappingFollowUpQuestionsData;
 exports.mappingReasoningData = mappingReasoningData;
 exports.mappingSortData = mappingSortData;
 exports.mappingSuggestionsData = mappingSuggestionsData;
-exports.mergeInteraction = mergeInteraction;
 exports.retainFacetCountsInData = retainFacetCountsInData;
 exports.writeAffiliationInfoToInteraction = writeAffiliationInfoToInteraction;
 exports.writeAnswerStageToMeta = writeAnswerStageToMeta;
@@ -24,6 +24,7 @@ exports.writeMisoIdFromSession = writeMisoIdFromSession;
 exports.writeMisoIdToMeta = writeMisoIdToMeta;
 exports.writeMisoIdToSession = writeMisoIdToSession;
 exports.writeRequestFromPreviousData = writeRequestFromPreviousData;
+exports.writeRequestMetadataToInteraction = writeRequestMetadataToInteraction;
 exports.writeUnanswerableToMeta = writeUnanswerableToMeta;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../constants.js");
@@ -111,6 +112,16 @@ function mappingFollowUpQuestionsData(data) {
   }));
 }
 
+// payload //
+function disableAnswerForNonQueryRequest(payload, type) {
+  if (type === _constants.REQUEST_TYPE.QUERY) {
+    return payload;
+  }
+  return Object.assign({}, payload, {
+    answer: false
+  });
+}
+
 // data //
 function getRevision(data) {
   return data && data.value && data.value.revision;
@@ -392,6 +403,23 @@ function buildBaseInteraction(args) {
 function areProducts(role, items = []) {
   return (0, _constants.isProductRole)(role) || items.length > 0 && typeof items[0] === 'object' && items[0].product_id;
 }
+function writeRequestMetadataToInteraction(payload, args) {
+  const {
+    data
+  } = args;
+  if (!data) {
+    return payload;
+  }
+  const metadata = data.request && data.request.payload && data.request.payload.metadata;
+  if (!metadata) {
+    return payload;
+  }
+  return (0, _commons.mergeInteractions)(payload, {
+    context: {
+      custom_context: metadata
+    }
+  });
+}
 function writeAffiliationInfoToInteraction(payload, args) {
   if (args.role !== _constants.ROLE.AFFILIATION) {
     return payload;
@@ -401,7 +429,7 @@ function writeAffiliationInfoToInteraction(payload, args) {
   } = args;
   const channel = items[0] && items[0].channel || undefined;
   const positions = items.map(v => v.position);
-  return mergeInteraction(payload, {
+  return (0, _commons.mergeInteractions)(payload, {
     context: {
       custom_context: {
         channel,
@@ -416,7 +444,7 @@ function writeEventTargetToInteraction(payload, {
   if (!event_target) {
     return payload;
   }
-  return mergeInteraction(payload, {
+  return (0, _commons.mergeInteractions)(payload, {
     context: {
       custom_context: {
         event_target
@@ -424,13 +452,6 @@ function writeEventTargetToInteraction(payload, {
     }
   });
 }
-function mergeInteraction(base = {}, patch = {}) {
-  return (0, _commons.trimObj)(Object.assign({}, base, patch, {
-    context: (0, _commons.trimObj)(Object.assign({}, base.context, patch.context, {
-      custom_context: (0, _commons.trimObj)(Object.assign({}, base.context && base.context.custom_context, patch.context && patch.context.custom_context))
-    }))
-  }));
-}
 function writeUnanswerableToMeta(data) {
   const {
     value

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

@@ -90,9 +90,6 @@ class SearchBasedWorkflow extends _base.default {
     this._hub.update(_index.fields.query(), args);
   }
   _query(args) {
-    // keep track of the query args for refine and more calls
-    this._queryArgs = args;
-
     // reset filters view
     this._views.filters.reset({
       silent: true
@@ -102,9 +99,11 @@ class SearchBasedWorkflow extends _base.default {
     this.restart();
 
     // payload
-    const payload = this._buildPayload(args);
+    const type = _constants.REQUEST_TYPE.QUERY;
+    const payload = this._buildPayload(args, type);
     this._request({
-      payload
+      payload,
+      type
     });
   }
   _refine() {
@@ -118,10 +117,12 @@ class SearchBasedWorkflow extends _base.default {
     this.restart();
 
     // payload
+    const type = _constants.REQUEST_TYPE.REFINE;
     const query = this._getQuery();
-    const payload = this._buildPayload(query);
+    const payload = this._buildPayload(query, type);
     this._request({
-      payload
+      payload,
+      type
     });
   }
 
@@ -140,23 +141,26 @@ class SearchBasedWorkflow extends _base.default {
     this._page++;
 
     // payload
+    const type = _constants.REQUEST_TYPE.MORE;
     const query = this._getQuery();
-    let payload = this._buildPayload(query);
-    payload = this._processPayloadForMoreRequest(payload);
+    const payload = this._buildPayload(query, type);
     this._request({
-      payload
+      payload,
+      type
     });
   }
   _getQuery() {
-    // TODO: just get from the hub
-    return this._queryArgs;
+    return this._hub.states[_index.fields.query()];
   }
   _getPageSize() {
     return this._options.resolved.api.payload.rows;
   }
-  _buildPayload(payload) {
+  _buildPayload(payload, type) {
     payload = this._writeFiltersToPayload(payload);
     payload = this._writePageInfoToPayload(payload);
+    if (type === _constants.REQUEST_TYPE.MORE) {
+      payload = this._processPayloadForMoreRequest(payload);
+    }
     return payload;
   }
   _writeFiltersToPayload(payload) {
@@ -194,7 +198,7 @@ class SearchBasedWorkflow extends _base.default {
   }
   _writePageInfoToPayload(payload) {
     return Object.assign({}, payload, {
-      _meta: Object.assign({}, payload._meta, {
+      metadata: Object.assign({}, payload.metadata, {
         page: this._page
       })
     });
@@ -236,9 +240,9 @@ class SearchBasedWorkflow extends _base.default {
       return data; // the initial state
     }
     const {
-      _meta
+      metadata
     } = request.payload;
-    if (!_meta || !_meta.page) {
+    if (!metadata || !metadata.page) {
       return (0, _processors.writeMisoIdAsRootMisoId)(data); // not from "more" request
     }
     // concat records if it's from "more" request
@@ -267,6 +271,30 @@ class SearchBasedWorkflow extends _base.default {
     payload = this._writeRootMisoIdToInteraction(payload);
     return payload;
   }
+  _writeRequestInfoToInteraction(payload, args) {
+    const {
+      data
+    } = args;
+    if (!data) {
+      return payload;
+    }
+    const requestPayload = data.request && data.request.payload;
+    if (!requestPayload) {
+      return payload;
+    }
+    const {
+      q,
+      fq
+    } = requestPayload;
+    return (0, _commons.mergeInteractions)(payload, {
+      context: {
+        custom_context: {
+          q,
+          fq
+        }
+      }
+    });
+  }
   _writeRootMisoIdToInteraction(payload) {
     const data = this._hub.states[_index.fields.data()];
     const {
@@ -275,7 +303,7 @@ class SearchBasedWorkflow extends _base.default {
     if (!root_miso_id) {
       return payload;
     }
-    return (0, _processors.mergeInteraction)(payload, {
+    return (0, _commons.mergeInteractions)(payload, {
       context: {
         custom_context: {
           root_miso_id

package/dist/cjs/workflow/unit.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
 var _base = _interopRequireDefault(require("./base.js"));
-var _processors = require("./processors.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 class UnitWorkflow extends _base.default {
   _initProperties(args) {
@@ -32,7 +31,7 @@ class UnitWorkflow extends _base.default {
   _writeUnitIdToInteraction(payload) {
     const unit_id = this.id;
     const unit_instance_uuid = this.uuid;
-    return (0, _processors.mergeInteraction)(payload, {
+    return (0, _commons.mergeInteractions)(payload, {
       context: {
         custom_context: {
           unit_id,

package/package.json

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

package/src/actor/index.js

@@ -6,4 +6,5 @@ export { default as SessionMaker } from './sessions.js';
 export { default as DataActor } from './data.js';
 export { default as ViewsActor } from './views.js';
 export { default as FeedbackActor } from './feedback.js';
+export { default as TrackersActor } from './trackers.js';
 export { default as InteractionsActor } from './interactions.js';

package/src/actor/tracker.js

@@ -29,7 +29,7 @@ export default class Tracker {
     validateEventType(type);
 
     const { options } = this;
-    if (!options) {
+    if (!options || options.active === false) {
       return;
     }
 

package/src/actor/trackers.js

@@ -0,0 +1,30 @@
+import { ROLE } from '../constants.js';
+import Tracker from './tracker.js';
+
+export default class TrackersActor {
+
+  constructor(hub, { options }) {
+    this._hub = hub;
+    this._options = options;
+    this._trackers = {};
+  }
+
+  get(role) {
+    if (!this._trackers[role]) {
+      const itemless = role === ROLE.CONTAINER;
+      this._trackers[role] = new Tracker({
+        hub: this._hub,
+        role,
+        itemless,
+        options: () => this._getTrackerOptions(role),
+      });
+    }
+    return this._trackers[role];
+  }
+
+  _getTrackerOptions(role) {
+    const allTrackerOptions = this._options.resolved.trackers;
+    return allTrackerOptions && allTrackerOptions[role] || { active: false };
+  }
+
+}

package/src/constants.js

@@ -139,3 +139,9 @@ export const WORKFLOW_CONFIGURABLE = Object.freeze({
   PAGINATION: 'pagination',
   TEMPLATES: 'templates',
 });
+
+export const REQUEST_TYPE = Object.freeze({
+  QUERY: 'query',
+  REFINE: 'refine',
+  MORE: 'more',
+});

package/src/version.js

@@ -1 +1 @@
-export default '1.12.3-beta.5';
+export default '1.12.3';

package/src/workflow/answer-based.js

@@ -1,11 +1,11 @@
-import { API } from '@miso.ai/commons';
+import { API, mergeInteractions } from '@miso.ai/commons';
 import Workflow from './base.js';
 import { fields, FeedbackActor } from '../actor/index.js';
 import { ROLE, STATUS, QUESTION_SOURCE } from '../constants.js';
 import { SearchBoxLayout, TextLayout, ListLayout, GalleryLayout, TypewriterLayout, FeedbackLayout, AffiliationLayout } from '../layout/index.js';
 import { processData as processAffiliationData } from '../affiliation/index.js';
 import { mergeRolesOptions, autoQuery as autoQueryFn, DEFAULT_AUTO_QUERY_PARAM, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
-import { mappingAnswerData, mappingReasoningData, writeAnswerStageToMeta, writeEventTargetToInteraction, mergeInteraction } from './processors.js';
+import { mappingAnswerData, mappingReasoningData, writeAnswerStageToMeta, writeEventTargetToInteraction } from './processors.js';
 import { enableUseLink } from './use-link.js';
 import { isTracked, markAsTracked } from '../util/trackers.js';
 
@@ -226,7 +226,7 @@ export default class AnswerBasedWorkflow extends Workflow {
     }
     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;
+    const questionSource = request && request.payload && request.payload.metadata && request.payload.metadata.question_source;
 
     if (!question) {
       return; // at initial phase
@@ -256,10 +256,30 @@ export default class AnswerBasedWorkflow extends Workflow {
     return payload;
   }
 
+  _writeRequestInfoToInteraction(payload, args) {
+    const { data } = args;
+    if (!data) {
+      return payload;
+    }
+    const requestPayload = data.request && data.request.payload;
+    if (!requestPayload) {
+      return payload;
+    }
+    const { question, fq } = requestPayload;
+    return mergeInteractions(payload, {
+      context: {
+        custom_context: {
+          question,
+          fq,
+        },
+      },
+    });
+  }
+
   _writeAskPropertiesToInteraction(payload = {}, args) {
     const question_source = this._getQuestionSourceFromViewState(args);
     const question_id = this.questionId;
-    return mergeInteraction(payload, {
+    return mergeInteractions(payload, {
       context: {
         custom_context: {
           question_source,
@@ -274,7 +294,7 @@ export default class AnswerBasedWorkflow extends Workflow {
       return payload;
     }
     const { items = [] } = args;
-    return mergeInteraction(payload, {
+    return mergeInteractions(payload, {
       context: {
         custom_context: {
           urls: items.map(item => item.url),
@@ -289,7 +309,7 @@ export default class AnswerBasedWorkflow extends Workflow {
   _getQuestionSourceFromViewState(args) {
     const { request } = this._hub.states[fields.view(args.role)] || {};
     const { payload } = request || {};
-    return (payload && payload._meta && payload._meta.question_source) || undefined;
+    return (payload && payload.metadata && payload.metadata.question_source) || undefined;
   }
 
   // handlers //

package/src/workflow/ask.js

@@ -1,9 +1,8 @@
-import { defineValues, trimObj, API } from '@miso.ai/commons';
+import { defineValues, trimObj, API, mergeInteractions } from '@miso.ai/commons';
 import AnswerBasedWorkflow from './answer-based.js';
 import { fields } from '../actor/index.js';
 import { ROLE, STATUS, QUESTION_SOURCE } from '../constants.js';
 import { OptionListLayout, ListLayout, SearchBoxLayout, TypewriterLayout } from '../layout/index.js';
-import { mergeInteraction } from './processors.js';
 import { mergeRolesOptions, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
 import { mappingSuggestionsData, mappingFollowUpQuestionsData } from './processors.js';
 import { followUp as followUpTemplate } from '../defaults/ask/templates.js';
@@ -138,8 +137,8 @@ export default class Ask extends AnswerBasedWorkflow {
       ...options,
       question: q, // question, not q
       parent_question_id: parentQuestionId,
-      _meta: {
-        ...options._meta,
+      metadata: {
+        ...options.metadata,
         question_source: qs || QUESTION_SOURCE.ORGANIC, // might be null, not undefined
       },
     });
@@ -191,7 +190,7 @@ export default class Ask extends AnswerBasedWorkflow {
       question_source = this._getQuestionSourceFromViewState(args);
     }
 
-    return mergeInteraction(payload, {
+    return mergeInteractions(payload, {
       context: {
         custom_context: {
           property,

package/src/workflow/base.js

@@ -1,10 +1,18 @@
-import { Component, isNullLike } from '@miso.ai/commons';
-import { Hub, SessionMaker, DataActor, ViewsActor, InteractionsActor, fields } from '../actor/index.js';
+import { Component, isNullLike, mergeInteractions } from '@miso.ai/commons';
+import { Hub, SessionMaker, DataActor, ViewsActor, InteractionsActor, TrackersActor, fields } from '../actor/index.js';
 import * as sources from '../source.js';
 import { STATUS, ROLE } from '../constants.js';
 import { ContainerLayout, ErrorLayout } from '../layout/index.js';
 import { WorkflowOptions, mergeApiOptions, makeConfigurable } from './options/index.js';
-import { getRevision, writeRequestFromPreviousData, writeDataStatus, writeMisoIdToMeta, buildBaseInteraction, writeAffiliationInfoToInteraction, mergeInteraction } from './processors.js';
+import {
+  getRevision,
+  writeRequestFromPreviousData,
+  writeDataStatus,
+  writeMisoIdToMeta,
+  buildBaseInteraction,
+  writeRequestMetadataToInteraction,
+  writeAffiliationInfoToInteraction,
+} from './processors.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({});
 
@@ -70,6 +78,7 @@ export default class Workflow extends Component {
     this._sessions = new SessionMaker(hub);
     this._data = new DataActor(hub, { source: sources.api(client), options });
     this._views = new ViewsActor(hub, { extensions, layouts, roles, options, workflow: this });
+    //this._trackers = new TrackersActor(hub, { options });
     this._interactions = new InteractionsActor(hub, { client, options });
   }
 
@@ -265,7 +274,8 @@ export default class Workflow extends Component {
   }
 
   _onTracker(args) {
-    const payload = this._buildInteraction(args);
+    const data = this._hub.states[fields.data()];
+    const payload = this._buildInteraction({ ...args, data });
     this._sendInteraction(payload);
   }
 
@@ -280,7 +290,9 @@ export default class Workflow extends Component {
   }
 
   _defaultProcessInteraction(payload, args) {
+    payload = writeRequestMetadataToInteraction(payload, args);
     payload = this._writeApiInfoToInteraction(payload, args);
+    payload = this._writeRequestInfoToInteraction(payload, args);
     payload = this._writeMisoIdToInteraction(payload, args);
     payload = writeAffiliationInfoToInteraction(payload, args);
     return payload;
@@ -288,7 +300,7 @@ export default class Workflow extends Component {
 
   _writeApiInfoToInteraction(payload) {
     const { group, name } = this._options.resolved.api;
-    return mergeInteraction(payload, {
+    return mergeInteractions(payload, {
       context: {
         custom_context: {
           api_group: group,
@@ -298,11 +310,15 @@ export default class Workflow extends Component {
     });
   }
 
+  _writeRequestInfoToInteraction(payload, args) {
+    return payload;
+  }
+
   _writeMisoIdToInteraction(payload, args) {
     // TODO: ad-hoc, try to pass info from tracker
     const state = this._hub.states[fields.view(args.role)] || {};
     const miso_id = (state.meta && state.meta.miso_id) || undefined;
-    return miso_id ? mergeInteraction(payload, { miso_id }) : payload;
+    return miso_id ? mergeInteractions(payload, { miso_id }) : payload;
   }
 
   _sendInteraction(payload) {

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

@@ -1,3 +1,4 @@
+import { mergeApiPayloads } from '@miso.ai/commons';
 import AnswerBasedWorkflow from './answer-based.js';
 import { ROLE, STATUS, QUESTION_SOURCE } from '../constants.js';
 import { mergeRolesOptions } from './options/index.js';
@@ -50,13 +51,11 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
   }
 
   _writeQuestionSourceToPayload({ qs, ...payload } = {}) {
-    return {
-      ...payload,
-      _meta: {
-        ...payload._meta,
+    return mergeApiPayloads(payload, {
+      metadata: {
         question_source: qs || QUESTION_SOURCE.ORGANIC, // might be null, not undefined
       },
-    };
+    });
   }
 
   // data //

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

@@ -1,8 +1,8 @@
-import { trimObj } from '@miso.ai/commons';
+import { mergeApiPayloads } 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';
+import { writeMisoIdToSession, disableAnswerForNonQueryRequest } from './processors.js';
 
 // we want to override members, not adding to it
 const ROLES_OPTIONS = {
@@ -43,13 +43,13 @@ export default class HybridSearchResults extends SearchBasedWorkflow {
     return this._superworkflow._answer._hub.states[fields.query()];
   }
 
-  _buildPayload(payload) {
+  _buildPayload(payload, type) {
+    payload = super._buildPayload(payload, type);
     // borrow the work from the sibling
     payload = this._superworkflow._answer._writeQuestionSourceToPayload(payload);
-    payload = this._writeFiltersToPayload(payload);
-    payload = this._writePageInfoToPayload(payload);
     payload = this._writeQuestionIdToPayload(payload);
-    return { ...payload, answer: false };
+    payload = disableAnswerForNonQueryRequest(payload, type);
+    return payload;
   }
 
   _buildOrderBy(sort) {
@@ -61,13 +61,11 @@ export default class HybridSearchResults extends SearchBasedWorkflow {
   }
 
   _writeQuestionIdToPayload(payload) {
-    return {
-      ...payload,
-      _meta: trimObj({
-        ...payload._meta,
+    return mergeApiPayloads(payload, {
+      metadata: {
         question_id: this._superworkflow._answer.questionId,
-      }),
-    };
+      },
+    });
   }
 
   // data //

package/src/workflow/options/api.js

@@ -1,4 +1,4 @@
-import { trimObj } from '@miso.ai/commons';
+import { trimObj, mergeApiPayloads } from '@miso.ai/commons';
 import { mergeOptions } from './utils.js';
 
 export function normalizeApiOptions([name, payload] = []) {
@@ -29,18 +29,3 @@ export function mergeApiOptions(...optionsList) {
     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 } : {};
-}

package/src/workflow/processors.js

@@ -1,5 +1,5 @@
-import { trimObj } from '@miso.ai/commons';
-import { STATUS, ROLE, EVENT_TYPE, isPerformanceEventType, isProductRole } from '../constants.js';
+import { trimObj, mergeInteractions } from '@miso.ai/commons';
+import { STATUS, ROLE, EVENT_TYPE, REQUEST_TYPE, isPerformanceEventType, isProductRole } from '../constants.js';
 import { fields } from '../actor/index.js';
 
 // role mappings //
@@ -61,6 +61,14 @@ export function mappingFollowUpQuestionsData(data) {
   return (data.value.followup_questions || []).map(text => ({ text }));
 }
 
+// payload //
+export function disableAnswerForNonQueryRequest(payload, type) {
+  if (type === REQUEST_TYPE.QUERY) {
+    return payload;
+  }
+  return { ...payload, answer: false };
+}
+
 // data //
 export function getRevision(data) {
   return data && data.value && data.value.revision;
@@ -308,6 +316,22 @@ function areProducts(role, items = []) {
   return isProductRole(role) || (items.length > 0 && typeof items[0] === 'object' && items[0].product_id);
 }
 
+export function writeRequestMetadataToInteraction(payload, args) {
+  const { data } = args;
+  if (!data) {
+    return payload;
+  }
+  const metadata = data.request && data.request.payload && data.request.payload.metadata;
+  if (!metadata) {
+    return payload;
+  }
+  return mergeInteractions(payload, {
+    context: {
+      custom_context: metadata,
+    },
+  });
+}
+
 export function writeAffiliationInfoToInteraction(payload, args) {
   if (args.role !== ROLE.AFFILIATION) {
     return payload;
@@ -315,7 +339,7 @@ export function writeAffiliationInfoToInteraction(payload, args) {
   const { items } = args;
   const channel = (items[0] && items[0].channel) || undefined;
   const positions = items.map(v => v.position);
-  return mergeInteraction(payload, {
+  return mergeInteractions(payload, {
     context: {
       custom_context: {
         channel,
@@ -329,7 +353,7 @@ export function writeEventTargetToInteraction(payload, { event_target } = {}) {
   if (!event_target) {
     return payload;
   }
-  return mergeInteraction(payload, {
+  return mergeInteractions(payload, {
     context: {
       custom_context: {
         event_target,
@@ -338,21 +362,6 @@ export function writeEventTargetToInteraction(payload, { event_target } = {}) {
   });
 }
 
-export function mergeInteraction(base = {}, patch = {}) {
-  return trimObj({
-    ...base,
-    ...patch,
-    context: trimObj({
-      ...base.context,
-      ...patch.context,
-      custom_context: trimObj({
-        ...(base.context && base.context.custom_context),
-        ...(patch.context && patch.context.custom_context),
-      }),
-    }),
-  });
-}
-
 export function writeUnanswerableToMeta(data) {
   const { value } = data;
   if (!value) {

package/src/workflow/search-based.js

@@ -1,9 +1,9 @@
-import { API, asArray, trimObj } from '@miso.ai/commons';
+import { API, asArray, trimObj, mergeInteractions } from '@miso.ai/commons';
 import Workflow from './base.js';
 import { fields } from '../actor/index.js';
-import { STATUS, ROLE, WORKFLOW_CONFIGURABLE } from '../constants.js';
+import { STATUS, ROLE, WORKFLOW_CONFIGURABLE, REQUEST_TYPE } from '../constants.js';
 import { SearchBoxLayout, ListLayout, TextLayout, FacetsLayout, SelectLayout, MoreButtonLayout } from '../layout/index.js';
-import { mappingSortData, writeKeywordsToData, retainFacetCountsInData, writeExhaustionToData, writeMisoIdAsRootMisoId, concatItemsFromMoreResponse, mergeInteraction } from './processors.js';
+import { mappingSortData, writeKeywordsToData, retainFacetCountsInData, writeExhaustionToData, writeMisoIdAsRootMisoId, concatItemsFromMoreResponse } from './processors.js';
 import { mergeRolesOptions, autoQuery as autoQueryFn, makeConfigurable, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
 
 const DEFAULT_ROWS = 10;
@@ -99,9 +99,6 @@ export default class SearchBasedWorkflow extends Workflow {
   }
 
   _query(args) {
-    // keep track of the query args for refine and more calls
-    this._queryArgs = args;
-
     // reset filters view
     this._views.filters.reset({ silent: true });
 
@@ -109,9 +106,10 @@ export default class SearchBasedWorkflow extends Workflow {
     this.restart();
 
     // payload
-    const payload = this._buildPayload(args);
+    const type = REQUEST_TYPE.QUERY;
+    const payload = this._buildPayload(args, type);
 
-    this._request({ payload });
+    this._request({ payload, type });
   }
 
   _refine() {
@@ -123,10 +121,11 @@ export default class SearchBasedWorkflow extends Workflow {
     this.restart();
 
     // payload
+    const type = REQUEST_TYPE.REFINE;
     const query = this._getQuery();
-    const payload = this._buildPayload(query);
+    const payload = this._buildPayload(query, type);
 
-    this._request({ payload });
+    this._request({ payload, type });
   }
 
   // TODO: expose API
@@ -144,25 +143,27 @@ export default class SearchBasedWorkflow extends Workflow {
     this._page++;
 
     // payload
+    const type = REQUEST_TYPE.MORE;
     const query = this._getQuery();
-    let payload = this._buildPayload(query);
-    payload = this._processPayloadForMoreRequest(payload);
+    const payload = this._buildPayload(query, type);
 
-    this._request({ payload });
+    this._request({ payload, type });
   }
 
   _getQuery() {
-    // TODO: just get from the hub
-    return this._queryArgs;
+    return this._hub.states[fields.query()];
   }
 
   _getPageSize() {
     return this._options.resolved.api.payload.rows;
   }
 
-  _buildPayload(payload) {
+  _buildPayload(payload, type) {
     payload = this._writeFiltersToPayload(payload);
     payload = this._writePageInfoToPayload(payload);
+    if (type === REQUEST_TYPE.MORE) {
+      payload = this._processPayloadForMoreRequest(payload);
+    }
     return payload;
   }
 
@@ -203,8 +204,8 @@ export default class SearchBasedWorkflow extends Workflow {
   _writePageInfoToPayload(payload) {
     return {
       ...payload,
-      _meta: {
-        ...payload._meta,
+      metadata: {
+        ...payload.metadata,
         page: this._page,
       },
     };
@@ -243,8 +244,8 @@ export default class SearchBasedWorkflow extends Workflow {
     if (!request) {
       return data; // the initial state
     }
-    const { _meta } = request.payload;
-    if (!_meta || !_meta.page) {
+    const { metadata } = request.payload;
+    if (!metadata || !metadata.page) {
       return writeMisoIdAsRootMisoId(data); // not from "more" request
     }
     // concat records if it's from "more" request
@@ -268,13 +269,33 @@ export default class SearchBasedWorkflow extends Workflow {
     return payload;
   }
 
+  _writeRequestInfoToInteraction(payload, args) {
+    const { data } = args;
+    if (!data) {
+      return payload;
+    }
+    const requestPayload = data.request && data.request.payload;
+    if (!requestPayload) {
+      return payload;
+    }
+    const { q, fq } = requestPayload;
+    return mergeInteractions(payload, {
+      context: {
+        custom_context: {
+          q,
+          fq,
+        },
+      },
+    });
+  }
+
   _writeRootMisoIdToInteraction(payload) {
     const data = this._hub.states[fields.data()];
     const { root_miso_id } = (data && data.value) || {};
     if (!root_miso_id) {
       return payload;
     }
-    return mergeInteraction(payload, {
+    return mergeInteractions(payload, {
       context: {
         custom_context: {
           root_miso_id,

package/src/workflow/unit.js

@@ -1,6 +1,5 @@
-import { defineValues } from '@miso.ai/commons';
+import { defineValues, mergeInteractions } from '@miso.ai/commons';
 import Workflow from './base.js';
-import { mergeInteraction } from './processors.js';
 
 export default class UnitWorkflow extends Workflow {
 
@@ -25,7 +24,7 @@ export default class UnitWorkflow extends Workflow {
   _writeUnitIdToInteraction(payload) {
     const unit_id = this.id;
     const unit_instance_uuid = this.uuid;
-    return mergeInteraction(payload, {
+    return mergeInteractions(payload, {
       context: {
         custom_context: {
           unit_id,