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

package/dist/cjs/actor/tracker-states.js

@@ -1,61 +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");
-const {
-  IMPRESSION,
-  VIEWABLE,
-  CLICK
-} = _constants.EVENT_TYPE;
-const {
-  UNTRACKED,
-  TRIGGERED
-} = _constants.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.
- */
-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 ? Object.assign({}, state) : UNTRACKED_STATES;
-  }
-  get(item, type) {
-    const state = this._states.get(this._getKey(item));
-    return state && state[type] || UNTRACKED;
-  }
-  set(items, type, status) {
-    (0, _constants.validateEventType)(type);
-    (0, _constants.validateTrackingStatus)(status);
-    for (const item of (0, _commons.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) {
-    (0, _commons.computeIfAbsent)(this._states, this._getKey(item), () => Object.assign({}, UNTRACKED_STATES))[type] = status;
-  }
-}
-exports.default = States;

package/dist/cjs/actor/tracker.js

@@ -1,109 +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 fields = _interopRequireWildcard(require("./fields.js"));
-var _trackerStates = _interopRequireDefault(require("./tracker-states.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-// a dummy item array for manipulating deduplication
-const ITEMLESS_DUMMY_ITEMS = [Symbol('itemless')];
-class Tracker {
-  constructor({
-    hub,
-    role,
-    options
-  }) {
-    this._hub = hub;
-    this._role = role;
-    this._options = options;
-    // TODO: know item type
-
-    this._states = new _trackerStates.default(this._getSessionId());
-  }
-  get options() {
-    return typeof this._options === 'function' ? this._options() : this._options;
-  }
-  getState(item) {
-    return this._states.getFullState(item);
-  }
-  _trigger(type, items, meta) {
-    (0, _constants.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((0, _commons.asArray)(items), type);
-      if (items.length === 0) {
-        return;
-      }
-      this._states.set(items, type, _constants.TRACKING_STATUS.TRIGGERED);
-    }
-    this._sendToHub(Object.assign({
-      type,
-      items: itemless ? undefined : items
-    }, meta));
-  }
-  _sendToHub(args) {
-    this._hub.trigger(fields.tracker(), Object.freeze((0, _commons.trimObj)(Object.assign({
-      role: this._role
-    }, args))));
-  }
-  _syncSession() {
-    const sessionId = this._getSessionId();
-    if (!sessionId) {
-      return;
-    }
-    if (!this._states || sessionId !== this._states.sessionId) {
-      this._states = new _trackerStates.default(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)];
-  }
-}
-exports.default = Tracker;
-for (const type of _constants.PERFORMANCE_EVENT_TYPES) {
-  Tracker.prototype[(0, _commons.snakeToLowerCamel)(type)] = function (items, meta) {
-    this._trigger(type, items, meta);
-  };
-}
-for (const type of _constants.DIRECT_TRACKING_EVENT_TYPES) {
-  Tracker.prototype[(0, _commons.snakeToLowerCamel)(type)] = function (args) {
-    this._syncSession();
-    this._sendToHub(Object.assign({}, args, {
-      type
-    }));
-  };
-}

package/dist/cjs/actor/trackers.js

@@ -1,52 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.TrackersActor = void 0;
-exports.proxyTrackers = proxyTrackers;
-var _constants = require("../constants.js");
-var _tracker = _interopRequireDefault(require("./tracker.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-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.default({
-        hub: this._hub,
-        role,
-        itemless: role === _constants.ROLE.CONTAINER,
-        options: () => this._getTrackerOptions(role)
-      });
-    }
-    return this._trackers[role];
-  }
-  _getTrackerOptions(role) {
-    const allTrackerOptions = this._options.resolved.trackers;
-    return allTrackerOptions && allTrackerOptions[role] || {
-      active: false
-    };
-  }
-}
-exports.TrackersActor = TrackersActor;
-function proxyTrackers(trackers) {
-  return new Proxy(trackers, {
-    get: (target, prop) => {
-      try {
-        return target.get(prop);
-      } catch (_) {}
-      return undefined;
-    }
-  });
-}

