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

package/src/actor/fields.js

@@ -1,51 +0,0 @@
-export function session() {
-  return 'session';
-}
-
-export function completions() {
-  return 'completions';
-}
-
-export function filters() {
-  return 'filters';
-}
-
-export function query() {
-  return 'query';
-}
-
-export function request() {
-  return 'request';
-}
-
-export function response() {
-  return 'response';
-}
-
-export function data() {
-  return 'data';
-}
-
-export function view(role) {
-  return role ? `view:${role}` : 'view';
-}
-
-export function tracker() {
-  return 'tracker';
-}
-
-export function interaction() {
-  return 'interaction';
-}
-
-export function feedback() {
-  return 'feedback';
-}
-
-export function input() {
-  return 'input';
-}
-
-export function more() {
-  return 'more';
-}

package/src/actor/filters.js

@@ -1,149 +0,0 @@
-import { EventEmitter, trimObj, defineValues } from '@miso.ai/commons';
-import * as fields from './fields.js';
-
-function mergeState(state = {}, update = {}) {
-  return Object.freeze(trimObj({
-    ...state,
-    ...update,
-    facets: Object.freeze(trimObj({
-      ...state.facets,
-      ...update.facets,
-    })),
-  }));
-}
-
-function optionsToState({ sort } = {}) {
-  // TODO: facets
-  return trimObj({
-    facets: Object.freeze({}),
-    sort: sortOptionsToState(sort),
-  });
-}
-
-function sortOptionsToState(sort) {
-  if (!sort) {
-    return undefined;
-  }
-  const { options = [] } = sort;
-  for (const option of options) {
-    if (option.default) {
-      return Object.freeze(option);
-    }
-  }
-  return Object.freeze(options[0]);
-}
-
-export default class Filters {
-
-  constructor(views, { facets: facetsOptions } = {}) {
-    this._views = views;
-    this._hub = views._hub;
-    const error = this._error = this._error.bind(this);
-    this._events = new EventEmitter({ target: this, error });
-    defineValues(this, { facets: new Facets(this, facetsOptions) });
-
-    this._unsubscribes = [
-      views._options.on('filters', () => this._syncOptions()),
-    ];
-
-    this._syncOptions();
-    this._states = undefined;
-  }
-
-  _syncOptions() {
-    const options = this._views._options.resolved.filters;
-    this._initialStates = optionsToState(options);
-    this.apply({ silent: true });
-  }
-
-  _getStates() {
-    return this._states || this._initialStates;
-  }
-
-  update(updates) {
-    const oldStates = this._getStates();
-    this._states = mergeState({ ...oldStates, ...updates });
-    const states = this._getStates();
-    this._events.emit('update', { updates, states, oldStates });
-  }
-
-  reset({ silent = false } = {}) {
-    // TODO: review this
-    const oldStates = this._states;
-    this._states = undefined;
-    const states = this._getStates();
-    this._hub.update(fields.filters(), states, { silent });
-    this._events.emit('reset', { states, oldStates });
-  }
-
-  apply({ silent = false } = {}) {
-    const states = this._getStates();
-    this._hub.update(fields.filters(), states, { silent });
-    !silent && this._events.emit('apply');
-  }
-
-  _error(error) {
-    this._views._error(error);
-  }
-
-  _destroy() {
-    for (const unsubscribe of this._unsubscribes) {
-      unsubscribe();
-    }
-    this._unsubscribes = [];
-  }
-
-}
-
-class Facets {
-
-  constructor(filters, options = {}) {
-    this._filters = filters;
-    this._options = options;
-  }
-
-  isSelected(field, value) {
-    return this._getFieldValues(field).includes(value);
-  }
-
-  select(field, value) {
-    if (this.isSelected(field, value)) {
-      return;
-    }
-    this._select(field, value);
-  }
-
-  unselect(field, value) {
-    if (!this.isSelected(field, value)) {
-      return;
-    }
-    this._unselect(field, value);
-  }
-
-  toggle(field, value) {
-    if (this.isSelected(field, value)) {
-      this._unselect(field, value);
-    } else {
-      this._select(field, value);
-    }
-  }
-
-  _getFieldValues(field) {
-    return this._filters._getStates().facets[field] || [];
-  }
-
-  _select(field, value) {
-    const values = this._options.multivalued ? [...this._getFieldValues(field), value] : [value];
-    values.sort();
-    this._filters.update({ facets: { [field]: values } });
-  }
-
-  _unselect(field, value) {
-    let values = this._getFieldValues(field).filter(v => v !== value);
-    if (values.length === 0) {
-      values = undefined;
-    }
-    this._filters.update({ facets: { [field]: values } });
-  }
-
-}

package/src/actor/hub.js

