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

package/dist/cjs/workflow/base.js

@@ -1,418 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-var _index = require("../actor/index.js");
-var sources = _interopRequireWildcard(require("../source.js"));
-var _constants = require("../constants.js");
-var _index2 = require("../layout/index.js");
-var _index3 = require("./options/index.js");
-var _processors = require("./processors.js");
-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); }
-const DEFAULT_API_OPTIONS = Object.freeze({});
-const DEFAULT_LAYOUTS = Object.freeze({
-  [_constants.ROLE.CONTAINER]: _index2.ContainerLayout.type,
-  [_constants.ROLE.ERROR]: _index2.ErrorLayout.type
-});
-const DEFAULT_TRACKERS = Object.freeze({});
-const DEFAULT_OPTIONS = Object.freeze({
-  api: DEFAULT_API_OPTIONS,
-  layouts: DEFAULT_LAYOUTS,
-  trackers: DEFAULT_TRACKERS
-});
-const ROLES_OPTIONS = Object.freeze({
-  mappings: {
-    [_constants.ROLE.ERROR]: data => data.error
-  }
-});
-class Workflow extends _commons.Component {
-  constructor(args) {
-    super(args.name || 'workflow', args.plugin);
-    let {
-      context,
-      plugin,
-      client,
-      defaults,
-      options,
-      extraOptions
-    } = args;
-    this._context = context;
-    this._plugin = plugin = plugin || context._plugin;
-    this._client = client = client || context._client;
-    args = Object.freeze(Object.assign({}, args, {
-      plugin,
-      client
-    }));
-    this._name = args.name;
-    this._roles = args.roles;
-    this._extensions = plugin._getExtensions(client);
-    this._defaults = defaults;
-    this._options = options || new _index3.WorkflowOptions(context && context._options, defaults);
-    this._extraOptions = extraOptions || {};
-    this._hub = new _index.Hub({
-      onUpdate: event => this._onHubUpdate(event),
-      onEmit: event => this._onHubEmit(event)
-    });
-    this._sessionContext = new WeakMap();
-    this._pluginContext = {
-      processInteractionPasses: []
-    };
-    client._events.emit('workflow', this);
-    this._initProperties(args);
-    this._initActors(args);
-    this._initSubscriptions(args);
-    this._initSession(args);
-  }
-  _initProperties() {}
-  _initActors({
-    roles
-  }) {
-    const hub = this._hub;
-    const client = this._client;
-    const options = this._options;
-    const extensions = this._extensions;
-    const layouts = this._plugin.layouts;
-    this._sessions = new _index.SessionMaker(hub);
-    this._trackers = new _index.TrackersActor(hub, {
-      roles,
-      options
-    });
-    this._proxyTrackers = (0, _index.proxyTrackers)(this._trackers);
-    this._data = new _index.DataActor(hub, Object.assign({
-      source: sources.api(client),
-      options
-    }, this._extraOptions.api));
-    this._views = new _index.ViewsActor(hub, {
-      extensions,
-      layouts,
-      roles,
-      options,
-      workflow: this
-    });
-    this._interactions = new _index.InteractionsActor(hub, {
-      client,
-      options
-    });
-  }
-  _initSubscriptions({
-    roles
-  }) {
-    this._unsubscribes = [this._hub.on(_index.fields.session(), session => this._onSession(session)), this._hub.on(_index.fields.response(), data => this.updateData(data)), this._hub.on(_index.fields.tracker(), args => this._onTracker(args))];
-    if (roles.main) {
-      this._unsubscribes.push(this._hub.on(_index.fields.view(roles.main), state => this._onMainViewUpdate(state)));
-    }
-  }
-  _initSession() {
-    this.restart();
-  }
-  _getSessionContext(session) {
-    let context = this._sessionContext.get(session);
-    if (!context) {
-      this._sessionContext.set(session, context = {});
-    }
-    return context;
-  }
-
-  // hub //
-  _onHubUpdate(event) {
-    this._runCallbacks(this._client.meta.parent._hubUpdateCallbacks, event);
-  }
-  _onHubEmit(event) {
-    this._runCallbacks(this._client.meta.parent._hubEmitCallbacks, event);
-    this._emitAsWorkflowEvent(event);
-  }
-  _emitAsWorkflowEvent({
-    action: _action,
-    name,
-    state,
-    silent
-  }) {
-    if (!silent) {
-      this._emit(name, Object.assign({
-        _action
-      }, state));
-    }
-  }
-
-  // properties //
-  get uuid() {
-    // TODO: review this
-    return this.session && this.session.uuid;
-  }
-  get session() {
-    return this._hub.states[_index.fields.session()];
-  }
-  get states() {
-    return this._hub.states;
-  }
-  get status() {
-    const data = this._hub.states[_index.fields.data()];
-    return data && data.status;
-  }
-  get views() {
-    return this._views.interface;
-  }
-
-  // lifecycle //
-  restart() {
-    this._emitInterruptEventIfNecessary();
-    this._sessions.restart();
-    return this;
-  }
-  _emitInterruptEventIfNecessary() {
-    const {
-      main
-    } = this._roles;
-    if (!main) {
-      return;
-    }
-    const state = this._hub.states[_index.fields.view(main)] || {};
-    if (state.session && state.status === _constants.STATUS.LOADING) {
-      // it's interrupted by a new question
-      this._emitLifecycleEvent('interrupt', state);
-      this._emitLifecycleEvent('finally', state);
-    }
-  }
-  _onSession(session) {
-    this.updateData({
-      session
-    });
-  }
-  _onMainViewUpdate(state) {
-    const {
-      status
-    } = state;
-    const done = status === _constants.STATUS.READY;
-    const erroneous = status === _constants.STATUS.ERRONEOUS;
-    const eventName = erroneous ? 'error' : status;
-    this._emitLifecycleEvent(eventName, state);
-    if (done) {
-      this._emitLifecycleEvent('done', state);
-    }
-    if (done || erroneous) {
-      this._emitLifecycleEvent('finally', state);
-    }
-  }
-  _shallEmitLifecycleEvent(name, {
-    session
-  }) {
-    const context = this._getSessionContext(session);
-    const events = context.lifecycleEvents || (context.lifecycleEvents = new Set());
-    const emitted = events.has(name);
-    events.add(name);
-    return !emitted;
-  }
-  _emitLifecycleEvent(name, event) {
-    if (!this._shallEmitLifecycleEvent(name, event)) {
-      return;
-    }
-    this._emit(name, event);
-  }
-
-  // request //
-  _request(options = {}) {
-    this._writeRequestTimeToSession(Date.now(), options);
-    const {
-      session
-    } = this;
-    const request = (0, _index3.mergeApiOptions)(this._options.resolved.api, options);
-    this.updateData({
-      session,
-      request
-    });
-    this._hub.update(_index.fields.request(), Object.assign({}, request, {
-      session
-    }));
-  }
-  _writeRequestTimeToSession(timestamp, options) {
-    const {
-      session
-    } = this;
-    session.meta.requestAt = timestamp;
-  }
-
-  // data //
-  updateData(data) {
-    if (!data) {
-      throw new Error(`Data is required.`);
-    }
-    const {
-      session
-    } = data;
-    if (!session) {
-      throw new Error(`Session is required to update data.`);
-    }
-    if (!this.session) {
-      throw new Error(`No session is created yet. Call workflow.restart() to start a new session.`);
-    }
-    if (session.uuid !== this.session.uuid) {
-      return; // ignore data for old session or inactive session
-    }
-
-    // compare revision to omit outdated data, if any
-    const revision = (0, _processors.getRevision)(data);
-    if (!(0, _commons.isNullLike)(revision)) {
-      const currentRevision = (0, _processors.getRevision)(this._hub.states[_index.fields.data()]);
-      if (!(0, _commons.isNullLike)(currentRevision) && revision <= currentRevision) {
-        return;
-      }
-    }
-    this._updateData(data);
-    return this;
-  }
-  _updateData(data) {
-    const oldData = this._hub.states[_index.fields.data()];
-    data = this._defaultProcessData(data, oldData);
-    for (const process of this._options.resolved.dataProcessor) {
-      data = process(data, oldData);
-    }
-    this._updateDataInHub(data, oldData);
-  }
-  _defaultProcessData(data, oldData) {
-    data = (0, _processors.writeRequestFromPreviousData)(data, oldData);
-    data = (0, _processors.writeDataStatus)(data);
-    data = (0, _processors.writeMisoIdToMeta)(data);
-    return data;
-  }
-  _updateDataInHub(data) {
-    this._hub.update(_index.fields.data(), data);
-  }
-
-  // TODO: notifyViewUpdateAll()
-
-  notifyViewUpdate(role, state) {
-    state = Object.assign({
-      status: _constants.STATUS.READY,
-      session: this.session
-    }, state);
-    this._hub.update(_index.fields.view(role), state);
-    return this;
-  }
-
-  // trackers //
-  get trackers() {
-    return this._proxyTrackers;
-  }
-  _onTracker(args) {
-    const workflow = this;
-    const data = this._hub.states[_index.fields.data()];
-    const payload = this._buildInteraction(Object.assign({}, args, {
-      data,
-      workflow
-    }));
-    this._sendInteraction(payload);
-  }
-  _buildInteraction(args) {
-    let payload = (0, _processors.buildBaseInteraction)(args);
-    payload = this._defaultProcessInteraction(payload, args);
-    for (const p of this._pluginContext.processInteractionPasses) {
-      payload = p(payload, args);
-    }
-    const {
-      preprocess = []
-    } = this._options.resolved.interactions;
-    for (const p of preprocess) {
-      payload = p(payload, args);
-    }
-    return payload;
-  }
-  _defaultProcessInteraction(payload, args) {
-    payload = this._writeApiInfoToInteraction(payload, args);
-    payload = this._writeMisoIdToInteraction(payload, args);
-    payload = (0, _processors.writeSessionInfoToInteraction)(payload, args);
-    payload = (0, _processors.writeRequestInfoToInteraction)(payload, args);
-    payload = (0, _processors.writeRequestMetadataToInteraction)(payload, args);
-    payload = (0, _processors.writeAffiliationInfoToInteraction)(payload, args);
-    return payload;
-  }
-  _writeApiInfoToInteraction(payload) {
-    const {
-      group,
-      name
-    } = this._options.resolved.api;
-    return (0, _commons.mergeInteractions)(payload, {
-      context: {
-        custom_context: {
-          api_group: group,
-          api_name: name
-        }
-      }
-    });
-  }
-  _writeMisoIdToInteraction(payload, args) {
-    // TODO: ad-hoc, try to pass info from tracker
-    const state = this._hub.states[_index.fields.view(args.role)] || {};
-    const miso_id = state.meta && state.meta.miso_id || undefined;
-    return miso_id ? (0, _commons.mergeInteractions)(payload, {
-      miso_id
-    }) : payload;
-  }
-  _sendInteraction(payload) {
-    const {
-      handle
-    } = this._options.resolved.interactions;
-    if (typeof handle === 'function') {
-      handle(payload);
-    } else {
-      this._hub.trigger(_index.fields.interaction(), payload);
-    }
-  }
-
-  // destroy //
-  destroy(options) {
-    this._emit('destroy');
-    this._destroy(options);
-  }
-  get destroyed() {
-    return !!this._destroyed;
-  }
-  _destroy({
-    dom
-  } = {}) {
-    for (const unsubscribe of this._unsubscribes || []) {
-      unsubscribe();
-    }
-    this._unsubscribes = [];
-    this._views._destroy({
-      dom
-    });
-    this._data._destroy();
-    this._destroyed = true;
-  }
-
-  // helper //
-  _runCallbacks(callbacks, event) {
-    for (const callback of callbacks) {
-      try {
-        callback(Object.assign({
-          workflow: this
-        }, event));
-      } catch (e) {
-        this._error(e);
-      }
-    }
-  }
-  _emit(name, data) {
-    this._events.emit(name, Object.assign({
-      _event: name
-    }, data));
-    if (this._context) {
-      this._context._events.emit(name, Object.assign({
-        workflow: this,
-        _event: name
-      }, data));
-    }
-  }
-}
-exports.default = Workflow;
-(0, _index3.makeConfigurable)(Workflow.prototype);
-Object.assign(Workflow, {
-  DEFAULT_API_OPTIONS,
-  DEFAULT_LAYOUTS,
-  DEFAULT_TRACKERS,
-  DEFAULT_OPTIONS,
-  ROLES_OPTIONS
-});

