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

package/dist/cjs/layout/triggerable.js

@@ -0,0 +1,79 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TriggerableMixin = void 0;
+exports.makeTriggerable = makeTriggerable;
+var _commons = require("@miso.ai/commons");
+var _constants = require("../constants.js");
+var _index = require("../actor/index.js");
+function makeTriggerable(prototype) {
+  (0, _commons.mixin)(prototype, TriggerableMixin.prototype);
+}
+class TriggerableMixin {
+  _initTriggerable() {
+    this._trigger = undefined;
+  }
+  _syncTrigger(element, state) {
+    if (!this.options.infiniteScroll) {
+      return;
+    }
+    const workflowPaginationOptions = this.workflowOptions.pagination;
+    if (!workflowPaginationOptions.active || workflowPaginationOptions.mode !== 'infiniteScroll') {
+      return;
+    }
+    // only track trigger when ready
+    if (state.status === _constants.STATUS.READY) {
+      this._trackTrigger(element);
+    } else {
+      this._untrackTrigger();
+    }
+  }
+  async _trackTrigger(element) {
+    if (this._trigger) {
+      return;
+    }
+    const triggerElement = element.querySelector('[data-role="trigger"]');
+    if (!triggerElement) {
+      return;
+    }
+    const ac = new AbortController();
+    this._trigger = Object.freeze({
+      element: triggerElement,
+      ac
+    });
+    let result = false;
+    try {
+      await (0, _commons.viewable)(triggerElement, {
+        area: 1,
+        duration: 0,
+        signal: ac.signal
+      });
+      result = true;
+    } catch (e) {
+      if (e.name !== 'AbortError') {
+        throw e;
+      }
+    } finally {
+      this._trigger = undefined;
+    }
+    if (result) {
+      this._onTrigger();
+    }
+  }
+  _onTrigger() {
+    this._view.hub.trigger(_index.fields.more());
+  }
+  _untrackTrigger() {
+    if (!this._trigger) {
+      return;
+    }
+    this._trigger.ac && this._trigger.ac.abort();
+    this._trigger = undefined;
+  }
+  _destroyTriggerable() {
+    this._untrackTrigger();
+  }
+}
+exports.TriggerableMixin = TriggerableMixin;

package/dist/cjs/util/states.js

@@ -15,21 +15,6 @@ const {
   UNTRACKED,
   TRIGGERED
 } = _constants.TRACKING_STATUS;
