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

package/dist/cjs/asset/svgs.js

@@ -3,7 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.TRIANGLE = exports.SEND = exports.SEARCH = void 0;
+exports.TRIANGLE = exports.SEND = exports.SEARCH = exports.ICON_NAMES = void 0;
+exports.getIcon = getIcon;
 var _version = _interopRequireDefault(require("../version.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function trianglePath(r) {
@@ -14,13 +15,18 @@ function trianglePath(r) {
 }
 const PREFIX = 'miso-ui-icon';
 const ID = `${PREFIX}-svg-${_version.default.replaceAll('.', '_')}`;
+const ICON_NAME = {
+  SEND: 'send',
+  SEARCH: 'search',
+  TRIANGLE: 'triangle'
+};
 
 // CC0 SVGs
-const ICON_SEND = `<symbol id="${PREFIX}-send" viewBox="0 0 32 32"><path fill="currentColor" d="M11.499,19.173l5.801,-5.849c0.389,-0.392 1.022,-0.394 1.414,-0.006c0.392,0.389 0.395,1.022 0.006,1.414l-5.798,5.847l5.306,8.002c0.207,0.313 0.572,0.483 0.945,0.441c0.373,-0.042 0.691,-0.289 0.824,-0.64l9.024,-23.904c0.138,-0.366 0.05,-0.78 -0.226,-1.058c-0.276,-0.278 -0.689,-0.369 -1.057,-0.233l-24.004,8.892c-0.353,0.13 -0.602,0.448 -0.646,0.821c-0.044,0.373 0.125,0.74 0.438,0.948l7.973,5.325Z"/></symbol>`;
-const ICON_SEARCH = `<symbol id="${PREFIX}-search" viewBox="0 0 24 24"><path fill="currentColor" d="M4 11C4 7.13401 7.13401 4 11 4C14.866 4 18 7.13401 18 11C18 14.866 14.866 18 11 18C7.13401 18 4 14.866 4 11ZM11 2C6.02944 2 2 6.02944 2 11C2 15.9706 6.02944 20 11 20C13.125 20 15.078 19.2635 16.6177 18.0319L20.2929 21.7071C20.6834 22.0976 21.3166 22.0976 21.7071 21.7071C22.0976 21.3166 22.0976 20.6834 21.7071 20.2929L18.0319 16.6177C19.2635 15.078 20 13.125 20 11C20 6.02944 15.9706 2 11 2Z"/></symbol>`;
+const ICON_SEND = `<symbol id="${PREFIX}-${ICON_NAME.SEND}" viewBox="0 0 32 32"><path fill="currentColor" d="M11.499,19.173l5.801,-5.849c0.389,-0.392 1.022,-0.394 1.414,-0.006c0.392,0.389 0.395,1.022 0.006,1.414l-5.798,5.847l5.306,8.002c0.207,0.313 0.572,0.483 0.945,0.441c0.373,-0.042 0.691,-0.289 0.824,-0.64l9.024,-23.904c0.138,-0.366 0.05,-0.78 -0.226,-1.058c-0.276,-0.278 -0.689,-0.369 -1.057,-0.233l-24.004,8.892c-0.353,0.13 -0.602,0.448 -0.646,0.821c-0.044,0.373 0.125,0.74 0.438,0.948l7.973,5.325Z"/></symbol>`;
+const ICON_SEARCH = `<symbol id="${PREFIX}-${ICON_NAME.SEARCH}" viewBox="0 0 24 24"><path fill="currentColor" d="M4 11C4 7.13401 7.13401 4 11 4C14.866 4 18 7.13401 18 11C18 14.866 14.866 18 11 18C7.13401 18 4 14.866 4 11ZM11 2C6.02944 2 2 6.02944 2 11C2 15.9706 6.02944 20 11 20C13.125 20 15.078 19.2635 16.6177 18.0319L20.2929 21.7071C20.6834 22.0976 21.3166 22.0976 21.7071 21.7071C22.0976 21.3166 22.0976 20.6834 21.7071 20.2929L18.0319 16.6177C19.2635 15.078 20 13.125 20 11C20 6.02944 15.9706 2 11 2Z"/></symbol>`;
 
 // Custom SVGs
-const ICON_TRIANGLE = `<symbol id="${PREFIX}-triangle" viewBox="-5 -5 105 105"><path d="${trianglePath(5)}"/></symbol>`;
+const ICON_TRIANGLE = `<symbol id="${PREFIX}-${ICON_NAME.TRIANGLE}" viewBox="-5 -5 105 105"><path d="${trianglePath(5)}"/></symbol>`;
 const ICONS = [ICON_SEND, ICON_SEARCH, ICON_TRIANGLE];
 const SPRITES_SVG = `<svg id="${ID}" style="display:none;">${ICONS.join('')}</svg>`;
 let loaded = false;
@@ -32,9 +38,13 @@ function loadSvgSprites() {
   document.head.insertAdjacentHTML('beforeend', SPRITES_SVG);
 }
 loadSvgSprites();
-function getSvg(name) {
+function _icon(name) {
   return `<svg class="miso-ui-icon miso-ui-icon-${name}"><use href="#${PREFIX}-${name}"></use></svg>`;
 }
-const SEND = exports.SEND = getSvg('send');
-const SEARCH = exports.SEARCH = getSvg('search');
-const TRIANGLE = exports.TRIANGLE = getSvg('triangle');
+const ICON_NAMES = exports.ICON_NAMES = new Set(Object.values(ICON_NAME));
+function getIcon(name) {
+  return ICON_NAMES.has(name) ? _icon(name) : '';
+}
+const SEND = exports.SEND = _icon(ICON_NAME.SEND);
+const SEARCH = exports.SEARCH = _icon(ICON_NAME.SEARCH);
+const TRIANGLE = exports.TRIANGLE = _icon(ICON_NAME.TRIANGLE);

package/dist/cjs/defaults/hybrid-search/answer-box.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _constants = require("./constants.js");
 var _constants2 = require("../../constants.js");
+var _index = require("../../actor/index.js");
 var _phrases = require("./phrases.js");
 const CLASS_OPEN = 'answer-box-open';
 const CLASS_SHOWN = 'answer-box-shown';
@@ -29,7 +30,12 @@ class AnswerBox {
 
     // expose widget API
     workflow.answerBox = this;
-    workflow._unsubscribes.push(() => this.destroy()); // TODO: review
+    workflow._unsubscribes.push(() => {
+      if (workflow.answerBox === this) {
+        this.destroy();
+        workflow.answerBox = undefined;
+      }
+    });
 
     // handle toggle button clicks
     const callback = event => this._handleClick(event);
@@ -38,7 +44,9 @@ class AnswerBox {
     // sync state
     this._syncWofkflowStatus();
     this._syncButtonText();
-    this._unsubscribes = [() => element.removeEventListener('click', callback), workflow._answer.on('loading', () => this.hide()), workflow._answer.on('error', () => this.show()), workflow._answer.on('ready', () => this.show())];
+    this._unsubscribes = [() => element.removeEventListener('click', callback),
+    // cling to data rather than view, as we may miss view event when tab is inactive due to raf
+    workflow._answer._hub.on(_index.fields.data(), () => this._syncWofkflowStatus())];
   }
   _handleClick(_ref) {
     let {
@@ -75,6 +83,13 @@ class AnswerBox {
       button.textContent = phrase;
     }
   }
+  _syncScroll() {
+    if (!this.isOpen) {
+      this._element.scrollIntoView({
+        behavior: 'smooth'
+      });
+    }
+  }
   destroy() {
     for (const unsubscribe of this._unsubscribes) {
       unsubscribe();
@@ -110,6 +125,7 @@ for (const [method, [action, className]] of Object.entries(METHODS)) {
     this._updateBoxStatus(action, className);
     if (className === CLASS_OPEN) {
       this._syncButtonText();
+      this._syncScroll();
     }
   };
 }

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

@@ -37,7 +37,7 @@ class Sections extends _templates.Sections {
     } = this._helpers;
     return phrase(options, {
       name: 'question',
-      tag: 'h3'
+      tag: 'div'
     }).replaceAll('${value}', '<miso-question></miso-question>');
   }
   answerBoxToggle(options) {
@@ -121,15 +121,19 @@ function root() {
   } = helpers;
   options = normalizeOptions(options);
   const {
-    answerBox
+    answerBox,
+    answerGroup
   } = sections;
+  const {
+    answerBox: answerBoxOptions = true
+  } = options;
   return [section(options, {
     name: 'question'
   }, [container(options, {
     name: 'query'
   }, '<miso-query></miso-query>')]), section(options, {
     name: 'answer'
-  }, [answerBox(options)]), section(options, {
+  }, answerBoxOptions ? [answerBox(options)] : answerGroup(options)), section(options, {
     name: 'search-results'
   }, sections.searchResultsGroup(options))].join('');
 }

package/dist/cjs/layout/input/search-box.js

@@ -19,26 +19,40 @@ const DEFAULT_AUTOCOMPLETE_CLASSNAME = 'miso-autocomplete';
 function root(layout) {
   const {
     className,
+    templates,
     role,
     options,
-    workflow,
     autocomplete
   } = layout;
   const {
-    placeholder,
-    buttonText
+    placeholder
   } = options;
   const roleAttr = role ? `data-role="${role}"` : '';
-  const buttonContent = buttonText || workflow === 'search' ? _svgs.SEARCH : _svgs.SEND;
   return `
 <div class="${className}" ${roleAttr}>
   <div class="${className}__input-group">
     <input class="${className}__input" type="text" data-role="input" ${placeholder ? `placeholder="${placeholder}"` : ''}>
-    <button class="${className}__button" type="submit" data-role="submit">${buttonContent}</button>
+    <button class="${className}__button" type="submit" data-role="submit">${templates.buttonContent(layout)}</button>
   </div>
   <div class="${autocomplete.className}" data-role="autocomplete"></div>
 </div>`.trim();
 }
+function buttonContent(layout) {
+  const {
+    templates,
+    options
+  } = layout;
+  if (options.buttonText) {
+    return options.buttonText; // legacy
+  }
+  const {
+    buttonText,
+    buttonIcon
+  } = templates;
+  const text = typeof buttonText === 'function' ? buttonText(layout) : `${buttonText}`;
+  const icon = typeof buttonIcon === 'function' ? buttonIcon(layout) : (0, _svgs.getIcon)(buttonIcon) || `${buttonIcon}`;
+  return text + icon;
+}
 function completions(layout, items) {
   const {
     templates,
@@ -110,6 +124,9 @@ function completionItem(layout, type, item) {
 }
 const DEFAULT_TEMPLATES = Object.freeze({
   root,
+  buttonContent,
+  buttonText: '',
+  buttonIcon: 'search',
   completions,
   completionList,
   completionItem,

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

package/dist/cjs/workflow/ask.js

@@ -20,6 +20,11 @@ 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, {
+    templates: {
+      buttonIcon: 'send'
+    }
+  }],
   [_constants.ROLE.RELATED_RESOURCES]: [_index2.ListLayout.type, {
     incremental: true,
     itemType: 'article'

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.7"
+    "@miso.ai/commons": "1.11.0-beta.9"
   },
-  "version": "1.11.0-beta.7"
+  "version": "1.11.0-beta.9"
 }

package/src/asset/svgs.js

@@ -10,12 +10,18 @@ function trianglePath(r) {
 const PREFIX = 'miso-ui-icon';
 const ID = `${PREFIX}-svg-${version.replaceAll('.', '_')}`;
 
+const ICON_NAME = {
+  SEND: 'send',
+  SEARCH: 'search',
+  TRIANGLE: 'triangle',
+};
+
 // CC0 SVGs
-const ICON_SEND = `<symbol id="${PREFIX}-send" viewBox="0 0 32 32"><path fill="currentColor" d="M11.499,19.173l5.801,-5.849c0.389,-0.392 1.022,-0.394 1.414,-0.006c0.392,0.389 0.395,1.022 0.006,1.414l-5.798,5.847l5.306,8.002c0.207,0.313 0.572,0.483 0.945,0.441c0.373,-0.042 0.691,-0.289 0.824,-0.64l9.024,-23.904c0.138,-0.366 0.05,-0.78 -0.226,-1.058c-0.276,-0.278 -0.689,-0.369 -1.057,-0.233l-24.004,8.892c-0.353,0.13 -0.602,0.448 -0.646,0.821c-0.044,0.373 0.125,0.74 0.438,0.948l7.973,5.325Z"/></symbol>`;
-const ICON_SEARCH = `<symbol id="${PREFIX}-search" viewBox="0 0 24 24"><path fill="currentColor" d="M4 11C4 7.13401 7.13401 4 11 4C14.866 4 18 7.13401 18 11C18 14.866 14.866 18 11 18C7.13401 18 4 14.866 4 11ZM11 2C6.02944 2 2 6.02944 2 11C2 15.9706 6.02944 20 11 20C13.125 20 15.078 19.2635 16.6177 18.0319L20.2929 21.7071C20.6834 22.0976 21.3166 22.0976 21.7071 21.7071C22.0976 21.3166 22.0976 20.6834 21.7071 20.2929L18.0319 16.6177C19.2635 15.078 20 13.125 20 11C20 6.02944 15.9706 2 11 2Z"/></symbol>`;
+const ICON_SEND = `<symbol id="${PREFIX}-${ICON_NAME.SEND}" viewBox="0 0 32 32"><path fill="currentColor" d="M11.499,19.173l5.801,-5.849c0.389,-0.392 1.022,-0.394 1.414,-0.006c0.392,0.389 0.395,1.022 0.006,1.414l-5.798,5.847l5.306,8.002c0.207,0.313 0.572,0.483 0.945,0.441c0.373,-0.042 0.691,-0.289 0.824,-0.64l9.024,-23.904c0.138,-0.366 0.05,-0.78 -0.226,-1.058c-0.276,-0.278 -0.689,-0.369 -1.057,-0.233l-24.004,8.892c-0.353,0.13 -0.602,0.448 -0.646,0.821c-0.044,0.373 0.125,0.74 0.438,0.948l7.973,5.325Z"/></symbol>`;
+const ICON_SEARCH = `<symbol id="${PREFIX}-${ICON_NAME.SEARCH}" viewBox="0 0 24 24"><path fill="currentColor" d="M4 11C4 7.13401 7.13401 4 11 4C14.866 4 18 7.13401 18 11C18 14.866 14.866 18 11 18C7.13401 18 4 14.866 4 11ZM11 2C6.02944 2 2 6.02944 2 11C2 15.9706 6.02944 20 11 20C13.125 20 15.078 19.2635 16.6177 18.0319L20.2929 21.7071C20.6834 22.0976 21.3166 22.0976 21.7071 21.7071C22.0976 21.3166 22.0976 20.6834 21.7071 20.2929L18.0319 16.6177C19.2635 15.078 20 13.125 20 11C20 6.02944 15.9706 2 11 2Z"/></symbol>`;
 
 // Custom SVGs
-const ICON_TRIANGLE = `<symbol id="${PREFIX}-triangle" viewBox="-5 -5 105 105"><path d="${trianglePath(5)}"/></symbol>`;
+const ICON_TRIANGLE = `<symbol id="${PREFIX}-${ICON_NAME.TRIANGLE}" viewBox="-5 -5 105 105"><path d="${trianglePath(5)}"/></symbol>`;
 
 const ICONS = [ICON_SEND, ICON_SEARCH, ICON_TRIANGLE];
 
@@ -33,10 +39,16 @@ function loadSvgSprites() {
 
 loadSvgSprites();
 
-function getSvg(name) {
+function _icon(name) {
   return `<svg class="miso-ui-icon miso-ui-icon-${name}"><use href="#${PREFIX}-${name}"></use></svg>`;
 }
 
-export const SEND = getSvg('send');
-export const SEARCH = getSvg('search');
-export const TRIANGLE = getSvg('triangle');
+export const ICON_NAMES = new Set(Object.values(ICON_NAME));
+
+export function getIcon(name) {
+  return ICON_NAMES.has(name) ? _icon(name) : '';
+}
+
+export const SEND = _icon(ICON_NAME.SEND);
+export const SEARCH = _icon(ICON_NAME.SEARCH);
+export const TRIANGLE = _icon(ICON_NAME.TRIANGLE);

package/src/defaults/hybrid-search/answer-box.js

@@ -1,5 +1,6 @@
 import { CLASS_PREFIX } from './constants.js';
 import { STATUS } from '../../constants.js';
+import { fields } from '../../actor/index.js';
 import { showMore as DEFAULT_PHRASE_SHOW_MORE, showLess as DEFAULT_PHRASE_SHOW_LESS } from './phrases.js';
 
 const CLASS_OPEN = 'answer-box-open';
@@ -23,7 +24,12 @@ export default class AnswerBox {
 
     // expose widget API
     workflow.answerBox = this;
-    workflow._unsubscribes.push(() => this.destroy()); // TODO: review
+    workflow._unsubscribes.push(() => {
+      if (workflow.answerBox === this) {
+        this.destroy();
+        workflow.answerBox = undefined;
+      }
+    });
 
     // handle toggle button clicks
     const callback = event => this._handleClick(event);
@@ -35,9 +41,8 @@ export default class AnswerBox {
 
     this._unsubscribes = [
       () => element.removeEventListener('click', callback),
-      workflow._answer.on('loading', () => this.hide()),
-      workflow._answer.on('error', () => this.show()),
-      workflow._answer.on('ready', () => this.show()),
+      // cling to data rather than view, as we may miss view event when tab is inactive due to raf
+      workflow._answer._hub.on(fields.data(), () => this._syncWofkflowStatus()),
     ];
   }
 
@@ -74,6 +79,12 @@ export default class AnswerBox {
     }
   }
 
+  _syncScroll() {
+    if (!this.isOpen) {
+      this._element.scrollIntoView({ behavior: 'smooth' });
+    }
+  }
+
   destroy() {
     for (const unsubscribe of this._unsubscribes) {
       unsubscribe();
@@ -113,6 +124,7 @@ for (const [method, [action, className]] of Object.entries(METHODS)) {
     this._updateBoxStatus(action, className);
     if (className === CLASS_OPEN) {
       this._syncButtonText();
+      this._syncScroll();
     }
   };
 }

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

@@ -20,7 +20,7 @@ class Sections extends _Sections {
 
   question(options) {
     const { phrase } = this._helpers;
-    return phrase(options, { name: 'question', tag: 'h3' }).replaceAll('${value}', '<miso-question></miso-question>');
+    return phrase(options, { name: 'question', tag: 'div' }).replaceAll('${value}', '<miso-question></miso-question>');
   }
 
   answerBoxToggle(options) {
@@ -75,14 +75,13 @@ export const sections = externalize(new Sections({ helpers }));
 export function root(options = {}) {
   const { normalizeOptions, section, container } = helpers;
   options = normalizeOptions(options);
-  const { answerBox } = sections;
+  const { answerBox, answerGroup } = sections;
+  const { answerBox: answerBoxOptions = true } = options;
   return [
     section(options, { name: 'question' }, [
       container(options, { name: 'query' }, '<miso-query></miso-query>'),
     ]),
-    section(options, { name: 'answer' }, [
-      answerBox(options),
-    ]),
+    section(options, { name: 'answer' }, answerBoxOptions ? [ answerBox(options) ] : answerGroup(options)),
     section(options, { name: 'search-results' }, sections.searchResultsGroup(options)),
   ].join('');
 };

package/src/layout/input/search-box.js

@@ -3,27 +3,37 @@ import { LAYOUT_CATEGORY, STATUS, EVENT_TYPE, DATA_ASPECT } from '../../constant
 import { fields } from '../../actor/index.js';
 import TemplateBasedLayout from '../template.js';
 import { imageBlock, productInfoBlock } from '../templates.js';
-import { SEND, SEARCH } from '../../asset/svgs.js';
+import { getIcon } from '../../asset/svgs.js';
 
 const TYPE = 'search-box';
 const DEFAULT_CLASSNAME = 'miso-search-box';
 const DEFAULT_AUTOCOMPLETE_CLASSNAME = 'miso-autocomplete';
 
 function root(layout) {
-  const { className, role, options, workflow, autocomplete } = layout;
-  const { placeholder, buttonText } = options;
+  const { className, templates, role, options, autocomplete } = layout;
+  const { placeholder } = options;
   const roleAttr = role ? `data-role="${role}"` : '';
-  const buttonContent = buttonText || workflow === 'search' ? SEARCH : SEND;
   return `
 <div class="${className}" ${roleAttr}>
   <div class="${className}__input-group">
     <input class="${className}__input" type="text" data-role="input" ${placeholder ? `placeholder="${placeholder}"` : ''}>
-    <button class="${className}__button" type="submit" data-role="submit">${buttonContent}</button>
+    <button class="${className}__button" type="submit" data-role="submit">${templates.buttonContent(layout)}</button>
   </div>
   <div class="${autocomplete.className}" data-role="autocomplete"></div>
 </div>`.trim();
 }
 
+function buttonContent(layout) {
+  const { templates, options } = layout;
+  if (options.buttonText) {
+    return options.buttonText; // legacy
+  }
+  const { buttonText, buttonIcon } = templates;
+  const text = typeof buttonText === 'function' ? buttonText(layout) : `${buttonText}`;
+  const icon = typeof buttonIcon === 'function' ? buttonIcon(layout) : (getIcon(buttonIcon) || `${buttonIcon}`);
+  return text + icon;
+}
+
 function completions(layout, items) {
   const { templates, workflow, autocomplete } = layout;
   // use options under layout.autocomplete from now on
@@ -84,6 +94,9 @@ function completionItem(layout, type, item) {
 
 const DEFAULT_TEMPLATES = Object.freeze({
   root,
+  buttonContent,
+  buttonText: '',
+  buttonIcon: 'search',
   completions,
   completionList,
   completionItem,

package/src/version.js

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

package/src/workflow/ask.js

@@ -2,7 +2,7 @@ import { defineValues, trimObj, API } from '@miso.ai/commons';
 import AnswerBasedWorkflow from './answer-based.js';
 import { fields } from '../actor/index.js';
 import { ROLE, ORGANIC_QUESTION_SOURCE } from '../constants.js';
-import { OptionListLayout, ListLayout } from '../layout/index.js';
+import { OptionListLayout, ListLayout, SearchBoxLayout } from '../layout/index.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({
   ...AnswerBasedWorkflow.DEFAULT_API_OPTIONS,
@@ -15,6 +15,7 @@ const DEFAULT_API_OPTIONS = Object.freeze({
 
 const DEFAULT_LAYOUTS = Object.freeze({
   ...AnswerBasedWorkflow.DEFAULT_LAYOUTS,
+  [ROLE.QUERY]: [SearchBoxLayout.type, { templates: { buttonIcon: 'send' } }],
   [ROLE.RELATED_RESOURCES]: [ListLayout.type, { incremental: true, itemType: 'article' }],
   [ROLE.QUERY_SUGGESTIONS]: OptionListLayout.type,
 });