@miso.ai/client-sdk-ui 1.11.5-beta.0 → 1.11.5-beta.10

package/dist/cjs/layout/templates.js

@@ -263,19 +263,30 @@ function tagPair(_ref13, _ref14) {
       role = 'item'
     } = _ref12,
     meta = _objectWithoutPropertiesLoose(_ref12, _excluded);
-  const {
-    link = {}
-  } = options;
-  const {
-    target = '_blank',
-    rel = 'noopener'
-  } = link; // TODO: other properties
   const tag = meta.link !== false && url ? 'a' : 'div';
-  const urlAttrs = meta.link !== false && url ? `href="${url}" target="${target}" rel="${rel}"` : '';
+  const urlAttrs = meta.link !== false && url ? `href="${url}" ${linkAttrs(options.link)}` : '';
   const productAttrs = product_id ? `${_constants.ATTR_DATA_MISO_PRODUCT_ID}="${product_id}"` : '';
   const roleAttrs = role ? `data-role="${role}"` : '';
   return [`<${tag} class="${className}__${classSuffix}" ${roleAttrs} ${productAttrs} ${urlAttrs}>`, `</${tag}>`];
 }
+function linkAttrs() {
+  let link = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  const {
+    target = '_blank',
+    rel = 'noopener',
+    open = true
+  } = link; // TODO: other properties
+  let attrs = '';
+  if (open) {
+    if (target) {
+      attrs += ` target="${target}"`;
+    }
+    if (rel) {
+      attrs += ` rel="${rel}"`;
+    }
+  }
+  return attrs;
+}
 const DEFAULT_DATE_OPTIONS = Object.freeze({
   locale: 'en-US',
   year: 'numeric',

package/dist/cjs/util/dom.js

@@ -0,0 +1,101 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.addOrRemoveClass = addOrRemoveClass;
+exports.cssAspectRatio = cssAspectRatio;
+exports.resolveCssLength = resolveCssLength;
+exports.setOrRemoveAttribute = setOrRemoveAttribute;
+function setOrRemoveAttribute(element, name, value) {
+  if (value === undefined) {
+    element.removeAttribute(name);
+  } else {
+    element.setAttribute(name, value);
+  }
+}
+function addOrRemoveClass(element, name, add) {
+  if (add) {
+    element.classList.add(name);
+  } else {
+    element.classList.remove(name);
+  }
+}
+function resolveCssLength(str) {
+  if (typeof str === 'number') {
+    return str;
+  }
+  const [value, unit] = parseLength(str);
+  switch (unit) {
+    case '':
+    case 'px':
+      return value;
+    case 'rem':
+      return remToPx(value);
+    default:
+      throw new Error(`Unsupported unit: ${unit}`);
+  }
+}
+function parseLength(str) {
+  const match = str.match(/^([+-]?(?:\d+|\d*\.\d+))([a-z]*)$/);
+  if (!match) {
+    throw new Error(`Invalid length: ${str}`);
+  }
+  const value = parseFloat(match[1]);
+  const unit = match[2] || '';
+  return [value, unit];
+}
+function remToPx() {
+  let value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
+  return value * parseFloat(getComputedStyle(document.documentElement).fontSize);
+}
+function cssAspectRatio(value) {
+  return value === undefined || value instanceof CssAspectRatio ? value : new CssAspectRatio(value);
+}
+class CssAspectRatio {
+  constructor(value) {
+    this._width = NaN;
+    this._height = NaN;
+    switch (typeof value) {
+      case 'number':
+        this._width = value;
+        this._height = 1;
+        break;
+      case 'object':
+        if (Array.isArray(value)) {
+          this._width = parseFloat(value[0]);
+          this._height = parseFloat(value[1]);
+        }
+        break;
+      case 'string':
+        const i = value.indexOf('/');
+        if (i < 0) {
+          this._width = parseFloat(value);
+          this._height = 1;
+        } else {
+          this._width = parseFloat(value.slice(0, i).trim());
+          this._height = parseFloat(value.slice(i + 1).trim());
+        }
+        break;
+    }
+    if (this._width === NaN || this._height === NaN) {
+      throw new Error(`Invalid aspect ratio value: ${value}`);
+    }
+  }
+  get width() {
+    return this._width;
+  }
+  get height() {
+    return this._height;
+  }
+  get floatValue() {
+    return this._width / this._height;
+  }
+  scaleBy(factor) {
+    factor = cssAspectRatio(factor);
+    return cssAspectRatio([factor._width * this._width, factor._height * this._height]);
+  }
+  toString() {
+    return this._height === 1 ? `${this._width}` : `${this._width} / ${this._height}`;
+  }
+}

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.5-beta.0';
+var _default = exports.default = '1.11.5-beta.10';

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

@@ -14,8 +14,7 @@ var _index4 = require("./options/index.js");
 var _processors = require("./processors.js");
 var _useLink = require("./use-link.js");
 var _trackers = require("../util/trackers.js");
-const _excluded = ["setValue", "focus", "param", "sourceParam"],
-  _excluded2 = ["event"];
+const _excluded = ["event"];
 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({}, _base.default.DEFAULT_API_OPTIONS, {
@@ -43,7 +42,7 @@ const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _base.default.DEFAULT_LA
   }],
   [_constants.ROLE.ANSWER]: _index2.TypewriterLayout.type,
   [_constants.ROLE.FEEDBACK]: _index2.FeedbackLayout.type,
-  [_constants.ROLE.IMAGES]: [_index2.CarouselLayout.type, {
+  [_constants.ROLE.IMAGES]: [_index2.GalleryLayout.type, {
     incremental: true,
     itemType: 'image'
   }],
@@ -84,22 +83,6 @@ const ROLES_OPTIONS = (0, _index4.mergeRolesOptions)(_base.default.ROLES_OPTIONS
   main: _constants.ROLE.ANSWER,
   members: Object.keys(DEFAULT_LAYOUTS)
 });
-function normalizeAutoQueryOptions() {
-  let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let {
-      setValue = true,
-      focus = true,
-      param = 'q',
-      sourceParam = 'qs'
-    } = _ref,
-    options = _objectWithoutPropertiesLoose(_ref, _excluded);
-  return Object.assign({
-    setValue,
-    focus,
-    param,
-    sourceParam
-  }, options);
-}
 class AnswerBasedWorkflow extends _base.default {
   // constructor //
   _initProperties(args) {
@@ -170,32 +153,7 @@ class AnswerBasedWorkflow extends _base.default {
   // query //
   autoQuery() {
     let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    const {
-      setValue,
-      focus,
-      param,
-      sourceParam
-    } = this._autoQuery = normalizeAutoQueryOptions(options);
-    const searchParams = new URLSearchParams(window.location.search);
-    const q = searchParams.get(param);
-    const qs = searchParams.get(sourceParam);
-    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
-      });
-    }
+    _index4.autoQuery.call(this, options);
   }
   query(args) {
     // TODO: also accept "question", "questionSource"?
@@ -228,9 +186,20 @@ class AnswerBasedWorkflow extends _base.default {
   _buildPayload() {
     throw new Error(`Not implemented`);
   }
+  _writeWikiLinkTemplateToPayload(payload) {
+    if (!this._autoQuery || !this._autoQuery.param || this._autoQuery.param === _index4.DEFAULT_AUTO_QUERY_PARAM) {
+      return payload;
+    }
+    return Object.assign({}, payload, {
+      wiki_link_template: `?${this._autoQuery.param}=%s`
+    });
+  }
 
   // data //
   _updateData(data) {
+    // capture question ID and register at context
+    this._writeQuestionIdFromData(data);
+
     // if it's the head response, write question id and return
     if (data.value && !data.value.answer_stage) {
       this._handleHeadResponse(data);
@@ -241,51 +210,49 @@ class AnswerBasedWorkflow extends _base.default {
     // update URL if autoQuery.updateUrl is not false
     this._updateUrlIfNecessary(data);
   }
-  _handleHeadResponse(data) {
-    // capture question ID and register at context
-    this._writeQuestionIdFromData(data);
-  }
+  _handleHeadResponse(data) {}
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
     data = (0, _index3.processData)(data);
     data = (0, _processors.writeAnswerStageToMeta)(data);
     return data;
   }
-  _writeQuestionIdFromData(_ref2) {
+  _writeQuestionIdFromData(_ref) {
     let {
       value
-    } = _ref2;
-    if (!value) {
-      return;
-    }
-    const {
-      question_id: questionId
-    } = value;
-    this._writeQuestionId(questionId);
+    } = _ref;
+    value && this._writeQuestionId(value.question_id);
   }
-  _updateUrlIfNecessary(_ref3) {
+  _updateUrlIfNecessary(_ref2) {
     let {
       value,
       request
-    } = _ref3;
-    if (!value || !this._autoQuery || this._autoQuery.updateUrl === false) {
-      // explicitly false
+    } = _ref2;
+    if (!this._autoQuery || !this._autoQuery.updateUrl) {
       return;
     }
     const {
-      param
+      param,
+      sourceParam
     } = this._autoQuery;
-    const {
-      question
-    } = value;
-    const organic = request && request.payload && request.payload._meta && request.payload._meta.question_source === _constants.ORGANIC_QUESTION_SOURCE;
+    const question = value && value.question || request && request.payload && request.payload.question;
+    const questionSource = request && request.payload && request.payload._meta && request.payload._meta.question_source;
+    if (!question) {
+      return; // at initial phase
+    }
     const url = new URL(window.location);
     const currentQuestion = url.searchParams.get(param);
-    // TODO: review this, handle &qs=
-    if (question !== currentQuestion && (!organic || this._autoQuery.updateUrl === true)) {
-      url.searchParams.set(param, question);
-      window.history.replaceState({}, '', url);
+    const currentQuestionSource = url.searchParams.get(sourceParam) || _constants.ORGANIC_QUESTION_SOURCE;
+    if (question === currentQuestion && questionSource === currentQuestionSource) {
+      return;
+    }
+    url.searchParams.set(param, question);
+    if (questionSource === _constants.ORGANIC_QUESTION_SOURCE) {
+      url.searchParams.delete(sourceParam);
+    } else {
+      url.searchParams.set(sourceParam, questionSource);
     }
+    window.history.replaceState({}, '', url);
   }
 
   // interactions //
@@ -293,6 +260,7 @@ class AnswerBasedWorkflow extends _base.default {
     payload = super._defaultProcessInteraction(payload, args);
     payload = this._writeAskPropertiesToInteraction(payload, args);
     payload = this._writeAnswerClickInteraction(payload, args);
+    payload = (0, _processors.writeEventTargetToInteraction)(payload, args);
     return payload;
   }
   _writeAskPropertiesToInteraction() {
@@ -338,11 +306,11 @@ class AnswerBasedWorkflow extends _base.default {
   }
 
   // handlers //
-  _onCitationClick(_ref4) {
+  _onCitationClick(_ref3) {
     let {
       index,
       event
-    } = _ref4;
+    } = _ref3;
     if ((0, _trackers.isTracked)(event)) {
       return;
     }
@@ -359,13 +327,17 @@ class AnswerBasedWorkflow extends _base.default {
     }
     // TODO: should we track impression as well?
     (0, _trackers.markAsTracked)(event);
-    this._views.trackers.sources.click([source.product_id]);
+    // distinguish from regular sources element click
+    // TODO
+    this._views.trackers.sources.click([source.product_id], {
+      event_target: 'citation-link'
+    });
   }
-  _onAnswerLinkClick(_ref5) {
+  _onAnswerLinkClick(_ref4) {
     let {
         event
-      } = _ref5,
-      item = _objectWithoutPropertiesLoose(_ref5, _excluded2);
+      } = _ref4,
+      item = _objectWithoutPropertiesLoose(_ref4, _excluded);
     if ((0, _trackers.isTracked)(event)) {
       return;
     }

package/dist/cjs/workflow/ask.js

@@ -134,18 +134,20 @@ class Ask extends _answerBased.default {
         q,
         qs
       } = _ref,
-      payload = _objectWithoutPropertiesLoose(_ref, _excluded);
+      options = _objectWithoutPropertiesLoose(_ref, _excluded);
     const {
       parentQuestionId
     } = this;
-    return (0, _commons.trimObj)(Object.assign({}, payload, {
+    let payload = (0, _commons.trimObj)(Object.assign({}, options, {
       question: q,
       // question, not q
       parent_question_id: parentQuestionId,
-      _meta: Object.assign({}, payload._meta, {
+      _meta: Object.assign({}, options._meta, {
         question_source: qs || _constants.ORGANIC_QUESTION_SOURCE // might be null, not undefined
       })
     }));
+    payload = this._writeWikiLinkTemplateToPayload(payload);
+    return payload;
   }
 
   // interactions //

package/dist/cjs/workflow/base.js

@@ -20,17 +20,19 @@ function injectLogger(hub, callback) {
     trigger
   } = hub;
   hub.update = (name, state, options) => {
+    const result = update.call(hub, name, state, options);
     if (!options || !options.silent) {
       callback('update', name, state, options);
     }
-    return update.call(hub, name, state, options);
+    return result;
   };
   hub.trigger = function () {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
+    const result = trigger.apply(hub, args);
     callback('trigger', ...args);
-    return trigger.apply(hub, args);
+    return result;
   };
   return hub;
 }

package/dist/cjs/workflow/explore.js

@@ -85,6 +85,18 @@ class Explore extends _base.default {
     }
     return super.useApi(options);
   }
+  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() {
@@ -137,8 +149,7 @@ class Explore extends _base.default {
     const related_questions = value.related_questions.map(linkFn ? text => ({
       text,
       url: this._getSubmitUrl({
-        q: text
-      }, {
+        q: text,
         generated: true
       })
     }) : text => ({
@@ -166,14 +177,13 @@ class Explore extends _base.default {
     this._hub.update(_index.fields.query(), args);
   }
   _query(args) {
-    this._submitToPage(args);
+    this._submitToPage(Object.assign({}, args, {
+      generated: false
+    }));
   }
   _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) {
+    if (!args.generated || !this._productId) {
       return url;
     }
     return `${url}&qs=${encodeURIComponent(this._productId)}`;

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

@@ -48,6 +48,7 @@ class HybridSearchAnswer extends _answerBased.default {
   // query //
   _buildPayload(payload) {
     payload = this._writeQuestionSourceToPayload(payload);
+    payload = this._writeWikiLinkTemplateToPayload(payload);
     payload = this._superworkflow._results._writeFiltersToPayload(payload);
     return payload;
   }
@@ -68,6 +69,8 @@ class HybridSearchAnswer extends _answerBased.default {
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
     data = (0, _processors.writeKeywordsToData)(data);
+    data = (0, _processors.writeMisoIdFromSession)(data);
+    data = (0, _processors.writeUnanswerableToMeta)(data);
     return data;
   }
   _updateDataInHub(data) {
@@ -82,6 +85,8 @@ class HybridSearchAnswer extends _answerBased.default {
   }
   _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);
   }
@@ -91,6 +96,14 @@ class HybridSearchAnswer extends _answerBased.default {
     }));
   }
 
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    return this._superworkflow._defaultProcessInteraction(payload, args);
+  }
+  _defaultProcessInteraction0(payload, args) {
+    return super._defaultProcessInteraction(payload, args);
+  }
+
   // destroy //
   _destroy(options) {
     this._destroyAutocomplete();

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

@@ -8,6 +8,7 @@ var _commons = require("@miso.ai/commons");
 var _searchBased = _interopRequireDefault(require("./search-based.js"));
 var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
+var _processors = require("./processors.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // we want to override members, not adding to it
 const ROLES_OPTIONS = Object.assign({}, _searchBased.default.ROLES_OPTIONS, {
@@ -66,6 +67,21 @@ class HybridSearchResults extends _searchBased.default {
       }))
     });
   }
+
+  // data //
+  _defaultProcessData(data) {
+    data = super._defaultProcessData(data);
+    (0, _processors.writeMisoIdToSession)(data);
+    return data;
+  }
+
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    return this._superworkflow._defaultProcessInteraction(payload, args);
+  }
+  _defaultProcessInteraction0(payload, args) {
+    return super._defaultProcessInteraction(payload, args);
+  }
 }
 exports.default = HybridSearchResults;
 Object.assign(HybridSearchResults, {

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

@@ -81,14 +81,7 @@ class HybridSearch extends _base.default {
     }
   }
   _initActors() {
-    const hub = this._hub;
-    const client = this._client;
-    const options = this._options;
     this._views = new _hybridSearchViews.default(this);
-    this._interactions = new _index.InteractionsActor(hub, {
-      client,
-      options
-    });
   }
   _initSession() {
     this._results._sessions.restart();
@@ -128,7 +121,9 @@ class HybridSearch extends _base.default {
 
   // interactions //
   _defaultProcessInteraction(payload, args) {
-    return this._answer._defaultProcessInteraction(payload, args);
+    payload = this._answer._defaultProcessInteraction0(payload, args);
+    payload = this._results._defaultProcessInteraction0(payload, args);
+    return payload;
   }
 
   // destroy //

package/dist/cjs/workflow/options/auto-query.js

@@ -0,0 +1,62 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DEFAULT_AUTO_QUERY_SOURCE_PARAM = exports.DEFAULT_AUTO_QUERY_PARAM = void 0;
+exports.autoQuery = autoQuery;
+exports.normalizeAutoQueryOptions = normalizeAutoQueryOptions;
+var _commons = require("@miso.ai/commons");
+var _constants = require("../../constants.js");
+const _excluded = ["setValue", "focus", "updateUrl", "param", "sourceParam"];
+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_AUTO_QUERY_PARAM = exports.DEFAULT_AUTO_QUERY_PARAM = 'q';
+const DEFAULT_AUTO_QUERY_SOURCE_PARAM = exports.DEFAULT_AUTO_QUERY_SOURCE_PARAM = 'qs';
+function normalizeAutoQueryOptions() {
+  let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let {
+      setValue = true,
+      focus = true,
+      updateUrl = true,
+      param = DEFAULT_AUTO_QUERY_PARAM,
+      sourceParam = DEFAULT_AUTO_QUERY_SOURCE_PARAM
+    } = _ref,
+    options = _objectWithoutPropertiesLoose(_ref, _excluded);
+  return Object.assign({
+    setValue,
+    focus,
+    updateUrl,
+    param,
+    sourceParam
+  }, options);
+}
+function autoQuery() {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  // TODO: support getting value from URL path
+  const {
+    setValue,
+    focus,
+    param,
+    sourceParam
+  } = this._autoQuery = normalizeAutoQueryOptions(options);
+  const searchParams = new URLSearchParams(window.location.search);
+  const q = searchParams.get(param);
+  const qs = searchParams.get(sourceParam) || undefined;
+  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((0, _commons.trimObj)({
+      q,
+      qs
+    }));
+  }
+}

package/dist/cjs/workflow/options/index.js

@@ -112,4 +112,15 @@ Object.keys(_configurable).forEach(function (key) {
       return _configurable[key];
     }
   });
+});
+var _autoQuery = require("./auto-query.js");
+Object.keys(_autoQuery).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _autoQuery[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _autoQuery[key];
+    }
+  });
 });