@miso.ai/client-sdk-ui 1.11.4-beta.1 → 1.11.4-beta.3

package/dist/cjs/workflow/options/options.js

@@ -0,0 +1,154 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.WorkflowOptions = exports.WorkflowContextOptions = void 0;
+var _commons = require("@miso.ai/commons");
+var _constants = require("../../constants.js");
+var _api = require("./api.js");
+var _layouts = require("./layouts.js");
+var _dataProcessor = require("./data-processor.js");
+var _trackers = require("./trackers.js");
+var _interactions = require("./interactions.js");
+var _filters = require("./filters.js");
+var _pagination = require("./pagination.js");
+const FEATURES = [{
+  key: _constants.WORKFLOW_CONFIGURABLE.API,
+  normalize: _api.normalizeApiOptions,
+  merge: _api.mergeApiOptions
+}, {
+  key: _constants.WORKFLOW_CONFIGURABLE.LAYOUTS,
+  normalize: _layouts.normalizeLayoutsOptions,
+  merge: _layouts.mergeLayoutsOptions
+}, {
+  key: _constants.WORKFLOW_CONFIGURABLE.DATA_PROCESSOR,
+  normalize: _dataProcessor.normalizeDataProcessorOptions,
+  merge: _dataProcessor.mergeDataProcessorOptions
+}, {
+  key: _constants.WORKFLOW_CONFIGURABLE.TRACKERS,
+  normalize: _trackers.normalizeTrackersOptions,
+  merge: _trackers.mergeTrackersOptions
+}, {
+  key: _constants.WORKFLOW_CONFIGURABLE.INTERACTIONS,
+  normalize: _interactions.normalizeInteractionsOptions,
+  merge: _interactions.mergeInteractionsOptions
+}, {
+  key: _constants.WORKFLOW_CONFIGURABLE.FILTERS,
+  normalize: _filters.normalizeFiltersOptions,
+  merge: _filters.mergeFiltersOptions
+}, {
+  key: _constants.WORKFLOW_CONFIGURABLE.PAGINATION,
+  normalize: _pagination.normalizePaginationOptions,
+  merge: _pagination.mergePaginationOptions
+}];
+class WorkflowContextOptions {
+  constructor() {
+    this._events = new _commons.EventEmitter({
+      target: this
+    });
+    this._globals = {};
+  }
+  _notify(name) {
+    this._events.emit(name);
+    this._events.emit('_update', name);
+  }
+}
+exports.WorkflowContextOptions = WorkflowContextOptions;
+class WorkflowOptions {
+  constructor() {
+    let context = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    let defaults = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    this._events = new _commons.EventEmitter({
+      target: this
+    });
+    this._defaults = defaults; // TODO: we should call normalize() on defaults
+    this._context = context || {};
+    this._locals = {};
+    (0, _commons.defineValues)(this, {
+      resolved: new ResolvedWorkflowOptions(this),
+      defaults
+    });
+    if (context && context.on) {
+      this._unsubscribes = [context.on('_update', name => this._notify(name))];
+    }
+  }
+  _notify(name) {
+    this.resolved._invalidate(name);
+    this._events.emit(name);
+  }
+  _destroy() {
+    for (const unsubscribe of this._unsubscribes || []) {
+      unsubscribe();
+    }
+    this._unsubscribes = [];
+  }
+}
+exports.WorkflowOptions = WorkflowOptions;
+class ResolvedWorkflowOptions {
+  constructor(options) {
+    this._options = options;
+    this._cache = {};
+  }
+  _invalidate(key) {
+    this._cache[key] = undefined;
+  }
+  _get(_ref) {
+    let {
+      key,
+      merge
+    } = _ref;
+    if (this._cache[key] === undefined) {
+      const options = this._options;
+      const contextFeature = options._context[key];
+      this._cache[key] = merge(options._defaults[key], contextFeature && contextFeature.get(), options._locals[key]);
+    }
+    return this._cache[key];
+  }
+}
+class WorkflowConfigurableFeature {
+  constructor(options, store, key, normalize, merge) {
+    this._options = options;
+    this._store = store;
+    this._key = key;
+    this._normalize = value => value !== undefined ? normalize(value) : undefined;
+    this._merge = merge;
+  }
+  get() {
+    return this._store[this._key];
+  }
+  set(value) {
+    this._set(this._normalize(value));
+  }
+  merge(value) {
+    this._set(this._merge(this.get(), this._normalize(value)));
+  }
+  _set(value) {
+    this._store[this._key] = value;
+    this._options._notify(this._key);
+  }
+}
+for (const feature of FEATURES) {
+  const {
+    key,
+    normalize,
+    merge
+  } = feature;
+  Object.defineProperty(WorkflowContextOptions.prototype, key, {
+    get: function () {
+      const _key = `_${key}`;
+      return this[_key] || (this[_key] = new WorkflowConfigurableFeature(this, this._globals, key, normalize, merge));
+    }
+  });
+  Object.defineProperty(WorkflowOptions.prototype, key, {
+    get: function () {
+      const _key = `_${key}`;
+      return this[_key] || (this[_key] = new WorkflowConfigurableFeature(this, this._locals, key, normalize, merge));
+    }
+  });
+  Object.defineProperty(ResolvedWorkflowOptions.prototype, key, {
+    get: function () {
+      return this._get(feature);
+    }
+  });
+}

