@miso.ai/client-sdk-ui 1.11.0-beta.1 → 1.11.0-beta.10

package/src/workflow/explore.js

@@ -1,21 +1,24 @@
 import { API } from '@miso.ai/commons';
 import Workflow from './base.js';
-import { mergeApiOptions } from './options.js';
 import { fields } from '../actor/index.js';
 import { ROLE, EVENT_TYPE } from '../constants.js';
 import { ListLayout, SearchBoxLayout } from '../layout/index.js';
+import { mergeRolesOptions } from './options.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({
+  ...Workflow.DEFAULT_API_OPTIONS,
   group: API.GROUP.ASK,
   name: API.NAME.RELATED_QUESTIONS,
 });
 
 const DEFAULT_LAYOUTS = Object.freeze({
+  ...Workflow.DEFAULT_LAYOUTS,
   [ROLE.RELATED_QUESTIONS]: [ListLayout.type, { itemType: 'question', link: { rel: 'noopener nofollow' } }],
   [ROLE.QUERY]: [SearchBoxLayout.type, { placeholder: 'Ask a question' }],
 });
 
 const DEFAULT_TRACKERS = Object.freeze({
+  ...Workflow.DEFAULT_TRACKERS,
   [ROLE.RELATED_QUESTIONS]: {},
   [ROLE.CONTAINER]: {},
   [ROLE.QUERY]: {
@@ -24,11 +27,17 @@ const DEFAULT_TRACKERS = Object.freeze({
 });
 
 const DEFAULT_OPTIONS = Object.freeze({
+  ...Workflow.DEFAULT_OPTIONS,
   api: DEFAULT_API_OPTIONS,
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS,
 });
 
+const ROLES_OPTIONS = mergeRolesOptions(Workflow.ROLES_OPTIONS, {
+  main: ROLE.RELATED_QUESTIONS,
+  members: Object.keys(DEFAULT_LAYOUTS),
+});
+
 export default class Explore extends Workflow {
 
   constructor(plugin, client) {
@@ -36,7 +45,7 @@ export default class Explore extends Workflow {
       name: 'explore',
       plugin,
       client,
-      roles: Object.keys(DEFAULT_LAYOUTS),
+      roles: ROLES_OPTIONS,
       defaults: DEFAULT_OPTIONS,
     });
   }
@@ -52,7 +61,7 @@ export default class Explore extends Workflow {
     this._unsubscribes = [
       ...this._unsubscribes,
       this._views.get(ROLE.RELATED_QUESTIONS).on('click', event => this._handleRelatedQuestionClick(event)),
-      this._hub.on(fields.query(), payload => this.query(payload)),
+      this._hub.on(fields.query(), args => this._submit(args)),
     ];
   }
 
@@ -82,17 +91,16 @@ export default class Explore extends Workflow {
 
   // lifecycle //
   start({ relatedQuestions = true } = {}) {
-    if (relatedQuestions && this._linkFn === undefined) {
+    if (this._linkFn === undefined) {
       throw new Error('Define link mapping function before calling start()');
     }
-    this._sessions.start();
     // in explore workflow, start() triggers query
     // TODO: we should still make the query lifecycle
-    const { session } = this;
     if (relatedQuestions) {
-      this._hub.update(fields.request(), mergeApiOptions(this._options.resolved.api, { session }));
+      this._request();
     } else {
       // TODO: ad-hoc
+      const { session } = this;
       this.updateData({ session, request: {}, value: { related_questions: [] } });
     }
     return this;
@@ -124,7 +132,14 @@ export default class Explore extends Workflow {
     this._events.emit('select', Object.freeze({ ...event, question }));
   }
 
-  query({ q } = {}) {
+  query(args) {
+    if (!args.q) {
+      throw new Error(`q is required in query() call`);
+    }
+    this._hub.update(fields.query(), args);
+  }
+
+  _submit({ q } = {}) {
     if (!this._linkFn) {
       return;
     }

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

@@ -0,0 +1,92 @@
+import AnswerBasedWorkflow from './answer-based.js';
+import { ROLE, STATUS, ORGANIC_QUESTION_SOURCE } from '../constants.js';
+import { mergeRolesOptions } from './options.js';
+import { writeKeywordsToData } from './processors.js';
+import { makeAutocompletable } from './autocompletable.js';
+
+const ROLES_OPTIONS = mergeRolesOptions(AnswerBasedWorkflow.ROLES_OPTIONS, {
+  mappings: {
+    [ROLE.QUESTION]: ROLE.KEYWORDS,
+  },
+});
+
+export default class HybridSearchAnswer extends AnswerBasedWorkflow {
+
+  constructor(superworkflow) {
+    super({
+      name: 'hybrid-search/answer',
+      plugin: superworkflow._plugin,
+      client: superworkflow._client,
+      options: superworkflow._options,
+      defaults: superworkflow._defaults,
+      roles: ROLES_OPTIONS,
+      superworkflow,
+    });
+  }
+
+  _initProperties(args) {
+    super._initProperties(args);
+    this._initAutocomplete(args);
+    this._superworkflow = args.superworkflow;
+  }
+
+  _initSession() {} // no reset here, will manually reset later
+
+  restart() {
+    super.restart();
+    // cascade restart to the sibling
+    const results = this._superworkflow._results;
+    results._views.filters.reset();
+    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 //
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
+    data = writeKeywordsToData(data);
+    return data;
+  }
+
+  _updateDataInHub(data) {
+    switch (data.status) {
+      case STATUS.INITIAL:
+      case STATUS.LOADING:
+        // share the initial/loading status with its sibling
+        this._dispatchDataToSibling(data);
+        break;
+    }
+    super._updateDataInHub(data);
+  }
+
+  _handleHeadResponse(data) {
+    super._handleHeadResponse(data);
+    // share the search results with its sibling
+    this._dispatchDataToSibling(data);
+  }
+
+  _dispatchDataToSibling(data) {
+    this._resultsSession && this._superworkflow._results.updateData({ ...data, session: this._resultsSession });
+  }
+
+  // destroy //
+  _destroy(options) {
+    this._destroyAutocomplete();
+    super._destroy(options);
+  }
+
+}
+
+makeAutocompletable(HybridSearchAnswer.prototype);

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

@@ -0,0 +1,63 @@
+import { trimObj } from '@miso.ai/commons';
+import SearchBasedWorkflow from './search-based.js';
+import { fields } from '../actor/index.js';
+import { ROLE } from '../constants.js';
+import { mergeRolesOptions } from './options.js';
+import { writeFiltersToPayload } from './processors.js';
+
+const ROLES_OPTIONS = mergeRolesOptions(SearchBasedWorkflow.ROLES_OPTIONS, {
+  members: [ROLE.PRODUCTS, ROLE.KEYWORDS, ROLE.TOTAL, ROLE.FACETS, ROLE.MORE],
+});
+
+export default class HybridSearchResults extends SearchBasedWorkflow {
+
+  constructor(superworkflow) {
+    super({
+      name: 'hybrid-search/results',
+      plugin: superworkflow._plugin,
+      client: superworkflow._client,
+      options: superworkflow._options,
+      defaults: superworkflow._defaults,
+      roles: ROLES_OPTIONS,
+      superworkflow,
+    });
+  }
+
+  _initProperties(args) {
+    super._initProperties(args);
+    this._superworkflow = args.superworkflow;
+  }
+
+  _initSession() {} // no reset here, will manually reset later
+
+  // lifecycle //
+  _emitLifecycleEvent(name, event) {
+    super._emitLifecycleEvent(name, event);
+    this._superworkflow._emitLifecycleEvent(name, event);
+  }
+
+  // query //
+  _getQuery() {
+    // get stored query from sibling
+    return this._superworkflow._answer._hub.states[fields.query()];
+  }
+
+  _buildPayload({ filters, ...payload } = {}) {
+    // borrow the work from the sibling
+    payload = this._superworkflow._answer._buildPayload(payload);
+    payload = writeFiltersToPayload(payload, filters);
+    payload = this._writeQuestionIdToPayload(payload);
+    return { ...payload, answer: false };
+  }
+
+  _writeQuestionIdToPayload(payload) {
+    return {
+      ...payload,
+      _meta: trimObj({
+        ...payload._meta,
+        question_id: this._superworkflow._answer.questionId,
+      }),
+    };
+  }
+
+}

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

@@ -0,0 +1,124 @@
+import { ROLE } from '../constants.js';
+
+function getSubworkflowByRole(role) {
+  // TODO: ROLE.ERROR
+  switch (role) {
+    case ROLE.PRODUCTS:
+    case ROLE.TOTAL:
+    case ROLE.FACETS:
+    case ROLE.KEYWORDS:
+    case ROLE.MORE:
+      return 'results';
+    default:
+      return 'answer';
+  }
+}
+
+export default 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/src/workflow/hybrid-search.js

@@ -1,125 +1,154 @@
-import { trimObj, API } from '@miso.ai/commons';
+import { API } from '@miso.ai/commons';
+import { InteractionsActor } from '../actor/index.js';
+import Workflow from './base.js';
+import SearchBasedWorkflow from './search-based.js';
 import AnswerBasedWorkflow from './answer-based.js';
-import { mergeApiOptions } from './options.js';
-import { fields } from '../actor/index.js';
-import { ROLE, ORGANIC_QUESTION_SOURCE } from '../constants.js';
-import { ListLayout, TextLayout, FacetsLayout } from '../layout/index.js';
-import { writeKeywordsToData, addDataInstructions } from './processors.js';
+import { ROLE } from '../constants.js';
+import { SearchBoxLayout, TextLayout } from '../layout/index.js';
+import HybridSearchAnswer from './hybrid-search-answer.js';
+import HybridSearchResults from './hybrid-search-results.js';
+import HybridSearchViewsActor from './hybrid-search-views.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({
-  ...AnswerBasedWorkflow.DEFAULT_API_OPTIONS,
+  group: API.GROUP.ASK,
   name: API.NAME.SEARCH,
   payload: {
     ...AnswerBasedWorkflow.DEFAULT_API_OPTIONS.payload,
+    ...SearchBasedWorkflow.DEFAULT_API_OPTIONS.payload,
+    source_fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at', 'title'],
   },
 });
 
 const DEFAULT_LAYOUTS = Object.freeze({
   ...AnswerBasedWorkflow.DEFAULT_LAYOUTS,
-  [ROLE.PRODUCTS]: [ListLayout.type, { itemType: 'article' }],
-  [ROLE.KEYWORDS]: [TextLayout.type, { raw: true }],
-  [ROLE.HITS]: [TextLayout.type, { raw: true, format: 'number' }],
-  [ROLE.FACETS]: [FacetsLayout.type],
+  ...SearchBasedWorkflow.DEFAULT_LAYOUTS,
+  [ROLE.QUERY]: [SearchBoxLayout.type, { placeholder: '' }],
+  [ROLE.QUESTION]: [TextLayout.type, { raw: true }],
 });
 
 const DEFAULT_TRACKERS = Object.freeze({
   ...AnswerBasedWorkflow.DEFAULT_TRACKERS,
+  ...SearchBasedWorkflow.DEFAULT_TRACKERS,
+});
+
+const DEFAULT_PAGINATION = Object.freeze({
+  ...SearchBasedWorkflow.DEFAULT_PAGINATION,
+  active: true,
+});
+
+const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
+  api: {
+    group: API.GROUP.ASK,
+    name: API.NAME.SEARCH_AUTOCOMPLETE,
+    payload: {
+      completion_fields: ['suggested_queries'],
+    },
+  },
 });
 
 const DEFAULT_OPTIONS = Object.freeze({
   ...AnswerBasedWorkflow.DEFAULT_OPTIONS,
+  ...SearchBasedWorkflow.DEFAULT_OPTIONS,
   api: DEFAULT_API_OPTIONS,
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS,
+  autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS,
+  pagination: DEFAULT_PAGINATION,
 });
 
-const ROLES_CONFIG = Object.freeze({
-  [ROLE.QUESTION]: {
-    mapping: ROLE.KEYWORDS,
-  },
-  [ROLE.FACETS]: {
-    mapping: 'facet_counts',
-  },
+const ROLES_OPTIONS = Object.freeze({
+  main: ROLE.PRODUCTS,
+  members: Object.keys(DEFAULT_LAYOUTS),
+  mappings: Object.freeze({
+    ...AnswerBasedWorkflow.ROLES_OPTIONS.mappings,
+    ...SearchBasedWorkflow.ROLES_OPTIONS.mappings,
+  }),
 });
 
-export default class HybridSearch extends AnswerBasedWorkflow {
+export default class HybridSearch extends Workflow {
 
   constructor(plugin, client) {
     super({
       name: 'hybrid-search',
       plugin,
       client,
-      roles: Object.keys(DEFAULT_LAYOUTS),
-      rolesConfig: ROLES_CONFIG,
+      roles: ROLES_OPTIONS,
       defaults: DEFAULT_OPTIONS,
     });
   }
 
-  _initSubscriptions(args) {
-    super._initSubscriptions(args);
-    this._unsubscribes = [
-      ...this._unsubscribes,
-      this._hub.on(fields.filters(), filters => this._refine(filters)),
+  _initProperties(args) {
+    super._initProperties(args);
+    this._subworkflows = [
+      this._answer = new HybridSearchAnswer(this),
+      this._results = new HybridSearchResults(this),
     ];
   }
 
-  // query //
-  _buildPayload({ q, qs, filters, ...payload } = {}) {
-    const fq = this._buildFq(filters); // TODO: combine with fq in payload?
-    return trimObj({
-      ...payload,
-      q, // q, not question
-      fq,
-      _meta: {
-        ...payload._meta,
-        question_source: qs || ORGANIC_QUESTION_SOURCE, // might be null, not undefined
-      },
-    });
+  _getSubworkflow(name) {
+    switch (name) {
+      case 'answer':
+        return this._answer;
+      case 'results':
+        return this._results;
+      default:
+        throw new Error(`Invalid subworkflow: ${name}`);
+    }
   }
 
-  _buildFq(filters) {
-    if (!filters) {
-      return undefined;
-    }
-    const clauses = [];
-    const { facets } = filters;
-    for (const field in facets) {
-      const values = facets[field];
-      if (!values || !values.length) {
-        continue; // just in case
-      }
-      clauses.push(`${field}:(${values.map(v => `"${v}"`).join(' OR ')})`);
-    }
-    return clauses.map(c => `(${c})`).join(' AND ');
+  _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 });
   }
 
-  _refine(filters) {
-    const query = this._hub.states[fields.query()];
-    const payload = this._buildPayload({ ...query, filters, answer: false });
-    const { session } = this;
+  _initSession() {
+    this._results._sessions.restart();
+    this._answer._sessions.restart();
+  }
 
-    const event = mergeApiOptions(this._options.resolved.api, { payload, session, _skipLoading: true });
-    this._request(event);
+  // configuration //
+  useLink(fn) {
+    this._answer.useLink(fn);
+    return this;
+  }
 
-    // emulate loading status exclusively for products
-    // TODO
+  // properties //
+  get questionId() {
+    return this._answer.questionId;
   }
 
-  // data //
-  _defaultProcessData(data) {
-    data = super._defaultProcessData(data);
-    data = writeKeywordsToData(data);
-    data = instructPartialUpdates(data);
-    return data;
+  get filters() {
+    return this._results._views.filters;
   }
 
-}
+  get autocomplete() {
+    return this._answer.autocomplete;
+  }
+
+  // query //
+  autoQuery(options) {
+    this._answer.autoQuery(options);
+  }
 
-function instructPartialUpdates(data) {
-  if (!data.value) {
-    return data;
+  query(args) {
+    this._answer.query(args);
   }
-  return addDataInstructions(data, data.value.products ? 
-    { includes: [ ROLE.PRODUCTS, ROLE.HITS, ROLE.FACETS, ROLE.KEYWORDS, ROLE.QUESTION ], merge: true } :
-    { excludes: [ ROLE.PRODUCTS, ROLE.HITS, ROLE.FACETS ], merge: true });
+
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    return this._answer._defaultProcessInteraction(payload, args);
+  }
+
+  // destroy //
+  _destroy() {
+    for (const subworkflow of this._subworkflows) {
+      subworkflow.destroy();
+    }
+    super._destroy();
+  }
+
 }

package/src/workflow/options.js

@@ -110,15 +110,14 @@ export function normalizeInteractionsOptions(options) {
   return { ...options, preprocess };
 }
 
-export function normalizeAutocompleteOptions(options) {
+export function normalizePaginationOptions(options) {
   if (options === undefined) {
-    throw new Error(`Expect autocomplete options to be an object or a boolean value: ${options}`);
+    throw new Error(`Expect pagination options to be an object or a boolean value: ${options}`);
   }
   if (typeof options === 'boolean') {
-    options = { actor: options };
+    options = { active: options };
   }
-  const processData = normalizeDataProcessorOptions(options.processData);
-  return { ...options, processData };
+  return options;
 }
 
 // merge //
@@ -206,17 +205,33 @@ export function mergeInteractionsOptions(...optionsList) {
   }));
 }
 
-export function mergeAutocompleteOptions(...optionsList) {
+export function mergePaginationOptions(...optionsList) {
   if (optionsList[optionsList.length - 1] === false) {
     return false;
   }
+  return mergeOptions(optionsList, (merged, options) => Object.assign(merged, options));
+}
+
+export function mergeAutocompleteOptions(...optionsList) {
   return mergeOptions(optionsList, (merged, options) => Object.assign(merged, {
     ...options,
     api: mergeApiOptions(merged.api, options.api),
-    processData: mergeDataProcessorOptions(merged.processData, options.processData),
   }));
 }
 
+export function mergeRolesOptions(base, overrides) {
+  return Object.freeze({
+    ...base,
+    ...overrides,
+    members: mergeRolesMembers(base.members, overrides.members),
+    mappings: Object.freeze({ ...base.mappings, ...overrides.mappings }),
+  });
+}
+
+function mergeRolesMembers(base = [], overrides = []) {
+  return [...new Set([...base, ...overrides])];
+}
+
 
 
 // manifest //
@@ -247,9 +262,9 @@ const FEATURES = [
     merge: mergeInteractionsOptions,
   },
   {
-    key: 'autocomplete',
-    normalize: normalizeAutocompleteOptions,
-    merge: mergeAutocompleteOptions,
+    key: 'pagination',
+    normalize: normalizePaginationOptions,
+    merge: mergePaginationOptions,
   },
 ];
 
@@ -272,7 +287,7 @@ export class WorkflowOptions {
 
   constructor(context = {}, defaults = {}) {
     this._events = new EventEmitter({ target: this });
-    this._defaults = defaults;
+    this._defaults = defaults; // TODO: we should call normalize() on defaults
     this._context = context || {};
     this._locals = {};