@miso.ai/client-sdk-ui 1.11.0-beta.2 → 1.11.0-beta.4

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

@@ -5,19 +5,18 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
-var _answerBased = _interopRequireDefault(require("./answer-based.js"));
-var _options = require("./options.js");
 var _index = require("../actor/index.js");
+var _base = _interopRequireDefault(require("./base.js"));
+var _answerBased = _interopRequireDefault(require("./answer-based.js"));
 var _constants = require("../constants.js");
 var _index2 = require("../layout/index.js");
-var _processors = require("./processors.js");
-const _excluded = ["q", "qs", "filters"];
+var _hybridSearchAnswer = _interopRequireDefault(require("./hybrid-search-answer.js"));
+var _hybridSearchResults = _interopRequireDefault(require("./hybrid-search-results.js"));
 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 (e.includes(n)) continue; t[n] = r[n]; } return t; }
 const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_API_OPTIONS, {
   name: _commons.API.NAME.SEARCH,
   payload: Object.assign({}, _answerBased.default.DEFAULT_API_OPTIONS.payload, {
-    source_fl: [...(_answerBased.default.DEFAULT_API_OPTIONS.payload.source_fl || []), 'title', 'snippet']
+    fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at']
   })
 }));
 const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_LAYOUTS, {
@@ -47,7 +46,23 @@ const ROLES_CONFIG = Object.freeze({
     mapping: 'facet_counts'
   }
 });
