@miso.ai/client-sdk-ui 1.12.3 → 1.12.4-beta.0

package/dist/cjs/actor/data.js

@@ -12,11 +12,13 @@ function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t =
 class DataActor {
   constructor(hub, {
     source,
-    options
+    options,
+    polling = true
   }) {
     this._hub = hub;
     this._source = source;
     this._options = options;
+    this._polling = polling;
     this._unsubscribes = [hub.on(fields.session(), session => this._handleSession(session)), hub.on(fields.request(), event => this._handleRequest(event))];
   }
   get active() {
@@ -74,17 +76,19 @@ class DataActor {
             value: response._response
           });
         }
-        let value;
-        for await (value of response) {
-          // A new session invalidates ongoing data fetch for the old session, terminating the loop
-          if (!(0, _utils.isCurrentSession)(this._hub, session)) {
-            break;
+        if (this._polling) {
+          let value;
+          for await (value of response) {
+            // A new session invalidates ongoing data fetch for the old session, terminating the loop
+            if (!(0, _utils.isCurrentSession)(this._hub, session)) {
+              break;
+            }
+            this._emitResponse({
+              session,
+              request,
+              value
+            });
           }
-          this._emitResponse({
-            session,
-            request,
-            value
-          });
         }
       } else {
         this._emitResponseWithSessionCheck({

package/dist/cjs/defaults/ask/controls.js

@@ -53,10 +53,7 @@ function wireRelatedResources(client, element) {
   if (!element) {
     return;
   }
-  client.ui.asks.on('loading', event => {
-    // When a new query starts, associate the last section container (for related resources) to that workflow
-    for (const container of element.querySelectorAll('miso-ask')) {
-      container.workflow = event.workflow;
-    }
-  });
+  for (const container of element.querySelectorAll('miso-ask')) {
+    container.setAttribute('workflow', 'active');
+  }
 }

package/dist/cjs/defaults/ask/templates.js

@@ -125,6 +125,7 @@ class Sections extends _templates.Sections {
     const body = features.relatedResources === false ? '' : container(options, {
       name: 'related-resources',
       visibleWhen: 'nonempty',
+      workflow: 'active',
       logo
     }, [phrase(options, {
       name: 'related-resources',

package/dist/cjs/defaults/common/templates.js

@@ -164,7 +164,8 @@ class Helpers {
   container({
     classPrefix,
     circledCitationIndex,
-    parentQuestionId
+    parentQuestionId,
+    workflow
   }, {
     name,
     extraNames = [],
@@ -179,7 +180,8 @@ class Helpers {
       visibleWhen,
       trait,
       logo,
-      parentQuestionId
+      parentQuestionId,
+      workflow
     }, body);
   }
   element(tag, attributes = {}, body = '') {

package/dist/cjs/element/container/miso-ask.js

@@ -7,8 +7,9 @@ exports.default = void 0;
 var _misoContainer = _interopRequireDefault(require("./miso-container.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const TAG_NAME = 'miso-ask';
+const ATTR_WORKFLOW = 'workflow';
 const ATTR_PARENT_QUESTION_ID = 'parent-question-id';
-const OBSERVED_ATTRIBUTES = Object.freeze([..._misoContainer.default.observedAttributes, ATTR_PARENT_QUESTION_ID]);
+const OBSERVED_ATTRIBUTES = Object.freeze([..._misoContainer.default.observedAttributes, ATTR_WORKFLOW, ATTR_PARENT_QUESTION_ID]);
 class MisoAskElement extends _misoContainer.default {
   static get tagName() {
     return TAG_NAME;
@@ -17,6 +18,9 @@ class MisoAskElement extends _misoContainer.default {
     return OBSERVED_ATTRIBUTES;
   }
   _getWorkflow(client) {
+    if (this.boundToActiveWorkflow) {
+      return client.ui.asks.active;
+    }
     return this._getWorkflowByParentQuestionId(client, this.parentQuestionId);
   }
   _getWorkflowByParentQuestionId(client, id) {
@@ -40,24 +44,62 @@ class MisoAskElement extends _misoContainer.default {
       this.removeAttribute(ATTR_PARENT_QUESTION_ID);
     }
   }
-  get workflow() {
-    return this._workflow;
+  get boundToActiveWorkflow() {
+    return this.getAttribute(ATTR_WORKFLOW) === 'active';
   }
-  set workflow(workflow) {
-    this._setWorkflow(workflow);
-    this.parentQuestionId = workflow && workflow.parentQuestionId;
+  _setWorkflow(workflow) {
+    if (this._workflow === workflow) {
+      return;
+    }
+    super._setWorkflow(workflow);
+    if (workflow) {
+      this.parentQuestionId = workflow.parentQuestionId;
+    }
   }
 
   // lifecycle //
+  async connectedCallback() {
+    await super.connectedCallback();
+    if (document.body.contains(this)) {
+      // in case already disconnected
+      const context = this._client.ui.asks;
+      this._unsubscribes = [...(this._unsubscribes || []), context.on('active', event => {
+        if (!this.boundToActiveWorkflow) {
+          return;
+        }
+        this.workflow = event.workflow;
+      })];
+    }
+  }
+  disconnectedCallback() {
+    for (const unsubscribe of this._unsubscribes || []) {
+      unsubscribe();
+    }
+    this._unsubscribes = [];
+    super.disconnectedCallback();
+  }
   attributeChangedCallback(attr, oldValue, newValue) {
     switch (attr) {
       case ATTR_PARENT_QUESTION_ID:
         this._handleParentQuestionIdUpdate(oldValue, newValue);
         break;
+      case ATTR_WORKFLOW:
+        this._handleQuestionUpdate(oldValue, newValue);
+        break;
       default:
         super.attributeChangedCallback(attr, oldValue, newValue);
     }
   }
+  _handleQuestionUpdate(oldValue, newValue) {
+    oldValue = oldValue || undefined; // null -> undefined
+    newValue = newValue || undefined;
+    if (oldValue === newValue || !this._client) {
+      return;
+    }
+    if (newValue === ATTR_VALUE_ACTIVE) {
+      this._setWorkflow(this._getWorkflow(this._client));
+    }
+  }
   _handleParentQuestionIdUpdate(oldId, newId) {
     oldId = oldId || undefined; // null -> undefined
     newId = newId || undefined;

package/dist/cjs/element/container/miso-container.js

@@ -77,12 +77,14 @@ class MisoContainerElement extends _misoStub.default {
     if (document.body.contains(this)) {
       // in case already disconnected
       this._setWorkflow(this._getWorkflow(client));
+      this._onConnected(client);
     }
   }
   disconnectedCallback() {
     this._setWorkflow(undefined);
     super.disconnectedCallback();
   }
+  _onConnected(client) {}
   _getWorkflow(client) {
     throw new Error('Unimplemented');
   }

package/dist/cjs/version.js

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

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

@@ -210,7 +210,7 @@ class AnswerBasedWorkflow extends _base.default {
     super._updateData(data);
 
     // update URL if autoQuery.updateUrl is not false
-    this._updateUrlIfNecessary(data);
+    _index4.updateQueryParametersInUrl.call(this, data);
   }
   _handleHeadResponse(data) {}
   _defaultProcessData(data, oldData) {
@@ -224,99 +224,13 @@ class AnswerBasedWorkflow extends _base.default {
   }) {
     value && this._writeQuestionId(value.question_id);
   }
-  _updateUrlIfNecessary({
-    value,
-    request
-  }) {
-    if (!this._autoQuery || !this._autoQuery.updateUrl) {
-      return;
-    }
-    const {
-      param,
-      sourceParam
-    } = this._autoQuery;
-    const question = value && value.question || request && request.payload && request.payload.question;
-    const questionSource = request && request.payload && request.payload.metadata && request.payload.metadata.question_source;
-    if (!question) {
-      return; // at initial phase
-    }
-    const url = new URL(window.location);
-    const currentQuestion = url.searchParams.get(param);
-    const currentQuestionSource = url.searchParams.get(sourceParam) || _constants.QUESTION_SOURCE.ORGANIC;
-    if (question === currentQuestion && questionSource === currentQuestionSource) {
-      return;
-    }
-    url.searchParams.set(param, question);
-    if (questionSource === _constants.QUESTION_SOURCE.ORGANIC) {
-      url.searchParams.delete(sourceParam);
-    } else {
-      url.searchParams.set(sourceParam, questionSource);
-    }
-    window.history.replaceState({}, '', url);
-  }
 
   // interactions //
   _defaultProcessInteraction(payload, args) {
     payload = super._defaultProcessInteraction(payload, args);
-    payload = this._writeAskPropertiesToInteraction(payload, args);
-    payload = this._writeAnswerClickInteraction(payload, args);
-    payload = (0, _processors.writeEventTargetToInteraction)(payload, args);
+    payload = (0, _processors.writeAnswerInfoToInteraction)(payload, args);
     return payload;
   }
-  _writeRequestInfoToInteraction(payload, args) {
-    const {
-      data
-    } = args;
-    if (!data) {
-      return payload;
-    }
-    const requestPayload = data.request && data.request.payload;
-    if (!requestPayload) {
-      return payload;
-    }
-    const {
-      question,
-      fq
-    } = requestPayload;
-    return (0, _commons.mergeInteractions)(payload, {
-      context: {
-        custom_context: {
-          question,
-          fq
-        }
-      }
-    });
-  }
-  _writeAskPropertiesToInteraction(payload = {}, args) {
-    const question_source = this._getQuestionSourceFromViewState(args);
-    const question_id = this.questionId;
-    return (0, _commons.mergeInteractions)(payload, {
-      context: {
-        custom_context: {
-          question_source,
-          question_id
-        }
-      }
-    });
-  }
-  _writeAnswerClickInteraction(payload, args) {
-    if (args.role !== _constants.ROLE.ANSWER) {
-      return payload;
-    }
-    const {
-      items = []
-    } = args;
-    return (0, _commons.mergeInteractions)(payload, {
-      context: {
-        custom_context: {
-          urls: items.map(item => item.url),
-          texts: items.map(item => item.text),
-          class_names: items.map(item => item.className),
-          attributes: items.map(item => item.attributes)
-        }
-      }
-    });
-  }
   _getQuestionSourceFromViewState(args) {
     const {
       request

package/dist/cjs/workflow/ask.js

@@ -146,10 +146,10 @@ class Ask extends _answerBased.default {
     let payload = (0, _commons.trimObj)(Object.assign({}, options, {
       question: q,
       // question, not q
-      parent_question_id: parentQuestionId,
-      metadata: Object.assign({}, options.metadata, {
-        question_source: qs || _constants.QUESTION_SOURCE.ORGANIC // might be null, not undefined
-      })
+      parent_question_id: parentQuestionId
+    }));
+    payload = (0, _processors.writeQuestionSourceToPayload)(Object.assign({}, payload, {
+      qs
     }));
     payload = this._writeWikiLinkTemplateToPayload(payload);
     return payload;
@@ -184,7 +184,12 @@ class Ask extends _answerBased.default {
   }
 
   // interactions //
-  _writeAskPropertiesToInteraction(payload, args) {
+  _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
@@ -199,18 +204,17 @@ class Ask extends _answerBased.default {
       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);
     }
     return (0, _commons.mergeInteractions)(payload, {
       context: {
-        custom_context: {
+        custom_context: (0, _commons.trimObj)({
+          // question_id, question_source can be undefined
           property,
           root_question_id,
           parent_question_id,
           question_id,
           question_source
-        }
+        })
       }
     });
   }

package/dist/cjs/workflow/asks.js

@@ -26,7 +26,7 @@ function autoNextOptionsAsPredicate(options = DEFAULT_AUTO_NEXT_OPTIONS) {
   switch (typeof options) {
     case 'object':
       // TODO: support more options
-      return event => options.event === event._event;
+      return event => event && options.event === event._event;
     case 'function':
       return options;
     default:
@@ -40,7 +40,11 @@ class Asks extends _context.default {
     this._byPqid = new Map();
     this._root = new _ask.default(this); // initialize with default workflow
     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;
@@ -48,6 +52,9 @@ class Asks extends _context.default {
   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}`);
@@ -105,6 +112,34 @@ class Asks extends _context.default {
     } = 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]);

package/dist/cjs/workflow/base.js

@@ -36,7 +36,8 @@ class Workflow extends _commons.Component {
       plugin,
       client,
       defaults,
-      options
+      options,
+      extraOptions
     } = args;
     this._context = context;
     this._plugin = plugin = plugin || context._plugin;
@@ -50,6 +51,7 @@ class Workflow extends _commons.Component {
     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)
@@ -71,10 +73,10 @@ class Workflow extends _commons.Component {
     const extensions = this._extensions;
     const layouts = this._plugin.layouts;
     this._sessions = new _index.SessionMaker(hub);
-    this._data = new _index.DataActor(hub, {
+    this._data = new _index.DataActor(hub, Object.assign({
       source: sources.api(client),
       options
-    });
+    }, this._extraOptions.api));
     this._views = new _index.ViewsActor(hub, {
       extensions,
       layouts,
@@ -281,9 +283,11 @@ class Workflow extends _commons.Component {
     return this._views.trackers;
   }
   _onTracker(args) {
+    const workflow = this;
     const data = this._hub.states[_index.fields.data()];
     const payload = this._buildInteraction(Object.assign({}, args, {
-      data
+      data,
+      workflow
     }));
     this._sendInteraction(payload);
   }
@@ -299,10 +303,10 @@ class Workflow extends _commons.Component {
     return payload;
   }
   _defaultProcessInteraction(payload, args) {
-    payload = (0, _processors.writeRequestMetadataToInteraction)(payload, args);
     payload = this._writeApiInfoToInteraction(payload, args);
-    payload = this._writeRequestInfoToInteraction(payload, args);
     payload = this._writeMisoIdToInteraction(payload, args);
+    payload = (0, _processors.writeRequestInfoToInteraction)(payload, args);
+    payload = (0, _processors.writeRequestMetadataToInteraction)(payload, args);
     payload = (0, _processors.writeAffiliationInfoToInteraction)(payload, args);
     return payload;
   }
@@ -320,9 +324,6 @@ class Workflow extends _commons.Component {
       }
     });
   }
-  _writeRequestInfoToInteraction(payload, args) {
-    return payload;
-  }
   _writeMisoIdToInteraction(payload, args) {
     // TODO: ad-hoc, try to pass info from tracker
     const state = this._hub.states[_index.fields.view(args.role)] || {};
@@ -347,6 +348,9 @@ class Workflow extends _commons.Component {
     this._emit('destroy');
     this._destroy(options);
   }
+  get destroyed() {
+    return !!this._destroyed;
+  }
   _destroy({
     dom
   } = {}) {
@@ -358,6 +362,7 @@ class Workflow extends _commons.Component {
       dom
     });
     this._data._destroy();
+    this._destroyed = true;
   }
 
   // helper //

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

@@ -4,20 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _commons = require("@miso.ai/commons");
 var _answerBased = _interopRequireDefault(require("./answer-based.js"));
-var _constants = require("../constants.js");
-var _index = require("./options/index.js");
+var _index = require("../actor/index.js");
 var _processors = require("./processors.js");
-var _autocompletable = require("./autocompletable.js");
-const _excluded = ["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 (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
-const ROLES_OPTIONS = (0, _index.mergeRolesOptions)(_answerBased.default.ROLES_OPTIONS, {
-  mappings: {
-    [_constants.ROLE.QUESTION]: _constants.ROLE.KEYWORDS
-  }
-});
+const ROLES_OPTIONS = _answerBased.default.ROLES_OPTIONS;
 class HybridSearchAnswer extends _answerBased.default {
   constructor(superworkflow) {
     super({
@@ -32,39 +23,47 @@ class HybridSearchAnswer extends _answerBased.default {
   }
   _initProperties(args) {
     super._initProperties(args);
-    this._initAutocomplete(args);
     this._superworkflow = args.superworkflow;
   }
   _initSession() {} // no reset here, will manually reset later
 
-  restart() {
-    super.restart();
-    // cascade restart to the sibling
-    const results = this._superworkflow._results;
-    results._views.filters.reset({
-      silent: true
-    });
-    results.restart();
-    this._resultsSession = results.session; // keep track of the session
-  }
-
-  // query //
-  _buildPayload(payload) {
-    payload = this._writeQuestionSourceToPayload(payload);
-    payload = this._writeWikiLinkTemplateToPayload(payload);
-    payload = this._superworkflow._results._writeFiltersToPayload(payload);
-    return payload;
+  _doLoading(data) {
+    const {
+      session
+    } = this;
+    this.updateData(Object.assign({}, data, {
+      session
+    }));
   }
-  _writeQuestionSourceToPayload(_ref = {}) {
-    let {
-        qs
-      } = _ref,
-      payload = _objectWithoutPropertiesLoose(_ref, _excluded);
-    return (0, _commons.mergeApiPayloads)(payload, {
-      metadata: {
-        question_source: qs || _constants.QUESTION_SOURCE.ORGANIC // might be null, not undefined
-      }
+  _queryWithQuestionId(data) {
+    const {
+      session
+    } = this;
+    const {
+      request,
+      value
+    } = data;
+    this.updateData(Object.assign({}, data, {
+      session
+    }));
+    // start query with question_id
+    const {
+      question_id
+    } = value;
+    if (!question_id) {
+      return;
+    }
+    // forge the request
+    const payload = Object.assign({}, request.payload, {
+      question_id
     });
+    if (payload.metadata.page !== undefined) {
+      delete payload.metadata.page;
+    }
+    this._hub.update(_index.fields.request(), Object.assign({}, request, {
+      payload,
+      session
+    }));
   }
 
   // data //
@@ -75,42 +74,15 @@ class HybridSearchAnswer extends _answerBased.default {
     data = (0, _processors.writeUnanswerableToMeta)(data);
     return data;
   }
-  _updateDataInHub(data) {
-    switch (data.status) {
-      case _constants.STATUS.INITIAL:
-      case _constants.STATUS.LOADING:
-        // share the initial/loading status with its sibling
-        this._dispatchDataToSibling(data);
-        break;
-    }
-    super._updateDataInHub(data);
-  }
   _handleHeadResponse(data) {
     super._handleHeadResponse(data);
     // keep track of miso_id in session
     (0, _processors.writeMisoIdToSession)(data);
-    // share the search results with its sibling
-    this._dispatchDataToSibling(data);
-  }
-  _dispatchDataToSibling(data) {
-    this._resultsSession && this._superworkflow._results.updateData(Object.assign({}, data, {
-      session: this._resultsSession
-    }));
   }
 
   // interactions //
-  _defaultProcessInteraction(payload, args) {
-    return this._superworkflow._defaultProcessInteraction(payload, args);
-  }
-  _defaultProcessInteraction0(payload, args) {
-    return super._defaultProcessInteraction(payload, args);
-  }
-
-  // destroy //
-  _destroy(options) {
-    this._destroyAutocomplete();
-    super._destroy(options);
+  _onTracker(args) {
+    this._superworkflow._onTracker(args);
   }
 }
-exports.default = HybridSearchAnswer;
-(0, _autocompletable.makeAutocompletable)(HybridSearchAnswer.prototype);
+exports.default = HybridSearchAnswer;