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

package/src/workflow/options/auto-query.js

@@ -1,70 +0,0 @@
-import { trimObj } from '@miso.ai/commons';
-import { ROLE, QUESTION_SOURCE } from '../../constants.js';
-
-// TODO: eliminate browser dependency?
-
-export const DEFAULT_AUTO_QUERY_PARAM = 'q';
-export const DEFAULT_AUTO_QUERY_SOURCE_PARAM = 'qs';
-
-export function normalizeAutoQueryOptions({
-  setValue = true,
-  focus = true,
-  updateUrl = true,
-  param = DEFAULT_AUTO_QUERY_PARAM,
-  sourceParam = DEFAULT_AUTO_QUERY_SOURCE_PARAM,
-  ...options
-} = {}) {
-  return { setValue, focus, updateUrl, param, sourceParam, ...options };
-}
-
-export function autoQuery(options = {}) {
-  // TODO: support getting value from URL path
-  const { setValue, focus, param, sourceParam } = this._autoQuery = normalizeAutoQueryOptions(options);
-  const searchParams = new URLSearchParams(window.location.search);
-  const q = searchParams.get(param);
-  const qs = searchParams.get(sourceParam) || undefined;
-
-  // because it's probably not there yet, but this is an ad-hoc solution
-  setTimeout(() => {
-    for (const view of this._views.getAll(ROLE.QUERY)) {
-      const { layout } = view;
-      if (q && setValue) {
-        layout.value = q;
-      }
-      if (!q && focus) {
-        layout.focus();
-      }
-    }
-  });
-
-  if (q) {
-    this.query(trimObj({ q, qs }));
-  }
-}
-
-export function updateQueryParametersInUrl({ value, request }) {
-  if (!this._autoQuery || !this._autoQuery.updateUrl) {
-    return;
-  }
-  const { param, sourceParam } = this._autoQuery;
-  const query = (value && (value.question || value.keyword)) || (request && request.payload && (request.payload.question || request.payload.q));
-  const querySource = request && request.payload && request.payload.metadata && request.payload.metadata.question_source;
-
-  if (!query) {
-    return; // at initial phase
-  }
-
-  const url = new URL(window.location);
-  const currentQuery = url.searchParams.get(param);
-  const currentQuerySource = url.searchParams.get(sourceParam) || QUESTION_SOURCE.ORGANIC;
-  if (query === currentQuery && querySource === currentQuerySource) {
-    return;
-  }
-  url.searchParams.set(param, query);
-  if (querySource === QUESTION_SOURCE.ORGANIC) {
-    url.searchParams.delete(sourceParam);
-  } else {
-    url.searchParams.set(sourceParam, querySource);
-  }
-  window.history.replaceState({}, '', url);
-}

package/src/workflow/options/configurable.js

@@ -1,48 +0,0 @@
-import { WORKFLOW_CONFIGURABLE } from '../../constants.js';
-
-const DEFAULT_FEATURES = [
-  WORKFLOW_CONFIGURABLE.API,
-  WORKFLOW_CONFIGURABLE.LAYOUTS,
-  WORKFLOW_CONFIGURABLE.DATA_PROCESSOR,
-  WORKFLOW_CONFIGURABLE.TRACKERS,
-  WORKFLOW_CONFIGURABLE.INTERACTIONS,
-];
-
-export function makeConfigurable(prototype, features = DEFAULT_FEATURES) {
-  for (const feature of features) {
-    injectConfigurableFeature(prototype, feature);
-  }
-}
-
-function injectConfigurableFeature(prototype, feature) {
-  if (feature === 'api') {
-    Object.assign(prototype, {
-      useApi(...args) {
-        this._options.api.merge(args);
-        return this;
-      },
-      clearApi() {
-        this._options.api.set();
-        return this;
-      },
-    });
-  } else {
-    const upperCased = upperCase(feature);
-    Object.assign(prototype, {
-      [`use${upperCased}`](value) {
-        (this._options[feature]).merge(value);
-        return this;
-      },
-      [`clear${upperCased}`]() {
-        (this._options[feature]).set();
-        return this;
-      },
-    });
-  }
-}
-
-// helpers //
-// TODO: move to commons
-function upperCase(str) {
-  return str.charAt(0).toUpperCase() + str.slice(1);
-}

package/src/workflow/options/data-processor.js

@@ -1,15 +0,0 @@
-import { asArray } from '@miso.ai/commons';
-
-export function normalizeDataProcessorOptions(fns) {
-  fns = asArray(fns);
-  for (const fn of fns) {
-    if (typeof fn !== 'function') {
-      throw new Error(`Expect data processor options to be a function: ${fn}`);
-    }
-  }
-  return fns;
-}
-
-export function mergeDataProcessorOptions(...optionsList) {
-  return optionsList.flat().filter(Boolean);
-}

