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

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
-});

package/dist/cjs/workflow/ask.js

@@ -1,319 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-var _answerBased = _interopRequireDefault(require("./answer-based.js"));
-var _index = require("../actor/index.js");
-var _constants = require("../constants.js");
-var _index2 = require("../layout/index.js");
-var _index3 = require("./options/index.js");
-var _processors = require("./processors.js");
-var _templates = require("../defaults/ask/templates.js");
-var _autocompletable = require("./autocompletable.js");
-const _excluded = ["q", "qs", "questionId"];
-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({}, _answerBased.default.DEFAULT_API_OPTIONS, {
-  name: _commons.API.NAME.QUESTIONS,
-  payload: Object.assign({}, _answerBased.default.DEFAULT_API_OPTIONS.payload, {
-    related_resource_fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at']
-  })
-}));
-const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_LAYOUTS, {
-  [_constants.ROLE.QUERY]: [_index2.SearchBoxLayout.type, {
-    templates: {
-      buttonIcon: 'send'
-    }
-  }],
-  [_constants.ROLE.REASONING]: _index2.TypewriterLayout.type,
-  [_constants.ROLE.RELATED_RESOURCES]: [_index2.ListLayout.type, {
-    incremental: true,
-    itemType: 'article'
-  }],
-  [_constants.ROLE.QUERY_SUGGESTIONS]: _index2.OptionListLayout.type,
-  [_constants.ROLE.FOLLOW_UP_QUESTIONS]: _index2.OptionListLayout.type
-}));
-const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_TRACKERS, {
-  [_constants.ROLE.RELATED_RESOURCES]: _index3.DEFAULT_TRACKER_OPTIONS,
-  [_constants.ROLE.QUERY_SUGGESTIONS]: Object.assign({}, _index3.DEFAULT_TRACKER_OPTIONS, {
-    click: Object.assign({}, _index3.DEFAULT_TRACKER_OPTIONS.click, {
-      validate: event => event.button === 0 // loosen criteria, for it's not a hyperlink
-    })
-  })
-}));
-const DEFAULT_TEMPLATES = Object.freeze({
-  followUp: _templates.followUp
-});
-const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
-  api: {
-    group: _commons.API.GROUP.ASK,
-    name: _commons.API.NAME.AUTOCOMPLETE
-  }
-});
-const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_OPTIONS, {
-  api: DEFAULT_API_OPTIONS,
-  layouts: DEFAULT_LAYOUTS,
-  trackers: DEFAULT_TRACKERS,
-  templates: DEFAULT_TEMPLATES,
-  autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS
-}));
-const ROLES_OPTIONS = (0, _index3.mergeRolesOptions)(_answerBased.default.ROLES_OPTIONS, {
-  members: Object.keys(DEFAULT_LAYOUTS),
-  mappings: {
-    [_constants.ROLE.QUERY_SUGGESTIONS]: _processors.mappingSuggestionsData,
-    [_constants.ROLE.FOLLOW_UP_QUESTIONS]: _processors.mappingFollowUpQuestionsData
-  }
-});
-class Ask extends _answerBased.default {
-  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;
-    (0, _commons.defineValues)(this, {
-      parentQuestionId
-    });
-  }
-  _initSubscriptions(args) {
-    super._initSubscriptions(args);
-    this._unsubscribes = [...this._unsubscribes, this._hub.on(_index.fields.view(_constants.ROLE.REASONING), state => this._onReasoningViewUpdate(state)), this._views.on(_constants.ROLE.ANSWER, 'follow-up-click', event => this._onFollowUpClick(event)), this._views.on(_constants.ROLE.FOLLOW_UP_QUESTIONS, 'select', event => this._onFollowUpQuestionSelect(event)), this._views.on(_constants.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(_ref = {}) {
-    let {
-        q,
-        qs,
-        questionId
-      } = _ref,
-      options = _objectWithoutPropertiesLoose(_ref, _excluded);
-    if (questionId) {
-      return (0, _commons.trimObj)(Object.assign({}, options, {
-        question_id: questionId
-        // TODO: specify this is a replayed session
-      }));
-    }
-    const {
-      parentQuestionId
-    } = this;
-    let payload = (0, _commons.trimObj)(Object.assign({}, options, {
-      question: q,
-      // question, not q
-      parent_question_id: parentQuestionId
-    }));
-    payload = (0, _processors.writeQuestionSourceToPayload)(Object.assign({}, 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(_constants.ROLE.QUERY_SUGGESTIONS)) {
-      view.refresh();
-    }
-  }
-
-  // view //
-  _onReasoningViewUpdate({
-    status,
-    ongoing
-  }) {
-    if (status !== _constants.STATUS.READY || ongoing) {
-      return;
-    }
-    for (const view of this._views.getAll(_constants.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 === _constants.ROLE.FOLLOW_UP_QUESTIONS || args.role === _constants.ROLE.QUERY_SUGGESTIONS) {
-      property = 'suggested_followup_questions';
-    }
-    if (args.role === _constants.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 (0, _commons.mergeInteractions)(payload, {
-      context: {
-        custom_context: (0, _commons.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: _constants.QUESTION_SOURCE.INLINE_QUESTION_LINK
-    });
-    // TODO: track click?
-  }
-  _onFollowUpQuestionSelect({
-    value: q
-  }) {
-    this._submitFollowUpQuestion({
-      q,
-      qs: _constants.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: _constants.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);
-  }
-}
-exports.default = Ask;
-(0, _autocompletable.makeAutocompletable)(Ask.prototype);