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

package/dist/cjs/util/proxy.js

@@ -1,88 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-class ProxyElement {
-  constructor(element) {
-    this._get = typeof element === 'function' ? element : () => element;
-    this._handlers = [];
-    this._elementUpdatedHandlers = [];
-    this.sync();
-  }
-  get current() {
-    return this._element;
-  }
-  on(event, handler) {
-    if (event === 'element') {
-      return this._onElementUpdated(handler);
-    }
-    const element = this._get();
-    if (element) {
-      element.addEventListener(event, handler);
-    }
-    this._handlers.push({
-      event,
-      handler
-    });
-    return () => this._off(event, handler);
-  }
-  _off(event, handler) {
-    const element = this._get();
-    if (element) {
-      element.removeEventListener(event, handler);
-    }
-    (0, _commons.findAndRemoveItem)(this._handlers, en => en.handler === handler);
-  }
-  _onElementUpdated(handler) {
-    this._elementUpdatedHandlers.push(handler);
-    return () => {
-      (0, _commons.removeItem)(this._elementUpdatedHandlers, handler);
-    };
-  }
-  sync({
-    silent = false
-  } = {}) {
-    const element = this._get();
-    if (this._element === element) {
-      return;
-    }
-    this._offAllFromCurrentElement();
-    if (element) {
-      for (const {
-        event,
-        handler
-      } of this._handlers) {
-        element.addEventListener(event, handler);
-      }
-    }
-    const oldElement = this._element;
-    this._element = element;
-    if (silent) {
-      return;
-    }
-    for (const handler of this._elementUpdatedHandlers) {
-      try {
-        handler(element, oldElement);
-      } catch (e) {
-        console.error(e); // TODO
-      }
-    }
-  }
-  _offAllFromCurrentElement() {
-    if (this._element) {
-      for (const {
-        event,
-        handler
-      } of this._handlers) {
-        this._element.removeEventListener(event, handler);
-      }
-    }
-  }
-  destroy() {
-    this._offAllFromCurrentElement();
-  }
-}
-exports.default = ProxyElement;

package/dist/cjs/util/trackers.js

@@ -1,88 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isTracked = isTracked;
-exports.markAsTracked = markAsTracked;
-exports.normalizeTrackerOptions = normalizeTrackerOptions;
-exports.validateClick = validateClick;
-var _commons = require("@miso.ai/commons");
-const _excluded = ["impression", "viewable", "click"];
-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; }
-const TRACKED = Symbol.for('miso:tracked');
-function isTracked(event) {
-  return !!event[TRACKED];
-}
-function markAsTracked(event) {
-  event[TRACKED] = true;
-}
-const DEFAULT_TRACKER_OPTIONS = Object.freeze({
-  impression: Object.freeze({}),
-  viewable: Object.freeze({
-    area: 0.5,
-    duration: 1000
-  }),
-  click: Object.freeze({
-    lenient: false
-  })
-});
-function mergeOptions(def, opt) {
-  // if opt is falsy then return false, merge otherwise
-  return !!opt && Object.assign({}, def, opt);
-}
-
-// TODO: don't need this anymore
-function normalizeTrackerOptions(options) {
-  // TODO: make this { active: false } to keep it an object
-  if (options === false) {
-    return false; // turn off all tracking
-  }
-  if (options === true) {
-    options = {};
-  }
-  if (typeof options !== 'object') {
-    throw new Error(`Invalid options: ${options}`);
-  }
-  const {
-      impression = {},
-      viewable = {},
-      click = {}
-    } = options,
-    rest = _objectWithoutPropertiesLoose(options, _excluded);
-  return (0, _commons.trimObj)(Object.assign({}, DEFAULT_TRACKER_OPTIONS, rest, {
-    impression: mergeOptions(DEFAULT_TRACKER_OPTIONS.impression, impression),
-    viewable: mergeOptions(DEFAULT_TRACKER_OPTIONS.viewable, viewable),
-    click: mergeOptions(DEFAULT_TRACKER_OPTIONS.click, click)
-  }));
-}
-function validateClick(options = {}, event) {
-  if (!options) {
-    return false;
-  }
-  if (typeof options.validate === 'function') {
-    return options.validate(event);
-  }
-  if (options.lenient) {
-    return true;
-  }
-
-  // standard criteria
-  // 1. each event can only be tracked once
-  if (isTracked(event)) {
-    return false;
-  }
-  // 2. it must be a left click
-  if (event.button !== 0) {
-    return false;
-  }
-  // 3. event default must not be prevented
-  if (event.defaultPrevented) {
-    return false;
-  }
-  // 4. must go through a real link
-  if (!(0, _commons.findInAncestors)(event.target, element => element.tagName === 'A' && element.href || undefined)) {
-    return false;
-  }
-  return true;
-}