package/src/workflow/options/filters.js

@@ -1,10 +0,0 @@
-import { mergeOptions, normalizeOptions } from './utils.js';
-
-export const normalizeFiltersOptions = normalizeOptions;
-
-export function mergeFiltersOptions(...optionsList) {
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return mergeOptions(optionsList, (merged, options) => Object.assign(merged, options));
-}

package/src/workflow/options/index.js

@@ -1,11 +0,0 @@
-export * from './roles.js';
-export * from './api.js';
-export * from './layouts.js';
-export * from './data-processor.js';
-export * from './trackers.js';
-export * from './interactions.js';
-export * from './filters.js';
-export * from './pagination.js';
-export * from './options.js';
-export * from './configurable.js';
-export * from './auto-query.js';

package/src/workflow/options/interactions.js

@@ -1,36 +0,0 @@
-import { asArray } from '@miso.ai/commons';
-import { mergeOptions, concatArrays } from './utils.js';
-
-export function normalizeInteractionsOptions(options) {
-  if (options === undefined) {
-    return undefined;
-  }
-  if (options === false) {
-    return {
-      handle: () => {},
-    };
-  }
-  // preprocess
-  const preprocess = asArray(options.preprocess);
-  for (const p of preprocess) {
-    if (typeof p !== 'function') {
-      throw new Error(`Expect preprocess options to be a function: ${p}`);
-    }
-  }
-  // handle
-  if (options.handle && typeof options.handle !== 'function') {
-    throw new Error(`Expect handle options to be a function: ${options.handle}`);
-  }
-  return { ...options, preprocess };
-}
-
-export function mergeInteractionsOptions(...optionsList) {
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return mergeOptions(optionsList, (merged, options) => Object.assign(merged, {
-    ...options,
-    preprocess: concatArrays(merged.preprocess, options.preprocess),
-  }));
-}
-

package/src/workflow/options/layouts.js

@@ -1,73 +0,0 @@
-import { asArray, lowerCamelToSnake, kebabToSnake } from '@miso.ai/commons';
-import { ROLE } from '../../constants.js';
-import { mergeOptions } from './utils.js';
-
-export function normalizeLayoutsOptions(options = {}) {
-  if (options === false) {
-    return false;
-  }
-  // fallback: results -> products
-  const { results, ...rest } = options;
-  if (results !== undefined) {
-    console.warn(`useLayouts({ results: ... }) is deprecated, use useLayouts({ ${ROLE.PRODUCTS}: ... }) instead`);
-    options = { ...rest, [ROLE.PRODUCTS]: results };
-  }
-  const normalize = {};
-  for (const [role, args] of Object.entries(options)) {
-    normalize[normalizeRole(role)] = normalizeLayoutOptions(args);
-  }
-  return normalize;
-}
-
-function normalizeRole(role) {
-  role = lowerCamelToSnake(role);
-  role = kebabToSnake(role);
-  return role;
-}
-
-function normalizeLayoutOptions(args) {
-  // take args:
-  // * undefined
-  // * false
-  // * name (string)
-  // * options (object)
-  // * [name, options]
-  if (args === undefined) {
-    return undefined;
-  }
-  let [name, options] = asArray(args);
-  if (typeof name === 'object') {
-    options = name;
-    name = undefined;
-  }
-  return [name, options];
-}
-
-export function mergeLayoutsOptions(...optionsList) {
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return mergeOptions(optionsList, (merged, options) => {
-    for (const [role, args] of Object.entries(options)) {
-      merged[role] = mergeLayoutOptions(merged[role], args);
-    }
-    return merged;
-  });
-}
-
-function mergeLayoutOptions(base, overrides) {
-  overrides = normalizeLayoutOptions(overrides);
-  if (overrides[0] === false) {
-    return overrides;
-  }
-  return base && overrides ? [overrides[0] || base[0], mergeLayoutParameters(base[1], overrides[1])] : (overrides || base);
-}
-
-function mergeLayoutParameters(base, overrides) {
-  return {
-    ...base,
-    ...overrides,
-    link: { ...(base && base.link), ...(overrides && overrides.link) },
-    templates: { ...(base && base.templates), ...(overrides && overrides.templates) },
-  };
-}

package/src/workflow/options/options.js