package/dist/cjs/actor/utils.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isCurrentSession = isCurrentSession;
-function isCurrentSession(hub, session) {
-  if (!session) {
-    return false;
-  }
-  const {
-    session: currentSession
-  } = hub.states;
-  return currentSession && currentSession.index === session.index;
-}

package/dist/cjs/actor/view.js

@@ -1,294 +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 fields = _interopRequireWildcard(require("./fields.js"));
-var _proxy = _interopRequireDefault(require("../util/proxy.js"));
-const _excluded = ["value", "error", "status", "meta"];
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-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: browser dependency on syncSize
-
-function statesEqual(a, b) {
-  return a === b || a && b && a.status === b.status && a.error === b.error && a.value === b.value &&
-  // skip deep equals
-  a.ongoing === b.ongoing && stateEmptyness(a) === stateEmptyness(b) &&
-  // TODO: ad-hoc
-  sessionEquals(a.session, b.session);
-}
-function sessionEquals(a, b) {
-  return a === b || a && b && a.uuid === b.uuid;
-}
-function stateEmptyness(data) {
-  return data && data.meta && data.meta.empty;
-}
-class ViewActor {
-  constructor(views, role) {
-    this._events = new _commons.EventEmitter({
-      target: this
-    });
-    this._views = views;
-    // TODO: we should pull this up to views, for the results are also used in judging container emptyness
-    this._mapping = asMappingFunction((views._roles.mappings || {})[role] || role);
-    (0, _commons.defineValues)(this, {
-      role,
-      interface: new View(this)
-    });
-  }
-  get hub() {
-    return this._views._hub;
-  }
-  get element() {
-    return this._element;
-  }
-  set element(element) {
-    if (element === this._element) {
-      return;
-    }
-    if (this._element) {
-      this._safeApplyOnLayout('unrender', this._element);
-    }
-    this._element = element;
-    this._proxyElement && this._proxyElement.sync();
-    this._events.emit('element', element);
-    this.refresh({
-      force: true
-    });
-  }
-  get proxyElement() {
-    if (!this._proxyElement) {
-      this._proxyElement = new _proxy.default(() => this.element);
-    }
-    return this._proxyElement;
-  }
-  get layout() {
-    return this._layout;
-  }
-  set layout(layout) {
-    if (layout === this._layout) {
-      return;
-    }
-    if (layout && typeof layout.render !== 'function') {
-      throw new Error(`Render function is mandatory in a layout.`);
-    }
-
-    // clean up old layout
-    const {
-      element
-    } = this;
-    element && this._safeApplyOnLayout('unrender', element);
-    this._safeApplyOnLayout('destroy');
-    this._layout = layout;
-
-    // initialize new layout
-    if (layout) {
-      layout._view = this;
-      // don't use _safeApplyOnLayout, for any error should be thrown
-      if (typeof layout.initialize === 'function') {
-        layout.initialize(this);
-      }
-    }
-
-    // in case the data is already there
-    this.refresh({
-      force: true
-    });
-  }
-  get tracker() {
-    return this._views.trackers[this.role];
-  }
-  get workflow() {
-    return this._views._workflow;
-  }
-  get workflowOptions() {
-    return this._views._options.resolved;
-  }
-  get trackerOptions() {
-    return this._views._getTrackerOptions(this.role);
-  }
-  get filters() {
-    return this._views.filters;
-  }
-  async refresh({
-    force = false,
-    data
-  } = {}) {
-    // protocol: no reaction when layout is absent
-    if (!this._layout) {
-      return;
-    }
-
-    // nothing to do when element is absent
-    const {
-      element
-    } = this;
-    if (!element) {
-      return;
-    }
-
-    // sync data
-    const previousData = this._data;
-    this._data = data = this._sliceData(data || this._views._getData());
-
-    // if data is unchanged, skip unless forced
-    if (!force && statesEqual(data, previousData)) {
-      return;
-    }
-    const {
-      session,
-      status,
-      ongoing,
-      request,
-      meta,
-      value
-    } = data;
-    const baseState = Object.assign({
-      session,
-      status,
-      ongoing,
-      request,
-      meta,
-      data: value
-    }, getDataEmptyness(this.role, data));
-
-    // render
-    const notifyUpdate = (state = {}, options) => {
-      state !== false && this.updateState(Object.assign({}, baseState, state), options);
-    };
-    try {
-      await this._layout.render(element, data, {
-        notifyUpdate
-      });
-    } catch (error) {
-      this._error(error);
-      notifyUpdate({
-        error
-      });
-    }
-  }
-  updateState(state, {
-    silent = false
-  } = {}) {
-    // there might be error from notifyUpdate() call
-    const status = state.error ? _constants.STATUS.ERRONEOUS : state.status;
-    state = this._state = Object.freeze((0, _commons.trimObj)(Object.assign({}, state, {
-      status
-    })));
-    const {
-      role
-    } = this;
-    this.hub.update(fields.view(role), state, {
-      silent
-    });
-  }
-  _sliceData(data) {
-    const {
-        value,
-        status,
-        meta
-      } = data,
-      rest = _objectWithoutPropertiesLoose(data, _excluded);
-    const sliced = Object.assign({
-      value: this._mapping(data, this),
-      status,
-      data: value,
-      meta
-    }, rest);
-    if (this.role === _constants.ROLE.CONTAINER) {
-      // pass empty/nonempty information
-      sliced.meta = Object.assign({}, meta, {
-        empty: this._isContainerEmpty(data)
-      });
-    }
-    return (0, _commons.trimObj)(sliced);
-  }
-
-  // TODO: move this to workflow
-  _isContainerEmpty(data) {
-    const {
-      element
-    } = this;
-    if (!element) {
-      return false;
-    }
-    // iterate over all member components' roles
-    for (const {
-      role
-    } of element.components) {
-      // not a data role -> irrelevant
-      if (!(0, _constants.isDataRole)(role)) {
-        continue;
-      }
-      // respect data mapping
-      const mapping = asMappingFunction((this._views._roles.mappings || {})[role] || role);
-      const sliced = mapping(data, this); // TODO: the view passed in should be the view of the role, not container role
-      if (!isDateValueEmpty(role, sliced)) {
-        return false;
-      }
-    }
-    return true;
-  }
-  _syncSize() {
-    this._element && this._safeApplyOnLayout('syncSize', this._element);
-  }
-  _safeApplyOnLayout(method, ...args) {
-    if (!this._layout || typeof this._layout[method] !== 'function') {
-      return;
-    }
-    try {
-      this._layout[method](...args);
-    } catch (e) {
-      this._error(e);
-    }
-  }
-  _emit(name, data) {
-    this._events.emit(name, data);
-    this._views._events.emit(`${this.role}:${name}`, data);
-  }
-  _error(e) {
-    this._views._error(e);
-  }
-  _destroy() {
-    this._safeApplyOnLayout('destroy');
-    this._proxyElement && this._proxyElement.destroy();
-  }
-}
-exports.default = ViewActor;
-class View {
-  constructor(actor) {
-    (0, _commons.delegateGetters)(this, actor, ['role', 'layout', 'element', 'proxyElement', 'refresh', 'on', 'tracker']);
-  }
-}
-function asMappingFunction(fn) {
-  switch (typeof fn) {
-    case 'function':
-      return fn;
-    case 'string':
-      return data => data.value && data.value[fn];
-    default:
-      throw new Error(`Invalid mapping function: ${fn}`);
-  }
-}
-function getDataEmptyness(role, data) {
-  return isDataStatusRelevantToEmptyness(data) ? {
-    empty: !!isDateValueEmpty(role, data && data.value)
-  } : {};
-}
-function isDataStatusRelevantToEmptyness(data) {
-  return data.status === _constants.STATUS.READY && !data.ongoing;
-}
-function isDateValueEmpty(role, value) {
-  // TODO: ad-hoc
-  switch (role) {
-    case _constants.ROLE.ANSWER:
-    case _constants.ROLE.REASONING:
-      return !value || !value.value;
-    default:
-      return value === undefined || (Array.isArray(value) || typeof value === 'string') && !value.length;
-  }
-}