package/dist/cjs/workflow/affiliations.js

@@ -1,140 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.processAffiliationData = processAffiliationData;
-exports.processSovrnProduct = processSovrnProduct;
-var _commons = require("@miso.ai/commons");
-const _excluded = ["affiliation_products"],
-  _excluded2 = ["sovrn_aff"],
-  _excluded3 = ["products"],
-  _excluded4 = ["id", "deeplink", "headline", "description", "currency", "retailPrice", "salePrice", "discountRate", "image", "thumbnail", "merchant"];
-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; }
-function processAffiliationData(data) {
-  if (!data || !data.value) {
-    return data;
-  }
-  const {
-    value
-  } = data;
-  return Object.assign({}, data, {
-    value: processValue(value)
-  });
-}
-function processValue(value) {
-  if (value.affiliation_products) {
-    const {
-        affiliation_products
-      } = value,
-      rest = _objectWithoutPropertiesLoose(value, _excluded);
-    value = Object.assign({}, rest, {
-      affiliation: processMisoData(affiliation_products)
-    });
-  } else if (value.sovrn_aff) {
-    const {
-        sovrn_aff
-      } = value,
-      rest = _objectWithoutPropertiesLoose(value, _excluded2);
-    value = Object.assign({}, rest, {
-      affiliation: processSovrnData(sovrn_aff)
-    });
-  }
-  return postProcessValue(value);
-}
-function postProcessValue(value) {
-  const {
-    affiliation
-  } = value;
-  if (!affiliation) {
-    return value;
-  }
-  let {
-    channel,
-    products
-  } = affiliation;
-  if (!products) {
-    return value;
-  }
-  products = products.map(product => Object.assign({}, product));
-  let i = 0;
-  for (const product of products) {
-    if (channel) {
-      product.channel = channel;
-    }
-    product.position = i++;
-  }
-  return Object.assign({}, value, {
-    affiliation: Object.assign({}, affiliation, {
-      products
-    })
-  });
-}
-function processMisoData(products) {
-  return {
-    channel: 'miso',
-    products
-  };
-}
-function processSovrnData(_ref) {
-  let {
-      products
-    } = _ref,
-    data = _objectWithoutPropertiesLoose(_ref, _excluded3);
-  return Object.assign({
-    channel: 'sovrn'
-  }, data, {
-    products: products.map(processSovrnProduct)
-  });
-}
-function processSovrnProduct(_ref2) {
-  let {
-      id,
-      deeplink: url,
-      headline: title,
-      description,
-      currency,
-      retailPrice: original_price,
-      salePrice: sale_price,
-      discountRate: discount_rate_percent,
-      image: cover_image,
-      thumbnail,
-      merchant
-    } = _ref2,
-    product = _objectWithoutPropertiesLoose(_ref2, _excluded4);
-  const brand = merchant && merchant.name;
-  const brand_logo = merchant && merchant.logo;
-  return (0, _commons.trimObj)({
-    id: `sovrn-${id}`,
-    title,
-    description,
-    cover_image,
-    url,
-    currency,
-    original_price,
-    sale_price,
-    discount_rate_percent,
-    brand,
-    brand_logo,
-    custom_attributes: flatten(Object.assign({
-      sovrn_id: id,
-      thumbnail,
-      merchant
-    }, product))
-  });
-}
-function flatten(obj, prefix = '') {
-  return Object.keys(obj).reduce((acc, key) => {
-    const value = obj[key];
-    if (value === undefined) {
-      return acc;
-    }
-    const prefixedKey = prefix ? `${prefix}_${key}` : key;
-    if (typeof value === 'object') {
-      return Object.assign({}, acc, flatten(value, prefixedKey));
-    }
-    return Object.assign({}, acc, {
-      [prefixedKey]: value
-    });
-  }, {});
-}