@@ -1,47 +0,0 @@
-import { defineValues, EventEmitter } from '@miso.ai/commons';
-
-export default class Hub {
-
-  constructor(options = {}) {
-    (this._events = new EventEmitter())._injectSubscribeInterface(this);
-    this._options = options;
-    this._states = {};
-    defineValues(this, {
-      states: new Proxy(this._states, {
-        set() {}
-      }),
-    });
-  }
-
-  update(name, state, options = {}) {
-    this._states[name] = Object.freeze(state);
-    const event = Object.freeze({ action: 'update', name, state, ...options });
-    // callback after update, before emit
-    if (typeof this._options.onUpdate === 'function') {
-      this._options.onUpdate(event);
-    }
-    // emit
-    if (!options.silent) {
-      this._events.emit(name, state);
-    }
-    // callback after emit
-    if (typeof this._options.onEmit === 'function') {
-      this._options.onEmit(event);
-    }
-  }
-
-  trigger(name, state) {
-    const event = Object.freeze({ action: 'trigger', name, state });
-    // callback before emit
-    if (typeof this._options.onUpdate === 'function') {
-      this._options.onUpdate(event);
-    }
-    // emit
-    this._events.emit(name, state);
-    // callback after emit
-    if (typeof this._options.onEmit === 'function') {
-      this._options.onEmit(event);
-    }
-  }
-
-}

package/src/actor/index.js

@@ -1,10 +0,0 @@
-import * as fields from './fields.js';
-
-export { fields };
-export { default as Hub } from './hub.js';
-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 InteractionsActor } from './interactions.js';
-export * from './trackers.js';

package/src/actor/interactions.js

@@ -1,32 +0,0 @@
-import { asArray } from '@miso.ai/commons';
-import * as fields from './fields.js';
-
-export default class InteractionsActor {
-
-  constructor(hub, { client, options }) {
-    this._client = client;
-    this._options = options;
-    this._unsubscribes = [
-      hub.on(fields.interaction(), payload => this._handle(payload)),
-    ];
-  }
-
-  _handle(payload) {
-    // TODO: omit when option == false
-    payload = asArray(payload);
-
-    if (payload.length === 0) {
-      return;
-    }
-
-    this._client.api.interactions.upload(payload, { merge: true });
-  }
-
-  destroy() {
-    for (const unsubscribe of this._unsubscribes) {
-      unsubscribe();
-    }
-    this._unsubscribes = [];
-  }
-
-}

package/src/actor/sessions.js

@@ -1,21 +0,0 @@
-import { uuidv4 } from '@miso.ai/commons';
-import * as fields from './fields.js';
-
-export default class SessionMaker {
-
-  constructor(hub) {
-    this._hub = hub;
-    this._sessionIndex = 0;
-  }
-
-  restart() {
-    const session = Object.freeze({
-      uuid: uuidv4(),
-      index: this._sessionIndex++,
-      startAt: Date.now(),
-      meta: {},
-    });
-    this._hub.update(fields.session(), session);
-  }
-
-}

package/src/actor/tracker-states.js

@@ -1,57 +0,0 @@
-import { asArray, computeIfAbsent } from '@miso.ai/commons';
-import { EVENT_TYPE, TRACKING_STATUS, validateEventType, validateTrackingStatus } from '../constants.js';
-
-const { IMPRESSION, VIEWABLE, CLICK } = EVENT_TYPE;
-const { UNTRACKED, TRIGGERED } = TRACKING_STATUS;
-
-const UNTRACKED_STATES = Object.freeze({
-  [IMPRESSION]: UNTRACKED,
-  [VIEWABLE]: UNTRACKED,
-  [CLICK]: UNTRACKED,
-});
-
-/**
- * Tracking states for a session to keep track of the tracking status of each product.
- * For each entry there are status of impression, viewable, and click events.
- */
-export default class States {
-
-  constructor(sessionId) {
-    this.sessionId = sessionId;
-    this._states = new Map(); // item key -> {impression, viewable, click}
-  }
-
-  getFullState(item) {
-    // when we receive a bind event, impression is trigger, making an entry here
-    // so if the state is not found, the product is not present yet => all untracked
-    const state = this._states.get(this._getKey(item));
-    return state ? { ...state } : UNTRACKED_STATES;
-  }
-
-  get(item, type) {
-    const state = this._states.get(this._getKey(item));
-    return state && state[type] || UNTRACKED;
-  }
-
-  set(items, type, status) {
-    validateEventType(type);
-    validateTrackingStatus(status);
-    for (const item of asArray(items)) {
-      this._setOne(item, type, status);
-    }
-  }
-
-  untriggered(items, type) {
-    return items.filter(item => this.get(item, type) !== TRIGGERED);
-  }
-
-  _getKey(item) {
-    // TODO: ad-hoc! should move away to higher level
-    return item.product_id || item.text || item.id || item;
-  }
-
-  _setOne(item, type, status) {
-    computeIfAbsent(this._states, this._getKey(item), () => ({ ...UNTRACKED_STATES }))[type] = status;
-  }
-
-}