@@ -1,175 +0,0 @@
-import { EventEmitter, defineValues } from '@miso.ai/commons';
-import { WORKFLOW_CONFIGURABLE } from '../../constants.js';
-import { normalizeApiOptions, mergeApiOptions } from './api.js';
-import { normalizeLayoutsOptions, mergeLayoutsOptions } from './layouts.js';
-import { normalizeDataProcessorOptions, mergeDataProcessorOptions } from './data-processor.js';
-import { normalizeTrackersOptions, mergeTrackersOptions } from './trackers.js';
-import { normalizeInteractionsOptions, mergeInteractionsOptions } from './interactions.js';
-import { normalizeFiltersOptions, mergeFiltersOptions } from './filters.js';
-import { normalizePaginationOptions, mergePaginationOptions } from './pagination.js';
-import { normalizeTemplatesOptions, mergeTemplatesOptions } from './templates.js';
-
-const FEATURES = [
-  {
-    key: WORKFLOW_CONFIGURABLE.API,
-    normalize: normalizeApiOptions,
-    merge: mergeApiOptions,
-  },
-  {
-    key: WORKFLOW_CONFIGURABLE.LAYOUTS,
-    normalize: normalizeLayoutsOptions,
-    merge: mergeLayoutsOptions,
-  },
-  {
-    key: WORKFLOW_CONFIGURABLE.DATA_PROCESSOR,
-    normalize: normalizeDataProcessorOptions,
-    merge: mergeDataProcessorOptions,
-  },
-  {
-    key: WORKFLOW_CONFIGURABLE.TRACKERS,
-    normalize: normalizeTrackersOptions,
-    merge: mergeTrackersOptions,
-  },
-  {
-    key: WORKFLOW_CONFIGURABLE.INTERACTIONS,
-    normalize: normalizeInteractionsOptions,
-    merge: mergeInteractionsOptions,
-  },
-  {
-    key: WORKFLOW_CONFIGURABLE.FILTERS,
-    normalize: normalizeFiltersOptions,
-    merge: mergeFiltersOptions,
-  },
-  {
-    key: WORKFLOW_CONFIGURABLE.PAGINATION,
-    normalize: normalizePaginationOptions,
-    merge: mergePaginationOptions,
-  },
-  {
-    key: WORKFLOW_CONFIGURABLE.TEMPLATES,
-    normalize: normalizeTemplatesOptions,
-    merge: mergeTemplatesOptions,
-  },
-];
-
-
-
-export class WorkflowContextOptions {
-
-  constructor() {
-    this._events = new EventEmitter({ target: this });
-    this._globals = {};
-  }
-
-  _notify(name) {
-    this._events.emit(name);
-    this._events.emit('_update', name);
-  }
-
-}
-
-export class WorkflowOptions {
-
-  constructor(context = {}, defaults = {}) {
-    this._events = new EventEmitter({ target: this });
-    this._defaults = defaults; // TODO: we should call normalize() on defaults
-    this._context = context || {};
-    this._locals = {};
-
-    defineValues(this, {
-      resolved: new ResolvedWorkflowOptions(this),
-      defaults,
-    });
-
-    if (context && context.on) {
-      this._unsubscribes = [
-        context.on('_update', name => this._notify(name)),
-      ];
-    }
-  }
-
-  _notify(name) {
-    this.resolved._invalidate(name);
-    this._events.emit(name);
-  }
-
-  _destroy() {
-    for (const unsubscribe of this._unsubscribes || []) {
-      unsubscribe();
-    }
-    this._unsubscribes = [];
-  }
-
-}
-
-class ResolvedWorkflowOptions {
-
-  constructor(options) {
-    this._options = options;
-    this._cache = {};
-  }
-
-  _invalidate(key) {
-    this._cache[key] = undefined;
-  }
-
-  _get({ key, merge }) {
-    if (this._cache[key] === undefined) {
-      const options = this._options;
-      const contextFeature = options._context[key];
-      this._cache[key] = merge(options._defaults[key], contextFeature && contextFeature.get(), options._locals[key]);
-    }
-    return this._cache[key];
-  }
-
-}
-
-class WorkflowConfigurableFeature {
-
-  constructor(options, store, key, normalize, merge) {
-    this._options = options;
-    this._store = store;
-    this._key = key;
-    this._normalize = value => value !== undefined ? normalize(value) : undefined;
-    this._merge = merge;
-  }
-
-  get() {
-    return this._store[this._key];
-  }
-
-  set(value) {
-    this._set(this._normalize(value));
-  }
-
-  merge(value) {
-    this._set(this._merge(this.get(), this._normalize(value)));
-  }
-
-  _set(value) {
-    this._store[this._key] = value;
-    this._options._notify(this._key);
-  }
-
-}
-
-for (const feature of FEATURES) {
-  const { key, normalize, merge } = feature;
-  Object.defineProperty(WorkflowContextOptions.prototype, key, {
-    get: function() {
-      const _key = `_${key}`;
-      return this[_key] || (this[_key] = new WorkflowConfigurableFeature(this, this._globals, key, normalize, merge));
-    },
-  });
-  Object.defineProperty(WorkflowOptions.prototype, key, {
-    get: function() {
-      const _key = `_${key}`;
-      return this[_key] || (this[_key] = new WorkflowConfigurableFeature(this, this._locals, key, normalize, merge));
-    },
-  });
-  Object.defineProperty(ResolvedWorkflowOptions.prototype, key, {
-    get: function() {
-      return this._get(feature);
-    },
-  });
-}

