@miso.ai/client-sdk-ui 1.11.0-beta.5 → 1.11.0-beta.7

package/dist/cjs/defaults/hybrid-search/phrases.js

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.sources = exports.showMore = exports.showLess = exports.question = exports.keywords = exports.hits = void 0;
 /**
- * The phrase displayed right before <miso-question>
+ * The phrase to display <miso-question>
  */
-const question = exports.question = 'You asked...';
+const question = exports.question = 'You asked “${value}”';
 
 /**
  * The phrase displayed right before <miso-sources>

package/dist/cjs/defaults/hybrid-search/templates.js

@@ -31,6 +31,15 @@ class Sections extends _templates.Sections {
       classes: [`${classPrefix}__answer-box-inner`]
     }, this.answerGroup(options)), this.answerBoxToggle(options)]);
   }
+  question(options) {
+    const {
+      phrase
+    } = this._helpers;
+    return phrase(options, {
+      name: 'question',
+      tag: 'h3'
+    }).replaceAll('${value}', '<miso-question></miso-question>');
+  }
   answerBoxToggle(options) {
     const {
       element
@@ -51,7 +60,7 @@ class Sections extends _templates.Sections {
     } = this._helpers;
     return container(options, {
       name: 'search-results',
-      visibleWhen: 'ready'
+      visibleWhen: 'loading ready'
     }, [this.searchResultsInfoGroup(options), this.searchResultsFilters(options), '<miso-products></miso-products>']);
   }
   searchResultsInfoGroup(options) {

package/dist/cjs/version.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = exports.default = '1.11.0-beta.5';
+var _default = exports.default = '1.11.0-beta.7';

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

@@ -57,7 +57,8 @@ const DEFAULT_LAYOUTS = Object.freeze({
 });
 const DEFAULT_TRACKERS = Object.freeze({
   [_constants.ROLE.SOURCES]: {},
-  [_constants.ROLE.AFFILIATION]: {}
+  [_constants.ROLE.AFFILIATION]: {},
+  [_constants.ROLE.PRODUCTS]: {}
 });
 const DEFAULT_OPTIONS = Object.freeze({
   api: DEFAULT_API_OPTIONS,
@@ -204,6 +205,9 @@ class AnswerBasedWorkflow extends _base.default {
       return;
     }
     super._updateData(data);
+
+    // update URL if autoQuery.updateUrl is not false
+    this._updateUrlIfNecessary(data);
   }
   _handleHeadResponse(data) {
     // capture question ID and register at context
@@ -211,13 +215,9 @@ class AnswerBasedWorkflow extends _base.default {
   }
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
-
-    // update URL if autoQuery.updateUrl is not false
-    this._updateUrlIfNecessary(data);
-
-    // affiliation
     data = (0, _index3.processData)(data);
-    return (0, _processors.writeAnswerStageToMeta)(data);
+    data = (0, _processors.writeAnswerStageToMeta)(data);
+    return data;
   }
   _writeQuestionIdFromData(_ref) {
     let {

package/dist/cjs/workflow/base.js

@@ -178,15 +178,19 @@ class Workflow extends _commons.Component {
   _updateData(data) {
     this._sessions.start(); // in case session not started yet
 
-    data = (0, _processors.writeDataStatus)(data);
     data = this._defaultProcessData(data);
     for (const process of this._options.resolved.dataProcessor) {
       data = process(data);
     }
-    this._hub.update(_index.fields.data(), data);
+    this._updateDataInHub(data);
   }
   _defaultProcessData(data) {
-    return (0, _processors.writeMisoIdToMeta)(data);
+    data = (0, _processors.writeDataStatus)(data);
+    data = (0, _processors.writeMisoIdToMeta)(data);
+    return data;
+  }
+  _updateDataInHub(data) {
+    this._hub.update(_index.fields.data(), data);
   }
 
   /*

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

@@ -26,7 +26,6 @@ class HybridSearchAnswer extends _answerBased.default {
       rolesConfig: ROLES_CONFIG,
       superworkflow
     });
-    this.useInteractions(false);
   }
   _initProperties(args) {
     super._initProperties(args);
@@ -38,6 +37,7 @@ class HybridSearchAnswer extends _answerBased.default {
     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
   }
@@ -60,9 +60,12 @@ class HybridSearchAnswer extends _answerBased.default {
   }
 
   // data //
-  _updateData(data) {
-    // we want this to be available everywhere
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
     data = (0, _processors.writeKeywordsToData)(data);
+    return data;
+  }
+  _updateDataInHub(data) {
     switch (data.status) {
       case _constants.STATUS.INITIAL:
       case _constants.STATUS.LOADING:
@@ -70,7 +73,7 @@ class HybridSearchAnswer extends _answerBased.default {
         this._dispatchDataToSibling(data);
         break;
     }
-    super._updateData(data);
+    super._updateDataInHub(data);
   }
   _handleHeadResponse(data) {
     super._handleHeadResponse(data);
@@ -78,7 +81,7 @@ class HybridSearchAnswer extends _answerBased.default {
     this._dispatchDataToSibling(data);
   }
   _dispatchDataToSibling(data) {
-    this._superworkflow._results.updateData(Object.assign({}, data, {
+    this._resultsSession && this._superworkflow._results.updateData(Object.assign({}, data, {
       session: this._resultsSession
     }));
   }

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

@@ -30,7 +30,6 @@ class HybridSearchResults extends _base.default {
       rolesConfig: ROLES_CONFIG,
       superworkflow
     });
-    this.useInteractions(false);
   }
   _initProperties(args) {
     super._initProperties(args);
@@ -44,6 +43,12 @@ class HybridSearchResults extends _base.default {
 
   // query //
   _refine(filters) {
+    // remember current facet_counts
+    const {
+      facet_counts
+    } = this._hub.states[_index.fields.data()].value || {};
+    this._previousFacetCounts = facet_counts;
+
     // start a new session
     this.restart();
 
@@ -69,7 +74,7 @@ class HybridSearchResults extends _base.default {
       payload = _objectWithoutPropertiesLoose(_ref, _excluded);
     // borrow the work from the sibling
     payload = this._superworkflow._answer._buildPayload(payload);
-    payload = this._writeFqToPayload(Object.assign({}, payload, {
+    payload = this._writeFiltersToPayload(Object.assign({}, payload, {
       filters
     }));
     payload = this._writeQuestionIdToPayload(payload);
@@ -77,16 +82,13 @@ class HybridSearchResults extends _base.default {
       answer: false
     });
   }
-  _writeFqToPayload() {
+  _writeFiltersToPayload() {
     let _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     let {
         filters
       } = _ref2,
       payload = _objectWithoutPropertiesLoose(_ref2, _excluded2);
-    const fq = (0, _processors.composeFq)(filters); // TODO: combine with fq in payload?
-    return (0, _commons.trimObj)(Object.assign({}, payload, {
-      fq
-    }));
+    return (0, _commons.trimObj)(Object.assign({}, payload, (0, _processors.composeFiltersPayload)(filters)));
   }
   _writeQuestionIdToPayload(payload) {
     return Object.assign({}, payload, {
@@ -103,7 +105,32 @@ class HybridSearchResults extends _base.default {
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
     data = (0, _processors.writeKeywordsToData)(data);
+    data = this._retainFacetCounts(data);
     return data;
   }
+  _retainFacetCounts(data) {
+    if (!this._previousFacetCounts) {
+      return data;
+    }
+    const {
+      status,
+      value
+    } = data;
+    switch (status) {
+      case _constants.STATUS.INITIAL:
+      case _constants.STATUS.LOADING:
+        break;
+      default:
+        return data;
+    }
+    if (value && value.facet_counts) {
+      return data;
+    }
+    return Object.assign({}, data, {
+      value: Object.assign({}, value, {
+        facet_counts: this._previousFacetCounts
+      })
+    });
+  }
 }
 exports.default = HybridSearchResults;

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

@@ -16,10 +16,17 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 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, {
-    fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at']
+    source_fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at', 'title'],
+    fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at', 'title']
   })
 }));
 const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_LAYOUTS, {
+  [_constants.ROLE.QUERY]: [_index2.SearchBoxLayout.type, {
+    placeholder: ''
+  }],
+  [_constants.ROLE.QUESTION]: [_index2.TextLayout.type, {
+    raw: true
+  }],
   [_constants.ROLE.PRODUCTS]: [_index2.ListLayout.type, {
     itemType: 'article'
   }],

package/dist/cjs/workflow/processors.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.composeFq = composeFq;
+exports.composeFiltersPayload = composeFiltersPayload;
 exports.writeAnswerStageToMeta = writeAnswerStageToMeta;
 exports.writeDataStatus = writeDataStatus;
 exports.writeKeywordsToData = writeKeywordsToData;
@@ -13,10 +13,10 @@ var _constants = require("../constants.js");
 function writeDataStatus(data) {
   const status = getStatus(data);
   const ongoing = status === _constants.STATUS.READY ? !!data.ongoing : undefined;
-  return (0, _commons.trimObj)(Object.assign({}, data, {
+  return (0, _commons.trimObj)(Object.assign({
     status,
     ongoing
-  }));
+  }, data)); // let orinigal data override status and ongoing
 }
 function getStatus(data) {
   if (!data) {
@@ -53,7 +53,8 @@ function writeKeywordsToData(data) {
     request,
     value
   } = data;
-  if (!request || !value) {
+  // we still want the value in loading status
+  if (!request) {
     return data;
   }
   const {
@@ -93,21 +94,30 @@ function writeAnswerStageToMeta(data) {
     })
   });
 }
-function composeFq(filters) {
+function composeFiltersPayload(filters) {
   if (!filters) {
     return undefined;
   }
-  const clauses = [];
   const {
     facets
   } = filters;
+  return (0, _commons.trimObj)({
+    facet_filters: composeFacetFilters(facets)
+  });
+}
+function composeFacetFilters(facets) {
+  if (!facets) {
+    return undefined;
+  }
+  const filters = {};
   for (const field in facets) {
     const values = facets[field];
     if (!values || !values.length) {
       continue; // just in case
     }
-    const vstr = values.length === 1 ? `"${values[0]}"` : `(${values.map(v => `"${v}"`).join(' OR ')})`;
-    clauses.push(`${field}:${vstr}`);
+    filters[field] = {
+      terms: values
+    };
   }
-  return clauses.map(c => `(${c})`).join(' AND ') || undefined;
+  return Object.keys(filters).length ? filters : 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.5"
+    "@miso.ai/commons": "1.11.0-beta.7"
   },
-  "version": "1.11.0-beta.5"
+  "version": "1.11.0-beta.7"
 }

package/src/defaults/hybrid-search/phrases.js

@@ -1,7 +1,7 @@
 /**
- * The phrase displayed right before <miso-question>
+ * The phrase to display <miso-question>
  */
