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

package/dist/cjs/workflow/options.js

@@ -10,12 +10,14 @@ 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.normalizeAutocompleteOptions = normalizeAutocompleteOptions;
 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");
@@ -139,19 +141,16 @@ function normalizeInteractionsOptions(options) {
     preprocess
   });
 }
-function normalizeAutocompleteOptions(options) {
+function normalizePaginationOptions(options) {
   if (options === undefined) {
-    throw new Error(`Expect autocomplete options to be an object or a boolean value: ${options}`);
+    throw new Error(`Expect pagination options to be an object or a boolean value: ${options}`);
   }
   if (typeof options === 'boolean') {
     options = {
-      actor: options
+      active: options
     };
   }
-  const processData = normalizeDataProcessorOptions(options.processData);
-  return Object.assign({}, options, {
-    processData
-  });
+  return options;
 }
 
 // merge //
@@ -239,18 +238,34 @@ function mergeInteractionsOptions() {
     preprocess: concatArrays(merged.preprocess, options.preprocess)
   })));
 }
-function mergeAutocompleteOptions() {
+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),
-    processData: mergeDataProcessorOptions(merged.processData, options.processData)
+    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 = [{
@@ -274,9 +289,9 @@ const FEATURES = [{
   normalize: normalizeInteractionsOptions,
   merge: mergeInteractionsOptions
 }, {
-  key: 'autocomplete',
-  normalize: normalizeAutocompleteOptions,
-  merge: mergeAutocompleteOptions
+  key: 'pagination',
+  normalize: normalizePaginationOptions,
+  merge: mergePaginationOptions
 }];
 class WorkflowContextOptions {
   constructor() {
@@ -300,7 +315,7 @@ class WorkflowOptions {
     this._events = new _commons.EventEmitter({
       target: this
     });
-    this._defaults = defaults;
+    this._defaults = defaults; // TODO: we should call normalize() on defaults
     this._context = context || {};
     this._locals = {};
     (0, _commons.defineValues)(this, {
@@ -388,8 +403,8 @@ function injectConfigurableFeature(prototype, feature) {
   if (feature === 'api') {
     Object.assign(prototype, {
       useApi() {
-        for (var _len7 = arguments.length, args = new Array(_len7), _key8 = 0; _key8 < _len7; _key8++) {
-          args[_key8] = arguments[_key8];
+        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;

package/dist/cjs/workflow/processors.js

@@ -3,23 +3,31 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.addDataInstructions = addDataInstructions;
-exports.removeDataInstructions = removeDataInstructions;
+exports.buildBaseInteraction = buildBaseInteraction;
+exports.concatResults = concatResults;
+exports.getRevision = getRevision;
+exports.markExhaustion = markExhaustion;
+exports.mergeInteraction = mergeInteraction;
+exports.retainFacetCounts = retainFacetCounts;
+exports.writeAffiliationInfoToInteraction = writeAffiliationInfoToInteraction;
 exports.writeAnswerStageToMeta = writeAnswerStageToMeta;
 exports.writeDataStatus = writeDataStatus;
+exports.writeFiltersToPayload = writeFiltersToPayload;
 exports.writeKeywordsToData = writeKeywordsToData;
 exports.writeMisoIdToMeta = writeMisoIdToMeta;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../constants.js");
-const _excluded = ["_inst"];
-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; }
+// data //
+function getRevision(data) {
+  return data && data.value && data.value.revision;
+}
 function writeDataStatus(data) {
   const status = getStatus(data);
-  const ongoing = status === _constants.STATUS.READY ? !!data.ongoing : undefined;
-  return (0, _commons.trimObj)(Object.assign({}, data, {
+  const ongoing = status === _constants.STATUS.READY ? data.ongoing : undefined;
+  return (0, _commons.trimObj)(Object.assign({
     status,
     ongoing
-  }));
+  }, data)); // let orinigal data override status and ongoing
 }
 function getStatus(data) {
   if (!data) {
@@ -56,7 +64,8 @@ function writeKeywordsToData(data) {
     request,
     value
   } = data;
-  if (!request || !value) {
+  // we still want the value in loading status
+  if (!request) {
     return data;
   }
   const {
@@ -96,18 +105,177 @@ function writeAnswerStageToMeta(data) {
     })
   });
 }
-function addDataInstructions(data, instructions) {
-  if (!instructions) {
+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 retainFacetCounts(data, currentFacetCounts) {
+  if (!currentFacetCounts) {
+    return data;
+  }
+  const {
+    status,
+    value
+  } = data;
+  switch (status) {
+    case _constants.STATUS.INITIAL:
+    case _constants.STATUS.LOADING:
+      break;
+    default:
+      return data;
+  }
+  if (value && value.facet_counts) {
     return data;
   }
-  return Object.assign({
-    _inst: Object.assign({}, data._inst, instructions)
-  }, data);
+  return Object.assign({}, data, {
+    value: Object.assign({}, value, {
+      facet_counts: currentFacetCounts
+    })
+  });
+}
+function concatResults(oldData, newData) {
+  let {
+    role = _constants.ROLE.PRODUCTS
+  } = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  if (!newData.value) {
+    return oldData;
+  }
+  const {
+    [role]: oldProducts = []
+  } = oldData.value;
+  const {
+    [role]: newProducts = []
+  } = newData.value;
+  // keep exhaustion flag
+  // TODO
+  return Object.assign({}, newData, {
+    value: Object.assign({}, newData.value, {
+      [role]: [...oldProducts, ...newProducts]
+    })
+  });
 }
-function removeDataInstructions(data) {
-  if (typeof data !== 'object') {
+function markExhaustion(data) {
+  let {
+    role = _constants.ROLE.PRODUCTS
+  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  const {
+    status,
+    request,
+    value
+  } = data;
+  // keep track of the exhaustion state
+  if (status !== _constants.STATUS.READY || !request || !value) {
+    return data;
+  }
+  const {
+    [role]: products
+  } = value;
+  if (!products) {
     return data;
   }
-  const rest = _objectWithoutPropertiesLoose(data, _excluded);
-  return rest;
+  const {
+    rows
+  } = request.payload;
+  const {
+    length
+  } = products;
+  const exhausted = length < rows;
+  if (!exhausted) {
+    return data;
+  }
+  return Object.assign({}, data, {
+    meta: Object.assign({}, data.meta, {
+      exhausted: true
+    })
+  });
+}
+
+// interactions //
+function buildBaseInteraction(args) {
+  const {
+    role,
+    type,
+    items
+  } = args;
+  const payload = {
+    type: type === 'viewable' ? 'viewable_impression' : type,
+    context: {
+      custom_context: (0, _commons.trimObj)({
+        property: role
+      })
+    }
+  };
+  if ((0, _constants.isPerformanceEventType)(type)) {
+    if ((0, _constants.isProductRole)(role)) {
+      payload.product_ids = (items || []).map(v => typeof v === 'string' ? v : v.product_id).filter(v => v);
+    } else {
+      payload.product_ids = [];
+      payload.context.custom_context.items = (items || []).map(v => v.text || v.id || v);
+    }
+  }
+  switch (type) {
+    case _constants.EVENT_TYPE.SUBMIT:
+      payload.context.custom_context.value = args.value;
+      break;
+    case _constants.EVENT_TYPE.FEEDBACK:
+      payload.context.custom_context.value = payload.value = args.value;
+      payload.context.custom_context.result_type = payload.result_type = args.result_type;
+      break;
+  }
+  return (0, _commons.trimObj)(payload);
+}
+function writeAffiliationInfoToInteraction(payload, args) {
+  if (args.role !== _constants.ROLE.AFFILIATION) {
+    return payload;
+  }
+  const {
+    items
+  } = args;
+  const channel = items[0] && items[0].channel || undefined;
+  const positions = items.map(v => v.position);
+  return mergeInteraction(payload, {
+    context: {
+      custom_context: {
+        channel,
+        positions
+      }
+    }
+  });
+}
+function mergeInteraction() {
+  let base = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let patch = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return (0, _commons.trimObj)(Object.assign({}, base, patch, {
+    context: (0, _commons.trimObj)(Object.assign({}, base.context, patch.context, {
+      custom_context: (0, _commons.trimObj)(Object.assign({}, base.context && base.context.custom_context, patch.context && patch.context.custom_context))
+    }))
+  }));
 }

package/dist/cjs/workflow/recommendation.js

@@ -6,35 +6,39 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
 var _base = _interopRequireDefault(require("./base.js"));
-var _options = require("./options.js");
-var _index = require("../actor/index.js");
-var _index2 = require("../layout/index.js");
+var _index = require("../layout/index.js");
 var _constants = require("../constants.js");
+var _options = require("./options.js");
+var _processors = require("./processors.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const DEFAULT_API_OPTIONS = Object.freeze({
+const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_API_OPTIONS, {
   group: _commons.API.GROUP.RECOMMENDATION,
   name: _commons.API.NAME.USER_TO_PRODUCTS,
-  payload: {
+  payload: Object.assign({}, _base.default.DEFAULT_API_OPTIONS.payload, {
     fl: ['*']
-  }
-});
-const DEFAULT_LAYOUTS = Object.freeze({
-  [_constants.ROLE.PRODUCTS]: _index2.ListLayout.type
-});
-const DEFAULT_TRACKERS = Object.freeze({
+  })
+}));
+const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LAYOUTS, {
+  [_constants.ROLE.PRODUCTS]: _index.ListLayout.type
+}));
+const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _base.default.DEFAULT_TRACKERS, {
   [_constants.ROLE.PRODUCTS]: {}
-});
-const DEFAULT_OPTIONS = Object.freeze({
+}));
+const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_OPTIONS, {
   api: DEFAULT_API_OPTIONS,
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS
+}));
+const ROLES_OPTIONS = (0, _options.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
+  main: _constants.ROLE.PRODUCTS,
+  members: Object.keys(DEFAULT_LAYOUTS)
 });
 class Recommendation extends _base.default {
   constructor(context, id) {
     super({
       name: 'recommendation',
       context,
-      roles: Object.keys(DEFAULT_LAYOUTS),
+      roles: ROLES_OPTIONS,
       defaults: DEFAULT_OPTIONS,
       id
     });
@@ -48,32 +52,15 @@ class Recommendation extends _base.default {
       id
     });
   }
-  _initReset(args) {
+  _initSession(args) {
     this._context._members.set(args.id, this);
-    super._initReset(args);
+    super._initSession(args);
   }
 
   // lifecycle //
   start() {
-    this._sessions.start();
     // in recommendation workflow, start() triggers query
-    // TODO: we should still make the query lifecycle
-    const {
-      session
-    } = this;
-    this._hub.update(_index.fields.request(), (0, _options.mergeApiOptions)(this._options.resolved.api, {
-      session
-    }));
-    return this;
-  }
-
-  // TODO: deprecate this
-  startTracker() {
-    this.useApi(false);
-    this.useLayouts(false);
-    this._sessions.start();
-    this.notifyViewUpdate(_constants.ROLE.CONTAINER);
-    this.notifyViewUpdate(_constants.ROLE.PRODUCTS);
+    this._request();
     return this;
   }
   notifyViewUpdate() {
@@ -86,21 +73,21 @@ class Recommendation extends _base.default {
   }
 
   // interactions //
-  _preprocessInteraction(payload) {
-    payload = super._preprocessInteraction(payload) || {};
-    const {
-      context = {}
-    } = payload;
-    const {
-      custom_context = {}
-    } = context;
-    return Object.assign({}, payload, {
-      context: Object.assign({}, context, {
-        custom_context: (0, _commons.trimObj)(Object.assign({
-          unit_id: this.id,
-          unit_instance_uuid: this.uuid
-        }, custom_context))
-      })
+  _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
+        }
+      }
     });
   }
 

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

@@ -0,0 +1,186 @@
+"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 _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"];
+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, {
+  group: _commons.API.GROUP.SEARCH,
+  payload: Object.assign({}, _base.default.DEFAULT_API_OPTIONS.payload, {
+    fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at', 'title'],
+    rows: DEFAULT_ROWS
+  })
+}));
+const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LAYOUTS, {
+  [_constants.ROLE.QUERY]: [_index2.SearchBoxLayout.type],
+  [_constants.ROLE.PRODUCTS]: [_index2.ListLayout.type, {
+    incremental: true,
+    infiniteScroll: true
+  }],
+  [_constants.ROLE.KEYWORDS]: [_index2.TextLayout.type, {
+    raw: true
+  }],
+  [_constants.ROLE.TOTAL]: [_index2.TextLayout.type, {
+    raw: true,
+    format: 'number'
+  }],
+  [_constants.ROLE.FACETS]: [_index2.FacetsLayout.type],
+  [_constants.ROLE.MORE]: [_index2.MoreButtonLayout.type]
+}));
+const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _base.default.DEFAULT_TRACKERS, {
+  [_constants.ROLE.PRODUCTS]: {}
+}));
+const DEFAULT_PAGINATION = Object.freeze({
+  active: false,
+  mode: 'infiniteScroll',
+  pageLimit: 10
+});
+const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_OPTIONS, {
+  api: DEFAULT_API_OPTIONS,
+  layouts: DEFAULT_LAYOUTS,
+  trackers: DEFAULT_TRACKERS,
+  pagination: DEFAULT_PAGINATION
+}));
+const ROLES_OPTIONS = (0, _options.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
+  main: _constants.ROLE.PRODUCTS,
+  members: Object.keys(DEFAULT_LAYOUTS),
+  mappings: {
+    [_constants.ROLE.FACETS]: 'facet_counts'
+  }
+});
+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())];
+  }
+  restart() {
+    super.restart();
+    this._page = 0;
+  }
+
+  // properties //
+  get exhausted() {
+    const data = this._hub.states[_index.fields.data()];
+    return !!(data && data.meta && data.meta.exhausted);
+  }
+
+  // query //
+  query(args) {
+    if (!args.q) {
+      throw new Error(`q is required in query() call`);
+    }
+    this._hub.update(_index.fields.query(), args);
+  }
+  _query(args) {
+    // keep track of the query args for refine and more calls
+    this._queryArgs = args;
+
+    // start a new session
+    this.restart();
+
+    // payload
+    const payload = this._buildPayload(args);
+    this._request({
+      payload
+    });
+  }
+  _refine(filters) {
+    // remember current facet_counts
+    const {
+      facet_counts
+    } = this._hub.states[_index.fields.data()].value || {};
+    this._currentFacetCounts = facet_counts;
+
+    // start a new session
+    this.restart();
+
+    // payload
+    const query = this._getQuery();
+    const payload = this._buildPayload(Object.assign({}, query, {
+      filters
+    }));
+    this._request({
+      payload
+    });
+  }
+  _more() {
+    if (this.exhausted || this._page >= DEFAULT_PAGE_LIMIT - 1) {
+      return; // ignore
+    }
+    // don't create a new session!
+
+    // payload
+    const query = this._getQuery();
+    const filters = this._hub.states[_index.fields.filters()]; // get stored filters
+    const start = (this._page + 1) * this._getPageSize();
+    const payload = this._buildPayload(Object.assign({}, query, {
+      filters,
+      start
+    }));
+    this._request({
+      payload
+    });
+    this._page++;
+  }
+  _getQuery() {
+    return this._queryArgs;
+  }
+  _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);
+    return payload;
+  }
+
+  // data //
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
+    data = (0, _processors.writeKeywordsToData)(data);
+    data = (0, _processors.retainFacetCounts)(data, this._currentFacetCounts);
+    data = (0, _processors.markExhaustion)(data);
+    return data;
+  }
+  _updateDataInHub(data) {
+    data = this._appendResultsFromMoreRequest(data);
+    super._updateDataInHub(data);
+  }
+  _appendResultsFromMoreRequest(data) {
+    const {
+      request
+    } = data;
+    if (!request || !request.payload.start) {
+      return data; // the initial state, or not from "more" request
+    }
+    // concat records if it's from "more" request
+    const currentData = this._hub.states[_index.fields.data()];
+    return (0, _processors.concatResults)(currentData, data);
+  }
+}
+exports.default = SearchBasedWorkflow;
+(0, _options.makeConfigurable)(SearchBasedWorkflow.prototype, ['pagination']);
+Object.assign(SearchBasedWorkflow, {
+  DEFAULT_API_OPTIONS,
+  DEFAULT_LAYOUTS,
+  DEFAULT_TRACKERS,
+  DEFAULT_PAGINATION,
+  DEFAULT_OPTIONS,
+  ROLES_OPTIONS
+});