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

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/layout/input/facets.js

@@ -161,10 +161,10 @@ class FacetsLayout extends _template.default {
   }
   _render(element, data, controls) {
     super._render(element, data, controls);
-    this._syncSelections();
   }
   _afterRender(element, state) {
     this._syncBindings(element, state);
+    this._syncSelections();
   }
   _unrender() {
     this._clearBindings();
@@ -270,6 +270,10 @@ class FacetsLayout extends _template.default {
     return Array.from(element.querySelectorAll(`[data-role="option"]`));
   }
   _handleClick(event) {
+    // only left click
+    if (event.button !== 0) {
+      return;
+    }
     const element = event.target.closest(`[data-role="option"]`);
     if (!element) {
       return;

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.4';
+var _default = exports.default = '1.11.0-beta.6';

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

@@ -204,6 +204,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 +214,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

@@ -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

@@ -10,7 +10,8 @@ var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
 var _options = require("./options.js");
 var _processors = require("./processors.js");
-const _excluded = ["filters"];
+const _excluded = ["filters"],
+  _excluded2 = ["filters"];
 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 ROLES_CONFIG = Object.freeze({
@@ -43,14 +44,19 @@ 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();
 
     // get stored query from sibling
     const query = this._superworkflow._answer._hub.states[_index.fields.query()];
     const payload = this._buildPayload(Object.assign({}, query, {
-      filters,
-      answer: false
+      filters
     }));
     const {
       session
@@ -69,11 +75,32 @@ 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, {
+      filters
+    }));
+    payload = this._writeQuestionIdToPayload(payload);
+    return Object.assign({}, payload, {
+      answer: false
+    });
+  }
+  _writeFqToPayload() {
+    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
     }));
   }
+  _writeQuestionIdToPayload(payload) {
+    return Object.assign({}, payload, {
+      _meta: (0, _commons.trimObj)(Object.assign({}, payload._meta, {
+        question_id: this._superworkflow._answer.questionId
+      }))
+    });
+  }
   _request(event) {
     this._hub.update(_index.fields.request(), event);
   }
@@ -82,7 +109,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

@@ -20,6 +20,12 @@ const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _answerBased.default
   })
 }));
 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

@@ -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 {
@@ -106,7 +107,8 @@ function composeFq(filters) {
     if (!values || !values.length) {
       continue; // just in case
     }
-    clauses.push(`${field}:(${values.map(v => `"${v}"`).join(' OR ')})`);
+    const vstr = values.length === 1 ? `"${values[0]}"` : `(${values.map(v => `"${v}"`).join(' OR ')})`;
+    clauses.push(`${field}:${vstr}`);
   }
-  return clauses.map(c => `(${c})`).join(' AND ');
+  return clauses.map(c => `(${c})`).join(' AND ') || 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.4"
+    "@miso.ai/commons": "1.11.0-beta.6"
   },
-  "version": "1.11.0-beta.4"
+  "version": "1.11.0-beta.6"
 }

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/layout/input/facets.js

@@ -125,11 +125,11 @@ export default class FacetsLayout extends TemplateBasedLayout {
 
   _render(element, data, controls) {
     super._render(element, data, controls);
-    this._syncSelections();
   }
 
   _afterRender(element, state) {
     this._syncBindings(element, state);
+    this._syncSelections();
   }
 
   _unrender() {
@@ -220,6 +220,10 @@ export default class FacetsLayout extends TemplateBasedLayout {
   }
 
   _handleClick(event) {
+    // only left click
+    if (event.button !== 0) {
+      return;
+    }
     const element = event.target.closest(`[data-role="option"]`);
     if (!element) {
       return;

package/src/version.js

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

package/src/workflow/answer-based.js

@@ -176,6 +176,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 +188,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

@@ -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,7 +1,7 @@
 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';
 
@@ -43,12 +43,16 @@ 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();
 
     // get stored query from sibling
     const query = this._superworkflow._answer._hub.states[fields.query()];
-    const payload = this._buildPayload({ ...query, filters, answer: false });
+    const payload = this._buildPayload({ ...query, filters });
     const { session } = this;
     const event = mergeApiOptions(this._options.resolved.api, { payload, session });
 
@@ -58,6 +62,12 @@ 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._writeQuestionIdToPayload(payload);
+    return { ...payload, answer: false };
+  }
+
+  _writeFqToPayload({ filters, ...payload } = {}) {
     const fq = composeFq(filters); // TODO: combine with fq in payload?
     return trimObj({
       ...payload,
@@ -65,6 +75,16 @@ export default class HybridSearchResults extends Workflow {
     });
   }
 
+  _writeQuestionIdToPayload(payload) {
+    return {
+      ...payload,
+      _meta: trimObj({
+        ...payload._meta,
+        question_id: this._superworkflow._answer.questionId,
+      }),
+    };
+  }
+
   _request(event) {
     this._hub.update(fields.request(), event);
   }
@@ -73,7 +93,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';
 
@@ -18,6 +18,8 @@ const DEFAULT_API_OPTIONS = Object.freeze({
 
 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 || {};
@@ -84,7 +85,8 @@ export function composeFq(filters) {
     if (!values || !values.length) {
       continue; // just in case
     }
-    clauses.push(`${field}:(${values.map(v => `"${v}"`).join(' OR ')})`);
+    const vstr = values.length === 1 ? `"${values[0]}"` : `(${values.map(v => `"${v}"`).join(' OR ')})`;
+    clauses.push(`${field}:${vstr}`);
   }
-  return clauses.map(c => `(${c})`).join(' AND ');
+  return clauses.map(c => `(${c})`).join(' AND ') || undefined;
 }