@miso.ai/client-sdk-ui 1.13.2-beta.1 → 1.14.0-beta.3

package/src/workflow/search-based.js

@@ -1,329 +0,0 @@
-import { API, asArray, trimObj, mergeInteractions } from '@miso.ai/commons';
-import Workflow from './base.js';
-import { fields } from '../actor/index.js';
-import { STATUS, ROLE, WORKFLOW_CONFIGURABLE, REQUEST_TYPE } from '../constants.js';
-import { SearchBoxLayout, ListLayout, TextLayout, FacetsLayout, SelectLayout, MoreButtonLayout } from '../layout/index.js';
-import { mappingSortData, writeKeywordsToData, retainFacetCountsInData, writeExhaustionToData, writeMisoIdAsRootMisoId, concatItemsFromMoreResponse } from './processors.js';
-import { mergeRolesOptions, autoQuery as autoQueryFn, updateQueryParametersInUrl, makeConfigurable, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
-import { enableUseLink } from './use-link.js';
-
-const DEFAULT_ROWS = 10;
-const DEFAULT_PAGE_LIMIT = 10;
-
-const DEFAULT_API_OPTIONS = Object.freeze({
-  ...Workflow.DEFAULT_API_OPTIONS,
-  group: API.GROUP.SEARCH,
-  payload: {
-    ...Workflow.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({
-  ...Workflow.DEFAULT_LAYOUTS,
-  [ROLE.QUERY]: [SearchBoxLayout.type],
-  [ROLE.PRODUCTS]: [ListLayout.type, { incremental: true, infiniteScroll: true }],
-  [ROLE.KEYWORDS]: [TextLayout.type, { raw: true }],
-  [ROLE.TOTAL]: [TextLayout.type, { raw: true, templates: { content: totalContent } }],
-  [ROLE.FACETS]: [FacetsLayout.type],
-  [ROLE.SORT]: [SelectLayout.type],
-  [ROLE.MORE]: [MoreButtonLayout.type],
-});
-
-const DEFAULT_TRACKERS = Object.freeze({
-  ...Workflow.DEFAULT_TRACKERS,
-  [ROLE.PRODUCTS]: DEFAULT_TRACKER_OPTIONS,
-});
-
-const DEFAULT_PAGINATION = Object.freeze({
-  active: false,
-  mode: 'infiniteScroll',
-  pageLimit: 10,
-});
-
-const DEFAULT_OPTIONS = Object.freeze({
-  ...Workflow.DEFAULT_OPTIONS,
-  api: DEFAULT_API_OPTIONS,
-  layouts: DEFAULT_LAYOUTS,
-  trackers: DEFAULT_TRACKERS,
-  pagination: DEFAULT_PAGINATION,
-});
-
-const ROLES_OPTIONS = mergeRolesOptions(Workflow.ROLES_OPTIONS, {
-  main: ROLE.PRODUCTS,
-  members: Object.keys(DEFAULT_LAYOUTS),
-  mappings: {
-    [ROLE.FACETS]: 'facet_counts',
-    [ROLE.SORT]: mappingSortData,
-  },
-});
-
-export default class SearchBasedWorkflow extends Workflow {
-
-  _initSubscriptions(args) {
-    super._initSubscriptions(args);
-    this._unsubscribes = [
-      ...this._unsubscribes,
-      this._hub.on(fields.query(), args => this._query(args)),
-      this._hub.on(fields.filters(), () => this._refine()),
-      this._hub.on(fields.more(), () => this._more()),
-      this._views.on(ROLE.SORT, 'select', event => this._handleSortSelect(event)),
-    ];
-  }
-
-  restart() {
-    super.restart();
-    this._page = 0;
-  }
-
-  // properties //
-  get exhausted() {
-    const data = this._hub.states[fields.data()];
-    return !!(data && data.meta && data.meta.exhausted);
-  }
-
-  get page() {
-    return this._page;
-  }
-
-  // query //
-  autoQuery(options = {}) {
-    autoQueryFn.call(this, options);
-  }
-
-  query(args) {
-    if (!args.q) {
-      throw new Error(`q is required in query() call`);
-    }
-    this._hub.update(fields.query(), args);
-  }
-
-  _query(args) {
-    if (this._linkFn) {
-      this._submitToPage(args);
-      return;
-    }
-    const type = 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 = REQUEST_TYPE.REFINE;
-
-    // remember current facet_counts
-    const { facet_counts } = this._hub.states[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 !== 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 = REQUEST_TYPE.MORE;
-    const query = this._getQuery();
-    const payload = this._buildPayload(query, type);
-
-    this._request({ payload, type });
-  }
-
-  _getQuery() {
-    return this._hub.states[fields.query()];
-  }
-
-  _getPageSize() {
-    return this._options.resolved.api.payload.rows;
-  }
-
-  _buildPayload(payload, type) {
-    payload = this._writeFiltersToPayload(payload);
-    payload = this._writePageInfoToPayload(payload);
-    if (type === REQUEST_TYPE.MORE) {
-      payload = this._processPayloadForMoreRequest(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,
-      metadata: {
-        ...payload.metadata,
-        page: this._page,
-      },
-    };
-  }
-
-  _processPayloadForMoreRequest(payload = {}) {
-    const data = this._hub.states[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 {
-      ...payload,
-      exclude,
-    };
-  }
-
-  _writeRequestTimeToSession(timestamp, options = {}) {
-    if (options.type !== REQUEST_TYPE.QUERY) {
-      return;
-    }
-    super._writeRequestTimeToSession(timestamp, options);
-  }
-
-  // data //
-  _defaultProcessData(data, oldData) {
-    data = super._defaultProcessData(data, oldData);
-    data = writeKeywordsToData(data);
-    data = retainFacetCountsInData(data, this._currentFacetCounts);
-    data = writeExhaustionToData(data, { role: this._roles.main });
-    return data;
-  }
-
-  _updateData(data) {
-    super._updateData(data);
-    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 writeMisoIdAsRootMisoId(data); // not from "more" request
-    }
-    // concat records if it's from "more" request
-    const currentData = this._hub.states[fields.data()];
-    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();
-  }
-
-  // interactions //
-  _defaultProcessInteraction(payload, args) {
-    payload = super._defaultProcessInteraction(payload, args);
-    payload = this._writeRootMisoIdToInteraction(payload);
-    return payload;
-  }
-
-  _writeRootMisoIdToInteraction(payload) {
-    const data = this._hub.states[fields.data()];
-    const { root_miso_id } = (data && data.value) || {};
-    if (!root_miso_id) {
-      return payload;
-    }
-    return mergeInteractions(payload, {
-      context: {
-        custom_context: {
-          root_miso_id,
-        }
-      }
-    });
-  }
-
-}
-
-makeConfigurable(SearchBasedWorkflow.prototype, [WORKFLOW_CONFIGURABLE.PAGINATION, WORKFLOW_CONFIGURABLE.FILTERS]);
-
-enableUseLink(SearchBasedWorkflow.prototype);
-
-Object.assign(SearchBasedWorkflow, {
-  DEFAULT_API_OPTIONS,
-  DEFAULT_LAYOUTS,
-  DEFAULT_TRACKERS,
-  DEFAULT_PAGINATION,
-  DEFAULT_OPTIONS,
-  ROLES_OPTIONS,
-});

package/src/workflow/search.js

@@ -1,73 +0,0 @@
-import { API } from '@miso.ai/commons';
-import { ROLE } from '../constants.js';
-import SearchBasedWorkflow from './search-based.js';
-import { makeAutocompletable } from './autocompletable.js';
-
-const DEFAULT_API_OPTIONS = Object.freeze({
-  group: API.GROUP.SEARCH,
-  name: API.NAME.SEARCH,
-  payload: {
-    fl: ['*'],
-  },
-});
-
-const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
-  api: {
-    group: API.GROUP.SEARCH,
-    name: API.NAME.AUTOCOMPLETE,
-    payload: {
-      completion_fields: ['suggested_queries', 'title'],
-      fl: ['title', 'url', 'cover_image'],
-    },
-  },
-});
-
-const DEFAULT_LAYOUTS = Object.freeze({
-  ...SearchBasedWorkflow.DEFAULT_LAYOUTS,
-});
-
-const DEFAULT_TRACKERS = Object.freeze({
-  ...SearchBasedWorkflow.DEFAULT_TRACKERS,
-});
-
-const DEFAULT_OPTIONS = Object.freeze({
-  ...SearchBasedWorkflow.DEFAULT_OPTIONS,
-  api: DEFAULT_API_OPTIONS,
-  autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS,
-  layouts: DEFAULT_LAYOUTS,
-  trackers: DEFAULT_TRACKERS,
-});
-
-const ROLES_OPTIONS = SearchBasedWorkflow.ROLES_OPTIONS;
-
-export default class Search extends SearchBasedWorkflow {
-
-  constructor(plugin, client) {
-    super({
-      name: 'search',
-      plugin,
-      client,
-      roles: ROLES_OPTIONS,
-      defaults: DEFAULT_OPTIONS,
-    });
-  }
-
-  _initProperties(args) {
-    super._initProperties(args);
-    this._initAutocomplete(args);
-  }
-
-  notifyViewUpdate(role = ROLE.PRODUCTS, ...args) {
-    super.notifyViewUpdate(role, ...args);
-    return this;
-  }
-
-  // destroy //
-  _destroy(options) {
-    this._destroyAutocomplete();
-    super._destroy(options);
-  }
-
-}
-
-makeAutocompletable(Search.prototype);

package/src/workflow/unit.js

@@ -1,51 +0,0 @@
-import { defineValues, mergeInteractions } from '@miso.ai/commons';
-import Workflow from './base.js';
-
-export default class UnitWorkflow extends Workflow {
-
-  _initProperties(args) {
-    super._initProperties(args);
-    const { id } = args;
-    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 mergeInteractions(payload, {
-      context: {
-        custom_context: {
-          unit_id,
-          unit_instance_uuid,
-        },
-      },
-    });
-  }
-
-  // destroy //
-  _destroy(options) {
-    this._context._members.delete(this.id);
-    super._destroy(options);
-  }
-
-}
-
-Object.assign(UnitWorkflow, {
-  DEFAULT_API_OPTIONS: Workflow.DEFAULT_API_OPTIONS,
-  DEFAULT_LAYOUTS: Workflow.DEFAULT_LAYOUTS,
-  DEFAULT_TRACKERS: Workflow.DEFAULT_TRACKERS,
-  DEFAULT_OPTIONS: Workflow.DEFAULT_OPTIONS,
-  ROLES_OPTIONS: Workflow.ROLES_OPTIONS,
-});

package/src/workflow/units.js

@@ -1,43 +0,0 @@
-import { DEFAULT_UNIT_ID } from '../constants.js';
-import WorkflowContext from './context.js';
-
-export default class UnitWorkflowContext extends WorkflowContext {
-
-  constructor(name, plugin, client) {
-    super(name, plugin, client);
-    this._members = new Map();
-  }
-
-  workflows() {
-    return [...this._members.values()];
-  }
-
-  create(unitId = DEFAULT_UNIT_ID) {
-    if (this._members.has(unitId)) {
-      throw new Error(`Unit already exists: ${unitId}`);
-    }
-    return this._createAndEmit(unitId);
-  }
-
-  has(unitId = DEFAULT_UNIT_ID) {
-    return this._members.has(unitId);
-  }
-
-  get(unitId = 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');
-  }
-
-}

package/src/workflow/use-link.js

@@ -1,41 +0,0 @@
-import { mixin } from '@miso.ai/commons';
-
-// TODO: eliminate browser dependency
-
-export function enableUseLink(prototype) {
-  mixin(prototype, UseLinkMixin.prototype);
-}
-
-export 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({ q, ...args } = {}) {
-    if (!this._linkFn) {
-      throw new Error('useLink(fn) must be called before _getSubmitUrl()');
-    }
-    return this._linkFn[0](q, args);
-  }
-
-}