package/dist/cjs/workflow/options/pagination.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mergePaginationOptions = mergePaginationOptions;
+exports.normalizePaginationOptions = normalizePaginationOptions;
+var _utils = require("./utils.js");
+function normalizePaginationOptions(options) {
+  if (options === undefined) {
+    throw new Error(`Expect pagination options to be an object or a boolean value: ${options}`);
+  }
+  if (typeof options === 'boolean') {
+    options = {
+      active: options
+    };
+  }
+  return options;
+}
+function mergePaginationOptions() {
+  for (var _len = arguments.length, optionsList = new Array(_len), _key = 0; _key < _len; _key++) {
+    optionsList[_key] = arguments[_key];
+  }
+  if (optionsList[optionsList.length - 1] === false) {
+    return false;
+  }
+  return (0, _utils.mergeOptions)(optionsList, (merged, options) => Object.assign(merged, options));
+}

package/dist/cjs/workflow/options/roles.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mergeRolesOptions = mergeRolesOptions;
+function mergeRolesOptions(base, overrides) {
+  return Object.freeze(Object.assign({}, base, overrides, {
+    members: mergeRolesMembers(base.members, overrides.members),
+    mappings: Object.freeze(Object.assign({}, base.mappings, overrides.mappings))
+  }));
+}
+function mergeRolesMembers() {
+  let base = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  let overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  return [...new Set([...base, ...overrides])];
+}

package/dist/cjs/workflow/options/trackers.js

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mergeTrackersOptions = mergeTrackersOptions;
+exports.normalizeTrackersOptions = normalizeTrackersOptions;
+var _utils = require("./utils.js");
+function normalizeTrackersOptions(options) {
+  if (options === undefined || options === false) {
+    return options;
+  }
+  const normalized = {};
+  for (const [role, args] of Object.entries(options)) {
+    normalized[role] = normalizeTrackerOptions(args);
+  }
+  return normalized;
+}
+function normalizeTrackerOptions(options) {
+  return options;
+}
+function mergeTrackersOptions() {
+  for (var _len = arguments.length, optionsList = new Array(_len), _key = 0; _key < _len; _key++) {
+    optionsList[_key] = arguments[_key];
+  }
+  if (optionsList[optionsList.length - 1] === false) {
+    return false;
+  }
+  return (0, _utils.mergeOptions)(optionsList, (merged, options) => Object.assign(merged, Object.assign({}, options, {
+    impression: mergeTrackerEventOptions(merged.impression, options.impression),
+    viewable: mergeTrackerEventOptions(merged.viewable, options.viewable),
+    click: mergeTrackerEventOptions(merged.click, options.click)
+  })));
+}
+function mergeTrackerEventOptions() {
+  let base = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return overrides === false || base === false ? overrides : Object.assign({}, base, overrides);
+}

