@miso.ai/client-sdk-ui 1.10.3 → 1.11.0-beta.0

package/dist/cjs/actor/autocomplete.js

@@ -18,6 +18,8 @@ class AutocompleteActor {
     this._source = source;
     this._options = options;
     this._index = -1;
+
+    // TODO: listen to request:input instead
     this._unsubscribes = [hub.on(fields.input(), () => this._sync()), options.on('autocomplete', () => this._syncOptions())];
 
     // sync right away
@@ -133,7 +135,8 @@ class AutocompleteActor {
   }
   _emitCompletions(event) {
     event.source = 'actor';
-    this._hub.update(fields.completions(), event);
+    // TDOO: update response:autocomplete instead
+    this._hub.update(fields.data(_constants.DATA_ASPECT.AUTOCOMPLETE), event);
   }
   _error(error) {
     // TODO

package/dist/cjs/actor/data.js

@@ -58,12 +58,13 @@ class DataActor {
       session
     } = this._hub.states;
     const request = _objectWithoutPropertiesLoose(event, _excluded);
-
-    // emit response to update request
-    this._emitResponse({
-      session,
-      request
-    });
+    if (!event._skipLoading) {
+      // emit response to update request
+      this._emitResponse({
+        session,
+        request
+      });
+    }
     try {
       const {
         signal
@@ -78,6 +79,14 @@ class DataActor {
       }));
       // takes an iterable, either sync or async
       if (response && response[Symbol.asyncIterator]) {
+        // also emit reponse of the head request, if available
+        if (response._response) {
+          this._emitResponseWithSessionCheck({
+            session,
+            request,
+            value: response._response
+          });
+        }
         let value;
         for await (value of response) {
           // A new session invalidates ongoing data fetch for the old session, terminating the loop

package/dist/cjs/actor/fields.js

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.completions = completions;
 exports.data = data;
 exports.event = event;
 exports.feedback = feedback;
+exports.filters = filters;
 exports.input = input;
 exports.interaction = interaction;
 exports.query = query;
@@ -22,17 +22,20 @@ function session() {
 function suggestions() {
   return 'suggestions';
 }
+function filters() {
+  return 'filters';
+}
 function query() {
   return 'query';
 }
-function request() {
-  return 'request';
+function request(aspect) {
+  return aspect ? `request:${aspect}` : 'request';
 }
-function response() {
-  return 'response';
+function response(aspect) {
+  return aspect ? `response:${aspect}` : 'response';
 }
-function data() {
-  return 'data';
+function data(aspect) {
+  return aspect ? `data:${aspect}` : 'data';
 }
 function view(role) {
   return role ? `view:${role}` : 'view';
@@ -51,7 +54,4 @@ function feedback() {
 }
 function input() {
   return 'input';
-}
-function completions() {
-  return 'completions';
 }

package/dist/cjs/actor/filters.js

@@ -0,0 +1,114 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _commons = require("@miso.ai/commons");
+var fields = _interopRequireWildcard(require("./fields.js"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function mergeState() {
+  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let update = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return Object.freeze((0, _commons.trimObj)(Object.assign({}, state, update, {
+    facets: Object.freeze((0, _commons.trimObj)(Object.assign({}, state.facets, update.facets)))
+  })));
+}
+class Filters {
+  constructor(views) {
+    let {
+      facets: facetsOptions
+    } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    this._views = views;
+    this._hub = views._hub;
+    this._states = this._initialStates = mergeState({}); // TODO: support custom initial states
+    const error = this._error = this._error.bind(this);
+    this._events = new _commons.EventEmitter({
+      target: this,
+      error
+    });
+    (0, _commons.defineValues)(this, {
+      facets: new Facets(this, facetsOptions)
+    });
+  }
+  get states() {
+    return this._states;
+  }
+  update(updates) {
+    const oldStates = this._states;
+    const states = this._states = mergeState(Object.assign({}, this._states, updates));
+    this._events.emit('update', {
+      updates,
+      states,
+      oldStates
+    });
+  }
+  reset() {
+    const oldStates = this._states;
+    const states = this._states = this._initialStates;
+    this._events.emit('reset', {
+      states,
+      oldStates
+    });
+  }
+  apply() {
+    this._hub.update(fields.filters(), this._states);
+    this._events.emit('apply');
+  }
+  _error(error) {
+    this._views._error(error);
+  }
+  _destroy() {}
+}
+exports.default = Filters;
+class Facets {
+  constructor(filters) {
+    let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    this._filters = filters;
+    this._options = options;
+  }
+  isSelected(field, value) {
+    const state = this._filters._states.facets[field];
+    return state && state.includes(value);
+  }
+  select(field, value) {
+    if (this.isSelected(field, value)) {
+      return;
+    }
+    this._select(field, value);
+  }
+  unselect(field, value) {
+    if (!this.isSelected(field, value)) {
+      return;
+    }
+    this._unselect(field, value);
+  }
+  toggle(field, value) {
+    if (this.isSelected(field, value)) {
+      this._unselect(field, value);
+    } else {
+      this._select(field, value);
+    }
+  }
+  _select(field, value) {
+    const values = this._options.multiple ? [...(this._filters._states.facets[field] || []), value] : [value];
+    values.sort();
+    this._filters.update({
+      facets: {
+        [field]: values
+      }
+    });
+  }
+  _unselect(field, value) {
+    let values = this._filters._states.facets[field].filter(v => v !== value);
+    if (values.length === 0) {
+      values = undefined;
+    }
+    this._filters.update({
+      facets: {
+        [field]: values
+      }
+    });
+  }
+}

package/dist/cjs/actor/hub.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
+var _processors = require("../workflow/processors.js");
 class Hub {
   constructor() {
     (this._events = new _commons.EventEmitter())._injectSubscribeInterface(this);
@@ -19,7 +20,7 @@ class Hub {
     let {
       silent = false
     } = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-    this._states[name] = Object.freeze(state);
+    this._states[name] = Object.freeze((0, _processors.removeDataInstructions)(state));
     if (!silent) {
       this._events.emit(name, state);
     }

package/dist/cjs/actor/sessions.js

@@ -41,14 +41,12 @@ class SessionMaker {
     }));
   }
   restart() {
-    this.new({
-      force: true
-    });
-    this.start();
+    this._hub.update(fields.session(), this._create(true));
   }
   _create() {
+    let active = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
     return Object.freeze({
-      active: false,
+      active,
       uuid: (0, _commons.uuidv4)(),
       index: this._sessionIndex++,
       meta: {}

package/dist/cjs/actor/view.js

@@ -28,6 +28,7 @@ class ViewActor {
       target: this
     });
     this._views = views;
+    this._config = views._rolesConfig[role] || {};
     (0, _commons.defineValues)(this, {
       role,
       interface: new View(this)
@@ -111,6 +112,9 @@ class ViewActor {
     }
     return this._tracker;
   }
+  get filters() {
+    return this._views.filters;
+  }
   async refresh() {
     var _this = this;
     let {
@@ -209,16 +213,15 @@ class ViewActor {
     // used by tracker to expose tracker options to layout
     return this._views._getTrackerOptions(this.role);
   }
-  _sliceData(_ref2) {
-    let {
+  _sliceData(data) {
+    const {
         value,
-        error,
         status,
         meta
-      } = _ref2,
-      rest = _objectWithoutPropertiesLoose(_ref2, _excluded);
+      } = data,
+      rest = _objectWithoutPropertiesLoose(data, _excluded);
     const sliced = Object.assign({
-      value: this.role === _constants.ROLE.ERROR ? error : value && value[this.role],
+      value: asMappingFunction(this._config.mapping || this.role)(data),
       status,
       data: value,
       meta
@@ -287,4 +290,14 @@ class View {
   constructor(actor) {
     (0, _commons.delegateGetters)(this, actor, ['role', 'layout', 'element', 'proxyElement', 'refresh', 'on', 'tracker']);
   }
+}
+function asMappingFunction(fn) {
+  switch (typeof fn) {
+    case 'function':
+      return fn;
+    case 'string':
+      return data => data.value && data.value[fn];
+    default:
+      throw new Error(`Invalid mapping function: ${fn}`);
+  }
 }

package/dist/cjs/actor/views.js

@@ -8,6 +8,7 @@ var _commons = require("@miso.ai/commons");
 var _constants = require("../constants.js");
 var fields = _interopRequireWildcard(require("./fields.js"));
 var _view = _interopRequireDefault(require("./view.js"));
+var _filters = _interopRequireDefault(require("./filters.js"));
 var _tracker = _interopRequireDefault(require("./tracker.js"));
 var _trackers = require("../util/trackers.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
@@ -20,6 +21,7 @@ class ViewsActor {
       extensions,
       layouts,
       roles = [],
+      rolesConfig = {},
       options
     } = _ref;
     this._hub = hub;
@@ -27,10 +29,12 @@ class ViewsActor {
     this._extensions = extensions;
     this._layoutFactory = layouts;
     this._options = options;
+    this._rolesConfig = rolesConfig;
     this._containers = new Map();
     this._containerTracker = undefined;
     this._views = {};
     this._trackers = new Trackers(this, roles);
+    this._filters = new _filters.default(this);
     for (const role of roles) {
       this._views[role] = new _view.default(this, role);
     }
@@ -39,13 +43,18 @@ class ViewsActor {
     });
     const syncSize = () => this.syncSize();
     window.addEventListener('resize', syncSize);
-    this._unsubscribes = [() => window.removeEventListener('resize', syncSize), hub.on(fields.data(), () => this.refresh()), options.on('trackers', () => this._syncTrackers()), options.on('layouts', () => this._syncLayouts())];
+    this._unsubscribes = [() => window.removeEventListener('resize', syncSize), hub.on(fields.data(), data => this.refresh({
+      data
+    })), options.on('trackers', () => this._syncTrackers()), options.on('layouts', () => this._syncLayouts())];
     this._syncTrackers();
     this._syncLayouts();
   }
   get trackers() {
     return this._trackers;
   }
+  get filters() {
+    return this._filters;
+  }
 
   // elements //
   addContainer(element) {
@@ -174,29 +183,32 @@ class ViewsActor {
   }
   async refresh() {
     let {
-      force
+      force,
+      data
     } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    const data = this._getData();
+    data = this._getData(data);
     // container first
-    await Promise.all(this._getViews(true).map(view => view.refresh({
+    let views = this._getViews(true);
+    if (!force && data._inst) {
+      const {
+        includes,
+        excludes
+      } = data._inst;
+      if (includes) {
+        // always include containers
+        views = views.filter(view => view.role === _constants.ROLE.CONTAINER || includes.includes(view.role));
+      }
+      if (excludes) {
+        views = views.filter(view => !excludes.includes(view.role));
+      }
+    }
+    await Promise.all(views.map(view => view.refresh({
       force,
       data
     })));
   }
-  _getData() {
-    const {
-      [fields.data()]: data
-    } = this._hub.states;
-    // compare to cached
-    if (!this._data || this._data.data !== data) {
-      const status = !data || !data.session || !data.session.active ? _constants.STATUS.INITIAL : data.error ? _constants.STATUS.ERRONEOUS : data.value ? _constants.STATUS.READY : _constants.STATUS.LOADING;
-      const ongoing = status === _constants.STATUS.READY ? !!data.ongoing : undefined;
-      this._data = Object.freeze(Object.assign({}, data, {
-        status,
-        ongoing
-      }));
-    }
-    return this._data;
+  _getData(data) {
+    return data || this._hub.states[fields.data()];
   }
   _syncTrackers() {
     this._trackerOptions = this._options.resolved.trackers;
@@ -234,13 +246,14 @@ class ViewsActor {
       unsubscribe();
     }
     this._unsubscribes = [];
+    this._filters._destroy();
   }
 }
 exports.default = ViewsActor;
 class Views {
   constructor(actor) {
     this._actor = actor;
-    (0, _commons.delegateGetters)(this, actor, ['syncSize', 'refresh', 'trackers']);
+    (0, _commons.delegateGetters)(this, actor, ['syncSize', 'refresh', 'trackers', 'filters']);
   }
   get(role) {
     return this._actor.get(role).interface;

package/dist/cjs/constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.TRACKING_STATUS = exports.TRACKING_EVENT_TYPES = exports.STATUS = exports.ROLE = exports.ORGANIC_QUESTION_SOURCE = exports.LAYOUT_CATEGORY = exports.EVENT_TYPE = exports.DEFAULT_UNIT_ID = exports.ATTR_DATA_MISO_UNIT_ID = exports.ATTR_DATA_MISO_PRODUCT_ID = void 0;
+exports.TRACKING_STATUS = exports.TRACKING_EVENT_TYPES = exports.STATUS = exports.ROLE = exports.ORGANIC_QUESTION_SOURCE = exports.LAYOUT_CATEGORY = exports.EVENT_TYPE = exports.DEFAULT_UNIT_ID = exports.DATA_ASPECT = exports.ATTR_DATA_MISO_UNIT_ID = exports.ATTR_DATA_MISO_PRODUCT_ID = void 0;
 exports.isDataRole = isDataRole;
 exports.validateEventType = validateEventType;
 exports.validateTrackingStatus = validateTrackingStatus;
@@ -28,18 +28,25 @@ const ROLE = exports.ROLE = Object.freeze({
   QUERY_SUGGESTIONS: 'query_suggestions',
   RELATED_QUESTIONS: 'related_questions',
   AFFILIATION: 'affiliation',
+  KEYWORDS: 'keywords',
+  FACETS: 'facets',
+  HITS: 'hits',
   ERROR: 'error'
 });
-const DATA_ROLE_SET = new Set([ROLE.PRODUCTS, ROLE.CATEGORIES, ROLE.ATTRIBUTES, ROLE.RESULTS, ROLE.ITEMS, ROLE.QUESTION, ROLE.ANSWER, ROLE.SOURCES, ROLE.RELATED_RESOURCES, ROLE.QUERY_SUGGESTIONS, ROLE.RELATED_QUESTIONS, ROLE.AFFILIATION]);
+const DATA_ROLE_SET = new Set([ROLE.PRODUCTS, ROLE.CATEGORIES, ROLE.ATTRIBUTES, ROLE.RESULTS, ROLE.ITEMS, ROLE.QUESTION, ROLE.ANSWER, ROLE.SOURCES, ROLE.RELATED_RESOURCES, ROLE.QUERY_SUGGESTIONS, ROLE.RELATED_QUESTIONS, ROLE.AFFILIATION, ROLE.FACETS, ROLE.HITS]);
 function isDataRole(role) {
   return DATA_ROLE_SET.has(role);
 }
+const DATA_ASPECT = exports.DATA_ASPECT = Object.freeze({
+  AUTOCOMPLETE: 'autocomplete'
+});
 const LAYOUT_CATEGORY = exports.LAYOUT_CATEGORY = Object.freeze({
   CONTAINER: 'container',
   BANNER: 'banner',
   LIST: 'list',
   QUERY: 'query',
   RADIO: 'radio',
+  FILTERS: 'filters',
   TEXT: 'text',
   AFFILIATION: 'affiliation',
   ERROR: 'error'

package/dist/cjs/defaults/ask/constants.js

@@ -3,5 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.CLASS_PREFIX = void 0;
-const CLASS_PREFIX = exports.CLASS_PREFIX = 'miso-ask-combo';
+exports.CONAINER_TAG = exports.CLASS_PREFIX = void 0;
+const CLASS_PREFIX = exports.CLASS_PREFIX = 'miso-ask-combo';
+const CONAINER_TAG = exports.CONAINER_TAG = 'miso-ask';