@miso.ai/client-sdk-ui 1.11.0-beta.1 → 1.11.0-beta.11

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

@@ -0,0 +1,228 @@
+"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);
+  }
+  get page() {
+    return this._page;
+  }
+
+  // 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 still loading, complain
+    if (this.status !== _constants.STATUS.READY) {
+      throw new Error(`Can not call more() while loading.`);
+    }
+    // no more pages, ignore
+    if (this.exhausted || this._page >= DEFAULT_PAGE_LIMIT - 1) {
+      return;
+    }
+    // don't create a new session!
+
+    this._page++;
+
+    // payload
+    const query = this._getQuery();
+    const filters = this._hub.states[_index.fields.filters()]; // get stored filters
+    let payload = this._buildPayload(Object.assign({}, query, {
+      filters
+    }));
+    payload = this._processPayloadForMoreRequest(payload);
+    this._request({
+      payload
+    });
+  }
+  _getQuery() {
+    // TODO: just get from the hub
+    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);
+    payload = this._writePageInfoToPayload(payload);
+    return payload;
+  }
+  _writePageInfoToPayload(payload) {
+    return Object.assign({}, payload, {
+      _meta: Object.assign({}, payload._meta, {
+        page: this._page
+      })
+    });
+  }
+  _processPayloadForMoreRequest() {
+    let payload = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const data = this._hub.states[_index.fields.data()];
+    const {
+      [this._roles.main]: items = []
+    } = data && data.value || {};
+    const productIds = items.map(item => item.product_id).filter(v => v);
+    const exclude = [...(payload.exclude || []), ...productIds];
+    if (exclude.length === 0) {
+      return payload;
+    }
+    return Object.assign({}, payload, {
+      exclude
+    });
+  }
+
+  // data //
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
+    data = (0, _processors.writeKeywordsToData)(data);
+    data = (0, _processors.retainFacetCountsInData)(data, this._currentFacetCounts);
+    data = (0, _processors.writeExhaustionToData)(data, {
+      role: this._roles.main
+    });
+    return data;
+  }
+  _updateDataInHub(data) {
+    data = this._appendResultsFromMoreRequest(data);
+    super._updateDataInHub(data);
+  }
+  _appendResultsFromMoreRequest(data) {
+    const {
+      request
+    } = data;
+    if (!request) {
+      return data; // the initial state
+    }
+    const {
+      _meta
+    } = request.payload;
+    if (!_meta || !_meta.page) {
+      return data; // not from "more" request
+    }
+    // concat records if it's from "more" request
+    const currentData = this._hub.states[_index.fields.data()];
+    return (0, _processors.concatItemsFromMoreResponse)(currentData, data, {
+      role: this._roles.main
+    });
+  }
+}
+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
+});

package/dist/cjs/workflow/search.js

@@ -5,14 +5,9 @@ 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 sources = _interopRequireWildcard(require("../source.js"));
-var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
-var _index2 = require("../layout/index.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; }
+var _searchBased = _interopRequireDefault(require("./search-based.js"));
+var _autocompletable = require("./autocompletable.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const DEFAULT_API_OPTIONS = Object.freeze({
   group: _commons.API.GROUP.SEARCH,
@@ -22,7 +17,6 @@ const DEFAULT_API_OPTIONS = Object.freeze({
   }
 });
 const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
-  actor: false,
   api: {
     group: _commons.API.GROUP.SEARCH,
     name: _commons.API.NAME.AUTOCOMPLETE,
@@ -30,45 +24,31 @@ const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
       completion_fields: ['suggested_queries', 'title'],
       fl: ['title', 'url', 'cover_image']
     }
-  },
-  throttle: 300
-});
-const DEFAULT_LAYOUTS = Object.freeze({
-  [_constants.ROLE.QUERY]: _index2.SearchBoxLayout.type,
-  [_constants.ROLE.PRODUCTS]: _index2.ListLayout.type
-});
-const DEFAULT_TRACKERS = Object.freeze({
-  [_constants.ROLE.PRODUCTS]: {}
+  }
 });