package/dist/cjs/workflow/options/utils.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.concatArrays = concatArrays;
+exports.mergeOptions = mergeOptions;
+exports.normalizeOptions = normalizeOptions;
+var _commons = require("@miso.ai/commons");
+function concatArrays(a0, a1) {
+  return a0 && a0.length ? a1 && a1.length ? [...a0, ...a1] : a0 : a1;
+}
+function mergeOptions(optionsList, merge) {
+  let merged = {};
+  for (const options of optionsList) {
+    if (!options) {
+      continue;
+    }
+    merged = merge(merged, options);
+  }
+  return (0, _commons.trimObj)(merged);
+}
+function normalizeOptions(options) {
+  if (options === undefined) {
+    throw new Error(`Expect options to be an object or a boolean value: ${options}`);
+  }
+  if (typeof options === 'boolean') {
+    options = {
+      active: options
+    };
+  }
+  return options;
+}

package/dist/cjs/workflow/processors.js

@@ -6,17 +6,55 @@ Object.defineProperty(exports, "__esModule", {
 exports.buildBaseInteraction = buildBaseInteraction;
 exports.concatItemsFromMoreResponse = concatItemsFromMoreResponse;
 exports.getRevision = getRevision;
+exports.mappingSortData = mappingSortData;
 exports.mergeInteraction = mergeInteraction;
 exports.retainFacetCountsInData = retainFacetCountsInData;
 exports.writeAffiliationInfoToInteraction = writeAffiliationInfoToInteraction;
 exports.writeAnswerStageToMeta = writeAnswerStageToMeta;
 exports.writeDataStatus = writeDataStatus;
 exports.writeExhaustionToData = writeExhaustionToData;
-exports.writeFiltersToPayload = writeFiltersToPayload;
 exports.writeKeywordsToData = writeKeywordsToData;
 exports.writeMisoIdToMeta = writeMisoIdToMeta;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../constants.js");
+var _index = require("../actor/index.js");
+// role mappings //
+function mappingSortData(_) {
+  let {
+    hub,
+    workflowOptions = {}
+  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  const {
+    sort: {
+      options = []
+    } = {}
+  } = workflowOptions.filters || {};
+  if (!options.length) {
+    return [];
+  }
+  const {
+    sort
+  } = hub.states[_index.fields.filters()] || {};
+  const selectedField = sort && sort.field || findDefaultSortOption(options).field;
+  if (!selectedField) {
+    return options;
+  }
+  // mark selected
+  return options.map(option => {
+    return Object.assign({}, option, {
+      selected: option.field === selectedField
+    });
+  });
+}
+function findDefaultSortOption(options) {
+  for (const option of options) {
+    if (option.default) {
+      return option;
+    }
+  }
+  return options[0];
+}
+
 // data //
 function getRevision(data) {
   return data && data.value && data.value.revision;
@@ -105,38 +143,6 @@ function writeAnswerStageToMeta(data) {
     })
   });
 }
-function writeFiltersToPayload() {
-  let payload = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let filters = arguments.length > 1 ? arguments[1] : undefined;
-  return (0, _commons.trimObj)(Object.assign({}, payload, composeFiltersPayload(filters)));
-}
-function composeFiltersPayload(filters) {
-  if (!filters) {
-    return undefined;
-  }
-  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
-    }
-    filters[field] = {
-      terms: values
-    };
-  }
-  return Object.keys(filters).length ? filters : undefined;
-}
 function retainFacetCountsInData(data, currentFacetCounts) {
   if (!currentFacetCounts) {
     return data;

package/dist/cjs/workflow/recommendation.js

@@ -8,7 +8,7 @@ var _commons = require("@miso.ai/commons");
 var _base = _interopRequireDefault(require("./base.js"));
 var _index = require("../layout/index.js");
 var _constants = require("../constants.js");
-var _options = require("./options.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, {
@@ -29,7 +29,7 @@ const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_OP
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS
 }));
-const ROLES_OPTIONS = (0, _options.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
+const ROLES_OPTIONS = (0, _index2.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
   main: _constants.ROLE.PRODUCTS,
   members: Object.keys(DEFAULT_LAYOUTS)
 });

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

@@ -10,10 +10,8 @@ var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
 var _index2 = require("../layout/index.js");
 var _processors = require("./processors.js");
-var _options = require("./options.js");
-const _excluded = ["filters"];
+var _index3 = require("./options/index.js");
 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 DEFAULT_ROWS = 10;
 const DEFAULT_PAGE_LIMIT = 10;
 const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_API_OPTIONS, {
@@ -37,6 +35,7 @@ const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LA
     format: 'number'
   }],
   [_constants.ROLE.FACETS]: [_index2.FacetsLayout.type],
