@miso.ai/client-sdk-ui 1.11.0-beta.8 → 1.11.0

package/dist/cjs/workflow/base.js

@@ -9,42 +9,47 @@ var _index = require("../actor/index.js");
 var sources = _interopRequireWildcard(require("../source.js"));
 var _constants = require("../constants.js");
 var _index2 = require("../layout/index.js");
-var _utils = require("./utils.js");
 var _options = require("./options.js");
 var _processors = require("./processors.js");
-const _excluded = ["layouts", "interactions"],
-  _excluded2 = ["custom_context"],
-  _excluded3 = ["context"];
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.includes(n)) continue; t[n] = r[n]; } return t; }
+// TODO: just bury this into hub
+function injectLogger(hub, callback) {
+  const {
+    update,
+    trigger
+  } = hub;
+  hub.update = (name, state, options) => {
+    if (!options || !options.silent) {
+      callback('update', name, state, options);
+    }
+    return update.call(hub, name, state, options);
+  };
+  hub.trigger = function () {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    callback('trigger', ...args);
+    return trigger.apply(hub, args);
+  };
+  return hub;
+}
+const DEFAULT_API_OPTIONS = Object.freeze({});
 const DEFAULT_LAYOUTS = Object.freeze({
   [_constants.ROLE.CONTAINER]: _index2.ContainerLayout.type,
   [_constants.ROLE.ERROR]: _index2.ErrorLayout.type
 });
-const ROLES_CONFIG = Object.freeze({
-  [_constants.ROLE.ERROR]: {
-    mapping: data => data.error
+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
   }
 });
-function mergeDefaults(workflow) {
-  let _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  let {
-      layouts,
-      interactions
-    } = _ref,
-    defaults = _objectWithoutPropertiesLoose(_ref, _excluded);
-  const DEFAULT_INTERACTIONS = {
-    preprocess: [payload => workflow._preprocessInteraction(payload)]
-  };
-  return Object.assign({}, defaults, {
-    layouts: (0, _options.mergeLayoutsOptions)(DEFAULT_LAYOUTS, layouts),
-    interactions: (0, _options.mergeInteractionsOptions)(DEFAULT_INTERACTIONS, interactions)
-  });
-}
-function getRevision(data) {
-  return data && data.value && data.value.revision;
-}
 class Workflow extends _commons.Component {
   constructor(args) {
     var _this;
@@ -65,23 +70,25 @@ class Workflow extends _commons.Component {
     }));
     this._name = args.name;
     this._roles = args.roles;
-    this._rolesConfig = Object.assign({}, ROLES_CONFIG, args.rolesConfig);
     this._extensions = plugin._getExtensions(client);
-    this._options = options || new _options.WorkflowOptions(context && context._options, mergeDefaults(this, args.defaults));
-    this._hub = (0, _utils.injectLogger)(new _index.Hub(), function () {
+    this._defaults = args.defaults;
+    this._options = options || new _options.WorkflowOptions(context && context._options, args.defaults);
+    this._hub = injectLogger(new _index.Hub(), function () {
       return _this._log(...arguments);
     });
     this._initProperties(args);
     this._initActors(args);
     this._initSubscriptions(args);
-    this._initReset(args);
+    this._initSession(args);
   }
   _initProperties() {}
-  _initActors() {
+  _initActors(_ref) {
+    let {
+      name,
+      roles
+    } = _ref;
     const hub = this._hub;
     const client = this._client;
-    const roles = this._roles;
-    const rolesConfig = this._rolesConfig;
     const options = this._options;
     const extensions = this._extensions;
     const layouts = this._plugin.layouts;
@@ -94,20 +101,25 @@ class Workflow extends _commons.Component {
       extensions,
       layouts,
       roles,
-      rolesConfig,
       options,
-      workflow: this._name
+      workflow: name
     });
     this._interactions = new _index.InteractionsActor(hub, {
       client,
       options
     });
   }
-  _initSubscriptions() {
-    this._unsubscribes = [this._hub.on(_index.fields.response(), data => this.updateData(data))];
+  _initSubscriptions(_ref2) {
+    let {
+      roles
+    } = _ref2;
+    this._unsubscribes = [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)));
+    }
   }
