@miso.ai/client-sdk-ui 1.11.5 → 1.11.6-beta.1

package/dist/cjs/workflow/recommendation.js

@@ -5,35 +5,34 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
-var _base = _interopRequireDefault(require("./base.js"));
+var _unit = _interopRequireDefault(require("./unit.js"));
 var _index = require("../layout/index.js");
 var _constants = require("../constants.js");
 var _index2 = require("./options/index.js");
-var _processors = require("./processors.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_API_OPTIONS, {
+const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _unit.default.DEFAULT_API_OPTIONS, {
   group: _commons.API.GROUP.RECOMMENDATION,
   name: _commons.API.NAME.USER_TO_PRODUCTS,
-  payload: Object.assign({}, _base.default.DEFAULT_API_OPTIONS.payload, {
+  payload: Object.assign({}, _unit.default.DEFAULT_API_OPTIONS.payload, {
     fl: ['*']
   })
 }));
-const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LAYOUTS, {
+const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _unit.default.DEFAULT_LAYOUTS, {
   [_constants.ROLE.PRODUCTS]: _index.ListLayout.type
 }));
-const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _base.default.DEFAULT_TRACKERS, {
+const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _unit.default.DEFAULT_TRACKERS, {
   [_constants.ROLE.PRODUCTS]: _index2.DEFAULT_TRACKER_OPTIONS
 }));
-const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_OPTIONS, {
+const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _unit.default.DEFAULT_OPTIONS, {
   api: DEFAULT_API_OPTIONS,
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS
 }));
