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

package/src/workflow/affiliations.js

@@ -1,121 +0,0 @@
-import { trimObj } from '@miso.ai/commons';
-
-export function processAffiliationData(data) {
-  if (!data || !data.value) {
-    return data;
-  }
-  const { value } = data;
-  return {
-    ...data,
-    value: processValue(value)
-  };
-}
-
-function processValue(value) {
-  if (value.affiliation_products) {
-    const { affiliation_products, ...rest } = value;
-    value = {
-      ...rest,
-      affiliation: processMisoData(affiliation_products),
-    };
-  } else if (value.sovrn_aff) {
-    const { sovrn_aff, ...rest } = value;
-    value = {
-      ...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 => ({ ...product }));
-  let i = 0;
-  for (const product of products) {
-    if (channel) {
-      product.channel = channel;
-    }
-    product.position = i++;
-  }
-  return {
-    ...value,
-    affiliation: {
-      ...affiliation,
-      products,
-    },
-  };
-}
-
-function processMisoData(products) {
-  return {
-    channel: 'miso',
-    products,
-  };
-}
-
-function processSovrnData({ products, ...data }) {
-  return {
-    channel: 'sovrn',
-    ...data,
-    products: products.map(processSovrnProduct),
-  };
-}
-
-export function processSovrnProduct({
-  id,
-  deeplink: url,
-  headline: title,
-  description,
-  currency,
-  retailPrice: original_price,
-  salePrice: sale_price,
-  discountRate: discount_rate_percent,
-  image: cover_image,
-  thumbnail,
-  merchant,
-  ...product
-}) {
-  const brand = merchant && merchant.name;
-  const brand_logo = merchant && merchant.logo;
-  return trimObj({
-    id: `sovrn-${id}`,
-    title,
-    description,
-    cover_image,
-    url,
-    currency,
-    original_price,
-    sale_price,
-    discount_rate_percent,
-    brand,
-    brand_logo,
-    custom_attributes: flatten({
-      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 { ...acc, ...flatten(value, prefixedKey) };
-    }
-    return { ...acc, [prefixedKey]: value };
-  }, {});
-}

package/src/workflow/answer-based.js

@@ -1,312 +0,0 @@
-import { API } from '@miso.ai/commons';
-import Workflow from './base.js';
-import { fields, FeedbackActor } from '../actor/index.js';
-import { ROLE, STATUS, QUESTION_SOURCE } from '../constants.js';
-import { SearchBoxLayout, TextLayout, ListLayout, GalleryLayout, TypewriterLayout, FeedbackLayout, AffiliationLayout } from '../layout/index.js';
-import { processAffiliationData } from './affiliations.js';
-import { mergeRolesOptions, autoQuery as autoQueryFn, updateQueryParametersInUrl, DEFAULT_AUTO_QUERY_PARAM, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
-import { mappingAnswerData, mappingReasoningData, writeAnswerStageToMeta, writeAnswerInfoToInteraction } from './processors.js';
-import { enableUseLink } from './use-link.js';
-import { isTracked, markAsTracked } from '../util/trackers.js';
-
-const DEFAULT_API_OPTIONS = Object.freeze({
-  ...Workflow.DEFAULT_API_OPTIONS,
-  group: API.GROUP.ASK,
-  payload: {
-    ...Workflow.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: API.GROUP.ASK,
-    name: API.NAME.AUTOCOMPLETE,
-  },
-});
-
-const DEFAULT_LAYOUTS = Object.freeze({
-  ...Workflow.DEFAULT_LAYOUTS,
-  [ROLE.QUERY]: [SearchBoxLayout.type, { placeholder: 'Ask a question' }],
-  [ROLE.QUESTION]: [TextLayout.type, { tag: 'h2' }],
-  [ROLE.ANSWER]: TypewriterLayout.type,
-  [ROLE.FEEDBACK]: FeedbackLayout.type,
-  [ROLE.IMAGES]: [GalleryLayout.type, { incremental: true, itemType: 'image' }],
-  [ROLE.SOURCES]: [ListLayout.type, { incremental: true, itemType: 'article', templates: { ordered: true } }],
-  [ROLE.AFFILIATION]: [AffiliationLayout.type, { incremental: true, itemType: 'affiliation', link: { rel: 'noopener nofollow' } }],
-});
-
-const DEFAULT_TRACKERS = Object.freeze({
-  ...Workflow.DEFAULT_TRACKERS,
-  [ROLE.ANSWER]: {
-    active: true,
-    itemless: true,
-    deduplicated: false,
-    click: DEFAULT_TRACKER_OPTIONS.click, // click only
-  },
-  [ROLE.IMAGES]: DEFAULT_TRACKER_OPTIONS,
-  [ROLE.SOURCES]: DEFAULT_TRACKER_OPTIONS,
-  [ROLE.AFFILIATION]: DEFAULT_TRACKER_OPTIONS,
-  [ROLE.PRODUCTS]: DEFAULT_TRACKER_OPTIONS,
-});
-
-const DEFAULT_OPTIONS = Object.freeze({
-  ...Workflow.DEFAULT_OPTIONS,
-  api: DEFAULT_API_OPTIONS,
-  autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS,
-  layouts: DEFAULT_LAYOUTS,
-  trackers: DEFAULT_TRACKERS,
-});
-
-const ROLES_OPTIONS = mergeRolesOptions(Workflow.ROLES_OPTIONS, {
-  main: ROLE.ANSWER,
-  members: Object.keys(DEFAULT_LAYOUTS),
-  mappings: {
-    [ROLE.ANSWER]: mappingAnswerData,
-    [ROLE.REASONING]: mappingReasoningData,
-  },
-});
-
-export default class AnswerBasedWorkflow extends Workflow {
-
-  // constructor //
-  _initProperties(args) {
-    super._initProperties(args);
-    this._questionId = undefined;
-    this._autoQuery = false;
-  }
-
-  _initActors(args) {
-    super._initActors(args);
-    this._feedback = new FeedbackActor(this._hub);
-  }
-
-  _initSubscriptions(args) {
-    super._initSubscriptions(args);
-    this._unsubscribes = [
-      ...this._unsubscribes,
-      this._hub.on(fields.query(), args => this._query(args)),
-      this._views.on(ROLE.ANSWER, 'citation-click', event => this._onCitationClick(event)),
-      this._views.on(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[fields.view(this._roles.main)] || {};
-    if (state.session && state.status !== STATUS.INITIAL && (state.status !== 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 === STATUS.READY && !state.ongoing;
-    const erroneous = status === 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({ ...state, answer_stage: newAnswerStage }));
-      context.answerStage = newAnswerStage;
-    }
-
-    // blocked reason
-    const data = this._hub.states[fields.data()] || {};
-    const { value } = data;
-    if (value) {
-      const { blocked_reason } = value;
-      if (blocked_reason) {
-        this._emitLifecycleEvent('blocked', { ...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 = {}) {
-    autoQueryFn.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(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 || 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 === DEFAULT_AUTO_QUERY_PARAM) {
-      return payload;
-    }
-    return {
-      ...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
-    updateQueryParametersInUrl.call(this, data);
-  }
-
-  _handleHeadResponse(data) {}
-
-  _defaultProcessData(data, oldData) {
-    data = super._defaultProcessData(data, oldData);
-    data = processAffiliationData(data);
-    data = writeAnswerStageToMeta(data);
-    return data;
-  }
-
-  _writeQuestionIdFromData({ value }) {
-    value && this._writeQuestionId(value.question_id);
-  }
-
-  // interactions //
-  _defaultProcessInteraction(payload, args) {
-    payload = super._defaultProcessInteraction(payload, args);
-    payload = writeAnswerInfoToInteraction(payload, args);
-    return payload;
-  }
-
-  _getQuestionSourceFromViewState(args) {
-    const { request } = this._hub.states[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 (isTracked(event)) {
-      return;
-    }
-    const { value } = this._hub.states[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?
-    markAsTracked(event);
-    // distinguish from regular sources element click
-    this._views.trackers.sources.click([source.product_id], { event_target: 'citation-link' });
-  }
-
-  _onAnswerLinkClick({ event, ...item }) {
-    if (event.button !== 0) {
-      return; // only left click
-    }
-    if (isTracked(event)) {
-      return;
-    }
-    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);
-  }
-
-}
-
-enableUseLink(AnswerBasedWorkflow.prototype);
-
-Object.assign(AnswerBasedWorkflow, {
-  DEFAULT_API_OPTIONS,
-  DEFAULT_AUTOCOMPLETE_OPTIONS,
-  DEFAULT_LAYOUTS,
-  DEFAULT_TRACKERS,
-  DEFAULT_OPTIONS,
-  ROLES_OPTIONS,
-});

package/src/workflow/ask.js

@@ -1,284 +0,0 @@
-import { defineValues, trimObj, API, mergeInteractions } from '@miso.ai/commons';
-import AnswerBasedWorkflow from './answer-based.js';
-import { fields } from '../actor/index.js';
-import { ROLE, STATUS, QUESTION_SOURCE } from '../constants.js';
-import { OptionListLayout, ListLayout, SearchBoxLayout, TypewriterLayout } from '../layout/index.js';
-import { mergeRolesOptions, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
-import { writeQuestionSourceToPayload, mappingSuggestionsData, mappingFollowUpQuestionsData } from './processors.js';
-import { followUp as followUpTemplate } from '../defaults/ask/templates.js';
-import { makeAutocompletable } from './autocompletable.js';
-
-const DEFAULT_API_OPTIONS = Object.freeze({
-  ...AnswerBasedWorkflow.DEFAULT_API_OPTIONS,
-  name: API.NAME.QUESTIONS,
-  payload: {
-    ...AnswerBasedWorkflow.DEFAULT_API_OPTIONS.payload,
-    related_resource_fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at'],
-  },
-});
-
-const DEFAULT_LAYOUTS = Object.freeze({
-  ...AnswerBasedWorkflow.DEFAULT_LAYOUTS,
-  [ROLE.QUERY]: [SearchBoxLayout.type, { templates: { buttonIcon: 'send' } }],
-  [ROLE.REASONING]: TypewriterLayout.type,
-  [ROLE.RELATED_RESOURCES]: [ListLayout.type, { incremental: true, itemType: 'article' }],
-  [ROLE.QUERY_SUGGESTIONS]: OptionListLayout.type,
-  [ROLE.FOLLOW_UP_QUESTIONS]: OptionListLayout.type,
-});
-
-const DEFAULT_TRACKERS = Object.freeze({
-  ...AnswerBasedWorkflow.DEFAULT_TRACKERS,
-  [ROLE.RELATED_RESOURCES]: DEFAULT_TRACKER_OPTIONS,
-  [ROLE.QUERY_SUGGESTIONS]: {
-    ...DEFAULT_TRACKER_OPTIONS,
-    click: {
-      ...DEFAULT_TRACKER_OPTIONS.click,
-      validate: event => event.button === 0, // loosen criteria, for it's not a hyperlink
-    },
-  },
-});
-
-const DEFAULT_TEMPLATES = Object.freeze({
-  followUp: followUpTemplate,
-});
-
-const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
-  api: {
-    group: API.GROUP.ASK,
-    name: API.NAME.AUTOCOMPLETE,
-  },
-});
-
-const DEFAULT_OPTIONS = Object.freeze({
-  ...AnswerBasedWorkflow.DEFAULT_OPTIONS,
-  api: DEFAULT_API_OPTIONS,
-  layouts: DEFAULT_LAYOUTS,
-  trackers: DEFAULT_TRACKERS,
-  templates: DEFAULT_TEMPLATES,
-  autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS,
-});
-
-const ROLES_OPTIONS = mergeRolesOptions(AnswerBasedWorkflow.ROLES_OPTIONS, {
-  members: Object.keys(DEFAULT_LAYOUTS),
-  mappings: {
-    [ROLE.QUERY_SUGGESTIONS]: mappingSuggestionsData,
-    [ROLE.FOLLOW_UP_QUESTIONS]: mappingFollowUpQuestionsData,
-  },
-});
-
-export default class Ask extends AnswerBasedWorkflow {
-
-  constructor(context, parentQuestionId) {
-    super({
-      name: 'ask',
-      context,
-      roles: ROLES_OPTIONS,
-      defaults: DEFAULT_OPTIONS,
-      parentQuestionId,
-    });
-  }
-
-  _initProperties(args) {
-    super._initProperties(args);
-    this._initAutocomplete(args);
-    const { parentQuestionId } = args;
-    defineValues(this, { parentQuestionId });
-  }
-
-  _initSubscriptions(args) {
-    super._initSubscriptions(args);
-    this._unsubscribes = [
-      ...this._unsubscribes,
-      this._hub.on(fields.view(ROLE.REASONING), state => this._onReasoningViewUpdate(state)),
-      this._views.on(ROLE.ANSWER, 'follow-up-click', event => this._onFollowUpClick(event)),
-      this._views.on(ROLE.FOLLOW_UP_QUESTIONS, 'select', event => this._onFollowUpQuestionSelect(event)),
-      this._views.on(ROLE.QUERY_SUGGESTIONS, 'select', event => this._onQuerySuggestionSelect(event)),
-    ];
-  }
-
-  _initSession(args) {
-    // register at context
-    args.parentQuestionId && this._context._byPqid.set(args.parentQuestionId, this);
-    this._context._events.emit('create', this);
-    super._initSession(args);
-  }
-
-  // lifecycle //
-  restart() {
-    const { next } = this;
-    next && next.destroy();
-    if (this._questionId) {
-      this._context._byQid.delete(this._questionId);
-    }
-    super.restart();
-  }
-
-  // properties //
-  get rootQuestionId() {
-    return this._context.root.questionId;
-  }
-
-  get previous() {
-    const { parentQuestionId } = this;
-    return parentQuestionId ? this._context.getByQuestionId(parentQuestionId) : undefined;
-  }
-
-  get next() {
-    const { questionId } = this;
-    return questionId ? this._context.getByParentQuestionId(questionId) : undefined;
-  }
-
-  getOrCreateNext() {
-    const { questionId } = this;
-    return questionId ? this._context.getByParentQuestionId(questionId, { autoCreate: true }) : undefined;
-  }
-
-  // query //
-  _buildPayload({ q, qs, questionId, ...options } = {}) {
-    if (questionId) {
-      return trimObj({
-        ...options,
-        question_id: questionId,
-        // TODO: specify this is a replayed session
-      });
-    }
-    const { parentQuestionId } = this;
-    let payload = trimObj({
-      ...options,
-      question: q, // question, not q
-      parent_question_id: parentQuestionId,
-    });
-    payload = writeQuestionSourceToPayload({ ...payload, qs });
-    payload = this._writeWikiLinkTemplateToPayload(payload);
-    return payload;
-  }
-
-  // data //
-  _updateData(data) {
-    super._updateData(data);
-    this._triggerSuggestionsRefreshIfNecessary();
-  }
-
-  _triggerSuggestionsRefreshIfNecessary() {
-    const { next } = this;
-    if (!next) {
-      return;
-    }
-    for (const view of next._views.getAll(ROLE.QUERY_SUGGESTIONS)) {
-      view.refresh();
-    }
-  }
-
-  // view //
-  _onReasoningViewUpdate({ status, ongoing }) {
-    if (status !== STATUS.READY || ongoing) {
-      return;
-    }
-    for (const view of this._views.getAll(ROLE.REASONING)) {
-      const element = view.element && view.element.closest('[data-role="reasoning-box"]');
-      element && element.classList.add('done');
-    }
-  }
-
-  // interactions //
-  _defaultProcessInteraction(payload, args) {
-    payload = super._defaultProcessInteraction(payload, args);
-    payload = this._writeAdditionalAskPropertiesToInteraction(payload, args);
-    return payload;
-  }
-
-  _writeAdditionalAskPropertiesToInteraction(payload, args) {
-    const root_question_id = this.rootQuestionId;
-    let { property } = (payload.context && payload.context.custom_context) || {};
-    let question_id, parent_question_id, question_source;
-
-    if (args.role === ROLE.FOLLOW_UP_QUESTIONS || args.role === ROLE.QUERY_SUGGESTIONS) {
-      property = 'suggested_followup_questions';
-    }
-
-    if (args.role === ROLE.QUERY_SUGGESTIONS) {
-      parent_question_id = this.previous && this.previous.parentQuestionId;
-      question_id = this.parentQuestionId;
-      question_source = this.previous && this.previous.session.meta.question_source;
-    } else {
-      parent_question_id = this.parentQuestionId;
-    }
-
-    return mergeInteractions(payload, {
-      context: {
-        custom_context: trimObj({ // question_id, question_source can be undefined
-          property,
-          root_question_id,
-          parent_question_id,
-          question_id,
-          question_source,
-        }),
-      }
-    });
-  }
-
-  // handlers //
-  _onFollowUpClick({ q, event } = {}) {
-    if (event.button !== 0) {
-      return; // only left click
-    }
-    this._submitFollowUpQuestion({ q, qs: QUESTION_SOURCE.INLINE_QUESTION_LINK });
-    // TODO: track click?
-  }
-
-  _onFollowUpQuestionSelect({ value: q }) {
-    this._submitFollowUpQuestion({ q, qs: QUESTION_SOURCE.SUGGESTED_QUESTIONS });
-  }
-
-  _submitFollowUpQuestion({ q = '', qs } = {}) {
-    q = q.trim();
-    if (!q) {
-      return;
-    }
-    const next = this.getOrCreateNext();
-    next.query({ q, qs });
-  }
-
-  _onQuerySuggestionSelect({ value: q }) {
-    if (!q) {
-      return;
-    }
-    // backward compatible: query on current workflow
-    this.query({ q, qs: QUESTION_SOURCE.SUGGESTED_QUESTIONS });
-  }
-
-  // helpers //
-  _writeQuestionId(questionId) {
-    // capture question ID and register at context
-    if (!this._questionId && questionId) {
-      this._questionId = questionId;
-      this._context._byQid.set(questionId, this);
-    }
-  }
-
-  _clearQuestionId() {
-    // clear question id from previous session
-    if (this._questionId) {
-      this._context._byQid.delete(this._questionId);
-      this._questionId = undefined;
-    }
-  }
-
-  // destroy //
-  _destroy(options) {
-    const { next, parentQuestionId, questionId } = this;
-    if (next) {
-      next.destroy(options);
-    }
-    if (parentQuestionId) {
-      this._context._byPqid.delete(parentQuestionId);
-    }
-    if (questionId) {
-      this._context._byQid.delete(questionId);
-    }
-    super._destroy(options);
-  }
-
-}
-
-makeAutocompletable(Ask.prototype);