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

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

package/dist/cjs/workflow/asks.js

@@ -1,150 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _constants = require("../constants.js");
-var _context = _interopRequireDefault(require("./context.js"));
-var _ask = _interopRequireDefault(require("./ask.js"));
-var _index = require("./options/index.js");
-var _autocompletable = require("./autocompletable.js");
-const _excluded = ["root", "events"];
-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_AUTO_NEXT_OPTIONS = {
-  event: 'done'
-};
-function autoNextOptionsAsPredicate(options = DEFAULT_AUTO_NEXT_OPTIONS) {
-  if (options === true) {
-    options = DEFAULT_AUTO_NEXT_OPTIONS;
-  }
-  if (typeof options === 'string') {
-    options = {
-      event: options
-    };
-  }
-  switch (typeof options) {
-    case 'object':
-      // TODO: support more options
-      return event => event && options.event === event._event;
-    case 'function':
-      return options;
-    default:
-      return () => false;
-  }
-}
-class Asks extends _context.default {
-  constructor(plugin, client) {
-    super('asks', plugin, client);
-    this._initAutocompleteContext(); // must be earlier than root workflow
-    this._byQid = new Map();
-    this._byPqid = new Map();
-    this._root = new _ask.default(this); // initialize with default workflow
-    client._events.emit('postworkflow', this._root);
-    this._events.on('*', event => this._createNextIfNecessary(event));
-    this._events.on('loading', event => this._setActive(event.workflow));
-    this._events.on('destroy', () => this._requestEmitAfterDestroy());
-    this._events.on('after-destroy', () => this._syncActiveOnAfterDestroy());
-    this._autoNextFn = undefined;
-    this._active = this._root;
-  }
-  get root() {
-    return this._root;
-  }
-  get workflows() {
-    return [this._root, ...this._byPqid.values()];
-  }
-  get active() {
-    return this._active;
-  }
-  getByQuestionId(questionId) {
-    if (typeof questionId !== 'string') {
-      throw new Error(`Required ID to be a string: ${questionId}`);
-    }
-    return this._byQid.get(questionId);
-  }
-  getByParentQuestionId(parentQuestionId, {
-    autoCreate = false
-  } = {}) {
-    if (parentQuestionId === undefined) {
-      return this._root;
-    }
-    if (typeof parentQuestionId !== 'string') {
-      throw new Error(`Required ID to be a string: ${parentQuestionId}`);
-    }
-    let workflow = this._byPqid.get(parentQuestionId);
-    if (!workflow && autoCreate) {
-      workflow = new _ask.default(this, parentQuestionId);
-      this._client._events.emit('postworkflow', workflow);
-    }
-    return workflow;
-  }
-  reset(_ref = {}) {
-    let {
-        root = true,
-        events
-      } = _ref,
-      options = _objectWithoutPropertiesLoose(_ref, _excluded);
-    // clear event listeners on context
-    if (events === undefined) {
-      events = !!root; // events are default to be true only when root = true
-    }
-    if (events) {
-      this._events.clear();
-    }
-
-    // destroy all follow-up workflows
-    for (const workflow of this._byPqid.values()) {
-      workflow.destroy(options);
-    }
-
-    // reset root workflow
-    if (root) {
-      this._root.restart();
-    }
-  }
-  autoNext(options) {
-    this._autoNextFn = autoNextOptionsAsPredicate(options);
-  }
-  _createNextIfNecessary(event) {
-    if (!this._autoNextFn || !this._autoNextFn(event)) {
-      return;
-    }
-    const {
-      workflow
-    } = event;
-    workflow && workflow.getOrCreateNext();
-  }
-  _requestEmitAfterDestroy() {
-    if (this._emitAfterDestroyRequested) {
-      return;
-    }
-    this._emitAfterDestroyRequested = true;
-    setTimeout(() => {
-      this._emitAfterDestroyRequested = false;
-      this._events.emit('after-destroy', {});
-    }, 0);
-  }
-  _syncActiveOnAfterDestroy() {
-    if (!this._active.destroyed) {
-      return;
-    }
-    // find last non-initial workflow or root
-    let workflow = this._root;
-    for (; workflow.next && workflow.next.status !== _constants.STATUS.INITIAL; workflow = workflow.next) {}
-    this._setActive(workflow);
-  }
-  _setActive(workflow) {
-    if (workflow === this._active) {
-      return;
-    }
-    this._active = workflow;
-    this._events.emit('active', {
-      workflow
-    });
-  }
-}
-exports.default = Asks;
-(0, _index.makeConfigurable)(Asks.prototype, [_constants.WORKFLOW_CONFIGURABLE.TEMPLATES]);
-(0, _autocompletable.makeAutocompletableContext)(Asks.prototype);

package/dist/cjs/workflow/autocompletable.js