package/dist/cjs/workflow/answer-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 _affiliations = require("./affiliations.js");
-var _index3 = require("./options/index.js");
-var _processors = require("./processors.js");
-var _useLink = require("./use-link.js");
-var _trackers = require("../util/trackers.js");
-const _excluded = ["event"];
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-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; }
-const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_API_OPTIONS, {
-  group: _commons.API.GROUP.ASK,
-  payload: Object.assign({}, _base.default.DEFAULT_API_OPTIONS.payload, {
-    source_fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at'],
-    cite_link: 1,
-    cite_start: '[',
-    cite_end: ']'
-  })
-}));
-const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
-  actor: false,
-  api: {
-    group: _commons.API.GROUP.ASK,
-    name: _commons.API.NAME.AUTOCOMPLETE
-  }
-});
-const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LAYOUTS, {
-  [_constants.ROLE.QUERY]: [_index2.SearchBoxLayout.type, {
-    placeholder: 'Ask a question'
-  }],
-  [_constants.ROLE.QUESTION]: [_index2.TextLayout.type, {
-    tag: 'h2'
-  }],
-  [_constants.ROLE.ANSWER]: _index2.TypewriterLayout.type,
-  [_constants.ROLE.FEEDBACK]: _index2.FeedbackLayout.type,
-  [_constants.ROLE.IMAGES]: [_index2.GalleryLayout.type, {
-    incremental: true,
-    itemType: 'image'
-  }],
-  [_constants.ROLE.SOURCES]: [_index2.ListLayout.type, {
-    incremental: true,
-    itemType: 'article',
-    templates: {
-      ordered: true
-    }
-  }],
-  [_constants.ROLE.AFFILIATION]: [_index2.AffiliationLayout.type, {
-    incremental: true,
-    itemType: 'affiliation',
-    link: {
-      rel: 'noopener nofollow'
-    }
-  }]
-}));
-const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _base.default.DEFAULT_TRACKERS, {
-  [_constants.ROLE.ANSWER]: {
-    active: true,
-    itemless: true,
-    deduplicated: false,
-    click: _index3.DEFAULT_TRACKER_OPTIONS.click // click only
-  },
-  [_constants.ROLE.IMAGES]: _index3.DEFAULT_TRACKER_OPTIONS,
-  [_constants.ROLE.SOURCES]: _index3.DEFAULT_TRACKER_OPTIONS,
-  [_constants.ROLE.AFFILIATION]: _index3.DEFAULT_TRACKER_OPTIONS,
-  [_constants.ROLE.PRODUCTS]: _index3.DEFAULT_TRACKER_OPTIONS
-}));
-const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_OPTIONS, {
-  api: DEFAULT_API_OPTIONS,
-  autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS,
-  layouts: DEFAULT_LAYOUTS,
-  trackers: DEFAULT_TRACKERS
-}));
-const ROLES_OPTIONS = (0, _index3.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
-  main: _constants.ROLE.ANSWER,
-  members: Object.keys(DEFAULT_LAYOUTS),
-  mappings: {
-    [_constants.ROLE.ANSWER]: _processors.mappingAnswerData,
-    [_constants.ROLE.REASONING]: _processors.mappingReasoningData
-  }
-});
-class AnswerBasedWorkflow extends _base.default {
-  // constructor //
-  _initProperties(args) {
-    super._initProperties(args);
-    this._questionId = undefined;
-    this._autoQuery = false;
-  }
-  _initActors(args) {
-    super._initActors(args);
-    this._feedback = new _index.FeedbackActor(this._hub);
-  }
-  _initSubscriptions(args) {
-    super._initSubscriptions(args);
-    this._unsubscribes = [...this._unsubscribes, this._hub.on(_index.fields.query(), args => this._query(args)), this._views.on(_constants.ROLE.ANSWER, 'citation-click', event => this._onCitationClick(event)), this._views.on(_constants.ROLE.ANSWER, 'link-click', event => this._onAnswerLinkClick(event))];
-  }
-
-  // lifecycle //
-  restart() {
-    // clear question id from previous session
-    if (this._questionId) {
-      this._questionId = undefined;
-    }
-    // restart
-    super.restart();
-  }
-  _shallEmitLifecycleEvent(name, event) {
-    return name === 'answer-stage' || super._shallEmitLifecycleEvent(name, event);
-  }
-  _emitInterruptEventIfNecessary() {
-    const state = this._hub.states[_index.fields.view(this._roles.main)] || {};
-    if (state.session && state.status !== _constants.STATUS.INITIAL && (state.status !== _constants.STATUS.READY || state.ongoing)) {
-      // it's interrupted by a new question
-      this._emitLifecycleEvent('interrupt', state);
-      this._emitLifecycleEvent('finally', state);
-    }
-  }
-  _onMainViewUpdate(state) {
-    const {
-      status,
-      session
-    } = state;
-    const done = status === _constants.STATUS.READY && !state.ongoing;
-    const erroneous = status === _constants.STATUS.ERRONEOUS;
-    const eventName = done ? 'done' : erroneous ? 'error' : status;
-
-    // answer-stage
-    const context = this._getSessionContext(session);
-    const oldAnswerStage = context.answerStage;
-    const newAnswerStage = state.meta && state.meta.answer_stage;
-    if (newAnswerStage && newAnswerStage !== oldAnswerStage) {
-      this._emitLifecycleEvent('answer-stage', Object.freeze(Object.assign({}, state, {
-        answer_stage: newAnswerStage
-      })));
-      context.answerStage = newAnswerStage;
-    }
-
-    // blocked reason
-    const data = this._hub.states[_index.fields.data()] || {};
-    const {
-      value
-    } = data;
-    if (value) {
-      const {
-        blocked_reason
-      } = value;
-      if (blocked_reason) {
-        this._emitLifecycleEvent('blocked', Object.assign({}, state, {
-          blockedReason: blocked_reason
-        }));
-      }
-    }
-
-    // ready, done, or error
-    this._emitLifecycleEvent(eventName, state);
-    if (done || erroneous) {
-      // finally
-      this._emitLifecycleEvent('finally', state);
-    }
-  }
-
-  // properties //
-  get questionId() {
-    return this._questionId;
-  }
-
-  // query //
-  autoQuery(options = {}) {
-    _index3.autoQuery.call(this, options);
-  }
-  query(args) {
-    // TODO: also accept "question", "questionSource"?
-    if (!args.q && !args.questionId) {
-      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;
-    }
-    // start a new session
-    this.restart();
-
-    // keep track of question source on this session, for suggested questions interactions
-    this._writeQuestionSourceToSession(args);
-
-    // build payload and trigger request
-    const payload = this._buildPayload(args);
-    this._request({
-      payload
-    });
-  }
-  _writeQuestionSourceToSession(args) {
-    this.session.meta.question_source = args.qs || _constants.QUESTION_SOURCE.ORGANIC; // might be null, not undefined
-  }
-  _buildPayload() {
-    throw new Error(`Not implemented`);
-  }
-  _writeWikiLinkTemplateToPayload(payload) {
-    if (!this._autoQuery || !this._autoQuery.param || this._autoQuery.param === _index3.DEFAULT_AUTO_QUERY_PARAM) {
-      return payload;
-    }
-    return Object.assign({}, payload, {
-      wiki_link_template: `?${this._autoQuery.param}=%s`
-    });
-  }
-
-  // data //
-  _updateData(data) {
-    // capture question ID and register at context
-    this._writeQuestionIdFromData(data);
-
-    // if it's the head response, write question id and return
-    if (data.value && !data.value.answer_stage) {
-      this._handleHeadResponse(data);
-      return;
-    }
-    super._updateData(data);
-
-    // update URL if autoQuery.updateUrl is not false
-    _index3.updateQueryParametersInUrl.call(this, data);
-  }
-  _handleHeadResponse(data) {}
-  _defaultProcessData(data, oldData) {
-    data = super._defaultProcessData(data, oldData);
-    data = (0, _affiliations.processAffiliationData)(data);
-    data = (0, _processors.writeAnswerStageToMeta)(data);
-    return data;
-  }
-  _writeQuestionIdFromData({
-    value
-  }) {
-    value && this._writeQuestionId(value.question_id);
-  }
-
-  // interactions //
-  _defaultProcessInteraction(payload, args) {
-    payload = super._defaultProcessInteraction(payload, args);
-    payload = (0, _processors.writeAnswerInfoToInteraction)(payload, args);
-    return payload;
-  }
-  _getQuestionSourceFromViewState(args) {
-    const {
-      request
-    } = this._hub.states[_index.fields.view(args.role)] || {};
-    const {
-      payload
-    } = request || {};
-    return payload && payload.metadata && payload.metadata.question_source || undefined;
-  }
-
-  // handlers //
-  _onCitationClick({
-    index,
-    event
-  }) {
-    if (event.button !== 0) {
-      return; // only left click
-    }
-    if ((0, _trackers.isTracked)(event)) {
-      return;
-    }
-    const {
-      value
-    } = this._hub.states[_index.fields.data()] || {};
-    const {
-      sources
-    } = value || {};
-    // index is 1-based
-    const source = sources && sources[index - 1];
-    if (!source || !source.product_id) {
-      return;
-    }
-    // TODO: should we track impression as well?
-    (0, _trackers.markAsTracked)(event);
-    // distinguish from regular sources element click
-    this._views.trackers.sources.click([source.product_id], {
-      event_target: 'citation-link'
-    });
-  }
-  _onAnswerLinkClick(_ref) {
-    let {
-        event
-      } = _ref,
-      item = _objectWithoutPropertiesLoose(_ref, _excluded);
-    if (event.button !== 0) {
-      return; // only left click
-    }
-    if ((0, _trackers.isTracked)(event)) {
-      return;
-    }
-    (0, _trackers.markAsTracked)(event);
-    // put everything into args and let _defaultProcessInteraction() handles it
-    // for it's hard to make it a standard item
-    this._views.trackers.answer.click([], {
-      items: [item]
-    });
-  }
-
-  // helpers //
-  _writeQuestionId(questionId) {
-    if (!this._questionId && questionId) {
-      this._questionId = questionId;
-    }
-  }
-  _clearQuestionId() {
-    // clear question id from previous session
-    this._questionId = undefined;
-  }
-
-  // destroy //
-  _destroy(options) {
-    this._feedback._destroy();
-    // this._autocomplete._destroy();
-    super._destroy(options);
-  }
-}
-exports.default = AnswerBasedWorkflow;
-(0, _useLink.enableUseLink)(AnswerBasedWorkflow.prototype);
-Object.assign(AnswerBasedWorkflow, {
-  DEFAULT_API_OPTIONS,
-  DEFAULT_AUTOCOMPLETE_OPTIONS,
-  DEFAULT_LAYOUTS,
-  DEFAULT_TRACKERS,
-  DEFAULT_OPTIONS,
-  ROLES_OPTIONS
-});