@miso.ai/client-sdk-ui 1.12.3-beta.6 → 1.12.4-beta.0

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

@@ -4,17 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _hybridSearchResults = _interopRequireDefault(require("./hybrid-search-results.js"));
+var _searchBased = _interopRequireDefault(require("./search-based.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const RESULTS_ROLE_MEMBERS = _searchBased.default.ROLES_OPTIONS.members;
 function getSubworkflowByRole(role) {
   // TODO: ROLE.ERROR
-  return _hybridSearchResults.default.ROLES_OPTIONS.members.includes(role) ? 'results' : 'answer';
+  return RESULTS_ROLE_MEMBERS.includes(role) ? 'results' : 'answer';
 }
 class HybridSearchViewsActor {
-  constructor(workflow) {
-    this._workflow = workflow;
+  constructor(subviews) {
+    this._subviews = subviews;
     this._containers = new Set();
   }
+  get filters() {
+    return this._subviews.results.filters;
+  }
   get(role) {
     return this._getSubviews(role).get(role);
   }
@@ -31,8 +35,8 @@ class HybridSearchViewsActor {
     }
   }
   removeContainer(element) {
-    for (const subworkflow of this._workflow._subworkflows) {
-      subworkflow._views.removeContainer(element);
+    for (const subviews of this._getAllSubviews()) {
+      subviews.removeContainer(element);
     }
     this._containers.delete(element);
   }
@@ -55,14 +59,11 @@ class HybridSearchViewsActor {
   }
 
   // helpers //
-  _getSubworkflow(role) {
-    return this._workflow._getSubworkflow(getSubworkflowByRole(role));
-  }
   _getAllSubviews() {
-    return this._workflow._subworkflows.flatMap(subworkflow => subworkflow._views);
+    return Object.values(this._subviews);
   }
   _getSubviews(role) {
-    return this._getSubworkflow(role)._views;
+    return this._subviews[getSubworkflowByRole(role)];
   }
   _getViewByElement(element) {
     let {

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

@@ -5,16 +5,16 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
-var _base = _interopRequireDefault(require("./base.js"));
 var _searchBased = _interopRequireDefault(require("./search-based.js"));
 var _answerBased = _interopRequireDefault(require("./answer-based.js"));
 var _constants = require("../constants.js");
 var _index = require("../layout/index.js");
 var _templates = require("../layout/templates.js");
 var _hybridSearchAnswer = _interopRequireDefault(require("./hybrid-search-answer.js"));
-var _hybridSearchResults = _interopRequireDefault(require("./hybrid-search-results.js"));
 var _hybridSearchViews = _interopRequireDefault(require("./hybrid-search-views.js"));
 var _index2 = require("./options/index.js");
+var _processors = require("./processors.js");
+var _autocompletable = require("./autocompletable.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const DEFAULT_API_OPTIONS = Object.freeze({
   group: _commons.API.GROUP.ASK,
@@ -78,83 +78,136 @@ const ROLES_OPTIONS = Object.freeze({
   members: Object.keys(DEFAULT_LAYOUTS),
   mappings: Object.freeze(Object.assign({}, _answerBased.default.ROLES_OPTIONS.mappings, _searchBased.default.ROLES_OPTIONS.mappings))
 });
-class HybridSearch extends _base.default {
+const EXTRA_OPTIONS = Object.freeze({
+  api: Object.freeze({
+    polling: false
+  })
+});
+class HybridSearch extends _searchBased.default {
   constructor(plugin, client) {
     super({
       name: 'hybrid-search',
       plugin,
       client,
       roles: ROLES_OPTIONS,
-      defaults: DEFAULT_OPTIONS
+      defaults: DEFAULT_OPTIONS,
+      extraOptions: EXTRA_OPTIONS
     });
   }
   _initProperties(args) {
     super._initProperties(args);
-    this._subworkflows = [this._answer = new _hybridSearchAnswer.default(this), this._results = new _hybridSearchResults.default(this)];
-  }
-  _getSubworkflow(name) {
-    switch (name) {
-      case 'answer':
-        return this._answer;
-      case 'results':
-        return this._results;
-      default:
-        throw new Error(`Invalid subworkflow: ${name}`);
-    }
-  }
-  _initActors() {
-    this._views = new _hybridSearchViews.default(this);
-  }
-  _initSession() {
-    this._results._sessions.restart();
-    this._answer._sessions.restart();
+    this._initAutocomplete(args);
+    this._answer = new _hybridSearchAnswer.default(this);
+  }
+  _initActors(args) {
+    super._initActors(args);
+    this._views = new _hybridSearchViews.default({
+      results: this._views,
+      answer: this._answer._views
+    });
   }
-
-  // configuration //
-  useLink(fn, options) {
-    this._answer.useLink(fn, options);
-    return this;
+  restart({
+    type
+  } = {}) {
+    super.restart();
+    if (!type || type === _constants.REQUEST_TYPE.QUERY) {
+      this._answer.restart();
+    }
   }
 
   // properties //
   get answer() {
     return this._answer;
   }
-  get results() {
-    return this._results;
-  }
   get questionId() {
     return this._answer.questionId;
   }
-  get filters() {
-    return this._results._views.filters;
-  }
-  get autocomplete() {
-    return this._answer.autocomplete;
-  }
 
   // query //
-  autoQuery(options) {
-    this._answer.autoQuery(options);
+  _buildPayload(payload, type) {
+    payload = super._buildPayload(payload, type);
+    // borrow the work from the sibling
+    payload = (0, _processors.disableAnswerForNonQueryRequest)(payload, type);
+    payload = (0, _processors.writeQuestionSourceToPayload)(payload);
+    payload = this._writeQuestionIdToPayload(payload, type);
+    if (payload.answer !== false) {
+      // uses autoQuery params, so we want to apply to this workflow
+      payload = _answerBased.default.prototype._writeWikiLinkTemplateToPayload.call(this, payload);
+    }
+    return payload;
+  }
+  _buildOrderBy(sort) {
+    if (!sort) {
+      return undefined;
+    }
+    // works differently than search
+    return sort.field;
+  }
+  _writeQuestionIdToPayload(payload, type) {
+    if (type === _constants.REQUEST_TYPE.QUERY) {
+      return payload;
+    }
+    const question_id = this._answer.questionId;
+    if (!question_id) {
+      return payload;
+    }
+    return (0, _commons.mergeApiPayloads)(payload, {
+      metadata: {
+        question_id
+      }
+    });
   }
-  query(args) {
-    this._answer.query(args);
+
+  // data //
+  _defaultProcessData(data, oldData) {
+    data = super._defaultProcessData(data, oldData);
+    (0, _processors.writeMisoIdToSession)(data);
+    return data;
+  }
+  _updateDataInHub(data, oldData) {
+    this._dispatchDataToAnswerWorkflow(data);
+    data = (0, _processors.carryOverQuestionIdToData)(data, oldData); // TODO: may as well move to process data
+    super._updateDataInHub(data, oldData);
+  }
+  _dispatchDataToAnswerWorkflow(data) {
+    const {
+      request
+    } = data;
+    if (!request) {
+      return;
+    }
+    const {
+      type,
+      payload
+    } = request;
+    if (type !== _constants.REQUEST_TYPE.QUERY || !payload || payload.answer === false) {
+      return;
+    }
+    switch (data.status) {
+      case _constants.STATUS.LOADING:
+        // share the loading status with its sibling
+        this._answer._doLoading(data);
+        break;
+      case _constants.STATUS.READY:
+        // start a query with retrieved question ID, if any
+        this._answer._queryWithQuestionId(data);
+        break;
+    }
   }
 
   // interactions //
   _defaultProcessInteraction(payload, args) {
-    payload = this._answer._defaultProcessInteraction0(payload, args);
-    payload = this._results._defaultProcessInteraction0(payload, args);
+    payload = super._defaultProcessInteraction(payload, args);
+    payload = (0, _processors.writeAnswerInfoToInteraction)(payload, args);
     return payload;
   }
 
   // destroy //
   _destroy() {
-    for (const subworkflow of this._subworkflows) {
-      subworkflow.destroy();
-    }
+    this._answer.destroy();
     super._destroy();
   }
 }
 exports.default = HybridSearch;
-(0, _index2.makeConfigurable)(HybridSearch.prototype, [_constants.WORKFLOW_CONFIGURABLE.PAGINATION, _constants.WORKFLOW_CONFIGURABLE.FILTERS]);
+(0, _index2.makeConfigurable)(HybridSearch.prototype, [_constants.WORKFLOW_CONFIGURABLE.PAGINATION, _constants.WORKFLOW_CONFIGURABLE.FILTERS]);
+(0, _autocompletable.makeAutocompletable)(HybridSearch.prototype);

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

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.DEFAULT_AUTO_QUERY_SOURCE_PARAM = exports.DEFAULT_AUTO_QUERY_PARAM = void 0;
 exports.autoQuery = autoQuery;
 exports.normalizeAutoQueryOptions = normalizeAutoQueryOptions;
+exports.updateQueryParametersInUrl = updateQueryParametersInUrl;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../../constants.js");
 const _excluded = ["setValue", "focus", "updateUrl", "param", "sourceParam"];
@@ -57,4 +58,34 @@ function autoQuery(options = {}) {
       qs
     }));
   }
+}
+function updateQueryParametersInUrl({
+  value,
+  request
+}) {
+  if (!this._autoQuery || !this._autoQuery.updateUrl) {
+    return;
+  }
+  const {
+    param,
+    sourceParam
+  } = this._autoQuery;
+  const query = value && (value.question || value.keyword) || request && request.payload && (request.payload.question || request.payload.q);
+  const querySource = request && request.payload && request.payload.metadata && request.payload.metadata.question_source;
+  if (!query) {
+    return; // at initial phase
+  }
+  const url = new URL(window.location);
+  const currentQuery = url.searchParams.get(param);
+  const currentQuerySource = url.searchParams.get(sourceParam) || _constants.QUESTION_SOURCE.ORGANIC;
+  if (query === currentQuery && querySource === currentQuerySource) {
+    return;
+  }
+  url.searchParams.set(param, query);
+  if (querySource === _constants.QUESTION_SOURCE.ORGANIC) {
+    url.searchParams.delete(sourceParam);
+  } else {
+    url.searchParams.set(sourceParam, querySource);
+  }
+  window.history.replaceState({}, '', url);
 }

package/dist/cjs/workflow/processors.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.buildBaseInteraction = buildBaseInteraction;
+exports.carryOverQuestionIdToData = carryOverQuestionIdToData;
 exports.concatItemsFromMoreResponse = concatItemsFromMoreResponse;
 exports.disableAnswerForNonQueryRequest = disableAnswerForNonQueryRequest;
 exports.getRevision = getRevision;
@@ -14,6 +15,8 @@ exports.mappingSortData = mappingSortData;
 exports.mappingSuggestionsData = mappingSuggestionsData;
 exports.retainFacetCountsInData = retainFacetCountsInData;
 exports.writeAffiliationInfoToInteraction = writeAffiliationInfoToInteraction;
+exports.writeAnswerClickInfoToInteraction = writeAnswerClickInfoToInteraction;
+exports.writeAnswerInfoToInteraction = writeAnswerInfoToInteraction;
 exports.writeAnswerStageToMeta = writeAnswerStageToMeta;
 exports.writeDataStatus = writeDataStatus;
 exports.writeEventTargetToInteraction = writeEventTargetToInteraction;
@@ -23,12 +26,17 @@ exports.writeMisoIdAsRootMisoId = writeMisoIdAsRootMisoId;
 exports.writeMisoIdFromSession = writeMisoIdFromSession;
 exports.writeMisoIdToMeta = writeMisoIdToMeta;
 exports.writeMisoIdToSession = writeMisoIdToSession;
+exports.writeQuestionInfoToInteraction = writeQuestionInfoToInteraction;
+exports.writeQuestionSourceToPayload = writeQuestionSourceToPayload;
 exports.writeRequestFromPreviousData = writeRequestFromPreviousData;
+exports.writeRequestInfoToInteraction = writeRequestInfoToInteraction;
 exports.writeRequestMetadataToInteraction = writeRequestMetadataToInteraction;
 exports.writeUnanswerableToMeta = writeUnanswerableToMeta;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../constants.js");
 var _index = require("../actor/index.js");
+const _excluded = ["qs"];
+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; }
 // role mappings //
 function mappingSortData(_, {
   hub,
@@ -113,6 +121,17 @@ function mappingFollowUpQuestionsData(data) {
 }
 
 // payload //
+function writeQuestionSourceToPayload(_ref = {}) {
+  let {
+      qs
+    } = _ref,
+    payload = _objectWithoutPropertiesLoose(_ref, _excluded);
+  return (0, _commons.mergeApiPayloads)(payload, {
+    metadata: {
+      question_source: qs || _constants.QUESTION_SOURCE.ORGANIC // might be null, not undefined
+    }
+  });
+}
 function disableAnswerForNonQueryRequest(payload, type) {
   if (type === _constants.REQUEST_TYPE.QUERY) {
     return payload;
@@ -365,6 +384,19 @@ function writeExhaustionToData(data, {
     })
   });
 }
+function carryOverQuestionIdToData(data, oldData) {
+  const {
+    question_id
+  } = oldData && oldData.value || {};
+  if (!question_id) {
+    return data;
+  }
+  return Object.assign({}, data, {
+    value: Object.assign({}, data.value, {
+      question_id
+    })
+  });
+}
 
 // interactions //
 function buildBaseInteraction(args) {
@@ -420,6 +452,32 @@ function writeRequestMetadataToInteraction(payload, args) {
     }
   });
 }
+function writeRequestInfoToInteraction(payload, args) {
+  const {
+    data
+  } = args;
+  if (!data) {
+    return payload;
+  }
+  const requestPayload = data.request && data.request.payload;
+  if (!requestPayload) {
+    return payload;
+  }
+  const {
+    question,
+    q,
+    fq
+  } = requestPayload;
+  return (0, _commons.mergeInteractions)(payload, {
+    context: {
+      custom_context: {
+        question,
+        q,
+        fq
+      }
+    }
+  });
+}
 function writeAffiliationInfoToInteraction(payload, args) {
   if (args.role !== _constants.ROLE.AFFILIATION) {
     return payload;
@@ -438,6 +496,55 @@ function writeAffiliationInfoToInteraction(payload, args) {
     }
   });
 }
+function writeAnswerInfoToInteraction(payload, args) {
+  payload = writeQuestionInfoToInteraction(payload, args);
+  payload = writeAnswerClickInfoToInteraction(payload, args);
+  payload = writeEventTargetToInteraction(payload, args);
+  return payload;
+}
+function writeQuestionInfoToInteraction(payload = {}, {
+  data
+} = {}) {
+  if (!data) {
+    return payload;
+  }
+  const {
+    request = {},
+    value = {}
+  } = data;
+  const {
+    question_source
+  } = request.payload && request.payload.metadata || {};
+  const {
+    question_id
+  } = value;
+  return (0, _commons.mergeInteractions)(payload, {
+    context: {
+      custom_context: {
+        question_source,
+        question_id
+      }
+    }
+  });
+}
+function writeAnswerClickInfoToInteraction(payload, args) {
+  if (args.role !== _constants.ROLE.ANSWER) {
+    return payload;
+  }
+  const {
+    items = []
+  } = args;
+  return (0, _commons.mergeInteractions)(payload, {
+    context: {
+      custom_context: {
+        urls: items.map(item => item.url),
+        texts: items.map(item => item.text),
+        class_names: items.map(item => item.className),
+        attributes: items.map(item => item.attributes)
+      }
+    }
+  });
+}
 function writeEventTargetToInteraction(payload, {
   event_target
 } = {}) {

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

@@ -90,16 +90,19 @@ class SearchBasedWorkflow extends _base.default {
     this._hub.update(_index.fields.query(), args);
   }
   _query(args) {
+    const type = _constants.REQUEST_TYPE.QUERY;
+
     // reset filters view
     this._views.filters.reset({
       silent: true
     });
 
     // start a new session
-    this.restart();
+    this.restart({
+      type
+    });
 
     // payload
-    const type = _constants.REQUEST_TYPE.QUERY;
     const payload = this._buildPayload(args, type);
     this._request({
       payload,
@@ -107,6 +110,8 @@ class SearchBasedWorkflow extends _base.default {
     });
   }
   _refine() {
+    const type = _constants.REQUEST_TYPE.REFINE;
+
     // remember current facet_counts
     const {
       facet_counts
@@ -114,10 +119,11 @@ class SearchBasedWorkflow extends _base.default {
     this._currentFacetCounts = facet_counts;
 
     // start a new session
-    this.restart();
+    this.restart({
+      type
+    });
 
     // payload
-    const type = _constants.REQUEST_TYPE.REFINE;
     const query = this._getQuery();
     const payload = this._buildPayload(query, type);
     this._request({
@@ -228,9 +234,13 @@ class SearchBasedWorkflow extends _base.default {
     });
     return data;
   }
-  _updateDataInHub(data) {
+  _updateData(data) {
+    super._updateData(data);
+    _index3.updateQueryParametersInUrl.call(this, data);
+  }
+  _updateDataInHub(data, oldData) {
     data = this._appendResultsFromMoreRequest(data);
-    super._updateDataInHub(data);
+    super._updateDataInHub(data, oldData);
   }
   _appendResultsFromMoreRequest(data) {
     const {
@@ -271,30 +281,6 @@ 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 {

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.6"
+    "@miso.ai/commons": "1.12.4-beta.0"
   },
-  "version": "1.12.3-beta.6"
+  "version": "1.12.4-beta.0"
 }

package/src/actor/data.js

@@ -3,10 +3,11 @@ import { isCurrentSession } from './utils.js';
 
 export default class DataActor {
 
-  constructor(hub, { source, options }) {
+  constructor(hub, { source, options, polling = true }) {
     this._hub = hub;
     this._source = source;
     this._options = options;
+    this._polling = polling;
     this._unsubscribes = [
       hub.on(fields.session(), session => this._handleSession(session)),
       hub.on(fields.request(), event => this._handleRequest(event)),
@@ -57,13 +58,15 @@ export default class DataActor {
         if (response._response) {
           this._emitResponseWithSessionCheck({ session, request, value: response._response });
         }
-        let value;
-        for await (value of response) {
-          // A new session invalidates ongoing data fetch for the old session, terminating the loop
-          if (!isCurrentSession(this._hub, session)) {
-            break;
+        if (this._polling) {
+          let value;
+          for await (value of response) {
+            // A new session invalidates ongoing data fetch for the old session, terminating the loop
+            if (!isCurrentSession(this._hub, session)) {
+              break;
+            }
+            this._emitResponse({ session, request, value });
           }
-          this._emitResponse({ session, request, value });
         }
       } else {
         this._emitResponseWithSessionCheck({ session, request, value: response });

package/src/defaults/ask/controls.js

@@ -41,10 +41,7 @@ export function wireRelatedResources(client, element) {
   if (!element) {
     return;
   }
-  client.ui.asks.on('loading', (event) => {
-    // When a new query starts, associate the last section container (for related resources) to that workflow
-    for (const container of element.querySelectorAll('miso-ask')) {
-      container.workflow = event.workflow;
-    }
-  });
+  for (const container of element.querySelectorAll('miso-ask')) {
+    container.setAttribute('workflow', 'active');
+  }
 }

package/src/defaults/ask/templates.js

@@ -95,7 +95,7 @@ class Sections extends _Sections {
   relatedResourcesSection(options) {
     const { container, phrase, section } = this._helpers;
     const { features = {}, logo = true } = options;
-    const body = features.relatedResources === false ? '' : container(options, { name: 'related-resources', visibleWhen: 'nonempty', logo }, [
+    const body = features.relatedResources === false ? '' : container(options, { name: 'related-resources', visibleWhen: 'nonempty', workflow: 'active', logo }, [
       phrase(options, { name: 'related-resources', tag: 'h2' }),
       '<miso-related-resources></miso-related-resources>',
     ]);

package/src/defaults/common/templates.js

@@ -126,10 +126,10 @@ export class Helpers {
     }, body);
   }
 
-  container({ classPrefix, circledCitationIndex, parentQuestionId }, { name, extraNames = [], visibleWhen, trait, logo = false }, body) {
+  container({ classPrefix, circledCitationIndex, parentQuestionId, workflow }, { name, extraNames = [], visibleWhen, trait, logo = false }, body) {
     const classes = [name, ...extraNames].map(name => `${classPrefix}__${name}-container`);
     circledCitationIndex && classes.push('miso-circled-citation-index');
-    return this.element(this._context.CONAINER_TAG, { classes, visibleWhen, trait, logo, parentQuestionId }, body);
+    return this.element(this._context.CONAINER_TAG, { classes, visibleWhen, trait, logo, parentQuestionId, workflow }, body);
   }
 
   element(tag, attributes = {}, body = '') {