@@ -1,63 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.AutocompletableMixin = exports.AutocompletableContextMixin = void 0;
-exports.makeAutocompletable = makeAutocompletable;
-exports.makeAutocompletableContext = makeAutocompletableContext;
-var _commons = require("@miso.ai/commons");
-var _index = require("../actor/index.js");
-var _autocomplete = _interopRequireDefault(require("./autocomplete.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function makeAutocompletable(prototype) {
-  (0, _commons.mixin)(prototype, AutocompletableMixin.prototype);
-}
-function makeAutocompletableContext(prototype) {
-  (0, _commons.mixin)(prototype, AutocompletableContextMixin.prototype);
-}
-class AutocompletableMixin {
-  _initAutocomplete(args) {
-    this._autocomplete = new _autocomplete.default(this, {
-      defaults: args.defaults.autocomplete
-    });
-  }
-  get autocomplete() {
-    return this._autocomplete;
-  }
-  updateCompletions(data) {
-    this._hub.update(_index.fields.completions(), data);
-    return this;
-  }
-  _destroyAutocomplete() {
-    this._autocomplete && this._autocomplete._destroy();
-    this._autocomplete = undefined;
-  }
-}
-exports.AutocompletableMixin = AutocompletableMixin;
-class AutocompletableContextMixin {
-  _initAutocompleteContext() {
-    this._autocomplete = new AutocompleteContext(this);
-  }
-  get autocomplete() {
-    return this._autocomplete;
-  }
-}
-exports.AutocompletableContextMixin = AutocompletableContextMixin;
-class AutocompleteContext {
-  constructor(context) {
-    this._context = context;
-    this._active = false;
-  }
-
-  // API //
-  get enabled() {
-    return this._active;
-  }
-  enable() {
-    this._active = true;
-  }
-  disable() {
-    this._active = false;
-  }
-}

package/dist/cjs/workflow/autocomplete.js

@@ -1,120 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _constants = require("../constants.js");
-var _index = require("../actor/index.js");
-var _base = _interopRequireDefault(require("./base.js"));
-const _excluded = ["layouts", "trackers"],
-  _excluded2 = ["defaults"];
-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 ROLES_OPTIONS = Object.freeze({
-  members: []
-});
-function shimDefaults(_ref = {}) {
-  let options = _objectWithoutPropertiesLoose(_ref, _excluded);
-  return Object.assign({}, options, {
-    layouts: {},
-    trackers: {}
-  });
-}
-function sameInputValue(a, b) {
-  return getInputValue(a) === getInputValue(b);
-}
-function getInputValue(args) {
-  return args && args.value && args.value.trim() || undefined;
-}
-class Autocomplete extends _base.default {
-  constructor(superworkflow, _ref2 = {}) {
-    let {
-        defaults
-      } = _ref2,
-      args = _objectWithoutPropertiesLoose(_ref2, _excluded2);
-    super(Object.assign({
-      name: 'autocomplete',
-      plugin: superworkflow._plugin,
-      client: superworkflow._client,
-      defaults: shimDefaults(defaults),
-      roles: ROLES_OPTIONS,
-      superworkflow
-    }, args));
-    this._autocompleteContext = superworkflow && superworkflow._context && superworkflow._context.autocomplete;
-  }
-  _initProperties(args) {
-    super._initProperties(args);
-    this._superworkflow = args.superworkflow;
-    this._active = args.defaults.active;
-  }
-  _initSubscriptions(args) {
-    // TODO: how to sync options updates
-    super._initSubscriptions(args);
-    this._unsubscribes = [...this._unsubscribes, args.superworkflow._hub.on(_index.fields.input(), args => this._query(args))];
-  }
-
-  // API //
-  get enabled() {
-    return !!(this._active !== undefined ? this._active : this._autocompleteContext && this._autocompleteContext.enabled);
-  }
-  enable() {
-    this._active = true;
-  }
-  disable() {
-    this._active = false;
-  }
-
-  // query //
-  _query(args) {
-    if (!this.enabled || sameInputValue(args, this._args)) {
-      return;
-    }
-    this._args = args;
-
-    // start a new session
-    this.restart();
-    const {
-      session
-    } = this;
-    session.meta.input = args;
-
-    // if input value is blank, emit empty response
-    if (!getInputValue(args)) {
-      this._updateCompletions({
-        session,
-        status: _constants.STATUS.INITIAL
-      });
-      return;
-    }
-
-    // payload
-    const payload = this._buildPayload(args);
-
-    // request
-    this._request({
-      payload
-    });
-  }
-  _buildPayload(args) {
-    return {
-      q: getInputValue(args)
-    };
-  }
-
-  // data //
-  _updateDataInHub(data) {
-    if (data.value) {
-      data = Object.assign({}, data, {
-        value: data.value.completions
-      });
-    }
-    // update completion field in superworkflow hub
-    this._updateCompletions(data);
-  }
-  _updateCompletions(data) {
-    // TODO: session is different
-    this._superworkflow.updateCompletions(data);
-  }
-}
-exports.default = Autocomplete;