@miso.ai/client-sdk-ui 1.11.5-beta.0 → 1.11.5-beta.10

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

@@ -1,7 +1,7 @@
 import AnswerBasedWorkflow from './answer-based.js';
 import { ROLE, STATUS, ORGANIC_QUESTION_SOURCE } from '../constants.js';
 import { mergeRolesOptions } from './options/index.js';
-import { writeKeywordsToData } from './processors.js';
+import { writeKeywordsToData, writeMisoIdToSession, writeMisoIdFromSession, writeUnanswerableToMeta } from './processors.js';
 import { makeAutocompletable } from './autocompletable.js';
 
 const ROLES_OPTIONS = mergeRolesOptions(AnswerBasedWorkflow.ROLES_OPTIONS, {
@@ -44,6 +44,7 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
   // query //
   _buildPayload(payload) {
     payload = this._writeQuestionSourceToPayload(payload);
+    payload = this._writeWikiLinkTemplateToPayload(payload);
     payload = this._superworkflow._results._writeFiltersToPayload(payload);
     return payload;
   }
@@ -62,6 +63,8 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
     data = writeKeywordsToData(data);
+    data = writeMisoIdFromSession(data);
+    data = writeUnanswerableToMeta(data);
     return data;
   }
 
@@ -78,6 +81,8 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
 
   _handleHeadResponse(data) {
     super._handleHeadResponse(data);
+    // keep track of miso_id in session
+    writeMisoIdToSession(data);
     // share the search results with its sibling
     this._dispatchDataToSibling(data);
   }
@@ -86,6 +91,15 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
     this._resultsSession && this._superworkflow._results.updateData({ ...data, session: this._resultsSession });
   }
 
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    return this._superworkflow._defaultProcessInteraction(payload, args);
+  }
+
+  _defaultProcessInteraction0(payload, args) {
+    return super._defaultProcessInteraction(payload, args);
+  }
+
   // destroy //
   _destroy(options) {
     this._destroyAutocomplete();

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

@@ -2,6 +2,7 @@ import { trimObj } 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';
 
 // we want to override members, not adding to it
 const ROLES_OPTIONS = {
@@ -69,6 +70,22 @@ export default class HybridSearchResults extends SearchBasedWorkflow {
     };
   }
 
+  // data //
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
+    writeMisoIdToSession(data);
+    return data;
+  }
+
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    return this._superworkflow._defaultProcessInteraction(payload, args);
+  }
+
+  _defaultProcessInteraction0(payload, args) {
+    return super._defaultProcessInteraction(payload, args);
+  }
+
 }
 
 Object.assign(HybridSearchResults, {

package/src/workflow/hybrid-search.js

@@ -98,12 +98,7 @@ export default class HybridSearch extends Workflow {
   }
 
   _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 });
   }
 
   _initSession() {
@@ -149,7 +144,9 @@ export default class HybridSearch extends Workflow {
 
   // interactions //
   _defaultProcessInteraction(payload, args) {
-    return this._answer._defaultProcessInteraction(payload, args);
+    payload = this._answer._defaultProcessInteraction0(payload, args);
+    payload = this._results._defaultProcessInteraction0(payload, args);
+    return payload;
   }
 
   // destroy //

package/src/workflow/options/auto-query.js

@@ -0,0 +1,29 @@
+import { trimObj } from '@miso.ai/commons';
+import { ROLE } from '../../constants.js';
+
+export const DEFAULT_AUTO_QUERY_PARAM = 'q';
+export const DEFAULT_AUTO_QUERY_SOURCE_PARAM = 'qs';
+
+export function normalizeAutoQueryOptions({ setValue = true, focus = true, updateUrl = true, param = DEFAULT_AUTO_QUERY_PARAM, sourceParam = DEFAULT_AUTO_QUERY_SOURCE_PARAM, ...options } = {}) {
+  return { setValue, focus, updateUrl, param, sourceParam, ...options };
+}
+
+export function autoQuery(options = {}) {
+  // TODO: support getting value from URL path
+  const { setValue, focus, param, sourceParam } = this._autoQuery = normalizeAutoQueryOptions(options);
+  const searchParams = new URLSearchParams(window.location.search);
+  const q = searchParams.get(param);
+  const qs = searchParams.get(sourceParam) || undefined;
+  const { layout } = this._views.get(ROLE.QUERY);
+  if (layout) {
+    if (q && setValue) {
+      layout.value = q;
+    }
+    if (!q && focus) {
+      layout.focus();
+    }
+  }
+  if (q) {
+    this.query(trimObj({ q, qs }));
+  }
+}

package/src/workflow/options/index.js

@@ -8,3 +8,4 @@ export * from './filters.js';
 export * from './pagination.js';
 export * from './options.js';
 export * from './configurable.js';
+export * from './auto-query.js';

package/src/workflow/processors.js

@@ -68,6 +68,36 @@ export function writeMisoIdToMeta(data) {
   };
 }
 
+export function writeMisoIdToSession(data) {
+  const { session, value } = data;
+  if (!session || !value) {
+    return;
+  }
+  const { miso_id } = value;
+  if (!miso_id) {
+    return;
+  }
+  session.meta.miso_id = miso_id;
+}
+
+export function writeMisoIdFromSession(data) {
+  const { session, value } = data;
+  if (!session || !value) {
+    return data;
+  }
+  const { meta: { miso_id } = {} } = session;
+  if (!miso_id) {
+    return data;
+  }
+  return {
+    ...data,
+    meta: {
+      ...data.meta,
+      miso_id,
+    },
+  };
+}
+
 export function writeKeywordsToData(data) {
   const { request, value } = data;
   // we still want the value in loading status
@@ -230,6 +260,19 @@ export function writeAffiliationInfoToInteraction(payload, args) {
   });
 }
 