-const DEFAULT_OPTIONS = Object.freeze({
+const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _searchBased.default.DEFAULT_LAYOUTS));
+const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _searchBased.default.DEFAULT_TRACKERS));
+const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _searchBased.default.DEFAULT_OPTIONS, {
   api: DEFAULT_API_OPTIONS,
   autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS,
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS
-});
-class Search extends _base.default {
+}));
+const ROLES_OPTIONS = _searchBased.default.ROLES_OPTIONS;
+class Search extends _searchBased.default {
   constructor(plugin, client) {
     super({
       name: 'search',
       plugin,
       client,
-      roles: Object.keys(DEFAULT_LAYOUTS),
+      roles: ROLES_OPTIONS,
       defaults: DEFAULT_OPTIONS
     });
   }
-  _initActors(args) {
-    super._initActors(args);
-    this._autocomplete = new _index.AutocompleteActor(this._hub, {
-      source: sources.api(this._client),
-      options: this._options
-    });
-  }
-  _initSubscriptions(args) {
-    super._initSubscriptions(args);
-    this._unsubscribes = [...this._unsubscribes, this._hub.on(_index.fields.query(), args => this._query(args))];
+  _initProperties(args) {
+    super._initProperties(args);
+    this._initAutocomplete(args);
   }
-
-  // lifecycle //
   autoQuery() {
     let {
       setValue = true,
@@ -92,40 +72,6 @@ class Search extends _base.default {
       });
     }
   }
-  query(args) {
-    if (!args.q) {
-      throw new Error(`q is required in query() call`);
-    }
-    this._hub.update(_index.fields.query(), args);
-  }
-  _query(args) {
-    // start a new session
-    this.restart();
-    const {
-      session
-    } = this;
-
-    // build payload and trigger request
-    const payload = this._buildPayload(args);
-    const event = (0, _options.mergeApiOptions)(this._options.resolved.api, {
-      payload,
-      session
-    });
-    this._request(event);
-  }
-  _buildPayload(args) {
-    return args;
-  }
-  _request(event) {
-    this._hub.update(_index.fields.request(), event);
-  }
-  updateCompletions(event) {
-    // TODO: verify
-    this._hub.update(_index.fields.data(_constants.DATA_ASPECT.AUTOCOMPLETE), Object.assign({}, event, {
-      source: 'manual'
-    }));
-    return this;
-  }
   notifyViewUpdate() {
     let role = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _constants.ROLE.PRODUCTS;
     for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
@@ -134,6 +80,13 @@ class Search extends _base.default {
     super.notifyViewUpdate(role, ...args);
     return this;
   }
+
+  // destroy //
+  _destroy(options) {
+    this._feedback._destroy();
+    this._destroyAutocomplete();
+    super._destroy(options);
+  }
 }
 exports.default = Search;
-(0, _options.makeConfigurable)(Search.prototype, ['autocomplete']);
+(0, _autocompletable.makeAutocompletable)(Search.prototype);

package/package.json

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

package/src/actor/data.js

@@ -50,10 +50,8 @@ export default class DataActor {
     const { session } = this._hub.states;
     const { session: _, ...request } = event;
 
-    if (!event._skipLoading) {
-      // emit response to update request
-      this._emitResponse({ session, request });
-    }
+    // emit response to update request
+    this._emitResponse({ session, request });
 
     try {
       const { signal } = this._ac || {};

package/src/actor/feedback.js

@@ -1,4 +1,5 @@
 import * as fields from './fields.js';
+import { EVENT_TYPE } from '../constants.js';
 
 export default class FeedbackActor {
 
@@ -10,29 +11,11 @@ export default class FeedbackActor {
   }
   
   _trigger(state) {
-    const { [fields.data()]: data } = this._hub.states;
-    const { question_id } = data && data.value || {};
-    if (!question_id) {
-      return;
-    }
-    // TODO: ad-hoc
-    const { request } = data || {};
-    const { payload } = request || {};
-    const question_source = payload && payload._meta && payload._meta.question_source;
-    this._hub.trigger(fields.interaction(), this._buildInteraction(state, { question_source }));
-  }
-
-  _buildInteraction({ value, unselected }, { question_source }) {
-    return {
-      type: 'feedback',
-      context: {
-        custom_context: {
-          result_type: 'answer',
-          question_source,
-          value: unselected ? 'unselected' : value,
-        },
-      },
-    };
+    this._hub.trigger(fields.tracker(), {
+      type: EVENT_TYPE.FEEDBACK,
+      result_type: 'answer',
+      value: state.unselected ? 'unselected' : state.value,
+    });
   }
 
   _destroy() {

package/src/actor/fields.js

@@ -6,6 +6,10 @@ export function suggestions() {
   return 'suggestions';
 }
 
+export function completions() {
+  return 'completions';
+}
+
 export function filters() {
   return 'filters';
 }
@@ -14,16 +18,16 @@ export function query() {
   return 'query';
 }
 
-export function request(aspect) {
-  return aspect ? `request:${aspect}` : 'request';
+export function request() {
+  return 'request';
 }
 
-export function response(aspect) {
-  return aspect ? `response:${aspect}` : 'response';
+export function response() {
+  return 'response';
 }
 
-export function data(aspect) {
-  return aspect ? `data:${aspect}` : 'data';
+export function data() {
+  return 'data';
 }
 
 export function view(role) {
@@ -49,3 +53,7 @@ export function feedback() {
 export function input() {
   return 'input';
 }
+
+export function more() {
+  return 'more';
+}

package/src/actor/hub.js

@@ -1,5 +1,4 @@
 import { defineValues, EventEmitter } from '@miso.ai/commons';
-import { removeDataInstructions } from '../workflow/processors.js';
 
 export default class Hub {
 
@@ -14,7 +13,7 @@ export default class Hub {
   }
 
   update(name, state, { silent = false } = {}) {
-    this._states[name] = Object.freeze(removeDataInstructions(state));
+    this._states[name] = Object.freeze(state);
     if (!silent) {
       this._events.emit(name, state);
     }

package/src/actor/index.js

@@ -6,5 +6,4 @@ export { default as SessionMaker } from './sessions.js';
 export { default as DataActor } from './data.js';
 export { default as ViewsActor } from './views.js';
 export { default as FeedbackActor } from './feedback.js';
-export { default as AutocompleteActor } from './autocomplete.js';
 export { default as InteractionsActor } from './interactions.js';

package/src/actor/interactions.js

@@ -12,20 +12,14 @@ export default class InteractionsActor {
   }
 
   _handle(payload) {
+    // TODO: omit when option == false
     payload = asArray(payload);
-    const { preprocess = [], handle } = this._options.resolved.interactions;
-    for (const p of preprocess) {
-      payload = payload.map(p);
-    }
-    // TODO: support filter?
+
     if (payload.length === 0) {
       return;
     }
-    if (handle) {
-      handle(payload);
-    } else {
-      this._client.api.interactions.upload(payload, { merge: true });
-    }
+
+    this._client.api.interactions.upload(payload, { merge: true });
   }
 
   destroy() {

package/src/actor/sessions.js

@@ -1,4 +1,4 @@
-import { uuidv4, delegateGetters } from '@miso.ai/commons';
+import { uuidv4 } from '@miso.ai/commons';
 import * as fields from './fields.js';
 
 export default class SessionMaker {
@@ -6,42 +6,15 @@ export default class SessionMaker {
   constructor(hub) {
     this._hub = hub;
     this._sessionIndex = 0;
-    delegateGetters(hub, this, ['active']);
-  }
-
-  get active() {
-    const { session } = this._hub.states;
-    return !!(session && session.active);
-  }
-
-  new({ force = false } = {}) {
-    const currentSession = this._hub.states.session;
-    if (currentSession && !currentSession.active && !force) {
-      return;
-    }
-    const session = this._create();
-    this._hub.update(fields.session(), session);
-  }
-
-  start() {
-    const session = this._hub.states.session || this._create();
-    if (session.active) {
-      return;
-    }
-    this._hub.update(fields.session(), { ...session, active: true });
   }
 
   restart() {
-    this._hub.update(fields.session(), this._create(true));
-  }
-
-  _create(active = false) {
-    return Object.freeze({
-      active,
+    const session = Object.freeze({
       uuid: uuidv4(),
       index: this._sessionIndex++,
       meta: {},
     });
+    this._hub.update(fields.session(), session);
   }
 
 }

package/src/actor/tracker.js

@@ -1,8 +1,7 @@
-import { asArray } from '@miso.ai/commons';
-import { TRACKING_EVENT_TYPES, TRACKING_STATUS, EVENT_TYPE, validateEventType } from '../constants.js';
+import { asArray, trimObj } from '@miso.ai/commons';
+import { PERFORMANCE_EVENT_TYPES, TRACKING_STATUS, EVENT_TYPE, validateEventType } from '../constants.js';
 import * as fields from './fields.js';
 import States from '../util/states.js';
-import { toInteraction } from './utils.js';
 
 const VALUELESS_ITEMS = [Symbol('valueless')];
 
@@ -26,29 +25,36 @@ export default class Tracker {
     return this._states.getFullState(item);
   }
 
-  _trigger(type, items, meta = {}) {
+  _trigger(type, items) {
+    validateEventType(type);
     if (this._valueless) {
-      meta = items;
       items = VALUELESS_ITEMS;
     }
-    validateEventType(type);
+
     this._syncSession();
 
-    if (type !== EVENT_TYPE.SUBMIT) {
-      items = this._states.untriggered(asArray(items), type);
-      if (items.length === 0) {
-        return;
-      }
-      this._states.set(items, type, TRACKING_STATUS.TRIGGERED);
+    items = this._states.untriggered(asArray(items), type);
+    if (items.length === 0) {
+      return;
     }
+    this._states.set(items, type, TRACKING_STATUS.TRIGGERED);
 
-    const property = this._role === 'results' ? 'products' : this._role; // TODO: ad-hoc, see #83
-    const misoId = this._getMisoId();
-    const request = this._getRequestPayload();
-    const values = this._valueless ? undefined : items;
+    this._sendToHub({
+      type,
+      items: this._valueless ? undefined : items,
+    });
+  }
+
+  submit({ value }) {
+    this._syncSession();
+    this._sendToHub({
+      type: EVENT_TYPE.SUBMIT,
+      value,
+    });
+  }
 
-    // TODO: should trigger 'tracker' and let workflow translate to interactions
-    this._hub.trigger(fields.interaction(), toInteraction({ property, misoId, request }, { event: type, values, meta }));
+  _sendToHub(args) {
+    this._hub.trigger(fields.tracker(), Object.freeze(trimObj({ role: this._role, ...args })));
   }
 
   _syncSession() {
@@ -82,7 +88,7 @@ export default class Tracker {
 
 }
 
-for (const type of TRACKING_EVENT_TYPES) {
+for (const type of PERFORMANCE_EVENT_TYPES) {
   Tracker.prototype[type] = function(items, meta) {
     this._trigger(type, items, meta);
   };