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

package/src/workflow/options/trackers.js

@@ -0,0 +1,32 @@
+import { mergeOptions } from './utils.js';
+
+export 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;
+}
+
+export function mergeTrackersOptions(...optionsList) {
+  if (optionsList[optionsList.length - 1] === false) {
+    return false;
+  }
+  return mergeOptions(optionsList, (merged, options) => Object.assign(merged, {
+    ...options,
+    impression: mergeTrackerEventOptions(merged.impression, options.impression),
+    viewable: mergeTrackerEventOptions(merged.viewable, options.viewable),
+    click: mergeTrackerEventOptions(merged.click, options.click),
+  }));
+}
+
+function mergeTrackerEventOptions(base = {}, overrides = {}) {
+  return (overrides === false || base === false) ? overrides : { ...base, ...overrides };
+}

package/src/workflow/options/utils.js

@@ -0,0 +1,26 @@
+import { trimObj } from '@miso.ai/commons';
+
+export function concatArrays(a0, a1) {
+  return (a0 && a0.length) ? (a1 && a1.length) ? [...a0, ...a1] : a0 : a1;
+}
+
+export function mergeOptions(optionsList, merge) {
+  let merged = {};
+  for (const options of optionsList) {
+    if (!options) {
+      continue;
+    }
+    merged = merge(merged, options);
+  }
+  return trimObj(merged);
+}
+
+export 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/src/workflow/processors.js

@@ -1,5 +1,35 @@
 import { trimObj } from '@miso.ai/commons';
 import { STATUS, ROLE, EVENT_TYPE, isPerformanceEventType, isProductRole } from '../constants.js';
+import { fields } from '../actor/index.js';
+
+// role mappings //
+export function mappingSortData(_, { hub, workflowOptions = {} } = {}) {
+  const { sort: { options = [] } = {} } = workflowOptions.filters || {};
+  if (!options.length) {
+    return [];
+  }
+  const { sort } = hub.states[fields.filters()] || {};
+  const selectedField = (sort && sort.field) || findDefaultSortOption(options).field;
+  if (!selectedField) {
+    return options;
+  }
+  // mark selected
+  return options.map(option => {
+    return {
+      ...option,
+      selected: option.field === selectedField,
+    };
+  });
+}
+
+function findDefaultSortOption(options) {
+  for (const option of options) {
+    if (option.default) {
+      return option;
+    }
+  }
+  return options[0];
+}
 
 // data //
 export function getRevision(data) {
@@ -79,40 +109,6 @@ export function writeAnswerStageToMeta(data) {
   };
 }
 
-export function writeFiltersToPayload(payload = {}, filters) {
-  return trimObj({
-    ...payload,
-    ...composeFiltersPayload(filters),
-  });
-}
-
-function composeFiltersPayload(filters) {
-  if (!filters) {
-    return undefined;
-  }
-  const { facets } = filters;
-  return 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;
-}
-
 export function retainFacetCountsInData(data, currentFacetCounts) {
   if (!currentFacetCounts) {
     return data;

package/src/workflow/recommendation.js

@@ -2,7 +2,7 @@ import { defineValues, API } from '@miso.ai/commons';
 import Workflow from './base.js';
 import { ListLayout } from '../layout/index.js';
 import { ROLE } from '../constants.js';
-import { mergeRolesOptions } from './options.js';
+import { mergeRolesOptions } from './options/index.js';
 import { mergeInteraction } from './processors.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({

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,