@miso.ai/client-sdk-ui 1.10.3-beta.0 → 1.10.4-beta.0

package/dist/cjs/workflow/ask.js

@@ -5,112 +5,94 @@ 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 sources = _interopRequireWildcard(require("../source/index.js"));
-var _index2 = require("../actor/index.js");
+var _answerBased = _interopRequireDefault(require("./answer-based.js"));
+var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
-var _index3 = require("../layout/index.js");
-var _index4 = require("../affiliation/index.js");
+var _index2 = require("../layout/index.js");
 const _excluded = ["q", "qs"];
-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 _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _objectDestructuringEmpty(t) { if (null == t) throw new TypeError("Cannot destructure " + t); }
 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({
-  group: _commons.API.GROUP.ASK,
+const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_API_OPTIONS, {
   name: _commons.API.NAME.QUESTIONS,
-  payload: {
-    source_fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at'],
-    related_resource_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({
-  [_constants.ROLE.QUERY]: [_index3.SearchBoxLayout.type, {
-    placeholder: 'Ask a question'
-  }],
-  [_constants.ROLE.QUESTION]: [_index3.TextLayout.type, {
-    tag: 'h2'
-  }],
-  [_constants.ROLE.ANSWER]: _index3.TypewriterLayout.type,
-  [_constants.ROLE.FEEDBACK]: _index3.FeedbackLayout.type,
-  [_constants.ROLE.SOURCES]: [_index3.ListLayout.type, {
-    incremental: true,
-    itemType: 'article',
-    templates: {
-      ordered: true
-    }
-  }],
-  [_constants.ROLE.RELATED_RESOURCES]: [_index3.ListLayout.type, {
+  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.RELATED_RESOURCES]: [_index2.ListLayout.type, {
     incremental: true,
     itemType: 'article'
   }],
-  [_constants.ROLE.QUERY_SUGGESTIONS]: _index3.OptionListLayout.type,
-  [_constants.ROLE.AFFILIATION]: [_index3.AffiliationLayout.type, {
-    incremental: true,
-    itemType: 'affiliation',
-    link: {
-      rel: 'noopener nofollow'
-    }
-  }]
-});
-const DEFAULT_TRACKERS = Object.freeze({
-  [_constants.ROLE.SOURCES]: {},
+  [_constants.ROLE.QUERY_SUGGESTIONS]: _index2.OptionListLayout.type
+}));
+const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_TRACKERS, {
   [_constants.ROLE.RELATED_RESOURCES]: {},
-  [_constants.ROLE.AFFILIATION]: {},
   [_constants.ROLE.QUERY_SUGGESTIONS]: {
     click: {
       validate: event => event.button === 0 // left click only
     }
   }
-});
-const DEFAULT_OPTIONS = Object.freeze({
+}));
+const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_OPTIONS, {
   api: DEFAULT_API_OPTIONS,
-  autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS,
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS
-});
-class Ask extends _base.default {
+}));
+class Ask extends _answerBased.default {
   constructor(context, parentQuestionId) {
     super({
       name: 'ask',
       context,
       roles: Object.keys(DEFAULT_LAYOUTS),
-      defaults: DEFAULT_OPTIONS
+      defaults: DEFAULT_OPTIONS,
+      parentQuestionId
     });
-    this._context = context;
-    this._autoQuery = false;
+  }
+  _initProperties(args) {
+    super._initProperties(args);
+    const {
+      parentQuestionId
+    } = args;
     (0, _commons.defineValues)(this, {
       parentQuestionId
     });
-    this._feedback = new _index2.FeedbackActor(this._hub);
+  }
+  _initSubscriptions(args) {
     this._setSuggestedQuestions();
-
-    /*
-    this._autocomplete = new AutocompleteActor(this._hub, {
-      source: sources.api(this._client),
-      options: this._options,
+    super._initSubscriptions(args);
+  }
+  _setSuggestedQuestions() {
+    const {
+      previous
+    } = this;
+    if (!previous) {
+      return;
+    }
+    const values = previous.states[_index.fields.data()].value;
+    const value = values.suggested_followup_questions || values.followup_questions || [];
+    this._hub.update(_index.fields.suggestions(), {
+      value: value.map(text => ({
+        text
+      }))
     });
-    */
-
-    this._unsubscribes = [...this._unsubscribes, this._hub.on(_index2.fields.query(), payload => this.query(payload)), this._hub.on(_index2.fields.view(_constants.ROLE.ANSWER), data => this._onAnswerViewUpdate(data)), this._views.get(_constants.ROLE.ANSWER).on('citation-click', event => this._onCitationClick(event))];
-    parentQuestionId && context._byPqid.set(parentQuestionId, this);
-    context._events.emit('create', this);
-    this.reset(); // create a session so query suggestions can be tracked
   }
-  get questionId() {
-    return this._questionId;
+  _initReset(args) {
+    // register at context
+    args.parentQuestionId && this._context._byPqid.set(args.parentQuestionId, this);
+    this._context._events.emit('create', this);
+    super._initReset(args);
+  }
+
+  // lifecycle //
+  restart() {
+    if (this._questionId) {
+      this._context._byQid.delete(this._questionId);
+    }
+    super.restart();
   }
+
+  // properties //
   get rootQuestionId() {
     return this._context.root.questionId;
   }
@@ -135,227 +117,73 @@ class Ask extends _base.default {
     }) : undefined;
   }
 