+  [_constants.ROLE.SORT]: [_index2.SelectLayout.type],
   [_constants.ROLE.MORE]: [_index2.MoreButtonLayout.type]
 }));
 const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _base.default.DEFAULT_TRACKERS, {
@@ -53,17 +52,18 @@ const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_OP
   trackers: DEFAULT_TRACKERS,
   pagination: DEFAULT_PAGINATION
 }));
-const ROLES_OPTIONS = (0, _options.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
+const ROLES_OPTIONS = (0, _index3.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
   main: _constants.ROLE.PRODUCTS,
   members: Object.keys(DEFAULT_LAYOUTS),
   mappings: {
-    [_constants.ROLE.FACETS]: 'facet_counts'
+    [_constants.ROLE.FACETS]: 'facet_counts',
+    [_constants.ROLE.SORT]: _processors.mappingSortData
   }
 });
 class SearchBasedWorkflow extends _base.default {
   _initSubscriptions(args) {
     super._initSubscriptions(args);
-    this._unsubscribes = [...this._unsubscribes, this._hub.on(_index.fields.query(), args => this._query(args)), this._hub.on(_index.fields.filters(), filters => this._refine(filters)), this._hub.on(_index.fields.more(), () => this._more())];
+    this._unsubscribes = [...this._unsubscribes, this._hub.on(_index.fields.query(), args => this._query(args)), this._hub.on(_index.fields.filters(), () => this._refine()), this._hub.on(_index.fields.more(), () => this._more()), this._views.get(_constants.ROLE.SORT).on('select', event => this._handleSortSelect(event))];
   }
   restart() {
     super.restart();
@@ -99,7 +99,7 @@ class SearchBasedWorkflow extends _base.default {
       payload
     });
   }