-class HybridSearch extends _answerBased.default {
+const SUBWORKFLOW = Object.freeze({
+  ANSWER: 'answer',
+  RESULTS: 'results'
+});
+function getSubworkflowByRole(role) {
+  // TODO: ROLE.ERROR
+  switch (role) {
+    case _constants.ROLE.PRODUCTS:
+    case _constants.ROLE.HITS:
+    case _constants.ROLE.FACETS:
+    case _constants.ROLE.KEYWORDS:
+      return SUBWORKFLOW.RESULTS;
+    default:
+      return SUBWORKFLOW.ANSWER;
+  }
+}
+class HybridSearch extends _base.default {
   constructor(plugin, client) {
     super({
       name: 'hybrid-search',
@@ -58,68 +73,177 @@ class HybridSearch extends _answerBased.default {
       defaults: DEFAULT_OPTIONS
     });
   }
-  _initSubscriptions(args) {
-    super._initSubscriptions(args);
-    this._unsubscribes = [...this._unsubscribes, this._hub.on(_index.fields.filters(), filters => this._refine(filters))];
+  _initProperties(args) {
+    super._initProperties(args);
+    this._subworkflows = [this._answer = new _hybridSearchAnswer.default(this), this._results = new _hybridSearchResults.default(this)];
   }
-
-  // query //
-  _buildPayload() {
-    let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  _getSubworkflow(name) {
+    switch (name) {
+      case SUBWORKFLOW.ANSWER:
+        return this._answer;
+      case SUBWORKFLOW.RESULTS:
+        return this._results;
+      default:
+        throw new Error(`Invalid subworkflow: ${name}`);
+    }
+  }
+  _initActors() {
+    const hub = this._hub;
+    const client = this._client;
+    const options = this._options;
+    this._views = new HybridSearchViewsActor(this);
+    this._interactions = new _index.InteractionsActor(hub, {
+      client,
+      options
+    });
+  }
+  _initReset() {
+    this._results.reset();
+    this._answer.reset();
+  }
+  restart() {
     let {
-        q,
-        qs,
-        filters
-      } = _ref,
-      payload = _objectWithoutPropertiesLoose(_ref, _excluded);
-    const fq = (0, _processors.composeFq)(filters); // TODO: combine with fq in payload?
-    return (0, _commons.trimObj)(Object.assign({}, payload, {
-      q,
-      // q, not question
-      fq,
-      _meta: Object.assign({}, payload._meta, {
-        question_source: qs || _constants.ORGANIC_QUESTION_SOURCE // might be null, not undefined
-      })
-    }));
-  }
-  _refine(filters) {
-    const query = this._hub.states[_index.fields.query()];
-    const payload = this._buildPayload(Object.assign({}, query, {
-      filters,
-      answer: false
-    }));
+      answer = true
+    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const previousSession = this.session;
+    this._sessions.restart();
     const {
       session
     } = this;
-    const event = (0, _options.mergeApiOptions)(this._options.resolved.api, {
-      payload,
-      session,
-      _skipLoading: true
-    });
-    this._request(event);
+    if (!answer) {
+      session._answer = previousSession._answer || previousSession;
+    }
+    return this;
+  }
 
-    // emulate loading status exclusively for products
-    // TODO
+  // properties //
+  get questionId() {
+    return this._answer.questionId;
+  }
+  get filters() {
+    return this._results._views.filters;
+  }
+
+  // query //
+  autoQuery(options) {
+    this._answer.autoQuery(options);
+  }
+  query(args) {
+    this._answer.query(args);
+  }
+
+  // interactions //
+  _preprocessInteraction(payload) {
+    return this._answer._preprocessInteraction(payload);
   }
 
-  // data //
-  _defaultProcessData(data) {
-    data = super._defaultProcessData(data);
-    data = (0, _processors.writeKeywordsToData)(data);
-    data = instructPartialUpdates(data);
-    return data;
+  // destroy //
+  _destroy() {
+    for (const subworkflow of this._subworkflows) {
+      subworkflow.destroy();
+    }
+    super._destroy();
   }
 }
 exports.default = HybridSearch;
-function instructPartialUpdates(data) {
-  if (!data.value) {
-    return data;
-  }
-  return (0, _processors.addDataInstructions)(data, data.value.products ? {
-    includes: [_constants.ROLE.PRODUCTS, _constants.ROLE.HITS, _constants.ROLE.FACETS, _constants.ROLE.KEYWORDS, _constants.ROLE.QUESTION],
-    merge: true
-  } : {
-    excludes: [_constants.ROLE.PRODUCTS, _constants.ROLE.HITS, _constants.ROLE.FACETS],
-    merge: true
-  });
+class HybridSearchViewsActor {
+  constructor(workflow) {
+    this._workflow = workflow;
+    this._containers = new Set();
+  }
+  get(role) {
+    return this._getSubviews(role).get(role);
+  }
+  addContainer(element) {
+    if (this._containers.has(element)) {
+      return;
+    }
+    this._containers.add(element);
+    const {
+      components
+    } = element;
+    for (const component of components) {
+      this.addComponent(component);
+    }
+  }
+  removeContainer(element) {
+    for (const subworkflow of this._workflow._subworkflows) {
+      subworkflow._views.removeContainer(element);
+    }
+    this._containers.delete(element);
+  }
+  addComponent(element) {
+    this._getViewByElement(element).element = element;
+    this._addContainerToSubviews(element._container, element);
+  }
+  removeComponent(element) {
+    this._getViewByElement(element).element = undefined;
+    this._removeContainerFromSubviewsIfNecessary(element._container);
+  }
+  updateComponentRole(element, oldRole, newRole) {
+    // TODO
+  }
+  refreshElement(element) {
+    const view = element.isContainer ? this._containers.get(element) : this._getViewByElement(element);
+    view && view.refresh({
+      force: true
+    });
+  }
+
+  // helpers //
+  _getSubworkflow(role) {
+    return this._workflow._getSubworkflow(getSubworkflowByRole(role));
+  }
+  _getAllSubviews() {
+    return this._workflow._subworkflows.flatMap(subworkflow => subworkflow._views);
+  }
+  _getSubviews(role) {
+    return this._getSubworkflow(role)._views;
+  }
+  _getViewByElement(element) {
+    let {
+      role
+    } = element;
+    if (!role) {
+      throw new Error('Component must have a role');
+    }
+    return this.get(role);
+  }
+  _addContainerToSubviews(container, child) {
+    if (!container) {
+      return;
+    }
+    const {
+      role
+    } = child;
+    const subviews = this._getSubviews(role);
+    if (subviews._containers.has(container)) {
+      return;
+    }
+    // check if the container is in other subviews
+    for (const otherSubviews of this._getAllSubviews()) {
+      if (otherSubviews === subviews) {
+        continue;
+      }
+      if (otherSubviews._containers.has(container)) {
+        // find the conflicting element
+        for (const component of container.components) {
+          if (otherSubviews.containsElement(component)) {
+            throw new Error(`<${container.tagName}> cannot contain both <${component.tagName}> and <${child.tagName}>, for they don't share the same data lifecycle.`);
+          }
+        }
+        throw new Error(`Failed to add container <${container.tagName}> with child component <${child.tagName}>.`);
+      }
+    }
+    // add the container to the subviews
+    subviews.addContainer(container);
+  }
+  _removeContainerFromSubviewsIfNecessary(container) {
+    if (!container || container.components.length > 0) {
+      return;
+    }
+    for (const subviews of this._getAllSubviews()) {
+      subviews.removeContainer(container);
+    }
+  }
 }

package/dist/cjs/workflow/processors.js

@@ -3,17 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.addDataInstructions = addDataInstructions;
 exports.composeFq = composeFq;
-exports.removeDataInstructions = removeDataInstructions;
 exports.writeAnswerStageToMeta = writeAnswerStageToMeta;
 exports.writeDataStatus = writeDataStatus;
 exports.writeKeywordsToData = writeKeywordsToData;
 exports.writeMisoIdToMeta = writeMisoIdToMeta;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../constants.js");
-const _excluded = ["_inst"];
-function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.includes(n)) continue; t[n] = r[n]; } return t; }
 function writeDataStatus(data) {
   const status = getStatus(data);
   const ongoing = status === _constants.STATUS.READY ? !!data.ongoing : undefined;
@@ -97,21 +93,6 @@ function writeAnswerStageToMeta(data) {
     })
   });
 }
