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

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

@@ -1,337 +0,0 @@
-"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 _index3 = require("./options/index.js");
-var _useLink = require("./use-link.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-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
-  })
-}));
-function totalContent(layout, {
-  value
-}) {
-  if (value === undefined) {
-    return '';
-  }
-  const {
-    formatNumber
-  } = layout.templates.helpers;
-  const formatted = formatNumber(value);
-  const label = value === 1 ? 'result' : 'results';
-  return `${formatted} ${label}`;
-}
-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,
-    templates: {
-      content: totalContent
-    }
-  }],
-  [_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, {
-  [_constants.ROLE.PRODUCTS]: _index3.DEFAULT_TRACKER_OPTIONS
-}));
-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, _index3.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
-  main: _constants.ROLE.PRODUCTS,
-  members: Object.keys(DEFAULT_LAYOUTS),
-  mappings: {
-    [_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(), () => this._refine()), this._hub.on(_index.fields.more(), () => this._more()), this._views.on(_constants.ROLE.SORT, 'select', event => this._handleSortSelect(event))];
-  }
-  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 //
-  autoQuery(options = {}) {
-    _index3.autoQuery.call(this, options);
-  }
-  query(args) {
-    if (!args.q) {
-      throw new Error(`q is required in query() call`);
-    }
-    this._hub.update(_index.fields.query(), args);
-  }
-  _query(args) {
-    if (this._linkFn) {
-      this._submitToPage(args);
-      return;
-    }
-    const type = _constants.REQUEST_TYPE.QUERY;
-
-    // reset filters view
-    this._views.filters.reset({
-      silent: true
-    });
-
-    // start a new session
-    this.restart({
-      type
-    });
-
-    // payload
-    const payload = this._buildPayload(args, type);
-    this._request({
-      payload,
-      type
-    });
-  }
-  _refine() {
-    const type = _constants.REQUEST_TYPE.REFINE;
-
-    // remember current facet_counts
-    const {
-      facet_counts
-    } = this._hub.states[_index.fields.data()].value || {};
-    this._currentFacetCounts = facet_counts;
-
-    // start a new session
-    this.restart({
-      type
-    });
-
-    // payload
-    const query = this._getQuery();
-    const payload = this._buildPayload(query, type);
-    this._request({
-      payload,
-      type
-    });
-  }
-
-  // TODO: expose API
-  _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 type = _constants.REQUEST_TYPE.MORE;
-    const query = this._getQuery();
-    const payload = this._buildPayload(query, type);
-    this._request({
-      payload,
-      type
-    });
-  }
-  _getQuery() {
-    return this._hub.states[_index.fields.query()];
-  }
-  _getPageSize() {
-    return this._options.resolved.api.payload.rows;
-  }
-  _buildPayload(payload, type) {
-    payload = this._writeFiltersToPayload(payload);
-    payload = this._writePageInfoToPayload(payload);
-    if (type === _constants.REQUEST_TYPE.MORE) {
-      payload = this._processPayloadForMoreRequest(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, {
-      metadata: Object.assign({}, payload.metadata, {
-        page: this._page
-      })
-    });
-  }
-  _processPayloadForMoreRequest(payload = {}) {
-    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
-    });
-  }
-  _writeRequestTimeToSession(timestamp, options = {}) {
-    if (options.type !== _constants.REQUEST_TYPE.QUERY) {
-      return;
-    }
-    super._writeRequestTimeToSession(timestamp, options);
-  }
-
-  // data //
-  _defaultProcessData(data, oldData) {
-    data = super._defaultProcessData(data, oldData);
-    data = (0, _processors.writeKeywordsToData)(data);
-    data = (0, _processors.retainFacetCountsInData)(data, this._currentFacetCounts);
-    data = (0, _processors.writeExhaustionToData)(data, {
-      role: this._roles.main
-    });
-    return data;
-  }
-  _updateData(data) {
-    super._updateData(data);
-    _index3.updateQueryParametersInUrl.call(this, data);
-  }
-  _updateDataInHub(data, oldData) {
-    data = this._appendResultsFromMoreRequest(data);
-    super._updateDataInHub(data, oldData);
-  }
-  _appendResultsFromMoreRequest(data) {
-    const {
-      request
-    } = data;
-    if (!request) {
-      return data; // the initial state
-    }
-    const {
-      metadata
-    } = request.payload;
-    if (!metadata || !metadata.page) {
-      return (0, _processors.writeMisoIdAsRootMisoId)(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
-    });
-  }
-
-  // view actions //
-  _handleSortSelect({
-    value
-  } = {}) {
-    if (!value) {
-      return;
-    }
-    this._views.filters.update({
-      sort: value
-    });
-    this._views.filters.apply();
-  }
-
-  // interactions //
-  _defaultProcessInteraction(payload, args) {
-    payload = super._defaultProcessInteraction(payload, args);
-    payload = this._writeRootMisoIdToInteraction(payload);
-    return payload;
-  }
-  _writeRootMisoIdToInteraction(payload) {
-    const data = this._hub.states[_index.fields.data()];
-    const {
-      root_miso_id
-    } = data && data.value || {};
-    if (!root_miso_id) {
-      return payload;
-    }
-    return (0, _commons.mergeInteractions)(payload, {
-      context: {
-        custom_context: {
-          root_miso_id
-        }
-      }
-    });
-  }
-}
-exports.default = SearchBasedWorkflow;
-(0, _index3.makeConfigurable)(SearchBasedWorkflow.prototype, [_constants.WORKFLOW_CONFIGURABLE.PAGINATION, _constants.WORKFLOW_CONFIGURABLE.FILTERS]);
-(0, _useLink.enableUseLink)(SearchBasedWorkflow.prototype);
-Object.assign(SearchBasedWorkflow, {
-  DEFAULT_API_OPTIONS,
-  DEFAULT_LAYOUTS,
-  DEFAULT_TRACKERS,
-  DEFAULT_PAGINATION,
-  DEFAULT_OPTIONS,
-  ROLES_OPTIONS
-});