-
-/*
-const STATES = {
-  NEW: Object.freeze({
-    [IMPRESSION]: UNTRACKED,
-    [VIEWABLE]: UNTRACKED,
-  }),
-  UNTRACKED: Object.freeze({
-    [IMPRESSION]: UNTRACKED,
-    [VIEWABLE]: UNTRACKED,
-    [CLICK]: UNTRACKED,
-  }),
-};
-*/
-
 const UNTRACKED_STATES = Object.freeze({
   [IMPRESSION]: UNTRACKED,
   [VIEWABLE]: UNTRACKED,

package/dist/cjs/version.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = exports.default = '1.11.0-beta.8';
+var _default = exports.default = '1.11.0';

package/dist/cjs/workflow/answer-based.js

@@ -6,24 +6,23 @@ 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 _index3 = require("../affiliation/index.js");
+var _options = require("./options.js");
 var _processors = require("./processors.js");
+var _useLink = require("./use-link.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// import * as sources from '../source.js';
-
-const DEFAULT_API_OPTIONS = Object.freeze({
+const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_API_OPTIONS, {
   group: _commons.API.GROUP.ASK,
-  payload: {
+  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: {
@@ -31,7 +30,7 @@ const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
     name: _commons.API.NAME.AUTOCOMPLETE
   }
 });
-const DEFAULT_LAYOUTS = Object.freeze({
+const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LAYOUTS, {
   [_constants.ROLE.QUERY]: [_index2.SearchBoxLayout.type, {
     placeholder: 'Ask a question'
   }],
@@ -54,17 +53,21 @@ const DEFAULT_LAYOUTS = Object.freeze({
       rel: 'noopener nofollow'
     }
   }]
-});
-const DEFAULT_TRACKERS = Object.freeze({
+}));
+const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _base.default.DEFAULT_TRACKERS, {
   [_constants.ROLE.SOURCES]: {},
   [_constants.ROLE.AFFILIATION]: {},
   [_constants.ROLE.PRODUCTS]: {}
-});
-const DEFAULT_OPTIONS = Object.freeze({
+}));
+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, _options.mergeRolesOptions)(_base.default.ROLES_OPTIONS, {
+  main: _constants.ROLE.ANSWER,
+  members: Object.keys(DEFAULT_LAYOUTS)
 });
 class AnswerBasedWorkflow extends _base.default {
   // constructor //
@@ -76,16 +79,10 @@ class AnswerBasedWorkflow extends _base.default {
   _initActors(args) {
     super._initActors(args);
     this._feedback = new _index.FeedbackActor(this._hub);
-    /*
-    this._autocomplete = new AutocompleteActor(this._hub, {
-      source: sources.api(this._client),
-      options: this._options,
-    });
-    */
   }
   _initSubscriptions(args) {
     super._initSubscriptions(args);
-    this._unsubscribes = [...this._unsubscribes, this._hub.on(_index.fields.query(), args => this._query(args)), this._hub.on(_index.fields.view(_constants.ROLE.ANSWER), data => this._onAnswerViewUpdate(data)), this._views.get(_constants.ROLE.ANSWER).on('citation-click', event => this._onCitationClick(event))];
+    this._unsubscribes = [...this._unsubscribes, this._hub.on(_index.fields.query(), args => this._query(args)), this._views.get(_constants.ROLE.ANSWER).on('citation-click', event => this._onCitationClick(event))];
   }
 
   // lifecycle //
@@ -94,26 +91,29 @@ class AnswerBasedWorkflow extends _base.default {
     if (this._questionId) {
       this._questionId = undefined;
     }
-    // interrupt event
-    // TODO: move to workflow base
-    const {
-      session,
-      status,
-      ongoing
-    } = this._hub.states[_index.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);
-    }
     // restart
     super.restart();
   }
+  _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
+    } = state;
+    const done = status === _constants.STATUS.READY && !state.ongoing;
+    const erroneous = status === _constants.STATUS.ERRONEOUS;
+    const eventName = done ? 'done' : erroneous ? 'error' : status;
+    this._emitLifecycleEvent(eventName, state);
+    if (done || erroneous) {
+      this._emitLifecycleEvent('finally', state);
+    }
+  }
 
   // properties //
   get questionId() {
@@ -157,46 +157,29 @@ class AnswerBasedWorkflow extends _base.default {
   }
   _query() {
     let args = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    if (this._linkFn) {
+      this._submitToPage(args);
+      return;
+    }
     // start a new session
     this.restart();
 
-    // TODO: move to ask workflow
     // keep track of question source on this session, for suggested questions interactions
     this._writeQuestionSourceToSession(args);
 
     // build payload and trigger request
-    const {
-      session
-    } = this;
     const payload = this._buildPayload(args);
-    const event = (0, _options.mergeApiOptions)(this._options.resolved.api, {
-      payload,
-      session
+    this._request({
+      payload
     });
-    this._request(event);
   }
   _writeQuestionSourceToSession(args) {
-    this.session.meta.question_source = args.questionSource || _constants.ORGANIC_QUESTION_SOURCE; // might be null, not undefined
-  }
-  _request(event) {
-    this._hub.update(_index.fields.request(), event);
+    this.session.meta.question_source = args.qs || _constants.ORGANIC_QUESTION_SOURCE; // might be null, not undefined
   }
   _buildPayload() {
     throw new Error(`Not implemented`);
   }
 
-  // autocomplete //
-  /*
-  updateCompletions(event) {
-    // TODO: verify
-    this._hub.update(fields.data(DATA_ASPECT.AUTOCOMPLETE), {
-      ...event,
-      source: 'manual',
-    });
-    return this;
-  }
-  */
-
   // data //
   _updateData(data) {
     // if it's the head response, write question id and return
@@ -254,58 +237,40 @@ class AnswerBasedWorkflow extends _base.default {
   }
 
   // interactions //
-  _preprocessInteraction(payload) {
-    payload = super._preprocessInteraction(payload);
-    payload = this._writeQuestionIdToInteractions(payload);
+  _defaultProcessInteraction(payload, args) {
+    payload = super._defaultProcessInteraction(payload, args);
+    payload = this._writeAskPropertiesToInteraction(payload, args);
     return payload;
   }
-  _writeQuestionIdToInteractions() {
+  _writeAskPropertiesToInteraction() {
     let payload = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    let args = arguments.length > 1 ? arguments[1] : undefined;
+    const question_source = this._getQuestionSourceFromViewState(args);
+    const question_id = this.questionId;
+    return (0, _processors.mergeInteraction)(payload, {
+      context: {
+        custom_context: {
+          question_source,
+          question_id
+        }
+      }
+    });
+  }
+  _getQuestionSourceFromViewState(args) {
     const {
-      context = {}
-    } = payload;
+      request
+    } = this._hub.states[_index.fields.view(args.role)] || {};
     const {
-      custom_context = {}
-    } = context;
-    let {
-      questionId
-    } = this;
-    return Object.assign({}, payload, {
-      context: Object.assign({}, context, {
-        custom_context: (0, _commons.trimObj)(Object.assign({
-          question_id: questionId
-        }, custom_context))
-      })
-    });
+      payload
+    } = request || {};
+    return payload && payload._meta && payload._meta.question_source || undefined;
   }
 
   // handlers //
-  _onAnswerViewUpdate(_ref3) {
-    let {
-      session,
-      status,
-      ongoing
-    } = _ref3;
-    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);
-    }
-  }
-  _onCitationClick(_ref4) {
+  _onCitationClick(_ref3) {
     let {
       index
-    } = _ref4;
+    } = _ref3;
     const {
       value
     } = this.states[_index.fields.data()] || {};
@@ -341,13 +306,13 @@ class AnswerBasedWorkflow extends _base.default {
     super._destroy(options);
   }
 }
-
-// makeConfigurable(AnswerBasedWorkflow.prototype, ['autocomplete']);
 exports.default = AnswerBasedWorkflow;
+(0, _useLink.enableUseLink)(AnswerBasedWorkflow.prototype);
 Object.assign(AnswerBasedWorkflow, {
   DEFAULT_API_OPTIONS,
   DEFAULT_AUTOCOMPLETE_OPTIONS,
   DEFAULT_LAYOUTS,
   DEFAULT_TRACKERS,
-  DEFAULT_OPTIONS
+  DEFAULT_OPTIONS,
+  ROLES_OPTIONS
 });

package/dist/cjs/workflow/ask.js

@@ -9,9 +9,9 @@ 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 _processors = require("./processors.js");
 const _excluded = ["q", "qs"];
 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(Object.assign({}, _answerBased.default.DEFAULT_API_OPTIONS, {
   name: _commons.API.NAME.QUESTIONS,
@@ -44,12 +44,13 @@ const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _answerBased.default.DEF
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS
 }));
+const ROLES_OPTIONS = _answerBased.default.ROLES_OPTIONS;
 class Ask extends _answerBased.default {
   constructor(context, parentQuestionId) {
     super({
       name: 'ask',
       context,
-      roles: Object.keys(DEFAULT_LAYOUTS),
+      roles: ROLES_OPTIONS,
       defaults: DEFAULT_OPTIONS,
       parentQuestionId
     });
@@ -83,11 +84,11 @@ class Ask extends _answerBased.default {
       }))
     });
   }