-function addDataInstructions(data, instructions) {
-  if (!instructions) {
-    return data;
-  }
-  return Object.assign({
-    _inst: Object.assign({}, data._inst, instructions)
-  }, data);
-}
-function removeDataInstructions(data) {
-  if (typeof data !== 'object') {
-    return data;
-  }
-  const rest = _objectWithoutPropertiesLoose(data, _excluded);
-  return rest;
-}
 function composeFq(filters) {
   if (!filters) {
     return undefined;

package/package.json

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

package/src/actor/data.js

@@ -50,10 +50,8 @@ export default class DataActor {
     const { session } = this._hub.states;
     const { session: _, ...request } = event;
 
-    if (!event._skipLoading) {
-      // emit response to update request
-      this._emitResponse({ session, request });
-    }
+    // emit response to update request
+    this._emitResponse({ session, request });
 
     try {
       const { signal } = this._ac || {};

package/src/actor/hub.js

@@ -1,5 +1,4 @@
 import { defineValues, EventEmitter } from '@miso.ai/commons';
-import { removeDataInstructions } from '../workflow/processors.js';
 
 export default class Hub {
 
@@ -14,7 +13,7 @@ export default class Hub {
   }
 
   update(name, state, { silent = false } = {}) {
-    this._states[name] = Object.freeze(removeDataInstructions(state));
+    this._states[name] = Object.freeze(state);
     if (!silent) {
       this._events.emit(name, state);
     }

package/src/actor/sessions.js

@@ -10,12 +10,13 @@ export default class SessionMaker {
   }
 
   get active() {
-    const { session } = this._hub.states;
+    // TODO: may eliminate active flag?
+    const session = this._hub.states[fields.session()];
     return !!(session && session.active);
   }
 
   new({ force = false } = {}) {
-    const currentSession = this._hub.states.session;
+    const currentSession = this._hub.states[fields.session()];
     if (currentSession && !currentSession.active && !force) {
       return;
     }
@@ -24,7 +25,7 @@ export default class SessionMaker {
   }
 
   start() {
-    const session = this._hub.states.session || this._create();
+    const session = this._hub.states[fields.session()] || this._create();
     if (session.active) {
       return;
     }

package/src/actor/views.js

@@ -99,6 +99,10 @@ export default class ViewsActor {
     // TODO
   }
 
+  containsElement(element) {
+    return this._containers.has(element) || this._views[element.role];
+  }
+
   refreshElement(element) {
     const view = element.isContainer ? this._containers.get(element) : this._getViewByElement(element);
     view && view.refresh({ force: true });

package/src/defaults/hybrid-search/answer-box.js

@@ -35,9 +35,9 @@ export default class AnswerBox {
 
     this._unsubscribes = [
       () => element.removeEventListener('click', callback),
-      workflow.on('loading', () => this.hide()),
-      workflow.on('error', () => this.show()),
-      workflow.on('ready', () => this.show()),
+      workflow._answer.on('loading', () => this.hide()),
+      workflow._answer.on('error', () => this.show()),
+      workflow._answer.on('ready', () => this.show()),
     ];
   }
 
@@ -52,7 +52,7 @@ export default class AnswerBox {
   }
 
   _syncWofkflowStatus() {
-    const { status } = this._workflow;
+    const { status } = this._workflow._answer;
     switch (status) {
       case STATUS.ERRONEOUS:
       case STATUS.READY:

package/src/layout/trackable.js

@@ -1,4 +1,4 @@
-import { mixin } from '@miso.ai/commons'; 
+import { mixin } from '@miso.ai/commons';
 import Bindings from '../util/bindings.js';
 import Viewables from '../util/viewables.js';
 import { validateClick } from '../util/trackers.js';

package/src/version.js

@@ -1 +1 @@
-export default '1.11.0-beta.2';
+export default '1.11.0-beta.4';

package/src/workflow/answer-based.js

@@ -133,16 +133,21 @@ export default class AnswerBasedWorkflow extends Workflow {
     // start a new session
     this.restart();
 
-    // keep track of question source on this session
-    const { session } = this;
-    session.meta.question_source = args.questionSource || ORGANIC_QUESTION_SOURCE; // might be null, not undefined
+    // TODO: move to ask workflow
+    // keep track of question source on this session, for suggested questions interactions
+    this._writeQuestionSourceToSession(args);
 
     // build payload and trigger request
+    const { session } = this;
     const payload = this._buildPayload(args);
     const event = mergeApiOptions(this._options.resolved.api, { payload, session });
     this._request(event);
   }
 
+  _writeQuestionSourceToSession(args) {
+    this.session.meta.question_source = args.questionSource || ORGANIC_QUESTION_SOURCE; // might be null, not undefined
+  }
+
   _request(event) {
     this._hub.update(fields.request(), event);
   }
@@ -164,11 +169,22 @@ export default class AnswerBasedWorkflow extends Workflow {
   */
 
   // data //
-  _defaultProcessData(data) {
-    data = super._defaultProcessData(data);
+  _updateData(data) {
+    // if it's the head response, write question id and return
+    if (data.value && !data.value.answer_stage) {
+      this._handleHeadResponse(data);
+      return;
+    }
+    super._updateData(data);
+  }
 
+  _handleHeadResponse(data) {
     // capture question ID and register at context
     this._writeQuestionIdFromData(data);
+  }
+
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
 
     // update URL if autoQuery.updateUrl is not false
     this._updateUrlIfNecessary(data);

package/src/workflow/ask.js

@@ -2,7 +2,7 @@ import { defineValues, trimObj, API } from '@miso.ai/commons';
 import AnswerBasedWorkflow from './answer-based.js';
 import { fields } from '../actor/index.js';
 import { ROLE, ORGANIC_QUESTION_SOURCE } from '../constants.js';
-import { OptionListLayout, ListLayout, TextLayout } from '../layout/index.js';
+import { OptionListLayout, ListLayout } from '../layout/index.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({
   ...AnswerBasedWorkflow.DEFAULT_API_OPTIONS,
@@ -64,6 +64,7 @@ export default class Ask extends AnswerBasedWorkflow {
     if (!previous) {
       return;
     }
+    // TODO: write question_source from payload._meta, so we don't need to write it to session.meta
     const values = previous.states[fields.data()].value;
     const value = values.suggested_followup_questions || values.followup_questions || [];
     this._hub.update(fields.suggestions(), { value: value.map(text => ({ text })) });

package/src/workflow/base.js

@@ -5,7 +5,7 @@ import { STATUS, ROLE } from '../constants.js';
 import { ContainerLayout, ErrorLayout } from '../layout/index.js';
 import { injectLogger } from './utils.js';
 import { WorkflowOptions, mergeLayoutsOptions, mergeInteractionsOptions, makeConfigurable } from './options.js';
-import { writeDataStatus, writeMisoIdToMeta, addDataInstructions } from './processors.js';
+import { writeDataStatus, writeMisoIdToMeta } from './processors.js';
 
 const DEFAULT_LAYOUTS = Object.freeze({
   [ROLE.CONTAINER]: ContainerLayout.type,
@@ -38,7 +38,7 @@ export default class Workflow extends Component {
   constructor(args) {
     super(args.name || 'workflow', args.plugin);
 
-    let { context, plugin, client } = args;
+    let { context, plugin, client, options } = args;
     this._context = context;
     this._plugin = plugin = plugin || context._plugin;
     this._client = client = client || context._client;
@@ -49,7 +49,7 @@ export default class Workflow extends Component {
     this._rolesConfig = { ...ROLES_CONFIG, ...args.rolesConfig };
 
     this._extensions = plugin._getExtensions(client);
-    this._options = new WorkflowOptions(context && context._options, mergeDefaults(this, args.defaults));
+    this._options = options || new WorkflowOptions(context && context._options, mergeDefaults(this, args.defaults));
     this._hub = injectLogger(new Hub(), (...args) => this._log(...args));
 
     this._initProperties(args);
@@ -90,7 +90,7 @@ export default class Workflow extends Component {
   }
 
   get session() {
-    return this._hub.states.session;
+    return this._hub.states[fields.session()];
   }
 
   get active() {
@@ -128,7 +128,7 @@ export default class Workflow extends Component {
   }
 
   // states //
-  updateData(data, { instructions } = {}) {
+  updateData(data) {
     if (!data) {
       throw new Error(`Data is required.`);
     }
@@ -152,6 +152,12 @@ export default class Workflow extends Component {
       }
     }
 
+    this._updateData(data);
+
+    return this;
+  }
+
+  _updateData(data) {
     this._sessions.start(); // in case session not started yet
 
     data = writeDataStatus(data);
@@ -160,19 +166,14 @@ export default class Workflow extends Component {
       data = process(data);
     }
 
-    // write data instructions from function args
-    data = addDataInstructions(data, instructions);
-    data = this._mergeDataIfNecessary(data);
-
     this._hub.update(fields.data(), data);
-
-    return this;
   }
 
   _defaultProcessData(data) {
     return writeMisoIdToMeta(data);
   }
 
+  /*
   _mergeDataIfNecessary(data) {
     if (!data._inst || !data._inst.merge) {
       return data;
@@ -184,6 +185,7 @@ export default class Workflow extends Component {
   }
 
   _handleResponseObject() {}
+  */
 
   // TODO: notifyViewUpdateAll()
 

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

@@ -0,0 +1,78 @@
+import AnswerBasedWorkflow from './answer-based.js';
+import { ROLE, STATUS, ORGANIC_QUESTION_SOURCE } from '../constants.js';
+import { writeKeywordsToData } from './processors.js';
+
+const ROLES_CONFIG = Object.freeze({
+  [ROLE.QUESTION]: {
+    mapping: ROLE.KEYWORDS,
+  },
+});
+
+export default class HybridSearchAnswer extends AnswerBasedWorkflow {
+
+  constructor(superworkflow) {
+    super({
+      name: 'hybrid-search/answer',
+      plugin: superworkflow._plugin,
+      client: superworkflow._client,
+      options: superworkflow._options,
+      roles: Object.keys(AnswerBasedWorkflow.DEFAULT_LAYOUTS),
+      rolesConfig: ROLES_CONFIG,
+      superworkflow,
+    });
+    this.useInteractions(false);
+  }
+
+  _initProperties(args) {
+    super._initProperties(args);
+    this._superworkflow = args.superworkflow;
+  }
+
+  _initReset() {} // no reset here, will manually reset later
+
+  restart() {
+    super.restart();
+    // cascade restart to the sibling
+    const results = this._superworkflow._results;
+    results.restart();
+    this._resultsSession = results.session; // keep track of the session
+  }
+
+  // query //
+  _buildPayload({ q, qs, ...payload } = {}) {
+    return {
+      ...payload,
+      q, // q, not question
+      _meta: {
+        ...payload._meta,
+        question_source: qs || ORGANIC_QUESTION_SOURCE, // might be null, not undefined
+      },
+    };
+  }
+
+  // data //
+  _updateData(data) {
+    // we want this to be available everywhere
+    data = writeKeywordsToData(data);
+
+    switch (data.status) {
+      case STATUS.INITIAL:
+      case STATUS.LOADING:
+        // share the initial/loading status with its sibling
+        this._dispatchDataToSibling(data);
+        break;
+    }
+    super._updateData(data);
+  }
+
+  _handleHeadResponse(data) {
+    super._handleHeadResponse(data);
+    // share the search results with its sibling
+    this._dispatchDataToSibling(data);
+  }
+
+  _dispatchDataToSibling(data) {
+    this._superworkflow._results.updateData({ ...data, session: this._resultsSession });
+  }
+
+}