package/src/workflow/options/pagination.js

@@ -1,18 +0,0 @@
-import { mergeOptions } from './utils.js';
-
-export function normalizePaginationOptions(options) {
-  if (options === undefined) {
-    throw new Error(`Expect pagination options to be an object or a boolean value: ${options}`);
-  }
-  if (typeof options === 'boolean') {
-    options = { active: options };
-  }
-  return options;
-}
-
-export function mergePaginationOptions(...optionsList) {
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return mergeOptions(optionsList, (merged, options) => Object.assign(merged, options));
-}

package/src/workflow/options/roles.js

@@ -1,12 +0,0 @@
-export function mergeRolesOptions(base, overrides) {
-  return Object.freeze({
-    ...base,
-    ...overrides,
-    members: mergeRolesMembers(base.members, overrides.members),
-    mappings: Object.freeze({ ...base.mappings, ...overrides.mappings }),
-  });
-}
-
-function mergeRolesMembers(base = [], overrides = []) {
-  return [...new Set([...base, ...overrides])];
-}

package/src/workflow/options/templates.js

@@ -1,27 +0,0 @@
-import { mergeOptions } from './utils.js';
-
-export function normalizeTemplatesOptions(options = {}) {
-  const normalize = {};
-  for (const [key, args] of Object.entries(options)) {
-    normalize[key] = normalizeTemplateOptions(args);
-  }
-  return normalize;
-}
-
-function normalizeTemplateOptions(args) {
-  // TODO: if object, make it function arguments
-  return args === undefined ? undefined : typeof args !== 'function' ? () => args : args;
-}
-
-export function mergeTemplatesOptions(...optionsList) {
-  return mergeOptions(optionsList, (merged, options) => {
-    for (const [key, args] of Object.entries(options)) {
-      merged[key] = mergeTemplateOptions(merged[key], args);
-    }
-    return merged;
-  });
-}
-
-function mergeTemplateOptions(base, overrides) {
-  return normalizeTemplateOptions(overrides) || base;
-}

package/src/workflow/options/trackers.js

@@ -1,80 +0,0 @@
-import { TRACKING_EVENT_TYPES } from '../../constants.js';
-import { mergeOptions, normalizeOptions } from './utils.js';
-
-export const DEFAULT_TRACKER_OPTIONS = Object.freeze({
-  active: true,
-  impression: Object.freeze({
-    active: true,
-  }),
-  viewable: Object.freeze({
-    active: true,
-    area: 0.5,
-    duration: 1000,
-  }),
-  click: Object.freeze({
-    active: true,
-    lenient: false,
-  }),
-});
-
-export function normalizeTrackersOptions(options = {}) {
-  options = normalizeOptions(options);
-  const { active, ...rest } = options;
-  const normalized = {};
-  for (const [role, args] of Object.entries(rest)) {
-    normalized[role] = normalizeTrackerOptions(args);
-  }
-  return {
-    active,
-    ...normalized,
-  };
-}
-
-function normalizeTrackerOptions(options = {}) {
-  options = normalizeOptions(options);
-  const { active, ...rest } = options;
-  const normalized = {};
-  for (const [role, args] of Object.entries(rest)) {
-    normalized[role] = normalizeTrackerEventOptions(args);
-  }
-  return options;
-}
-
-function normalizeTrackerEventOptions(options = {}) {
-  options = normalizeOptions(options);
-  return options;
-}
-
-export function mergeTrackersOptions(...optionsList) {
-  // TODO: should be able to remove this
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return mergeOptions(optionsList, (merged, options) => {
-    for (const [key, args] of Object.entries(options)) {
-      if (args === undefined) {
-        continue;
-      }
-      merged[key] = key === 'active' ? args : mergeTrackerOptions(merged[key], args);
-    }
-    return merged;
-  });
-}
-
-function mergeTrackerOptions(base = {}, overrides = {}) {
-  const merged = { ...base };
-  for (const [key, args] of Object.entries(overrides)) {
-    if (args === undefined) {
-      continue;
-    }
-    merged[key] = TRACKING_EVENT_TYPES.includes(key) ? mergeTrackerEventOptions(base[key], args) : args;
-  }
-  return merged;
-}
-
-function mergeTrackerEventOptions(base = {}, overrides = {}) {
-  return {
-    ...base,
-    ...overrides,
-  };
-}

package/src/workflow/options/utils.js

@@ -1,26 +0,0 @@
-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;
-}