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

package/src/workflow/search-based.js

@@ -1,10 +1,10 @@
-import { API } from '@miso.ai/commons';
+import { API, asArray, trimObj } from '@miso.ai/commons';
 import Workflow from './base.js';
 import { fields } from '../actor/index.js';
-import { STATUS, ROLE } from '../constants.js';
-import { SearchBoxLayout, ListLayout, TextLayout, FacetsLayout, MoreButtonLayout } from '../layout/index.js';
-import { writeKeywordsToData, writeFiltersToPayload, retainFacetCountsInData, writeExhaustionToData, concatItemsFromMoreResponse } from './processors.js';
-import { mergeRolesOptions, makeConfigurable } from './options.js';
+import { STATUS, ROLE, WORKFLOW_CONFIGURABLE } from '../constants.js';
+import { SearchBoxLayout, ListLayout, TextLayout, FacetsLayout, SelectLayout, MoreButtonLayout } from '../layout/index.js';
+import { mappingSortData, writeKeywordsToData, retainFacetCountsInData, writeExhaustionToData, concatItemsFromMoreResponse } from './processors.js';
+import { mergeRolesOptions, makeConfigurable } from './options/index.js';
 
 const DEFAULT_ROWS = 10;
 const DEFAULT_PAGE_LIMIT = 10;
@@ -26,6 +26,7 @@ const DEFAULT_LAYOUTS = Object.freeze({
   [ROLE.KEYWORDS]: [TextLayout.type, { raw: true }],
   [ROLE.TOTAL]: [TextLayout.type, { raw: true, format: 'number' }],
   [ROLE.FACETS]: [FacetsLayout.type],
+  [ROLE.SORT]: [SelectLayout.type],
   [ROLE.MORE]: [MoreButtonLayout.type],
 });
 
@@ -53,6 +54,7 @@ const ROLES_OPTIONS = mergeRolesOptions(Workflow.ROLES_OPTIONS, {
   members: Object.keys(DEFAULT_LAYOUTS),
   mappings: {
     [ROLE.FACETS]: 'facet_counts',
+    [ROLE.SORT]: mappingSortData,
   },
 });
 
@@ -63,8 +65,9 @@ export default class SearchBasedWorkflow extends Workflow {
     this._unsubscribes = [
       ...this._unsubscribes,
       this._hub.on(fields.query(), args => this._query(args)),
-      this._hub.on(fields.filters(), filters => this._refine(filters)),
+      this._hub.on(fields.filters(), () => this._refine()),
       this._hub.on(fields.more(), () => this._more()),
+      this._views.get(ROLE.SORT).on('select', event => this._handleSortSelect(event)),
     ];
   }
 
@@ -104,7 +107,7 @@ export default class SearchBasedWorkflow extends Workflow {
     this._request({ payload });
   }
 