package/dist/cjs/workflow/search.js

@@ -1,64 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-var _constants = require("../constants.js");
-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,
-  name: _commons.API.NAME.SEARCH,
-  payload: {
-    fl: ['*']
-  }
-});
-const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
-  api: {
-    group: _commons.API.GROUP.SEARCH,
-    name: _commons.API.NAME.AUTOCOMPLETE,
-    payload: {
-      completion_fields: ['suggested_queries', 'title'],
-      fl: ['title', 'url', 'cover_image']
-    }
-  }
-});
-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
-}));
-const ROLES_OPTIONS = _searchBased.default.ROLES_OPTIONS;
-class Search extends _searchBased.default {
-  constructor(plugin, client) {
-    super({
-      name: 'search',
-      plugin,
-      client,
-      roles: ROLES_OPTIONS,
-      defaults: DEFAULT_OPTIONS
-    });
-  }
-  _initProperties(args) {
-    super._initProperties(args);
-    this._initAutocomplete(args);
-  }
-  notifyViewUpdate(role = _constants.ROLE.PRODUCTS, ...args) {
-    super.notifyViewUpdate(role, ...args);
-    return this;
-  }
-
-  // destroy //
-  _destroy(options) {
-    this._destroyAutocomplete();
-    super._destroy(options);
-  }
-}
-exports.default = Search;
-(0, _autocompletable.makeAutocompletable)(Search.prototype);

package/dist/cjs/workflow/unit.js

@@ -1,57 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-var _base = _interopRequireDefault(require("./base.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class UnitWorkflow extends _base.default {
-  _initProperties(args) {
-    super._initProperties(args);
-    const {
-      id
-    } = args;
-    (0, _commons.defineValues)(this, {
-      id
-    });
-  }
-  _initSession(args) {
-    this._context._members.set(args.id, this);
-    super._initSession(args);
-  }
-
-  // interactions //
-  _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, _commons.mergeInteractions)(payload, {
-      context: {
-        custom_context: {
-          unit_id,
-          unit_instance_uuid
-        }
-      }
-    });
-  }
-
-  // destroy //
-  _destroy(options) {
-    this._context._members.delete(this.id);
-    super._destroy(options);
-  }
-}
-exports.default = UnitWorkflow;
-Object.assign(UnitWorkflow, {
-  DEFAULT_API_OPTIONS: _base.default.DEFAULT_API_OPTIONS,
-  DEFAULT_LAYOUTS: _base.default.DEFAULT_LAYOUTS,
-  DEFAULT_TRACKERS: _base.default.DEFAULT_TRACKERS,
-  DEFAULT_OPTIONS: _base.default.DEFAULT_OPTIONS,
-  ROLES_OPTIONS: _base.default.ROLES_OPTIONS
-});

package/dist/cjs/workflow/units.js