-  _initReset(args) {
+  _initSession(args) {
     // register at context
     args.parentQuestionId && this._context._byPqid.set(args.parentQuestionId, this);
     this._context._events.emit('create', this);
-    super._initReset(args);
+    super._initSession(args);
   }
 
   // lifecycle //
@@ -145,31 +146,32 @@ class Ask extends _answerBased.default {
   }
 
   // interactions //
-  _preprocessInteraction(payload) {
-    payload = super._preprocessInteraction(payload) || {};
-    const {
-      context = {}
-    } = payload;
-    const _ref2 = context.custom_context || {},
-      custom_context = Object.assign({}, (_objectDestructuringEmpty(_ref2), _ref2));
+  _writeAskPropertiesToInteraction(payload, args) {
+    const root_question_id = this.rootQuestionId;
     let {
-      rootQuestionId,
-      parentQuestionId,
-      questionId
-    } = this;
-    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;
+      property
+    } = payload.context && payload.context.custom_context || {};
+    let question_id, parent_question_id, question_source;
+    if (args.role === _constants.ROLE.QUERY_SUGGESTIONS) {
+      property = 'suggested_followup_questions';
+      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;
+      question_id = this.questionId;
+      question_source = this._getQuestionSourceFromViewState(args);
     }
-    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 (0, _processors.mergeInteraction)(payload, {
+      context: {
+        custom_context: {
+          property,
+          root_question_id,
+          parent_question_id,
+          question_id,
+          question_source
+        }
+      }
     });
   }
 

package/dist/cjs/workflow/asks.js

@@ -66,7 +66,7 @@ class Asks extends _context.default {
 
     // reset root workflow
     if (root) {
-      this._root.reset();
+      this._root.restart();
     }
   }
 }

package/dist/cjs/workflow/autocompletable.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.AutocompletableMixin = void 0;
+exports.makeAutocompletable = makeAutocompletable;
+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);
+}
+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;

package/dist/cjs/workflow/autocomplete.js

@@ -0,0 +1,122 @@
+"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 (e.includes(n)) continue; t[n] = r[n]; } return t; }
+const ROLES_OPTIONS = Object.freeze({
+  members: []
+});
+function shimDefaults() {
+  let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let options = _objectWithoutPropertiesLoose(_ref, _excluded);
+  return Object.assign({
+    active: false
+  }, 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) {
+    let _ref2 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    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));
+  }
+  _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;
+  }
+  enable() {
+    this._active = true;
+  }
+  disable() {
+    this._active = false;
+  }
+
+  // query //
+  _query(args) {
+    if (!this._active || 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) {
+    this._superworkflow.updateCompletions(data);
+  }
+}
+exports.default = Autocomplete;