-  _refine(filters) {
+  _refine() {
     // remember current facet_counts
     const { facet_counts } = this._hub.states[fields.data()].value || {};
     this._currentFacetCounts = facet_counts;
@@ -114,7 +117,7 @@ export default class SearchBasedWorkflow extends Workflow {
 
     // payload
     const query = this._getQuery();
-    const payload = this._buildPayload({ ...query, filters });
+    const payload = this._buildPayload(query);
 
     this._request({ payload });
   }
@@ -134,8 +137,7 @@ export default class SearchBasedWorkflow extends Workflow {
 
     // payload
     const query = this._getQuery();
-    const filters = this._hub.states[fields.filters()]; // get stored filters
-    let payload = this._buildPayload({ ...query, filters });
+    let payload = this._buildPayload(query);
     payload = this._processPayloadForMoreRequest(payload);
 
     this._request({ payload });
@@ -150,12 +152,46 @@ export default class SearchBasedWorkflow extends Workflow {
     return this._options.resolved.api.payload.rows;
   }
 
-  _buildPayload({ filters, ...payload } = {}) {
-    payload = writeFiltersToPayload(payload, filters);
+  _buildPayload(payload) {
+    payload = this._writeFiltersToPayload(payload);
     payload = this._writePageInfoToPayload(payload);
     return payload;
   }
 
+  _writeFiltersToPayload(payload) {
+    const filters = this._hub.states[fields.filters()];
+    const { facets, sort } = filters || {};
+    return trimObj({
+      ...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 asArray(sort);
+  }
+
   _writePageInfoToPayload(payload) {
     return {
       ...payload,
@@ -208,9 +244,18 @@ export default class SearchBasedWorkflow extends Workflow {
     return concatItemsFromMoreResponse(currentData, data, { role: this._roles.main });
   }
 
+  // view actions //
+  _handleSortSelect({ value } = {}) {
+    if (!value) {
+      return;
+    }
+    this._views.filters.update({ sort: value });
+    this._views.filters.apply();
+  }
+
 }
 
-makeConfigurable(SearchBasedWorkflow.prototype, ['pagination']);
+makeConfigurable(SearchBasedWorkflow.prototype, [WORKFLOW_CONFIGURABLE.PAGINATION, WORKFLOW_CONFIGURABLE.FILTERS]);
 
 Object.assign(SearchBasedWorkflow, {
   DEFAULT_API_OPTIONS,

package/dist/cjs/workflow/options.js

@@ -1,448 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.WorkflowOptions = exports.WorkflowContextOptions = void 0;
-exports.makeConfigurable = makeConfigurable;
-exports.mergeApiOptions = mergeApiOptions;
-exports.mergeAutocompleteOptions = mergeAutocompleteOptions;
-exports.mergeDataProcessorOptions = mergeDataProcessorOptions;
-exports.mergeInteractionsOptions = mergeInteractionsOptions;
-exports.mergeLayoutsOptions = mergeLayoutsOptions;
-exports.mergePaginationOptions = mergePaginationOptions;
-exports.mergeRolesOptions = mergeRolesOptions;
-exports.mergeTrackersOptions = mergeTrackersOptions;
-exports.normalizeApiOptions = normalizeApiOptions;
-exports.normalizeDataProcessorOptions = normalizeDataProcessorOptions;
-exports.normalizeInteractionsOptions = normalizeInteractionsOptions;
-exports.normalizeLayoutsOptions = normalizeLayoutsOptions;
-exports.normalizePaginationOptions = normalizePaginationOptions;
-exports.normalizeTrackers = normalizeTrackers;
-var _commons = require("@miso.ai/commons");
-var _constants = require("../constants.js");
-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; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-// normalize //
-function normalizeApiOptions() {
-  let [name, payload] = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-  // TODO: take object form as well
-  if (name === false) {
-    return {
-      actor: false
-    };
-  }
-  if (typeof name === 'object' && payload === undefined) {
-    payload = name;
-    name = undefined;
-  }
-  let group = undefined;
-  if (name && name.indexOf('/') !== -1) {
-    [group, name] = name.split('/');
-  }
-  if (name && typeof name !== 'string' || payload !== undefined && typeof payload !== 'object') {
-    throw new Error(`Invalid arguments for useApi(): ${name}, ${payload}`);
-  }
-  return (0, _commons.trimObj)({
-    group,
-    name,
-    payload
-  });
-}
-function normalizeLayoutsOptions() {
-  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  if (options === false) {
-    return false;
-  }
-  // fallback: results -> products
-  const _ROLE$RESULTS = _constants.ROLE.RESULTS,
-    {
-      [_ROLE$RESULTS]: results
-    } = options,
-    rest = _objectWithoutPropertiesLoose(options, [_ROLE$RESULTS].map(_toPropertyKey));
-  if (results !== undefined) {
-    console.warn(`useLayouts({ ${[_constants.ROLE.RESULTS]}: ... }) is deprecated, use useLayouts({ ${[_constants.ROLE.PRODUCTS]}: ... }) instead`);
-    options = Object.assign({}, rest, {
-      [_constants.ROLE.PRODUCTS]: results
-    });
-  }
-  const normalize = {};
-  for (const [role, args] of Object.entries(options)) {
-    normalize[normalizeRole(role)] = normalizeLayoutOptions(args);
-  }
-  return normalize;
-}
-function normalizeRole(role) {
-  role = (0, _commons.lowerCamelToSnake)(role);
-  role = (0, _commons.kebabToSnake)(role);
-  return role;
-}
-function normalizeLayoutOptions(args) {
-  // take args:
-  // * undefined
-  // * false
-  // * name (string)
-  // * options (object)
-  // * [name, options]
-  if (args === undefined) {
-    return undefined;
-  }
-  let [name, options] = (0, _commons.asArray)(args);
-  if (typeof name === 'object') {
-    options = name;
-    name = undefined;
-  }
-  return [name, options];
-}
-function normalizeDataProcessorOptions(fns) {
-  fns = (0, _commons.asArray)(fns);
-  for (const fn of fns) {
-    if (typeof fn !== 'function') {
-      throw new Error(`Expect data processor options to be a function: ${fn}`);
-    }
-  }
-  return fns;
-}
-function normalizeTrackers(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 normalizeInteractionsOptions(options) {
-  if (options === undefined) {
-    return undefined;
-  }
-  if (options === false) {
-    return {
-      handle: () => {}
-    };
-  }
-  // preprocess
-  const preprocess = (0, _commons.asArray)(options.preprocess);
-  for (const p of preprocess) {
-    if (typeof p !== 'function') {
-      throw new Error(`Expect preprocess options to be a function: ${p}`);
-    }
-  }
-  // handle
-  if (options.handle && typeof options.handle !== 'function') {
-    throw new Error(`Expect handle options to be a function: ${options.handle}`);
-  }
-  return Object.assign({}, options, {
-    preprocess
-  });
-}
-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;
-}
-
-// merge //
-function mergeApiOptions() {
-  for (var _len = arguments.length, optionsList = new Array(_len), _key2 = 0; _key2 < _len; _key2++) {
-    optionsList[_key2] = arguments[_key2];
-  }
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return mergeOptions(optionsList, (merged, options) => Object.assign(merged, Object.assign({}, options, {
-    payload: mergeApiPayloads(merged.payload, options.payload)
-  })));
-}
-function mergeApiPayloads(base, overrides) {
-  return Object.assign({}, base, overrides, mergeObjectValueIfPresent('_meta', base, overrides));
-}
-function mergeObjectValueIfPresent(key, base, overrides) {
-  const baseValue = base && base[key];
-  const overridesValue = overrides && overrides[key];
-  const value = baseValue ? overridesValue ? Object.assign({}, baseValue, overridesValue) : baseValue : overridesValue;
-  return value !== undefined ? {
-    [key]: value
-  } : {};
-}
-function mergeLayoutsOptions() {
-  for (var _len2 = arguments.length, optionsList = new Array(_len2), _key3 = 0; _key3 < _len2; _key3++) {
-    optionsList[_key3] = arguments[_key3];
-  }
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return mergeOptions(optionsList, (merged, options) => {
-    for (const [role, args] of Object.entries(options)) {
-      merged[role] = mergeLayoutOptions(merged[role], args);
-    }
-    return merged;
-  });
-}
-function mergeLayoutOptions(base, overrides) {
-  overrides = normalizeLayoutOptions(overrides);
-  if (overrides[0] === false) {
-    return overrides;
-  }
-  return base && overrides ? [overrides[0] || base[0], mergeLayoutParameters(base[1], overrides[1])] : overrides || base;
-}
-function mergeLayoutParameters(base, overrides) {
-  return Object.assign({}, base, overrides, {
-    link: Object.assign({}, base && base.link, overrides && overrides.link),
-    templates: Object.assign({}, base && base.templates, overrides && overrides.templates)
-  });
-}
-function mergeDataProcessorOptions() {
-  for (var _len3 = arguments.length, optionsList = new Array(_len3), _key4 = 0; _key4 < _len3; _key4++) {
-    optionsList[_key4] = arguments[_key4];
-  }
-  return optionsList.flat().filter(Boolean);
-}
-function mergeTrackersOptions() {
-  for (var _len4 = arguments.length, optionsList = new Array(_len4), _key5 = 0; _key5 < _len4; _key5++) {
-    optionsList[_key5] = arguments[_key5];
-  }
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return 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);
-}
-function mergeInteractionsOptions() {
-  for (var _len5 = arguments.length, optionsList = new Array(_len5), _key6 = 0; _key6 < _len5; _key6++) {
-    optionsList[_key6] = arguments[_key6];
-  }
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return mergeOptions(optionsList, (merged, options) => Object.assign(merged, Object.assign({}, options, {
-    preprocess: concatArrays(merged.preprocess, options.preprocess)
-  })));
-}
-function mergePaginationOptions() {
-  for (var _len6 = arguments.length, optionsList = new Array(_len6), _key7 = 0; _key7 < _len6; _key7++) {
-    optionsList[_key7] = arguments[_key7];
-  }
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return mergeOptions(optionsList, (merged, options) => Object.assign(merged, options));
-}
-function mergeAutocompleteOptions() {
-  for (var _len7 = arguments.length, optionsList = new Array(_len7), _key8 = 0; _key8 < _len7; _key8++) {
-    optionsList[_key8] = arguments[_key8];
-  }
-  return mergeOptions(optionsList, (merged, options) => Object.assign(merged, Object.assign({}, options, {
-    api: mergeApiOptions(merged.api, options.api)
-  })));
-}
-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])];
-}
-
-// manifest //
-const FEATURES = [{
-  key: 'api',
-  normalize: normalizeApiOptions,
-  merge: mergeApiOptions
-}, {
-  key: 'layouts',
-  normalize: normalizeLayoutsOptions,
-  merge: mergeLayoutsOptions
-}, {
-  key: 'dataProcessor',
-  normalize: normalizeDataProcessorOptions,
-  merge: mergeDataProcessorOptions
-}, {
-  key: 'trackers',
-  normalize: normalizeTrackerOptions,
-  merge: mergeTrackersOptions
-}, {
-  key: 'interactions',
-  normalize: normalizeInteractionsOptions,
-  merge: mergeInteractionsOptions
-}, {
-  key: 'pagination',
-  normalize: normalizePaginationOptions,
-  merge: mergePaginationOptions
-}];
-class WorkflowContextOptions {
-  constructor() {
-    this._events = new _commons.EventEmitter({
-      target: this
-    });
-    this._globals = {};
-  }
-  _notify(name) {
-    this._events.emit(name, {
-      name,
-      value: this[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('*', event => this._notify(event.name))];
-    }
-  }
-  _notify(name) {
-    this._events.emit(name, {
-      name,
-      value: this.resolved[name]
-    });
-  }
-  _destroy() {
-    for (const unsubscribe of this._unsubscribes || []) {
-      unsubscribe();
-    }
-    this._unsubscribes = [];
-  }
-}
-exports.WorkflowOptions = WorkflowOptions;
-class WorkflowFeature {
-  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);
-  }
-}
-class ResolvedWorkflowOptions {
-  constructor(options) {
-    this._options = options;
-  }
-}
-for (const {
-  key,
-  normalize,
-  merge
-} of FEATURES) {
-  Object.defineProperty(WorkflowContextOptions.prototype, key, {
-    get: function () {
-      const _key = `_${key}`;
-      return this[_key] || (this[_key] = new WorkflowFeature(this, this._globals, key, normalize, merge));
-    }
-  });
-  Object.defineProperty(WorkflowOptions.prototype, key, {
-    get: function () {
-      const _key = `_${key}`;
-      return this[_key] || (this[_key] = new WorkflowFeature(this, this._locals, key, normalize, merge));
-    }
-  });
-  Object.defineProperty(ResolvedWorkflowOptions.prototype, key, {
-    get: function () {
-      const options = this._options;
-      const contextFeature = options._context[key];
-      return merge(options._defaults[key], contextFeature && contextFeature.get(), options._locals[key]);
-    }
-  });
-}
-const DEFAULT_FEATURES = ['api', 'layouts', 'dataProcessor', 'trackers', 'interactions'];
-function makeConfigurable(prototype) {
-  let features = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_FEATURES;
-  for (const feature of features) {
-    injectConfigurableFeature(prototype, feature);
-  }
-}
-function injectConfigurableFeature(prototype, feature) {
-  if (feature === 'api') {
-    Object.assign(prototype, {
-      useApi() {
-        for (var _len8 = arguments.length, args = new Array(_len8), _key9 = 0; _key9 < _len8; _key9++) {
-          args[_key9] = arguments[_key9];
-        }
-        this._options.api.merge(args);
-        return this;
-      },
-      clearApi() {
-        this._options.api.set();
-        return this;
-      }
-    });
-  } else {
-    const upperCased = upperCase(feature);
-    Object.assign(prototype, {
-      [`use${upperCased}`](value) {
-        this._options[feature].merge(value);
-        return this;
-      },
-      [`clear${upperCased}`]() {
-        this._options[feature].set();
-        return this;
-      }
-    });
-  }
-}
-
-// helpers //
-function upperCase(str) {
-  return str.charAt(0).toUpperCase() + str.slice(1);
-}
-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);
-}