-export const question = 'You asked...';
+export const question = 'You asked “${value}”';
 
 /**
  * The phrase displayed right before <miso-sources>

package/src/defaults/hybrid-search/templates.js

@@ -18,6 +18,11 @@ class Sections extends _Sections {
     ]);
   }
 
+  question(options) {
+    const { phrase } = this._helpers;
+    return phrase(options, { name: 'question', tag: 'h3' }).replaceAll('${value}', '<miso-question></miso-question>');
+  }
+
   answerBoxToggle(options) {
     const { element } = this._helpers;
     const { classPrefix } = options;
@@ -28,7 +33,7 @@ class Sections extends _Sections {
 
   searchResultsGroup(options) {
     const { container } = this._helpers;
-    return container(options, { name: 'search-results', visibleWhen: 'ready' }, [
+    return container(options, { name: 'search-results', visibleWhen: 'loading ready' }, [
       this.searchResultsInfoGroup(options),
       this.searchResultsFilters(options),
       '<miso-products></miso-products>',

package/src/version.js

@@ -1 +1 @@
-export default '1.11.0-beta.5';
+export default '1.11.0-beta.7';

package/src/workflow/answer-based.js

@@ -38,6 +38,7 @@ const DEFAULT_LAYOUTS = Object.freeze({
 const DEFAULT_TRACKERS = Object.freeze({
   [ROLE.SOURCES]: {},
   [ROLE.AFFILIATION]: {},
+  [ROLE.PRODUCTS]: {},
 });
 
 const DEFAULT_OPTIONS = Object.freeze({
@@ -176,6 +177,9 @@ export default class AnswerBasedWorkflow extends Workflow {
       return;
     }
     super._updateData(data);
+
+    // update URL if autoQuery.updateUrl is not false
+    this._updateUrlIfNecessary(data);
   }
 
   _handleHeadResponse(data) {
@@ -185,14 +189,9 @@ export default class AnswerBasedWorkflow extends Workflow {
 
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
-
-    // update URL if autoQuery.updateUrl is not false
-    this._updateUrlIfNecessary(data);
-
-    // affiliation
     data = processAffiliationData(data);
-
-    return writeAnswerStageToMeta(data);
+    data = writeAnswerStageToMeta(data);
+    return data;
   }
 
   _writeQuestionIdFromData({ value }) {

package/src/workflow/base.js

@@ -160,17 +160,22 @@ export default class Workflow extends Component {
   _updateData(data) {
     this._sessions.start(); // in case session not started yet
 
-    data = writeDataStatus(data);
     data = this._defaultProcessData(data);
     for (const process of this._options.resolved.dataProcessor) {
       data = process(data);
     }
 
-    this._hub.update(fields.data(), data);
+    this._updateDataInHub(data);
   }
 
   _defaultProcessData(data) {
-    return writeMisoIdToMeta(data);
+    data = writeDataStatus(data);
+    data = writeMisoIdToMeta(data);
+    return data;
+  }
+
+  _updateDataInHub(data) {
+    this._hub.update(fields.data(), data);
   }
 
   /*

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

@@ -20,7 +20,6 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
       rolesConfig: ROLES_CONFIG,
       superworkflow,
     });
-    this.useInteractions(false);
   }
 
   _initProperties(args) {
@@ -34,6 +33,7 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
     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
   }
@@ -51,10 +51,13 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
   }
 
   // data //
-  _updateData(data) {
-    // we want this to be available everywhere
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
     data = writeKeywordsToData(data);
+    return data;
+  }
 
+  _updateDataInHub(data) {
     switch (data.status) {
       case STATUS.INITIAL:
       case STATUS.LOADING:
@@ -62,7 +65,7 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
         this._dispatchDataToSibling(data);
         break;
     }
-    super._updateData(data);
+    super._updateDataInHub(data);
   }
 
   _handleHeadResponse(data) {
@@ -72,7 +75,7 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
   }
 
   _dispatchDataToSibling(data) {
-    this._superworkflow._results.updateData({ ...data, session: this._resultsSession });
+    this._resultsSession && this._superworkflow._results.updateData({ ...data, session: this._resultsSession });
   }
 
 }

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

@@ -1,9 +1,9 @@
 import { trimObj } from '@miso.ai/commons';
 import Workflow from './base.js';
 import { fields } from '../actor/index.js';
-import { ROLE } from '../constants.js';
+import { ROLE, STATUS } from '../constants.js';
 import { mergeApiOptions } from './options.js';
-import { writeKeywordsToData, composeFq } from './processors.js';
+import { writeKeywordsToData, composeFiltersPayload } from './processors.js';
 
 const ROLES_CONFIG = Object.freeze({
   [ROLE.FACETS]: {
@@ -23,7 +23,6 @@ export default class HybridSearchResults extends Workflow {
       rolesConfig: ROLES_CONFIG,
       superworkflow,
     });
-    this.useInteractions(false);
   }
 
   _initProperties(args) {
@@ -43,6 +42,10 @@ export default class HybridSearchResults extends Workflow {
 
   // query //
   _refine(filters) {
+    // remember current facet_counts
+    const { facet_counts } = this._hub.states[fields.data()].value || {};
+    this._previousFacetCounts = facet_counts;
+
     // start a new session
     this.restart();
 
@@ -58,16 +61,15 @@ export default class HybridSearchResults extends Workflow {
   _buildPayload({ filters, ...payload } = {}) {
     // borrow the work from the sibling
     payload = this._superworkflow._answer._buildPayload(payload);
-    payload = this._writeFqToPayload({ ...payload, filters });
+    payload = this._writeFiltersToPayload({ ...payload, filters });
     payload = this._writeQuestionIdToPayload(payload);
     return { ...payload, answer: false };
   }
 
-  _writeFqToPayload({ filters, ...payload } = {}) {
-    const fq = composeFq(filters); // TODO: combine with fq in payload?
+  _writeFiltersToPayload({ filters, ...payload } = {}) {
     return trimObj({
       ...payload,
-      fq,
+      ...composeFiltersPayload(filters),
     });
   }
 
@@ -89,7 +91,32 @@ export default class HybridSearchResults extends Workflow {
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
     data = writeKeywordsToData(data);
+    data = this._retainFacetCounts(data);
     return data;
   }
 
+  _retainFacetCounts(data) {
+    if (!this._previousFacetCounts) {
+      return data;
+    }
+    const { status, value } = data;
+    switch (status) {
+      case STATUS.INITIAL:
+      case STATUS.LOADING:
+        break;
+      default:
+        return data;
+    }
+    if (value && value.facet_counts) {
+      return data;
+    }
+    return {
+      ...data,
+      value: {
+        ...value,
+        facet_counts: this._previousFacetCounts,
+      },
+    };
+  }
+
 }

package/src/workflow/hybrid-search.js

@@ -3,7 +3,7 @@ import { InteractionsActor } from '../actor/index.js';
 import Workflow from './base.js';
 import AnswerBasedWorkflow from './answer-based.js';
 import { ROLE } from '../constants.js';
-import { ListLayout, TextLayout, FacetsLayout } from '../layout/index.js';
+import { SearchBoxLayout, ListLayout, TextLayout, FacetsLayout } from '../layout/index.js';
 import HybridSearchAnswer from './hybrid-search-answer.js';
 import HybridSearchResults from './hybrid-search-results.js';
 
@@ -12,12 +12,15 @@ const DEFAULT_API_OPTIONS = Object.freeze({
   name: API.NAME.SEARCH,
   payload: {
     ...AnswerBasedWorkflow.DEFAULT_API_OPTIONS.payload,
-    fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at'],
+    source_fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at', 'title'],
+    fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at', 'title'],
   },
 });
 
 const DEFAULT_LAYOUTS = Object.freeze({
   ...AnswerBasedWorkflow.DEFAULT_LAYOUTS,
+  [ROLE.QUERY]: [SearchBoxLayout.type, { placeholder: '' }],
+  [ROLE.QUESTION]: [TextLayout.type, { raw: true }],
   [ROLE.PRODUCTS]: [ListLayout.type, { itemType: 'article' }],
   [ROLE.KEYWORDS]: [TextLayout.type, { raw: true }],
   [ROLE.HITS]: [TextLayout.type, { raw: true, format: 'number' }],

package/src/workflow/processors.js

@@ -4,7 +4,7 @@ import { STATUS } from '../constants.js';
 export function writeDataStatus(data) {
   const status = getStatus(data);
   const ongoing = status === STATUS.READY ? !!data.ongoing : undefined;
-  return trimObj({ ...data, status, ongoing });
+  return trimObj({ status, ongoing, ...data }); // let orinigal data override status and ongoing
 }
 
 function getStatus(data) {
@@ -35,7 +35,8 @@ export function writeMisoIdToMeta(data) {
 
 export function writeKeywordsToData(data) {
   const { request, value } = data;
-  if (!request || !value) {
+  // we still want the value in loading status
+  if (!request) {
     return data;
   }
   const { payload } = request || {};
@@ -73,19 +74,29 @@ export function writeAnswerStageToMeta(data) {
   };
 }
 
-export function composeFq(filters) {
+export function composeFiltersPayload(filters) {
   if (!filters) {
     return undefined;
   }
-  const clauses = [];
   const { facets } = filters;
+  return trimObj({
+    facet_filters: composeFacetFilters(facets),
+  });
+}
+
+function composeFacetFilters(facets) {
+  if (!facets) {
+    return undefined;
+  }
+  const filters = {};
   for (const field in facets) {
     const values = facets[field];
     if (!values || !values.length) {
       continue; // just in case
     }
-    const vstr = values.length === 1 ? `"${values[0]}"` : `(${values.map(v => `"${v}"`).join(' OR ')})`;
-    clauses.push(`${field}:${vstr}`);
+    filters[field] = {
+      terms: values,
+    };
   }
-  return clauses.map(c => `(${c})`).join(' AND ') || undefined;
+  return Object.keys(filters).length ? filters : undefined;
 }