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

package/src/workflow/ask.js

@@ -1,11 +1,11 @@
 import { defineValues, trimObj, API } from '@miso.ai/commons';
 import AnswerBasedWorkflow from './answer-based.js';
 import { fields } from '../actor/index.js';
-import { ROLE, STATUS, ORGANIC_QUESTION_SOURCE } from '../constants.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 } from './processors.js';
+import { mappingSuggestionsData, mappingFollowUpQuestionsData } from './processors.js';
 import { followUp as followUpTemplate } from '../defaults/ask/templates.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({
@@ -23,6 +23,7 @@ const DEFAULT_LAYOUTS = Object.freeze({
   [ROLE.REASONING]: TypewriterLayout.type,
   [ROLE.RELATED_RESOURCES]: [ListLayout.type, { incremental: true, itemType: 'article' }],
   [ROLE.QUERY_SUGGESTIONS]: OptionListLayout.type,
+  [ROLE.FOLLOW_UP_QUESTIONS]: OptionListLayout.type,
 });
 
 const DEFAULT_TRACKERS = Object.freeze({
@@ -53,6 +54,7 @@ const ROLES_OPTIONS = mergeRolesOptions(AnswerBasedWorkflow.ROLES_OPTIONS, {
   members: Object.keys(DEFAULT_LAYOUTS),
   mappings: {
     [ROLE.QUERY_SUGGESTIONS]: mappingSuggestionsData,
+    [ROLE.FOLLOW_UP_QUESTIONS]: mappingFollowUpQuestionsData,
   },
 });
 
@@ -79,6 +81,9 @@ export default class Ask extends AnswerBasedWorkflow {
     this._unsubscribes = [
       ...this._unsubscribes,
       this._hub.on(fields.view(ROLE.REASONING), state => this._onReasoningViewUpdate(state)),
+      this._views.get(ROLE.ANSWER).on('follow-up-click', event => this._onFollowUpClick(event)),
+      this._views.get(ROLE.FOLLOW_UP_QUESTIONS).on('select', event => this._onFollowUpQuestionSelect(event)),
+      this._views.get(ROLE.QUERY_SUGGESTIONS).on('select', event => this._onQuerySuggestionSelect(event)),
     ];
   }
 
@@ -91,6 +96,8 @@ export default class Ask extends AnswerBasedWorkflow {
 
   // lifecycle //
   restart() {
+    const { next } = this;
+    next && next.destroy();
     if (this._questionId) {
       this._context._byQid.delete(this._questionId);
     }
@@ -126,7 +133,7 @@ export default class Ask extends AnswerBasedWorkflow {
       parent_question_id: parentQuestionId,
       _meta: {
         ...options._meta,
-        question_source: qs || ORGANIC_QUESTION_SOURCE, // might be null, not undefined
+        question_source: qs || QUESTION_SOURCE.ORGANIC, // might be null, not undefined
       },
     });
     payload = this._writeWikiLinkTemplateToPayload(payload);
@@ -163,8 +170,11 @@ export default class Ask extends AnswerBasedWorkflow {
     let { property } = (payload.context && payload.context.custom_context) || {};
     let question_id, parent_question_id, question_source;
 
-    if (args.role === ROLE.QUERY_SUGGESTIONS) {
+    if (args.role === ROLE.FOLLOW_UP_QUESTIONS || args.role === ROLE.QUERY_SUGGESTIONS) {
       property = 'suggested_followup_questions';
+    }
+
+    if (args.role === ROLE.QUERY_SUGGESTIONS) {
       parent_question_id = this.previous && this.previous.parentQuestionId;
       question_id = this.parentQuestionId;
       question_source = this.previous && this.previous.session.meta.question_source;
@@ -187,6 +197,36 @@ export default class Ask extends AnswerBasedWorkflow {
     });
   }
 
+  // handlers //
+  _onFollowUpClick({ q, event } = {}) {
+    if (event.button !== 0) {
+      return; // only left click
+    }
+    this._submitFollowUpQuestion({ q, qs: QUESTION_SOURCE.INLINE_QUESTION_LINK });
+    // TODO: track click?
+  }
+
+  _onFollowUpQuestionSelect({ value: q }) {
+    this._submitFollowUpQuestion({ q, qs: QUESTION_SOURCE.SUGGESTED_QUESTIONS });
+  }
+
+  _submitFollowUpQuestion({ q = '', qs } = {}) {
+    q = q.trim();
+    if (!q) {
+      return;
+    }
+    const next = this.getOrCreateNext();
+    next.query({ q, qs });
+  }
+
+  _onQuerySuggestionSelect({ value: q }) {
+    if (!q) {
+      return;
+    }
+    // backward compatible: query on current workflow
+    this.query({ q, qs: QUESTION_SOURCE.SUGGESTED_QUESTIONS });
+  }
+
   // helpers //
   _writeQuestionId(questionId) {
     // capture question ID and register at context
@@ -212,7 +252,10 @@ export default class Ask extends AnswerBasedWorkflow {
 
   // destroy //
   _destroy(options) {
-    const { parentQuestionId, questionId } = this;
+    const { next, parentQuestionId, questionId } = this;
+    if (next) {
+      next.destroy(options);
+    }
     if (parentQuestionId) {
       this._context._byPqid.delete(parentQuestionId);
     }

package/src/workflow/asks.js

@@ -19,7 +19,7 @@ function autoNextOptionsAsPredicate(options = DEFAULT_AUTO_NEXT_OPTIONS) {
     case 'function':
       return options;
     default:
-      return false;
+      return () => false;
   }
 }
 
@@ -31,6 +31,7 @@ export default class Asks extends WorkflowContext {
     this._byPqid = new Map();
     this._root = new Ask(this); // initialize with default workflow
     this._events.on('*', event => this._createNextIfNecessary(event));
+    this._autoNextFn = undefined;
   }
 
   get root() {

package/src/workflow/base.js

@@ -4,7 +4,7 @@ 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, writeDataStatus, writeMisoIdToMeta, buildBaseInteraction, writeAffiliationInfoToInteraction, mergeInteraction } from './processors.js';
+import { getRevision, writeRequestFromPreviousData, writeDataStatus, writeMisoIdToMeta, buildBaseInteraction, writeAffiliationInfoToInteraction, mergeInteraction } from './processors.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({});
 
@@ -75,6 +75,7 @@ export default class Workflow extends Component {
 
   _initSubscriptions({ roles }) {
     this._unsubscribes = [
+      this._hub.on(fields.session(), session => this._onSession(session)),
       this._hub.on(fields.response(), data => this.updateData(data)),
       this._hub.on(fields.tracker(), args => this._onTracker(args)),
     ];
@@ -154,6 +155,10 @@ export default class Workflow extends Component {
     }
   }
 
+  _onSession(session) {
+    this.updateData({ session });
+  }
+
   _onMainViewUpdate(state) {
     const { status } = state;
     const done = status === STATUS.READY;
@@ -186,8 +191,9 @@ export default class Workflow extends Component {
   // request //
   _request(options = {}) {
     const { session } = this;
-    const event = mergeApiOptions(this._options.resolved.api, { ...options, session });
-    this._hub.update(fields.request(), event);
+    const request = mergeApiOptions(this._options.resolved.api, options);
+    this.updateData({ session, request });
+    this._hub.update(fields.request(), { ...request, session });
   }
 
   // data //
@@ -221,15 +227,17 @@ export default class Workflow extends Component {
   }
 
   _updateData(data) {
-    data = this._defaultProcessData(data);
+    const oldData = this._hub.states[fields.data()];
+    data = this._defaultProcessData(data, oldData);
     for (const process of this._options.resolved.dataProcessor) {
-      data = process(data);
+      data = process(data, oldData);
     }
 
-    this._updateDataInHub(data);
+    this._updateDataInHub(data, oldData);
   }
 
-  _defaultProcessData(data) {
+  _defaultProcessData(data, oldData) {
+    data = writeRequestFromPreviousData(data, oldData);
     data = writeDataStatus(data);
     data = writeMisoIdToMeta(data);
     return data;
@@ -308,7 +316,7 @@ export default class Workflow extends Component {
 
   // destroy //
   destroy(options) {
-    this._events.emit('destroy');
+    this._emit('destroy');
     this._destroy(options);
   }
 

package/src/workflow/explore.js

@@ -121,8 +121,8 @@ export default class Explore extends UnitWorkflow {
     return this;
   }
 
-  _defaultProcessData(data) {
-    data = super._defaultProcessData(data);
+  _defaultProcessData(data, oldData) {
+    data = super._defaultProcessData(data, oldData);
     data = this._addUrlToRelatedQuestions(data);
     return data;
   }

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

@@ -1,5 +1,5 @@
 import AnswerBasedWorkflow from './answer-based.js';
-import { ROLE, STATUS, ORGANIC_QUESTION_SOURCE } from '../constants.js';
+import { ROLE, STATUS, QUESTION_SOURCE } from '../constants.js';
 import { mergeRolesOptions } from './options/index.js';
 import { writeKeywordsToData, writeMisoIdToSession, writeMisoIdFromSession, writeUnanswerableToMeta } from './processors.js';
 import { makeAutocompletable } from './autocompletable.js';
@@ -54,14 +54,14 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
       ...payload,
       _meta: {
         ...payload._meta,
-        question_source: qs || ORGANIC_QUESTION_SOURCE, // might be null, not undefined
+        question_source: qs || QUESTION_SOURCE.ORGANIC, // might be null, not undefined
       },
     };
   }
 
   // data //
-  _defaultProcessData(data) {
-    data = super._defaultProcessData(data);
+  _defaultProcessData(data, oldData) {
+    data = super._defaultProcessData(data, oldData);
     data = writeKeywordsToData(data);
     data = writeMisoIdFromSession(data);
     data = writeUnanswerableToMeta(data);

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

@@ -71,8 +71,8 @@ export default class HybridSearchResults extends SearchBasedWorkflow {
   }
 
   // data //
-  _defaultProcessData(data) {
-    data = super._defaultProcessData(data);
+  _defaultProcessData(data, oldData) {
+    data = super._defaultProcessData(data, oldData);
     writeMisoIdToSession(data);
     return data;
   }

package/src/workflow/processors.js

@@ -54,11 +54,30 @@ export function mappingSuggestionsData(_, { workflow } = {}) {
   return value && value.map(text => ({ text }));
 }
 
+export function mappingFollowUpQuestionsData(data) {
+  if (!data || !data.value) {
+    return undefined;
+  }
+  return (data.value.followup_questions || []).map(text => ({ text }));
+}
+
 // data //
 export function getRevision(data) {
   return data && data.value && data.value.revision;
 }
 
+export function writeRequestFromPreviousData(data, oldData) {
+  // patch request in case user call updateData() without request object in custom data scenario
+  if (!data || !data.value || data.request || !oldData || !oldData.request) {
+    return data;
+  }
+  const { request } = oldData;
+  return {
+    ...data,
+    request,
+  };
+}
+
 export function writeDataStatus(data) {
   const status = getStatus(data);
   const ongoing = status === STATUS.READY ? data.ongoing : undefined;
@@ -186,11 +205,29 @@ export function retainFacetCountsInData(data, currentFacetCounts) {
   };
 }
 
+export function writeMisoIdAsRootMisoId(data) {
+  const { value } = data;
+  if (!value) {
+    return data;
+  }
+  const { miso_id } = value;
+  if (!miso_id) {
+    return data;
+  }
+  return {
+    ...data,
+    value: {
+      ...value,
+      root_miso_id: miso_id,
+    },
+  };
+}
+
 export function concatItemsFromMoreResponse(oldData, newData, { role = ROLE.PRODUCTS } = {}) {
   if (!newData.value) {
     return oldData;
   }
-  const { [role]: oldProducts = [], facet_counts, total } = oldData.value;
+  const { [role]: oldProducts = [], facet_counts, total, root_miso_id } = oldData.value;
   const { [role]: newProducts = [] } = newData.value;
   // keep old exhaustion flag, just in case
   // TODO
@@ -202,6 +239,7 @@ export function concatItemsFromMoreResponse(oldData, newData, { role = ROLE.PROD
       ...newData.value,
       facet_counts,
       total,
+      root_miso_id,
       [role]: [...oldProducts, ...newProducts],
     },
   }
@@ -304,7 +342,7 @@ export function mergeInteraction(base = {}, patch = {}) {
   return trimObj({
     ...base,
     ...patch,
-    context:trimObj({
+    context: trimObj({
       ...base.context,
       ...patch.context,
       custom_context: trimObj({

package/src/workflow/search-based.js

@@ -3,7 +3,7 @@ import Workflow from './base.js';
 import { fields } from '../actor/index.js';
 import { STATUS, ROLE, WORKFLOW_CONFIGURABLE } from '../constants.js';
 import { SearchBoxLayout, ListLayout, TextLayout, FacetsLayout, SelectLayout, MoreButtonLayout } from '../layout/index.js';
-import { mappingSortData, writeKeywordsToData, retainFacetCountsInData, writeExhaustionToData, concatItemsFromMoreResponse } from './processors.js';
+import { mappingSortData, writeKeywordsToData, retainFacetCountsInData, writeExhaustionToData, writeMisoIdAsRootMisoId, concatItemsFromMoreResponse, mergeInteraction } from './processors.js';
 import { mergeRolesOptions, autoQuery as autoQueryFn, makeConfigurable, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
 
 const DEFAULT_ROWS = 10;
@@ -225,8 +225,8 @@ export default class SearchBasedWorkflow extends Workflow {
   }
 
   // data //
-  _defaultProcessData(data) {
-    data = super._defaultProcessData(data);
+  _defaultProcessData(data, oldData) {
+    data = super._defaultProcessData(data, oldData);
     data = writeKeywordsToData(data);
     data = retainFacetCountsInData(data, this._currentFacetCounts);
     data = writeExhaustionToData(data, { role: this._roles.main });
@@ -245,7 +245,7 @@ export default class SearchBasedWorkflow extends Workflow {
     }
     const { _meta } = request.payload;
     if (!_meta || !_meta.page) {
-      return data; // not from "more" request
+      return writeMisoIdAsRootMisoId(data); // not from "more" request
     }
     // concat records if it's from "more" request
     const currentData = this._hub.states[fields.data()];
@@ -261,6 +261,28 @@ export default class SearchBasedWorkflow extends Workflow {
     this._views.filters.apply();
   }
 
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    payload = super._defaultProcessInteraction(payload, args);
+    payload = this._writeRootMisoIdToInteraction(payload);
+    return payload;
+  }
+
+  _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, {
+      context: {
+        custom_context: {
+          root_miso_id,
+        }
+      }
+    });
+  }
+
 }
 
 makeConfigurable(SearchBasedWorkflow.prototype, [WORKFLOW_CONFIGURABLE.PAGINATION, WORKFLOW_CONFIGURABLE.FILTERS]);