package/src/actor/tracker.js

@@ -1,104 +0,0 @@
-import { asArray, trimObj, snakeToLowerCamel } from '@miso.ai/commons';
-import { PERFORMANCE_EVENT_TYPES, DIRECT_TRACKING_EVENT_TYPES, TRACKING_STATUS, validateEventType } from '../constants.js';
-import * as fields from './fields.js';
-import States from './tracker-states.js';
-
-// a dummy item array for manipulating deduplication
-const ITEMLESS_DUMMY_ITEMS = [Symbol('itemless')];
-
-export default class Tracker {
-
-  constructor({ hub, role, options }) {
-    this._hub = hub;
-    this._role = role;
-    this._options = options;
-    // TODO: know item type
-
-    this._states = new States(this._getSessionId());
-  }
-
-  get options() {
-    return typeof this._options === 'function' ? this._options() : this._options;
-  }
-
-  getState(item) {
-    return this._states.getFullState(item);
-  }
-
-  _trigger(type, items, meta) {
-    validateEventType(type);
-
-    const { options } = this;
-    if (!options || options.active === false) {
-      return;
-    }
-
-    this._syncSession();
-
-    const { deduplicated = true, itemless = false } = options;
-
-    if (deduplicated) {
-      if (itemless) {
-        items = ITEMLESS_DUMMY_ITEMS;
-      }
-      items = this._states.untriggered(asArray(items), type);
-      if (items.length === 0) {
-        return;
-      }
-      this._states.set(items, type, TRACKING_STATUS.TRIGGERED);
-    }
-
-    this._sendToHub({
-      type,
-      items: itemless ? undefined : items,
-      ...meta,
-    });
-  }
-
-  _sendToHub(args) {
-    this._hub.trigger(fields.tracker(), Object.freeze(trimObj({ role: this._role, ...args })));
-  }
-
-  _syncSession() {
-    const sessionId = this._getSessionId();
-    if (!sessionId) {
-      return;
-    }
-    if (!this._states || sessionId !== this._states.sessionId) {
-      this._states = new States(sessionId);
-    }
-  }
-
-  _getSessionId() {
-    const { session } = this._getViewState() || {};
-    return session && session.uuid;
-  }
-
-  _getMisoId() {
-    const state = this._getViewState();
-    return (state && state.meta && state.meta.miso_id) || undefined;
-  }
-
-  _getRequestPayload() {
-    const { request } = this._getViewState() || {};
-    return request && request.payload;
-  }
-
-  _getViewState() {
-    return this._hub.states[fields.view(this._role)];
-  }
-
-}
-
-for (const type of PERFORMANCE_EVENT_TYPES) {
-  Tracker.prototype[snakeToLowerCamel(type)] = function(items, meta) {
-    this._trigger(type, items, meta);
-  };
-}
-
-for (const type of DIRECT_TRACKING_EVENT_TYPES) {
-  Tracker.prototype[snakeToLowerCamel(type)] = function(args) {
-    this._syncSession();
-    this._sendToHub({ ...args, type });
-  };
-}

package/src/actor/trackers.js

@@ -1,45 +0,0 @@
-import { ROLE } from '../constants.js';
-import Tracker from './tracker.js';
-
-export class TrackersActor {
-
-  constructor(hub, { roles, options }) {
-    this._hub = hub;
-    this._roles = roles;
-    this._options = options;
-    this._trackers = {};
-  }
-
-  get(role) {
-    if (!this._roles.members.includes(role)) {
-      throw new Error(`Role "${role}" is not a member of this workflow.`);
-    }
-    if (!this._trackers[role]) {
-      this._trackers[role] = new Tracker({
-        hub: this._hub,
-        role,
-        itemless: role === ROLE.CONTAINER,
-        options: () => this._getTrackerOptions(role),
-      });
-    }
-    return this._trackers[role];
-  }
-
-  _getTrackerOptions(role) {
-    const allTrackerOptions = this._options.resolved.trackers;
-    return allTrackerOptions && allTrackerOptions[role] || { active: false };
-  }
-
-}
-
-export function proxyTrackers(trackers) {
-  return new Proxy(trackers, {
-    get: (target, prop) => {
-      try {
-        return target.get(prop);
-      } catch (_) {
-      }
-      return undefined;
-    },
-  });
-}

package/src/actor/utils.js

@@ -1,7 +0,0 @@
-export function isCurrentSession(hub, session) {
-  if (!session) {
-    return false;
-  }
-  const { session: currentSession } = hub.states;
-  return currentSession && currentSession.index === session.index;
-}