@@ -1,42 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _constants = require("../constants.js");
-var _context = _interopRequireDefault(require("./context.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class UnitWorkflowContext extends _context.default {
-  constructor(name, plugin, client) {
-    super(name, plugin, client);
-    this._members = new Map();
-  }
-  workflows() {
-    return [...this._members.values()];
-  }
-  create(unitId = _constants.DEFAULT_UNIT_ID) {
-    if (this._members.has(unitId)) {
-      throw new Error(`Unit already exists: ${unitId}`);
-    }
-    return this._createAndEmit(unitId);
-  }
-  has(unitId = _constants.DEFAULT_UNIT_ID) {
-    return this._members.has(unitId);
-  }
-  get(unitId = _constants.DEFAULT_UNIT_ID) {
-    if (typeof unitId !== 'string') {
-      throw new Error(`Required unit ID to be a string: ${unitId}`);
-    }
-    return this._members.get(unitId) || this._createAndEmit(unitId);
-  }
-  _createAndEmit(unitId) {
-    const workflow = this._create(unitId);
-    this._client._events.emit('postworkflow', workflow);
-    return workflow;
-  }
-  _create(unitId) {
-    throw new Error('Not implemented');
-  }
-}
-exports.default = UnitWorkflowContext;

package/dist/cjs/workflow/use-link.js

@@ -1,49 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.UseLinkMixin = void 0;
-exports.enableUseLink = enableUseLink;
-var _commons = require("@miso.ai/commons");
-const _excluded = ["q"];
-function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
-// TODO: eliminate browser dependency
-
-function enableUseLink(prototype) {
-  (0, _commons.mixin)(prototype, UseLinkMixin.prototype);
-}
-class UseLinkMixin {
-  useLink(fn, options = {}) {
-    if (typeof fn !== 'function' && fn !== false) {
-      throw new Error('useLink(fn) expects fn to be a function or false');
-    }
-    this._linkFn = fn ? [fn, options] : false;
-    return this;
-  }
-  _submitToPage(args = {}) {
-    if (!this._linkFn) {
-      return;
-    }
-    const url = this._getSubmitUrl(args);
-    const [_, options = {}] = this._linkFn;
-    if (options.open === false) {
-      window.location.href = url;
-    } else {
-      const target = options.target || '_blank';
-      const windowFeatures = options.windowFeatures || 'noopener';
-      window.open(url, target, windowFeatures);
-    }
-  }
-  _getSubmitUrl(_ref = {}) {
-    let {
-        q
-      } = _ref,
-      args = _objectWithoutPropertiesLoose(_ref, _excluded);
-    if (!this._linkFn) {
-      throw new Error('useLink(fn) must be called before _getSubmitUrl()');
-    }
-    return this._linkFn[0](q, args);
-  }
-}
-exports.UseLinkMixin = UseLinkMixin;

package/src/actor/data.js

@@ -1,106 +0,0 @@
-import * as fields from './fields.js';
-import { isCurrentSession } from './utils.js';
-
-export default class DataActor {
-
-  constructor(hub, { source, options, polling = true }) {
-    this._hub = hub;
-    this._source = source;
-    this._options = options;
-    this._polling = polling;
-    this._unsubscribes = [
-      hub.on(fields.session(), session => this._handleSession(session)),
-      hub.on(fields.request(), event => this._handleRequest(event)),
-    ];
-  }
-
-  get active() {
-    return this._options.resolved.api.actor !== false;
-  }
-
-  get source() {
-    return this._source;
-  }
-
-  _handleSession(session) {
-    // this is mandatory in any case
-    /*
-    if (!this.active) {
-      return;
-    }
-    */
-    // abort ongoing data fetch if any
-    if (!this._session || (session.index !== this._session.index)) {
-      // new session, abort preview data fetch if necessary
-      this._ac && this._ac.abort({
-        type: 'new-session',
-        message: 'A new session is created, discarding the old one.',
-      });
-      this._ac = new AbortController();
-    }
-    this._session = session;
-  }
-
-  async _handleRequest(event) {
-    // protocol: inactive -> no reaction
-    if (!this.active) {
-      return;
-    }
-    const { session, ...request } = event;
-
-    try {
-      const { signal } = this._ac || {};
-      const options = { ...event.options, signal };
-      const response = await this._source({ session, ...request, options });
-      // takes an iterable, either sync or async
-      if (response && response[Symbol.asyncIterator]) {
-        // also emit reponse of the head request, if available
-        if (response._response) {
-          this._emitResponseWithSessionCheck({ session, request, value: response._response });
-        }
-        if (this._polling) {
-          let value;
-          for await (value of response) {
-            // A new session invalidates ongoing data fetch for the old session, terminating the loop
-            if (!isCurrentSession(this._hub, session)) {
-              break;
-            }
-            this._emitResponse({ session, request, value });
-          }
-        }
-      } else {
-        this._emitResponseWithSessionCheck({ session, request, value: response });
-      }
-    } catch(error) {
-      this._error(error);
-      this._emitResponseWithSessionCheck({ session, request, error });
-    }
-  }
-
-  _emitResponseWithSessionCheck(response) {
-    // A new session invalidates ongoing data fetch
-    isCurrentSession(this._hub, response.session) && this._emitResponse(response);
-  }
-
-  _emitResponse(response) {
-    this._hub.update(fields.response(), response);
-  }
-
-  _error(error) {
-    // TODO
-    console.error(error);
-  }
-
-  _destroy() {
-    // abort ongoing data fetch if any
-    this._ac && this._ac.abort({
-      type: 'data-actor-destroy',
-      message: 'Data actor is destroyed.',
-    });
-    for (const unsubscribe of this._unsubscribes) {
-      unsubscribe();
-    }
-    this._unsubscribes = [];
-  }
-
-}

package/src/actor/feedback.js

@@ -1,28 +0,0 @@
-import * as fields from './fields.js';
-import { EVENT_TYPE } from '../constants.js';
-
-export default class FeedbackActor {
-
-  constructor(hub) {
-    this._hub = hub;
-    this._unsubscribes = [
-      hub.on(fields.feedback(), state => this._trigger(state)),
-    ];
-  }
-
-  _trigger(state) {
-    this._hub.trigger(fields.tracker(), {
-      type: EVENT_TYPE.FEEDBACK,
-      result_type: 'answer',
-      value: state.unselected ? 'unselected' : state.value,
-    });
-  }
-
-  _destroy() {
-    for (const unsubscribe of this._unsubscribes) {
-      unsubscribe();
-    }
-    this._unsubscribes = [];
-  }
-
-}