-  _initReset() {
-    this.reset();
+  _initSession() {
+    this.restart();
   }
   get uuid() {
     return this.session && this.session.uuid;
@@ -115,12 +127,6 @@ class Workflow extends _commons.Component {
   get session() {
     return this._hub.states[_index.fields.session()];
   }
-  get active() {
-    const {
-      session
-    } = this;
-    return !!session && session.active;
-  }
   get states() {
     return this._hub.states;
   }
@@ -133,20 +139,57 @@ class Workflow extends _commons.Component {
   }
 
   // lifecycle //
-  reset() {
-    this._sessions.new();
-    return this;
-  }
-  start() {
-    this._sessions.start();
-    return this;
-  }
   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);
+    }
+  }
+  _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);
+    }
+  }
+  _emitLifecycleEvent(name, event) {
+    this._emit(name, event);
+  }
+
+  // request //
+  _request() {
+    let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const {
+      session
+    } = this;
+    const event = (0, _options.mergeApiOptions)(this._options.resolved.api, Object.assign({}, options, {
+      session
+    }));
+    this._hub.update(_index.fields.request(), event);
+  }
 
-  // states //
+  // data //
   updateData(data) {
     if (!data) {
       throw new Error(`Data is required.`);
@@ -165,9 +208,9 @@ class Workflow extends _commons.Component {
     }
 
     // compare revision to omit outdated data, if any
-    const revision = getRevision(data);
+    const revision = (0, _processors.getRevision)(data);
     if (!(0, _commons.isNullLike)(revision)) {
-      const currentRevision = getRevision(this._hub.states[_index.fields.data()]);
+      const currentRevision = (0, _processors.getRevision)(this._hub.states[_index.fields.data()]);
       if (!(0, _commons.isNullLike)(currentRevision) && revision <= currentRevision) {
         return;
       }
@@ -176,8 +219,6 @@ class Workflow extends _commons.Component {
     return this;
   }
   _updateData(data) {
-    this._sessions.start(); // in case session not started yet
-
     data = this._defaultProcessData(data);
     for (const process of this._options.resolved.dataProcessor) {
       data = process(data);
@@ -193,23 +234,9 @@ class Workflow extends _commons.Component {
     this._hub.update(_index.fields.data(), data);
   }
 
-  /*
-  _mergeDataIfNecessary(data) {
-    if (!data._inst || !data._inst.merge) {
-      return data;
-    }
-    return {
-      ...this._hub.states[fields.data()],
-      ...data,
-    };
-  }
-   _handleResponseObject() {}
-  */
-
   // TODO: notifyViewUpdateAll()
 
   notifyViewUpdate(role, state) {
-    this._assertActive();
     state = Object.assign({
       status: _constants.STATUS.READY,
       session: this.session
@@ -222,30 +249,59 @@ class Workflow extends _commons.Component {
   get trackers() {
     return this._views.trackers;
   }
-
-  // TODO: extract to a separate function
-  _preprocessInteraction() {
-    let _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    let {
-        context: {
-          custom_context
-        } = {}
-      } = _ref2,
-      context = _objectWithoutPropertiesLoose(_ref2.context, _excluded2),
-      payload = _objectWithoutPropertiesLoose(_ref2, _excluded3);
+  _onTracker(args) {
+    const payload = this._buildInteraction(args);
+    this._sendInteraction(payload);
+  }
+  _buildInteraction(args) {
+    let payload = (0, _processors.buildBaseInteraction)(args);
+    payload = this._defaultProcessInteraction(payload, args);
     const {
-      group: api_group,
-      name: api_name
+      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.writeAffiliationInfoToInteraction)(payload, args);
+    return payload;
+  }
+  _writeApiInfoToInteraction(payload) {
+    const {
+      group,
+      name
     } = this._options.resolved.api;
-    return Object.assign({}, payload, {
-      context: Object.assign({}, context, {
-        custom_context: Object.assign({
-          api_group,
-          api_name
-        }, custom_context)
-      })
+    return (0, _processors.mergeInteraction)(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, _processors.mergeInteraction)(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) {
@@ -280,11 +336,13 @@ class Workflow extends _commons.Component {
       }, data));
     }
   }
-  _assertActive() {
-    if (!this.active) {
-      throw new Error(`Unit is not active yet. Call unit.start() to activate it.`);
-    }
-  }
 }
 exports.default = Workflow;
-(0, _options.makeConfigurable)(Workflow.prototype);
+(0, _options.makeConfigurable)(Workflow.prototype);
+Object.assign(Workflow, {
+  DEFAULT_API_OPTIONS,
+  DEFAULT_LAYOUTS,
+  DEFAULT_TRACKERS,
+  DEFAULT_OPTIONS,
+  ROLES_OPTIONS
+});

package/dist/cjs/workflow/explore.js

@@ -6,18 +6,19 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
 var _base = _interopRequireDefault(require("./base.js"));
-var _options = require("./options.js");
 var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
 var _index2 = require("../layout/index.js");
+var _options = require("./options.js");
+var _useLink = require("./use-link.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 (e.includes(n)) continue; t[n] = r[n]; } return t; }
-const DEFAULT_API_OPTIONS = Object.freeze({
+const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_API_OPTIONS, {
   group: _commons.API.GROUP.ASK,
   name: _commons.API.NAME.RELATED_QUESTIONS
-});
-const DEFAULT_LAYOUTS = Object.freeze({
+}));
+const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LAYOUTS, {
   [_constants.ROLE.RELATED_QUESTIONS]: [_index2.ListLayout.type, {
     itemType: 'question',
     link: {
@@ -27,18 +28,22 @@ const DEFAULT_LAYOUTS = Object.freeze({
   [_constants.ROLE.QUERY]: [_index2.SearchBoxLayout.type, {
     placeholder: 'Ask a question'
   }]
-});
-const DEFAULT_TRACKERS = Object.freeze({
+}));
+const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _base.default.DEFAULT_TRACKERS, {
   [_constants.ROLE.RELATED_QUESTIONS]: {},
   [_constants.ROLE.CONTAINER]: {},
   [_constants.ROLE.QUERY]: {
     [_constants.EVENT_TYPE.SUBMIT]: {}
   }
-});
-const DEFAULT_OPTIONS = Object.freeze({
+}));
+const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_OPTIONS, {
   api: DEFAULT_API_OPTIONS,
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS
+}));
+const ROLES_OPTIONS = (0, _options.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
+  main: _constants.ROLE.RELATED_QUESTIONS,
+  members: Object.keys(DEFAULT_LAYOUTS)
 });
 class Explore extends _base.default {
   constructor(plugin, client) {
@@ -46,7 +51,7 @@ class Explore extends _base.default {
       name: 'explore',
       plugin,
       client,
-      roles: Object.keys(DEFAULT_LAYOUTS),
+      roles: ROLES_OPTIONS,
       defaults: DEFAULT_OPTIONS
     });
   }
@@ -57,7 +62,7 @@ class Explore extends _base.default {
   }
   _initSubscriptions(args) {
     super._initSubscriptions(args);
-    this._unsubscribes = [...this._unsubscribes, this._views.get(_constants.ROLE.RELATED_QUESTIONS).on('click', event => this._handleRelatedQuestionClick(event)), this._hub.on(_index.fields.query(), payload => this.query(payload))];
+    this._unsubscribes = [...this._unsubscribes, this._views.get(_constants.ROLE.RELATED_QUESTIONS).on('click', event => this._handleRelatedQuestionClick(event)), this._hub.on(_index.fields.query(), args => this._query(args))];
   }
 
   // configuration //
@@ -76,34 +81,24 @@ class Explore extends _base.default {
     }
     return super.useApi(options);
   }
-  useLink(fn) {
-    if (typeof fn !== 'function' && fn !== false) {
-      throw new Error('useLink(fn) expects fn to be a function or false');
-    }
-    this._linkFn = fn;
-    return this;
-  }
 
   // lifecycle //
   start() {
     let {
       relatedQuestions = true
     } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    if (relatedQuestions && this._linkFn === undefined) {
-      throw new Error('Define link mapping function before calling start()');
+    if (this._linkFn === undefined) {
+      throw new Error('Must define link mapping function with useLink(fn) before calling start()');
     }
-    this._sessions.start();
     // in explore workflow, start() triggers query
     // TODO: we should still make the query lifecycle
-    const {
-      session
-    } = this;
     if (relatedQuestions) {
-      this._hub.update(_index.fields.request(), (0, _options.mergeApiOptions)(this._options.resolved.api, {
-        session
-      }));
+      this._request();
     } else {
       // TODO: ad-hoc
+      const {
+        session
+      } = this;
       this.updateData({
         session,
         request: {},
@@ -124,16 +119,24 @@ class Explore extends _base.default {
   }
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
-    let {
+    data = this._addUrlToRelatedQuestions(data);
+    return data;
+  }
+  _addUrlToRelatedQuestions(data) {
+    const {
       value
     } = data;
-    if (!value) {
+    if (!value || !value.related_questions) {
       return data;
     }
-    // patch value with links
-    const related_questions = value.related_questions.map(this._linkFn ? text => ({
+    const linkFn = this._linkFn && this._linkFn[0];
+    const related_questions = value.related_questions.map(linkFn ? text => ({
       text,
-      url: this._getAnswersUrl(text, true)
+      url: this._getSubmitUrl({
+        q: text
+      }, {
+        generated: true
+      })
     }) : text => ({
       text
     }));
@@ -152,26 +155,25 @@ class Explore extends _base.default {
       question
     })));
   }
-  query() {
-    let {
-      q
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    if (!this._linkFn) {
-      return;
+  query(args) {
+    if (!args.q) {
+      throw new Error(`q is required in query() call`);
     }
-    const url = this._getAnswersUrl(q);
-    window.open(url, '_blank');
+    this._hub.update(_index.fields.query(), args);
   }
-  _getAnswersUrl(text) {
-    let generated = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-    if (!this._linkFn) {
-      return;
-    }
-    const url = this._linkFn(text);
+  _query(args) {
+    this._submitToPage(args);
+  }
+  _getSubmitUrl(args) {
+    let {
+      generated = false
+    } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    let url = _useLink.UseLinkMixin.prototype._getSubmitUrl.call(this, args);
     if (!generated || !this._productId) {
       return url;
     }
     return `${url}&qs=${encodeURIComponent(this._productId)}`;
   }
 }
-exports.default = Explore;
+exports.default = Explore;
+(0, _useLink.enableUseLink)(Explore.prototype);

package/dist/cjs/workflow/hybrid-search-answer.js

@@ -6,13 +6,15 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _answerBased = _interopRequireDefault(require("./answer-based.js"));
 var _constants = require("../constants.js");
+var _options = require("./options.js");
 var _processors = require("./processors.js");
+var _autocompletable = require("./autocompletable.js");
 const _excluded = ["q", "qs"];
 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 (e.includes(n)) continue; t[n] = r[n]; } return t; }
-const ROLES_CONFIG = Object.freeze({
-  [_constants.ROLE.QUESTION]: {
-    mapping: _constants.ROLE.KEYWORDS
+const ROLES_OPTIONS = (0, _options.mergeRolesOptions)(_answerBased.default.ROLES_OPTIONS, {
+  mappings: {
+    [_constants.ROLE.QUESTION]: _constants.ROLE.KEYWORDS
   }
 });
 class HybridSearchAnswer extends _answerBased.default {
@@ -22,16 +24,17 @@ class HybridSearchAnswer extends _answerBased.default {
       plugin: superworkflow._plugin,
       client: superworkflow._client,
       options: superworkflow._options,
-      roles: Object.keys(_answerBased.default.DEFAULT_LAYOUTS),
-      rolesConfig: ROLES_CONFIG,
+      defaults: superworkflow._defaults,
+      roles: ROLES_OPTIONS,
       superworkflow
     });
   }
   _initProperties(args) {
     super._initProperties(args);
+    this._initAutocomplete(args);
     this._superworkflow = args.superworkflow;
   }
-  _initReset() {} // no reset here, will manually reset later
+  _initSession() {} // no reset here, will manually reset later
 
   restart() {
     super.restart();
@@ -85,5 +88,12 @@ class HybridSearchAnswer extends _answerBased.default {
       session: this._resultsSession
     }));
   }
+
+  // destroy //
+  _destroy(options) {
+    this._destroyAutocomplete();
+    super._destroy(options);
+  }
 }
-exports.default = HybridSearchAnswer;
+exports.default = HybridSearchAnswer;
+(0, _autocompletable.makeAutocompletable)(HybridSearchAnswer.prototype);