package/dist/cjs/workflow/context.js

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-var _index = require("./options/index.js");
-class WorkflowContext extends _commons.Component {
-  constructor(name, plugin, client) {
-    super(name, plugin);
-    this._name = name;
-    this._plugin = plugin;
-    this._client = client;
-    this._options = new _index.WorkflowContextOptions();
-  }
-}
-exports.default = WorkflowContext;
-(0, _index.makeConfigurable)(WorkflowContext.prototype);

package/dist/cjs/workflow/explore.js

@@ -1,210 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-var _unit = _interopRequireDefault(require("./unit.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 _useLink = require("./use-link.js");
-var _autocompletable = require("./autocompletable.js");
-const _excluded = ["value"];
-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({}, _unit.default.DEFAULT_API_OPTIONS, {
-  group: _commons.API.GROUP.ASK,
-  name: _commons.API.NAME.RELATED_QUESTIONS
-}));
-const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _unit.default.DEFAULT_LAYOUTS, {
-  [_constants.ROLE.RELATED_QUESTIONS]: [_index2.ListLayout.type, {
-    itemType: 'question',
-    link: {
-      rel: 'noopener nofollow'
-    }
-  }],
-  // TODO: should define by useLink()
-  [_constants.ROLE.QUERY]: [_index2.SearchBoxLayout.type, {
-    placeholder: 'Ask a question'
-  }]
-}));
-const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _unit.default.DEFAULT_TRACKERS, {
-  [_constants.ROLE.RELATED_QUESTIONS]: _index3.DEFAULT_TRACKER_OPTIONS,
-  [_constants.ROLE.CONTAINER]: Object.assign({}, _index3.DEFAULT_TRACKER_OPTIONS, {
-    itemless: true
-  }),
-  [_constants.ROLE.QUERY]: {
-    [_constants.EVENT_TYPE.SUBMIT]: {
-      active: true
-    }
-  }
-}));
-const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
-  api: {
-    group: _commons.API.GROUP.ASK,
-    name: _commons.API.NAME.QUERY_SUGGESTION
-  }
-});
-const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _unit.default.DEFAULT_OPTIONS, {
-  api: DEFAULT_API_OPTIONS,
-  layouts: DEFAULT_LAYOUTS,
-  trackers: DEFAULT_TRACKERS,
-  autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS
-}));
-const ROLES_OPTIONS = (0, _index3.mergeRolesOptions)(_unit.default.ROLES_OPTIONS, {
-  main: _constants.ROLE.RELATED_QUESTIONS,
-  members: Object.keys(DEFAULT_LAYOUTS)
-});
-class Explore extends _unit.default {
-  constructor(context, id) {
-    super({
-      name: 'explore',
-      context,
-      roles: ROLES_OPTIONS,
-      defaults: DEFAULT_OPTIONS,
-      id
-    });
-  }
-  _initProperties(args) {
-    super._initProperties(args);
-    this._initAutocomplete(args);
-    this._productId = undefined;
-    this._linkFn = undefined;
-  }
-  _initSubscriptions(args) {
-    super._initSubscriptions(args);
-    this._unsubscribes = [...this._unsubscribes, this._views.on(_constants.ROLE.RELATED_QUESTIONS, 'click', event => this._handleRelatedQuestionClick(event)), this._hub.on(_index.fields.query(), args => this._query(args))];
-  }
-
-  // configuration //
-  set productId(value) {
-    console.warning('DEPRECATED: use useApi() instead');
-    this.useApi({
-      product_id: value
-    });
-  }
-  useApi(...args) {
-    const options = (typeof args[0] === 'object' ? args[0] : args[1]) || {};
-    const {
-      product_id
-    } = options;
-    if (product_id) {
-      this._productId = product_id;
-    }
-    return super.useApi(...args);
-  }
-  useLink(fn, options) {
-    _useLink.UseLinkMixin.prototype.useLink.call(this, fn, options);
-    // also put options to layouts
-    if (options) {
-      this.useLayouts({
-        [_constants.ROLE.RELATED_QUESTIONS]: {
-          link: options
-        }
-      });
-    }
-    return this;
-  }
-
-  // lifecycle //
-  start({
-    relatedQuestions = true
-  } = {}) {
-    if (this._linkFn === undefined) {
-      throw new Error('Must define link mapping function with useLink(fn) before calling start()');
-    }
-    // in explore workflow, start() triggers query
-    // TODO: we should still make the query lifecycle
-    if (relatedQuestions) {
-      this._request();
-    } else {
-      // TODO: ad-hoc
-      const {
-        session
-      } = this;
-      this.updateData({
-        session,
-        request: {},
-        value: {
-          related_questions: []
-        }
-      });
-    }
-    return this;
-  }
-  notifyViewUpdate(role = _constants.ROLE.RELATED_QUESTIONS, ...args) {
-    super.notifyViewUpdate(role, ...args);
-    return this;
-  }
-  _defaultProcessData(data, oldData) {
-    data = super._defaultProcessData(data, oldData);
-    data = this._addUrlToRelatedQuestions(data);
-    return data;
-  }
-  _addUrlToRelatedQuestions(data) {
-    const {
-      value
-    } = data;
-    if (!value || !value.related_questions) {
-      return data;
-    }
-    const [linkFn, linkOptions = {}] = this._linkFn || [];
-    const getDisplayedUrl = text => linkFn && linkOptions.showUrl ? this._getSubmitUrl({
-      q: text,
-      generated: true
-    }) : '#';
-    const related_questions = value.related_questions.map(text => ({
-      text,
-      url: getDisplayedUrl(text)
-    }));
-    return Object.assign({}, data, {
-      value: Object.assign({}, value, {
-        related_questions
-      })
-    });
-  }
-  _handleRelatedQuestionClick(_ref) {
-    let {
-        value: question
-      } = _ref,
-      event = _objectWithoutPropertiesLoose(_ref, _excluded);
-    this._events.emit('select', Object.freeze(Object.assign({}, event, {
-      question
-    })));
-    const [linkFn, linkOptions = {}] = this._linkFn || [];
-    if (!linkFn || !linkOptions.showUrl) {
-      event.domEvent && event.domEvent.preventDefault();
-    }
-    if (linkFn && !linkOptions.showUrl) {
-      this._submitToPage({
-        q: question.text,
-        generated: true
-      });
-    }
-  }
-  query(args) {
-    if (!args.q) {
-      throw new Error(`q is required in query() call`);
-    }
-    this._hub.update(_index.fields.query(), args);
-  }
-  _query(args) {
-    this._submitToPage(Object.assign({}, args, {
-      generated: false
-    }));
-  }
-  _getSubmitUrl(args) {
-    // TODO: if trending_questions -> qs = '_trending'
-    let url = _useLink.UseLinkMixin.prototype._getSubmitUrl.call(this, args);
-    if (!args.generated || !this._productId) {
-      return url;
-    }
-    return `${url}&qs=${encodeURIComponent(this._productId)}`;
-  }
-}
-exports.default = Explore;
-(0, _useLink.enableUseLink)(Explore.prototype);
-(0, _autocompletable.makeAutocompletable)(Explore.prototype);

package/dist/cjs/workflow/explores.js

@@ -1,21 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _units = _interopRequireDefault(require("./units.js"));
-var _explore = _interopRequireDefault(require("./explore.js"));
-var _autocompletable = require("./autocompletable.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class Explores extends _units.default {
-  constructor(plugin, client) {
-    super('explores', plugin, client);
-    this._initAutocompleteContext();
-  }
-  _create(unitId) {
-    return new _explore.default(this, unitId);
-  }
-}
-exports.default = Explores;
-(0, _autocompletable.makeAutocompletableContext)(Explores.prototype);