-const ROLES_OPTIONS = (0, _index2.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
+const ROLES_OPTIONS = (0, _index2.mergeRolesOptions)(_unit.default.ROLES_OPTIONS, {
   main: _constants.ROLE.PRODUCTS,
   members: Object.keys(DEFAULT_LAYOUTS)
 });
-class Recommendation extends _base.default {
+class Recommendation extends _unit.default {
   constructor(context, id) {
     super({
       name: 'recommendation',
@@ -43,19 +42,6 @@ class Recommendation extends _base.default {
       id
     });
   }
-  _initProperties(args) {
-    super._initProperties(args);
-    const {
-      id
-    } = args;
-    (0, _commons.defineValues)(this, {
-      id
-    });
-  }
-  _initSession(args) {
-    this._context._members.set(args.id, this);
-    super._initSession(args);
-  }
 
   // lifecycle //
   start() {
@@ -63,38 +49,9 @@ class Recommendation extends _base.default {
     this._request();
     return this;
   }
-  notifyViewUpdate() {
-    let role = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _constants.ROLE.PRODUCTS;
-    for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-      args[_key - 1] = arguments[_key];
-    }
+  notifyViewUpdate(role = _constants.ROLE.PRODUCTS, ...args) {
     super.notifyViewUpdate(role, ...args);
     return this;
   }
-
-  // interactions //
-  _defaultProcessInteraction(payload, args) {
-    payload = super._defaultProcessInteraction(payload, args);
-    payload = this._writeUnitIdToInteraction(payload, args);
-    return payload;
-  }
-  _writeUnitIdToInteraction(payload) {
-    const unit_id = this.id;
-    const unit_instance_uuid = this.uuid;
-    return (0, _processors.mergeInteraction)(payload, {
-      context: {
-        custom_context: {
-          unit_id,
-          unit_instance_uuid
-        }
-      }
-    });
-  }
-
-  // destroy //
-  _destroy(options) {
-    this._context._members.delete(this.id);
-    super._destroy(options);
-  }
 }
 exports.default = Recommendation;

package/dist/cjs/workflow/recommendations.js

@@ -4,35 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _constants = require("../constants.js");
-var _context = _interopRequireDefault(require("./context.js"));
+var _units = _interopRequireDefault(require("./units.js"));
 var _recommendation = _interopRequireDefault(require("./recommendation.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class Recommendations extends _context.default {
+class Recommendations extends _units.default {
   constructor(plugin, client) {
     super('recommendations', plugin, client);
-    this._members = new Map();
   }
-  workflows() {
-    return [...this._members.values()];
-  }
-  create() {
-    let unitId = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _constants.DEFAULT_UNIT_ID;
-    if (this._members.has(unitId)) {
-      throw new Error(`Unit already exists: ${unitId}`);
-    }
+  _create(unitId) {
     return new _recommendation.default(this, unitId);
   }
-  has() {
-    let unitId = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _constants.DEFAULT_UNIT_ID;
-    return this._members.has(unitId);
-  }
-  get() {
-    let unitId = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _constants.DEFAULT_UNIT_ID;
-    if (typeof unitId !== 'string') {
-      throw new Error(`Required unit ID to be a string: ${unitId}`);
-    }
-    return this._members.get(unitId) || new _recommendation.default(this, unitId);
-  }
 }
 exports.default = Recommendations;

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

@@ -80,8 +80,7 @@ class SearchBasedWorkflow extends _base.default {
   }
 
   // query //
-  autoQuery() {
-    let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  autoQuery(options = {}) {
     _index3.autoQuery.call(this, options);
   }
   query(args) {
@@ -94,6 +93,11 @@ class SearchBasedWorkflow extends _base.default {
     // keep track of the query args for refine and more calls
     this._queryArgs = args;
 
+    // reset filters view
+    this._views.filters.reset({
+      silent: true
+    });
+
     // start a new session
     this.restart();
 
@@ -120,6 +124,8 @@ class SearchBasedWorkflow extends _base.default {
       payload
     });
   }
+
+  // TODO: expose API
   _more() {
     // if still loading, complain
     if (this.status !== _constants.STATUS.READY) {
@@ -193,8 +199,7 @@ class SearchBasedWorkflow extends _base.default {
       })
     });
   }
-  _processPayloadForMoreRequest() {
-    let payload = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  _processPayloadForMoreRequest(payload = {}) {
     const data = this._hub.states[_index.fields.data()];
     const {
       [this._roles.main]: items = []
@@ -244,10 +249,9 @@ class SearchBasedWorkflow extends _base.default {
   }
 
   // view actions //
-  _handleSortSelect() {
-    let {
-      value
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  _handleSortSelect({
+    value
+  } = {}) {
     if (!value) {
       return;
     }

package/dist/cjs/workflow/search.js

@@ -49,11 +49,7 @@ class Search extends _searchBased.default {
     super._initProperties(args);
     this._initAutocomplete(args);
   }
-  notifyViewUpdate() {
-    let role = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _constants.ROLE.PRODUCTS;
-    for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-      args[_key - 1] = arguments[_key];
-    }
+  notifyViewUpdate(role = _constants.ROLE.PRODUCTS, ...args) {
     super.notifyViewUpdate(role, ...args);
     return this;
   }

package/dist/cjs/workflow/unit.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _commons = require("@miso.ai/commons");
+var _base = _interopRequireDefault(require("./base.js"));
+var _processors = require("./processors.js");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class UnitWorkflow extends _base.default {
+  _initProperties(args) {
+    super._initProperties(args);
+    const {
+      id
+    } = args;
+    (0, _commons.defineValues)(this, {
+      id
+    });
+  }
+  _initSession(args) {
+    this._context._members.set(args.id, this);
+    super._initSession(args);
+  }
+
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    payload = super._defaultProcessInteraction(payload, args);
+    payload = this._writeUnitIdToInteraction(payload, args);
+    return payload;
+  }
+  _writeUnitIdToInteraction(payload) {
+    const unit_id = this.id;
+    const unit_instance_uuid = this.uuid;
+    return (0, _processors.mergeInteraction)(payload, {
+      context: {
+        custom_context: {
+          unit_id,
+          unit_instance_uuid
+        }
+      }
+    });
+  }
+
+  // destroy //
+  _destroy(options) {
+    this._context._members.delete(this.id);
+    super._destroy(options);
+  }
+}
+exports.default = UnitWorkflow;
+Object.assign(UnitWorkflow, {
+  DEFAULT_API_OPTIONS: _base.default.DEFAULT_API_OPTIONS,
+  DEFAULT_LAYOUTS: _base.default.DEFAULT_LAYOUTS,
+  DEFAULT_TRACKERS: _base.default.DEFAULT_TRACKERS,
+  DEFAULT_OPTIONS: _base.default.DEFAULT_OPTIONS,
+  ROLES_OPTIONS: _base.default.ROLES_OPTIONS
+});

package/dist/cjs/workflow/units.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _constants = require("../constants.js");
+var _context = _interopRequireDefault(require("./context.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class UnitWorkflowContext extends _context.default {
+  constructor(name, plugin, client) {
+    super(name, plugin, client);
+    this._members = new Map();
+  }
+  workflows() {
+    return [...this._members.values()];
+  }
+  create(unitId = _constants.DEFAULT_UNIT_ID) {
+    if (this._members.has(unitId)) {
+      throw new Error(`Unit already exists: ${unitId}`);
+    }
+    return this._create(unitId);
+  }
+  has(unitId = _constants.DEFAULT_UNIT_ID) {
+    return this._members.has(unitId);
+  }
+  get(unitId = _constants.DEFAULT_UNIT_ID) {
+    if (typeof unitId !== 'string') {
+      throw new Error(`Required unit ID to be a string: ${unitId}`);
+    }
+    return this._members.get(unitId) || this._create(unitId);
+  }
+  _create(unitId) {
+    throw new Error('Not implemented');
+  }
+}
+exports.default = UnitWorkflowContext;

package/dist/cjs/workflow/use-link.js

@@ -12,16 +12,14 @@ function enableUseLink(prototype) {
   (0, _commons.mixin)(prototype, UseLinkMixin.prototype);
 }
 class UseLinkMixin {
-  useLink(fn) {
-    let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  useLink(fn, options = {}) {
     if (typeof fn !== 'function' && fn !== false) {
       throw new Error('useLink(fn) expects fn to be a function or false');
     }
     this._linkFn = fn ? [fn, options] : false;
     return this;
   }
-  _submitToPage() {
-    let args = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  _submitToPage(args = {}) {
     if (!this._linkFn) {
       return;
     }
@@ -36,8 +34,7 @@ class UseLinkMixin {
       window.open(url, target, windowFeatures);
     }
   }
-  _getSubmitUrl() {
-    let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  _getSubmitUrl(_ref = {}) {
     let {
         q
       } = _ref,

package/package.json

@@ -26,7 +26,7 @@
     "url": "https://github.com/MisoAI/miso-client-js-sdk/issues"
   },
   "dependencies": {
-    "@miso.ai/commons": "1.11.5"
+    "@miso.ai/commons": "1.11.6-beta.1"
   },
-  "version": "1.11.5"
+  "version": "1.11.6-beta.1"
 }

package/src/actor/filters.js

@@ -67,10 +67,12 @@ export default class Filters {
     this._events.emit('update', { updates, states, oldStates });
   }
 
-  reset() {
-    const oldStates = this.states;
+  reset({ silent = false } = {}) {
+    // TODO: review this
+    const oldStates = this._states;
     this._states = undefined;
     const states = this._getStates();
+    this._hub.update(fields.filters(), states, { silent });
     this._events.emit('reset', { states, oldStates });
   }
 

package/src/actor/hub.js

@@ -2,8 +2,9 @@ import { defineValues, EventEmitter } from '@miso.ai/commons';
 
 export default class Hub {
 
-  constructor() {
+  constructor(options = {}) {
     (this._events = new EventEmitter())._injectSubscribeInterface(this);
+    this._options = options;
     this._states = {};
     defineValues(this, {
       states: new Proxy(this._states, {
@@ -12,15 +13,35 @@ export default class Hub {
     });
   }
 
-  update(name, state, { silent = false } = {}) {
+  update(name, state, options = {}) {
     this._states[name] = Object.freeze(state);
-    if (!silent) {
+    const event = Object.freeze({ action: 'update', name, state, ...options });
+    // callback after update, before emit
+    if (typeof this._options.onUpdate === 'function') {
+      this._options.onUpdate(event);
+    }
+    // emit
+    if (!options.silent) {
       this._events.emit(name, state);
     }
+    // callback after emit
+    if (typeof this._options.onEmit === 'function') {
+      this._options.onEmit(event);
+    }
   }
 
-  trigger(name, event) {
-    this._events.emit(name, event);
+  trigger(name, state) {
+    const event = Object.freeze({ action: 'trigger', name, state });
+    // callback before emit
+    if (typeof this._options.onUpdate === 'function') {
+      this._options.onUpdate(event);
+    }
+    // emit
+    this._events.emit(name, state);
+    // callback after emit
+    if (typeof this._options.onEmit === 'function') {
+      this._options.onEmit(event);
+    }
   }
 
 }

package/src/element/container/miso-explore.js

@@ -1,19 +1,19 @@
-import MisoContainerElement from './miso-container.js';
+import MisoUnitElement from './miso-unit.js';
 
 const TAG_NAME = 'miso-explore';
 
-export default class MisoExploreElement extends MisoContainerElement {
-
-  static get observedAttributes() {
-    return MisoContainerElement.observedAttributes;
-  }
+export default class MisoExploreElement extends MisoUnitElement {
 
   static get tagName() {
     return TAG_NAME;
   }
 
-  _getWorkflow(client) {
-    return client.ui.explore;
+  static get observedAttributes() {
+    return MisoUnitElement.observedAttributes;
+  }
+
+  _getWorkflowByUnitId(client, unitId) {
+    return client.ui.explores.get(unitId);
   }
 
 }

package/src/element/container/miso-hybrid-search.js

@@ -4,14 +4,14 @@ const TAG_NAME = 'miso-hybrid-search';
 
 export default class MisoHybridSearchElement extends MisoContainerElement {
 
-  static get observedAttributes() {
-    return MisoContainerElement.observedAttributes;
-  }
-
   static get tagName() {
     return TAG_NAME;
   }
 
+  static get observedAttributes() {
+    return MisoContainerElement.observedAttributes;
+  }
+
   _getWorkflow(client) {
     return client.ui.hybridSearch;
   }

package/src/element/container/miso-recommendation.js

@@ -1,61 +1,19 @@
-import MisoContainerElement from './miso-container.js';
+import MisoUnitElement from './miso-unit.js';
 
 const TAG_NAME = 'miso-recommendation';
 
-const ATTR_UNIT_ID = 'unit-id';
-const OBSERVED_ATTRIBUTES = Object.freeze([
-  ...MisoContainerElement.observedAttributes,
-  ATTR_UNIT_ID,
-]);
-
-export default class MisoRecommendationElement extends MisoContainerElement {
+export default class MisoRecommendationElement extends MisoUnitElement {
 
   static get tagName() {
     return TAG_NAME;
   }
 
   static get observedAttributes() {
-    return OBSERVED_ATTRIBUTES;
-  }
-
-  _getWorkflow(client) {
-    return this._getWorkflowByUnitId(client, this.unitId);
+    return MisoUnitElement.observedAttributes;
   }
 
   _getWorkflowByUnitId(client, unitId) {
     return client.ui.recommendations.get(unitId);
   }
 
-  // properties //
-  get unitId() {
-    return this.getAttribute(ATTR_UNIT_ID) || undefined;
-  }
-
-  set unitId(value) {
-    value = value && `${value}`;
-    if (value) {
-      this.setAttribute(ATTR_UNIT_ID, value);
-    } else {
-      this.removeAttribute(ATTR_UNIT_ID);
-    }
-  }
-
-  // lifecycle //
-  attributeChangedCallback(attr, oldValue, newValue) {
-    switch (attr) {
-      case ATTR_UNIT_ID:
-        this._handleUnitIdUpdate(oldValue, newValue);
-        break;
-      default:
-        super.attributeChangedCallback(attr, oldValue, newValue);
-    }
-  }
-
-  _handleUnitIdUpdate(oldUnitId, newUnitId) {
-    if (oldUnitId === newUnitId || !this._client) {
-      return;
-    }
-    this._setWorkflow(this._getWorkflowByUnitId(this._client, newUnitId));
-  }
-
 }

package/src/element/container/miso-search.js

@@ -4,14 +4,14 @@ const TAG_NAME = 'miso-search';
 
 export default class MisoSearchElement extends MisoContainerElement {
 
-  static get observedAttributes() {
-    return MisoContainerElement.observedAttributes;
-  }
-
   static get tagName() {
     return TAG_NAME;
   }
 
+  static get observedAttributes() {
+    return MisoContainerElement.observedAttributes;
+  }
+
   _getWorkflow(client) {
     return client.ui.search;
   }

package/src/element/container/miso-unit.js

@@ -0,0 +1,55 @@
+import MisoContainerElement from './miso-container.js';
+
+const ATTR_UNIT_ID = 'unit-id';
+const OBSERVED_ATTRIBUTES = Object.freeze([
+  ...MisoContainerElement.observedAttributes,
+  ATTR_UNIT_ID,
+]);
+
+export default class MisoUnitElement extends MisoContainerElement {
+
+  static get observedAttributes() {
+    return OBSERVED_ATTRIBUTES;
+  }
+
+  _getWorkflow(client) {
+    return this._getWorkflowByUnitId(client, this.unitId);
+  }
+
+  _getWorkflowByUnitId(client, unitId) {
+    throw new Error('Not implemented');
+  }
+
+  // properties //
+  get unitId() {
+    return this.getAttribute(ATTR_UNIT_ID) || undefined;
+  }
+
+  set unitId(value) {
+    value = value && `${value}`;
+    if (value) {
+      this.setAttribute(ATTR_UNIT_ID, value);
+    } else {
+      this.removeAttribute(ATTR_UNIT_ID);
+    }
+  }
+
+  // lifecycle //
+  attributeChangedCallback(attr, oldValue, newValue) {
+    switch (attr) {
+      case ATTR_UNIT_ID:
+        this._handleUnitIdUpdate(oldValue, newValue);
+        break;
+      default:
+        super.attributeChangedCallback(attr, oldValue, newValue);
+    }
+  }
+
+  _handleUnitIdUpdate(oldUnitId, newUnitId) {
+    if (oldUnitId === newUnitId || !this._client) {
+      return;
+    }
+    this._setWorkflow(this._getWorkflowByUnitId(this._client, newUnitId));
+  }
+
+}

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

@@ -329,7 +329,7 @@ export default class SearchBoxLayout extends TemplateBasedLayout {
   }
 
   async _submit(value) {
-    if (!value) {
+    if (!value || !value.trim()) {
       return;
     }
     this.close();

package/src/layout/radio/radio.js

@@ -50,6 +50,7 @@ export default class RadioLayout extends TemplateBasedLayout {
       view.hub.on(this._field, () => this._refresh()),
       proxyElement.on('click', (e) => this._handleClick(e)),
     ];
+    // TODO: it shall not carry the responsibility of setting default value
     this._defaultValue ? this._select(this._defaultValue, { silent: true }) : this._clear({ silent: true });
   }
 

package/src/layout/templates.js

@@ -100,8 +100,9 @@ export function imageInfoBlock(layout, data, meta) {
   ].join('')}</div>`;
 }
 
-export function titleBlock({ className }, { title }) {
-  return title ? `<div class="${className}__item-title">${escapeHtml(title)}</div>` : '';
+export function titleBlock({ className }, { title, _title_with_markups }) {
+  const text = _title_with_markups || escapeHtml(title);
+  return text ? `<div class="${className}__item-title">${text}</div>` : '';
 }
 
 export function brandBlock({ className }, { brand, brand_logo }) {

package/src/plugin.js

@@ -1,5 +1,5 @@
 import { Component, Resolution, defineAndUpgrade, delegateGetters, defineValues } from '@miso.ai/commons';
-import { Asks, HybridSearch, Explore, Search, Recommendations } from './workflow/index.js';
+import { Asks, HybridSearch, Explores, Search, Recommendations } from './workflow/index.js';
 import { AskCombo } from './combo/index.js';
 import Layouts from './layouts.js';
 import * as elements from './element/index.js';
@@ -23,6 +23,7 @@ export default class UiPlugin extends Component {
     super('ui');
     this.layouts = new Layouts(this);
     this._recommendations = new WeakMap();
+    this._explores = new WeakMap();
     this._asks = new WeakMap();
     this._extensions = new WeakMap();
     this._ready = new Resolution();
@@ -114,6 +115,14 @@ export default class UiPlugin extends Component {
     return recommendations;
   }
 
+  _getExplores(client) {
+    let explores = this._explores.get(client);
+    if (!explores) {
+      this._explores.set(client, explores = new Explores(this, client));
+    }
+    return explores;
+  }
+
   _getAsks(client) {
     let asks = this._asks.get(client);
     if (!asks) {
@@ -180,8 +189,12 @@ class Ui {
     return this._hybridSearch || (this._hybridSearch = new HybridSearch(this._plugin, this._client));
   }
 
+  get explores() {
+    return this._explores || (this._explores = this._plugin._getExplores(this._client));
+  }
+
   get explore() {
-    return this._explore || (this._explore = new Explore(this._plugin, this._client));
+    return this.explores.get(); // get default explore unit
   }
 
   get ready() {

package/src/version.js

@@ -1 +1 @@
-export default '1.11.5';
+export default '1.11.6-beta.1';