-  _refine(filters) {
+  _refine() {
     // remember current facet_counts
     const {
       facet_counts
@@ -111,9 +111,7 @@ class SearchBasedWorkflow extends _base.default {
 
     // payload
     const query = this._getQuery();
-    const payload = this._buildPayload(Object.assign({}, query, {
-      filters
-    }));
+    const payload = this._buildPayload(query);
     this._request({
       payload
     });
@@ -133,10 +131,7 @@ class SearchBasedWorkflow extends _base.default {
 
     // payload
     const query = this._getQuery();
-    const filters = this._hub.states[_index.fields.filters()]; // get stored filters
-    let payload = this._buildPayload(Object.assign({}, query, {
-      filters
-    }));
+    let payload = this._buildPayload(query);
     payload = this._processPayloadForMoreRequest(payload);
     this._request({
       payload
@@ -149,16 +144,44 @@ class SearchBasedWorkflow extends _base.default {
   _getPageSize() {
     return this._options.resolved.api.payload.rows;
   }
-  _buildPayload() {
-    let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    let {
-        filters
-      } = _ref,
-      payload = _objectWithoutPropertiesLoose(_ref, _excluded);
-    payload = (0, _processors.writeFiltersToPayload)(payload, filters);
+  _buildPayload(payload) {
+    payload = this._writeFiltersToPayload(payload);
     payload = this._writePageInfoToPayload(payload);
     return payload;
   }
+  _writeFiltersToPayload(payload) {
+    const filters = this._hub.states[_index.fields.filters()];
+    const {
+      facets,
+      sort
+    } = filters || {};
+    return (0, _commons.trimObj)(Object.assign({}, payload, {
+      facet_filters: this._buildFacetFilters(facets),
+      order_by: this._buildOrderBy(sort)
+    }));
+  }
+  _buildFacetFilters(facets) {
+    if (!facets) {
+      return undefined;
+    }
+    const filters = {};
+    for (const field in facets) {
+      const values = facets[field];
+      if (!values || !values.length) {
+        continue; // just in case
+      }
+      filters[field] = {
+        terms: values
+      };
+    }
+    return Object.keys(filters).length ? filters : undefined;
+  }
+  _buildOrderBy(sort) {
+    if (!sort) {
+      return undefined;
+    }
+    return (0, _commons.asArray)(sort);
+  }
   _writePageInfoToPayload(payload) {
     return Object.assign({}, payload, {
       _meta: Object.assign({}, payload._meta, {
@@ -215,9 +238,23 @@ class SearchBasedWorkflow extends _base.default {
       role: this._roles.main
     });
   }
+
+  // view actions //
+  _handleSortSelect() {
+    let {
+      value
+    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    if (!value) {
+      return;
+    }
+    this._views.filters.update({
+      sort: value
+    });
+    this._views.filters.apply();
+  }
 }
 exports.default = SearchBasedWorkflow;
-(0, _options.makeConfigurable)(SearchBasedWorkflow.prototype, ['pagination']);
+(0, _index3.makeConfigurable)(SearchBasedWorkflow.prototype, [_constants.WORKFLOW_CONFIGURABLE.PAGINATION, _constants.WORKFLOW_CONFIGURABLE.FILTERS]);
 Object.assign(SearchBasedWorkflow, {
   DEFAULT_API_OPTIONS,
   DEFAULT_LAYOUTS,

package/package.json

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

package/src/actor/filters.js

@@ -12,43 +12,84 @@ function mergeState(state = {}, update = {}) {
   }));
 }
 
+function optionsToState({ sort } = {}) {
+  // TODO: facets
+  return trimObj({
+    facets: Object.freeze({}),
+    sort: sortOptionsToState(sort),
+  });
+}
+
+function sortOptionsToState(sort) {
+  if (!sort) {
+    return undefined;
+  }
+  const { options = [] } = sort;
+  for (const option of options) {
+    if (option.default) {
+      return Object.freeze(option);
+    }
+  }
+  return Object.freeze(options[0]);
+}
+
 export default class Filters {
 
   constructor(views, { facets: facetsOptions } = {}) {
     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 EventEmitter({ target: this, error });
     defineValues(this, { facets: new Facets(this, facetsOptions) });
+
+    this._unsubscribes = [
+      views._options.on('filters', () => this._syncOptions()),
+    ];
+
+    this._syncOptions();
+    this._states = undefined;
+  }
+
+  _syncOptions() {
+    const options = this._views._options.resolved.filters;
+    this._initialStates = optionsToState(options);
+    this.apply({ silent: true });
   }
 
-  get states() {
-    return this._states;
+  _getStates() {
+    return this._states || this._initialStates;
   }
 
   update(updates) {
-    const oldStates = this._states;
-    const states = this._states = mergeState({ ...this._states, ...updates });
+    const oldStates = this._getStates();
+    this._states = mergeState({ ...oldStates, ...updates });
+    const states = this._getStates();
     this._events.emit('update', { updates, states, oldStates });
   }
 
   reset() {
-    const oldStates = this._states;
-    const states = this._states = this._initialStates;
+    const oldStates = this.states;
+    this._states = undefined;
+    const states = this._getStates();
     this._events.emit('reset', { states, oldStates });
   }
 
-  apply() {
-    this._hub.update(fields.filters(), this._states);
-    this._events.emit('apply');
+  apply({ silent = false } = {}) {
+    const states = this._getStates();
+    this._hub.update(fields.filters(), states, { silent });
+    !silent && this._events.emit('apply');
   }
 
   _error(error) {
     this._views._error(error);
   }
 
-  _destroy() {}
+  _destroy() {
+    for (const unsubscribe of this._unsubscribes) {
+      unsubscribe();
+    }
+    this._unsubscribes = [];
+  }
 
 }
 
@@ -87,7 +128,7 @@ class Facets {
   }
 
   _select(field, value) {
-    const values = this._options.multiple ? [...(this._filters._states.facets[field] || []), value] : [value];
+    const values = this._options.multivalued ? [...(this._filters._states.facets[field] || []), value] : [value];
     values.sort();
     this._filters.update({ facets: { [field]: values } });
   }

package/src/actor/tracker.js

@@ -7,20 +7,15 @@ const VALUELESS_ITEMS = [Symbol('valueless')];
 
 export default class Tracker {
 
-  constructor({ hub, role, valueless = false, options }) {
+  constructor({ hub, role, valueless = false }) {
     this._hub = hub;
     this._role = role;
     this._valueless = !!valueless;
-    this._options = options;
     // TODO: know item type
 
     this._states = new States(this._getSessionId());
   }
 
-  get options() {
-    return typeof this._options === 'function' ? this._options() : this._options;
-  }
-
   getState(item) {
     return this._states.getFullState(item);
   }