-  // lifecycle //
-  autoQuery() {
-    let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    const {
-      setValue = true,
-      focus = true
-    } = this._autoQuery = options;
-    const searchParams = new URLSearchParams(window.location.search);
-    const q = searchParams.get('q');
-    const qs = searchParams.get('qs');
-    const {
-      layout
-    } = this._views.get(_constants.ROLE.QUERY);
-    if (layout) {
-      if (q && setValue) {
-        layout.value = q;
-      }
-      if (!q && focus) {
-        layout.focus();
-      }
-    }
-    if (q) {
-      this.query({
-        q,
-        qs
-      });
-    }
-  }
-  query() {
+  // query //
+  _buildPayload() {
     let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     let {
-        q: question,
-        qs: questionSource
+        q,
+        qs
       } = _ref,
       payload = _objectWithoutPropertiesLoose(_ref, _excluded);
-    payload = Object.assign({}, payload, {
-      question
-    });
-    questionSource = questionSource || _constants.ORGANIC_QUESTION_SOURCE;
-    if (this.parentQuestionId) {
-      payload.parent_question_id = this.parentQuestionId;
-    }
-    (payload._meta || (payload._meta = {})).question_source = questionSource;
-
-    // clear question id from previous session
-    if (this._questionId) {
-      this._context._byQid.delete(this._questionId);
-      this._questionId = undefined;
-    }
-    this.restart();
     const {
-      session
+      parentQuestionId
     } = this;
-    session.meta.question_source = questionSource;
-    this._hub.update(_index2.fields.request(), (0, _options.mergeApiOptions)(this._options.resolved.api, {
-      payload,
-      session
+    return (0, _commons.trimObj)(Object.assign({}, payload, {
+      question: q,
+      // question, not q
+      parent_question_id: parentQuestionId,
+      _meta: Object.assign({}, payload._meta, {
+        question_source: qs || _constants.ORGANIC_QUESTION_SOURCE // might be null, not undefined
+      })
     }));
-    return this;
-  }
-  restart() {
-    // TODO: move to workflow base
-    const {
-      session,
-      status,
-      ongoing
-    } = this._hub.states[_index2.fields.view(_constants.ROLE.ANSWER)] || {};
-    if (session && status !== _constants.STATUS.INITIAL && (status !== _constants.STATUS.READY || ongoing)) {
-      // it's interrupted by a new question
-      const state = Object.freeze({
-        session,
-        status,
-        ongoing
-      });
-      this._emit('interrupt', state);
-      this._emit('finally', state);
-    }
-    super.restart();
-  }
-
-  /*
-  updateCompletions(event) {
-    // TODO: verify
-    this._hub.update(fields.completions(), {
-      ...event,
-      source: 'manual',
-    });
-    return this;
   }
-  */
-
-  _defaultProcessData(data) {
-    data = super._defaultProcessData(data);
-    const {
-      value,
-      request
-    } = data;
-    if (!value) {
-      return data;
-    }
-    const {
-      question_id: questionId,
-      question
-    } = value;
-    const organic = request && request.payload && request.payload._meta && request.payload._meta.question_source === _constants.ORGANIC_QUESTION_SOURCE;
-
-    // capture question ID and register at context
-    if (!this._questionId && questionId) {
-      this._questionId = questionId;
-      this._context._byQid.set(questionId, this);
-    }
 
-    // update URL if autoQuery.updateUrl is not false
-    if (this._autoQuery && this._autoQuery.updateUrl !== false) {
-      const url = new URL(window.location);
-      const currentQuestion = url.searchParams.get('q');
-      // TODO: review this, handle &s=
-      if (question !== currentQuestion && (!organic || this._autoQuery.updateUrl === true)) {
-        url.searchParams.set('q', question);
-        window.history.replaceState({}, '', url);
-      }
-    }
-
-    // affiliation
-    data = (0, _index4.processData)(data);
-
-    // 1. put answer_stage to meta
-    // 2. mark ongoing flag
-    return Object.assign({}, data, {
-      ongoing: !value.finished,
-      meta: Object.assign({}, data.meta, {
-        answer_stage: value.answer_stage
-      })
-    });
-  }
-  _onAnswerViewUpdate(_ref2) {
-    let {
-      session,
-      status,
-      ongoing
-    } = _ref2;
-    if (status === _constants.STATUS.INITIAL) {
-      return;
-    }
-    const done = status === _constants.STATUS.READY && !ongoing;
-    const erroneous = status === _constants.STATUS.ERRONEOUS;
-    const eventName = done ? 'done' : erroneous ? 'error' : status;
-    const state = Object.freeze({
-      session,
-      status,
-      ongoing
-    });
-    this._emit(eventName, state);
-    if (done || erroneous) {
-      this._emit('finally', state);
-    }
-  }
-  _setSuggestedQuestions() {
-    const {
-      previous
-    } = this;
-    if (!previous) {
-      return;
-    }
-    const values = previous.states[_index2.fields.data()].value;
-    const value = values.suggested_followup_questions || values.followup_questions || [];
-    this._hub.update(_index2.fields.suggestions(), {
-      value: value.map(text => ({
-        text
-      }))
-    });
-  }
-  _onCitationClick(_ref3) {
-    let {
-      index
-    } = _ref3;
-    const {
-      value
-    } = this.states[_index2.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?
-    this._trackers.sources.click([source.product_id], {
-      manual: false
-    });
-  }
+  // interactions //
   _preprocessInteraction(payload) {
     payload = super._preprocessInteraction(payload) || {};
     const {
       context = {}
     } = payload;
-    const {
-      custom_context = {}
-    } = context;
+    const _ref2 = context.custom_context || {},
+      custom_context = Object.assign({}, (_objectDestructuringEmpty(_ref2), _ref2));
     let {
       rootQuestionId,
       parentQuestionId,
       questionId
     } = this;
-    // when we track suggested questions, we are actually tracking the suggested_followup_questions of the previous workflow
     if (custom_context.property === _constants.ROLE.QUERY_SUGGESTIONS) {
       questionId = parentQuestionId;
       parentQuestionId = this.previous && this.previous.parentQuestionId;
       custom_context.property = 'suggested_followup_questions';
       custom_context.question_source = this.previous && this.previous.session.meta.question_source;
     }
-    payload.context = Object.assign({}, context, {
-      custom_context: (0, _commons.trimObj)(Object.assign({
-        root_question_id: rootQuestionId,
-        parent_question_id: parentQuestionId,
-        question_id: questionId
-      }, custom_context))
+    custom_context.question_id = questionId;
+    custom_context.root_question_id = rootQuestionId;
+    custom_context.parent_question_id = parentQuestionId;
+    return Object.assign({}, payload, {
+      context: Object.assign({}, context, {
+        custom_context: (0, _commons.trimObj)(custom_context)
+      })
     });
-    return payload;
   }
+
+  // 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 {
       parentQuestionId,
@@ -367,7 +195,6 @@ class Ask extends _base.default {
     if (questionId) {
       this._context._byQid.delete(questionId);
     }
-    this._feedback._destroy();
     super._destroy(options);
   }
 }

package/dist/cjs/workflow/base.js

@@ -6,11 +6,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
 var _index = require("../actor/index.js");
-var sources = _interopRequireWildcard(require("../source/index.js"));
+var sources = _interopRequireWildcard(require("../source.js"));
 var _constants = require("../constants.js");
-var _index3 = require("../layout/index.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"];
@@ -18,8 +19,13 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 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; }
 const DEFAULT_LAYOUTS = Object.freeze({
-  [_constants.ROLE.CONTAINER]: _index3.ContainerLayout.type,
-  [_constants.ROLE.ERROR]: _index3.ErrorLayout.type
+  [_constants.ROLE.CONTAINER]: _index2.ContainerLayout.type,
+  [_constants.ROLE.ERROR]: _index2.ErrorLayout.type
+});
+const ROLES_CONFIG = Object.freeze({
+  [_constants.ROLE.ERROR]: {
+    mapping: data => data.error
+  }
 });
 function mergeDefaults(workflow) {
   let _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -40,29 +46,44 @@ function getRevision(data) {
   return data && data.value && data.value.revision;
 }
 class Workflow extends _commons.Component {
-  constructor(_ref2) {
+  constructor(args) {
     var _this;
+    super(args.name || 'workflow', args.plugin);
+    _this = this;
     let {
-      name,
       context,
       plugin,
-      client,
-      roles,
-      defaults
-    } = _ref2;
-    super(name || 'workflow', plugin);
-    _this = this;
+      client
+    } = args;
     this._context = context;
     this._plugin = plugin = plugin || context._plugin;
     this._client = client = client || context._client;
-    this._name = name;
-    this._roles = roles;
-    const extensions = this._extensions = plugin._getExtensions(client);
-    const options = this._options = new _options.WorkflowOptions(context && context._options, mergeDefaults(this, defaults));
-    const hub = this._hub = (0, _utils.injectLogger)(new _index.Hub(), function () {
+    args = Object.freeze(Object.assign({}, args, {
+      plugin,
+      client
+    }));
+    this._name = args.name;
+    this._roles = args.roles;
+    this._rolesConfig = Object.assign({}, ROLES_CONFIG, args.rolesConfig);
+    this._extensions = plugin._getExtensions(client);
+    this._options = new _options.WorkflowOptions(context && context._options, mergeDefaults(this, args.defaults));
+    this._hub = (0, _utils.injectLogger)(new _index.Hub(), function () {
       return _this._log(...arguments);
     });
-    const layouts = plugin.layouts;
+    this._initProperties(args);
+    this._initActors(args);
+    this._initSubscriptions(args);
+    this._initReset(args);
+  }
+  _initProperties() {}
+  _initActors() {
+    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;
     this._sessions = new _index.SessionMaker(hub);
     this._data = new _index.DataActor(hub, {
       source: sources.api(client),
@@ -72,15 +93,21 @@ class Workflow extends _commons.Component {
       extensions,
       layouts,
       roles,
+      rolesConfig,
       options,
-      workflow: name
+      workflow: this._name
     });
     this._interactions = new _index.InteractionsActor(hub, {
       client,
       options
     });
+  }
+  _initSubscriptions() {
     this._unsubscribes = [this._hub.on(_index.fields.response(), data => this.updateData(data))];
   }
+  _initReset() {
+    this.reset();
+  }
   get uuid() {
     return this.session && this.session.uuid;
   }
@@ -96,6 +123,10 @@ class Workflow extends _commons.Component {
   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;
   }
@@ -110,13 +141,15 @@ class Workflow extends _commons.Component {
     return this;
   }
   restart() {
-    this.reset();
-    this.start();
+    this._sessions.restart();
     return this;
   }
 
   // states //
   updateData(data) {
+    let {
+      instructions
+    } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
     if (!data) {
       throw new Error(`Data is required.`);
     }
@@ -143,27 +176,28 @@ class Workflow extends _commons.Component {
     }
     this._sessions.start(); // in case session not started yet
 
+    data = (0, _processors.writeDataStatus)(data);
     data = this._defaultProcessData(data);
     for (const process of this._options.resolved.dataProcessor) {
       data = process(data);
     }
+
+    // write data instructions from function args
+    data = (0, _processors.addDataInstructions)(data, instructions);
+    data = this._mergeDataIfNecessary(data);
     this._hub.update(_index.fields.data(), data);
     return this;
   }
   _defaultProcessData(data) {
-    const {
-      value
-    } = data;
-    // put miso_id to meta
-    if (!value || !value.miso_id) {
+    return (0, _processors.writeMisoIdToMeta)(data);
+  }
+  _mergeDataIfNecessary(data) {
+    if (!data._inst || !data._inst.merge) {
       return data;
     }
-    return Object.assign({}, data, {
-      meta: Object.assign({}, data.meta, {
-        miso_id: value.miso_id
-      })
-    });
+    return Object.assign({}, this._hub.states[_index.fields.data()], data);
   }
+  _handleResponseObject() {}
 
   // TODO: notifyViewUpdateAll()
 
@@ -182,14 +216,14 @@ class Workflow extends _commons.Component {
     return this._views.trackers;
   }
   _preprocessInteraction() {
-    let _ref3 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    let _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     let {
         context: {
           custom_context
         } = {}
-      } = _ref3,
-      context = _objectWithoutPropertiesLoose(_ref3.context, _excluded2),
-      payload = _objectWithoutPropertiesLoose(_ref3, _excluded3);
+      } = _ref2,
+      context = _objectWithoutPropertiesLoose(_ref2.context, _excluded2),
+      payload = _objectWithoutPropertiesLoose(_ref2, _excluded3);
     const {
       group: api_group,
       name: api_name

package/dist/cjs/workflow/explore.js

@@ -49,10 +49,18 @@ class Explore extends _base.default {
       roles: Object.keys(DEFAULT_LAYOUTS),
       defaults: DEFAULT_OPTIONS
     });
+  }
+  _initProperties(args) {
+    super._initProperties(args);
     this._productId = undefined;
     this._linkFn = undefined;
+  }
+  _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))];
   }
+
+  // configuration //
   set productId(value) {
     console.warning('DEPRECATED: use useApi() instead');
     this.useApi({
@@ -95,8 +103,10 @@ class Explore extends _base.default {
         session
       }));
     } else {
+      // TODO: ad-hoc
       this.updateData({
         session,
+        request: {},
         value: {
           related_questions: []
         }