+export function writeEventTargetToInteraction(payload, { event_target } = {}) {
+  if (!event_target) {
+    return payload;
+  }
+  return mergeInteraction(payload, {
+    context: {
+      custom_context: {
+        event_target,
+      },
+    },
+  });
+}
+
 export function mergeInteraction(base = {}, patch = {}) {
   return trimObj({
     ...base,
@@ -244,3 +287,20 @@ export function mergeInteraction(base = {}, patch = {}) {
     }),
   });
 }
+
+export function writeUnanswerableToMeta(data) {
+  const { value } = data;
+  if (!value) {
+    return data;
+  }
+  if (!value.finished || value.finish_reason !== 'success' || (value.sources && value.sources.length > 0)) {
+    return data;
+  }
+  return {
+    ...data,
+    meta: {
+      ...data.meta,
+      unanswerable: true,
+    },
+  };
+}

package/src/workflow/search-based.js

@@ -4,7 +4,7 @@ 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 { mergeRolesOptions, makeConfigurable, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
+import { mergeRolesOptions, autoQuery as autoQueryFn, makeConfigurable, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
 
 const DEFAULT_ROWS = 10;
 const DEFAULT_PAGE_LIMIT = 10;
@@ -87,6 +87,10 @@ export default class SearchBasedWorkflow extends Workflow {
   }
 
   // query //
+  autoQuery(options = {}) {
+    autoQueryFn.call(this, options);
+  }
+
   query(args) {
     if (!args.q) {
       throw new Error(`q is required in query() call`);

package/src/workflow/search.js

@@ -57,23 +57,6 @@ export default class Search extends SearchBasedWorkflow {
     this._initAutocomplete(args);
   }
 
-  autoQuery({ setValue = true, focus = true, param = 'q' } = {}) {
-    // TODO: align implementation with AnswerBasedWorkflow
-    const q = new URLSearchParams(window.location.search).get(param);
-    const { layout } = this._views.get(ROLE.QUERY);
-    if (layout) {
-      if (q && setValue) {
-        layout.value = q;
-      }
-      if (!q && focus) {
-        layout.focus();
-      }
-    }
-    if (q) {
-      this.query({ q });
-    }
-  }
-
   notifyViewUpdate(role = ROLE.PRODUCTS, ...args) {
     super.notifyViewUpdate(role, ...args);
     return this;

package/src/workflow/use-link.js

@@ -30,11 +30,11 @@ export class UseLinkMixin {
     }
   }
 
-  _getSubmitUrl(args) {
+  _getSubmitUrl({ q, ...args } = {}) {
     if (!this._linkFn) {
       throw new Error('useLink(fn) must be called before _getSubmitUrl()');
     }
-    return this._linkFn[0](args.q);
+    return this._linkFn[0](q, args);
   }
 
 }