@miso.ai/client-sdk-ui 1.13.2-beta.0 → 1.14.0-beta.2

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

@@ -1,88 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _answerBased = _interopRequireDefault(require("./answer-based.js"));
-var _index = require("../actor/index.js");
-var _processors = require("./processors.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const ROLES_OPTIONS = _answerBased.default.ROLES_OPTIONS;
-class HybridSearchAnswer extends _answerBased.default {
-  constructor(superworkflow) {
-    super({
-      name: 'hybrid-search/answer',
-      plugin: superworkflow._plugin,
-      client: superworkflow._client,
-      options: superworkflow._options,
-      defaults: superworkflow._defaults,
-      roles: ROLES_OPTIONS,
-      superworkflow
-    });
-  }
-  _initProperties(args) {
-    super._initProperties(args);
-    this._superworkflow = args.superworkflow;
-  }
-  _initSession() {} // no reset here, will manually reset later
-
-  _doLoading(data) {
-    const {
-      session
-    } = this;
-    this.updateData(Object.assign({}, data, {
-      session
-    }));
-  }
-  _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 //
-  _defaultProcessData(data, oldData) {
-    data = super._defaultProcessData(data, oldData);
-    data = (0, _processors.writeKeywordsToData)(data);
-    data = (0, _processors.writeMisoIdFromSession)(data);
-    data = (0, _processors.writeUnanswerableToMeta)(data);
-    return data;
-  }
-  _handleHeadResponse(data) {
-    super._handleHeadResponse(data);
-    // keep track of miso_id in session
-    (0, _processors.writeMisoIdToSession)(data);
-  }
-
-  // interactions //
-  _onTracker(args) {
-    this._superworkflow._onTracker(args);
-  }
-}
-exports.default = HybridSearchAnswer;

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

@@ -1,109 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _searchBased = _interopRequireDefault(require("./search-based.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const RESULTS_ROLE_MEMBERS = _searchBased.default.ROLES_OPTIONS.members;
-function getSubworkflowByRole(role) {
-  // TODO: ROLE.ERROR
-  return RESULTS_ROLE_MEMBERS.includes(role) ? 'results' : 'answer';
-}
-class HybridSearchViewsActor {
-  constructor(subviews) {
-    this._subviews = subviews;
-    this._containers = new Set();
-  }
-  get filters() {
-    return this._subviews.results.filters;
-  }
-  on(role, event, callback) {
-    return this._getSubviews(role).on(role, event, callback);
-  }
-  get(role) {
-    return this._getSubviews(role).get(role);
-  }
-  getAll(role) {
-    return this._getSubviews(role).getAll(role);
-  }
-  addContainer(element) {
-    if (this._containers.has(element)) {
-      return;
-    }
-    this._containers.add(element);
-    const {
-      components
-    } = element;
-    for (const component of components) {
-      this.addComponent(component);
-    }
-  }
-  removeContainer(element) {
-    for (const subviews of this._getAllSubviews()) {
-      subviews.removeContainer(element);
-    }
-    this._containers.delete(element);
-  }
-  addComponent(element) {
-    this._getSubviews(element.role).addComponent(element);
-    this._addContainerToSubviews(element._container, element);
-  }
-  removeComponent(element) {
-    this._getSubviews(element.role).removeComponent(element);
-    this._removeContainerFromSubviewsIfNecessary(element._container);
-  }
-  updateComponentRole(element, oldRole, newRole) {
-    // TODO
-  }
-  refreshElement(element) {
-    this._getSubviews(element.role).refreshElement(element);
-  }
-
-  // helpers //
-  _getAllSubviews() {
-    return Object.values(this._subviews);
-  }
-  _getSubviews(role) {
-    return this._subviews[getSubworkflowByRole(role)];
-  }
-  _addContainerToSubviews(container, child) {
-    if (!container) {
-      return;
-    }
-    const {
-      role
-    } = child;
-    const subviews = this._getSubviews(role);
-    if (subviews._containers.has(container)) {
-      return;
-    }
-    // check if the container is in other subviews
-    for (const otherSubviews of this._getAllSubviews()) {
-      if (otherSubviews === subviews) {
-        continue;
-      }
-      if (otherSubviews._containers.has(container)) {
-        // find the conflicting element
-        for (const component of container.components) {
-          if (otherSubviews.containsElement(component)) {
-            throw new Error(`<${container.tagName.toLowerCase()}> cannot contain both <${component.tagName.toLowerCase()}> and <${child.tagName.toLowerCase()}>, for they don't share the same data lifecycle.`);
-          }
-        }
-        throw new Error(`Failed to add container <${container.tagName.toLowerCase()}> with child component <${child.tagName.toLowerCase()}>.`);
-      }
-    }
-    // add the container to the subviews
-    subviews.addContainer(container);
-  }
-  _removeContainerFromSubviewsIfNecessary(container) {
-    if (!container || container.components.length > 0) {
-      return;
-    }
-    for (const subviews of this._getAllSubviews()) {
-      subviews.removeContainer(container);
-    }
-  }
-}
-exports.default = HybridSearchViewsActor;

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

@@ -1,213 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-var _searchBased = _interopRequireDefault(require("./search-based.js"));
-var _answerBased = _interopRequireDefault(require("./answer-based.js"));
-var _constants = require("../constants.js");
-var _index = require("../layout/index.js");
-var _templates = require("../layout/templates.js");
-var _hybridSearchAnswer = _interopRequireDefault(require("./hybrid-search-answer.js"));
-var _hybridSearchViews = _interopRequireDefault(require("./hybrid-search-views.js"));
-var _index2 = require("./options/index.js");
-var _processors = require("./processors.js");
-var _autocompletable = require("./autocompletable.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const DEFAULT_API_OPTIONS = Object.freeze({
-  group: _commons.API.GROUP.ASK,
-  name: _commons.API.NAME.SEARCH,
-  payload: Object.assign({}, _answerBased.default.DEFAULT_API_OPTIONS.payload, _searchBased.default.DEFAULT_API_OPTIONS.payload, {
-    source_fl: ['cover_image', 'url', 'created_at', 'updated_at', 'published_at', 'title', 'authors']
-  })
-});
-const DEFAULT_LAYOUTS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_LAYOUTS, _searchBased.default.DEFAULT_LAYOUTS, {
-  [_constants.ROLE.QUERY]: [_index.SearchBoxLayout.type, {
-    placeholder: ''
-  }],
-  [_constants.ROLE.QUESTION]: [_index.TextLayout.type, {
-    raw: true
-  }],
-  [_constants.ROLE.SOURCES]: [_index.HorizontalLayout.type, {
-    incremental: true,
-    itemType: 'article',
-    templates: {
-      ordered: true,
-      article: _templates.compactArticle,
-      articleInfoBlock: _templates.compactArticleInfoBlock
-    }
-  }]
-}));
-const DEFAULT_TRACKERS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_TRACKERS, _searchBased.default.DEFAULT_TRACKERS));
-const DEFAULT_PAGINATION = Object.freeze(Object.assign({}, _searchBased.default.DEFAULT_PAGINATION, {
-  active: true
-}));
-const DEFAULT_AUTOCOMPLETE_OPTIONS = Object.freeze({
-  api: {
-    group: _commons.API.GROUP.ASK,
-    name: _commons.API.NAME.SEARCH_AUTOCOMPLETE,
-    payload: {
-      completion_fields: ['suggested_queries']
-    }
-  }
-});
-const DEFAULT_FILTERS_OPTIONS = Object.freeze({
-  sort: {
-    options: [{
-      field: 'relevance',
-      text: 'Relevance',
-      default: true
-    }, {
-      field: 'published_at',
-      text: 'Date'
-    }]
-  }
-});
-const DEFAULT_OPTIONS = Object.freeze(Object.assign({}, _answerBased.default.DEFAULT_OPTIONS, _searchBased.default.DEFAULT_OPTIONS, {
-  api: DEFAULT_API_OPTIONS,
-  layouts: DEFAULT_LAYOUTS,
-  trackers: DEFAULT_TRACKERS,
-  autocomplete: DEFAULT_AUTOCOMPLETE_OPTIONS,
-  pagination: DEFAULT_PAGINATION,
-  filters: DEFAULT_FILTERS_OPTIONS
-}));
-const ROLES_OPTIONS = Object.freeze({
-  main: _constants.ROLE.PRODUCTS,
-  members: Object.keys(DEFAULT_LAYOUTS),
-  mappings: Object.freeze(Object.assign({}, _answerBased.default.ROLES_OPTIONS.mappings, _searchBased.default.ROLES_OPTIONS.mappings))
-});
-const EXTRA_OPTIONS = Object.freeze({
-  api: Object.freeze({
-    polling: false
-  })
-});
-class HybridSearch extends _searchBased.default {
-  constructor(plugin, client) {
-    super({
-      name: 'hybrid-search',
-      plugin,
-      client,
-      roles: ROLES_OPTIONS,
-      defaults: DEFAULT_OPTIONS,
-      extraOptions: EXTRA_OPTIONS
-    });
-  }
-  _initProperties(args) {
-    super._initProperties(args);
-    this._initAutocomplete(args);
-    this._answer = new _hybridSearchAnswer.default(this);
-  }
-  _initActors(args) {
-    super._initActors(args);
-    this._views = new _hybridSearchViews.default({
-      results: this._views,
-      answer: this._answer._views
-    });
-  }
-  restart({
-    type
-  } = {}) {
-    super.restart();
-    if (!type || type === _constants.REQUEST_TYPE.QUERY) {
-      this._answer.restart();
-    }
-  }
-
-  // properties //
-  get answer() {
-    return this._answer;
-  }
-  get questionId() {
-    return this._answer.questionId;
-  }
-
-  // query //
-  _buildPayload(payload, type) {
-    payload = super._buildPayload(payload, type);
-    // borrow the work from the sibling
-    payload = (0, _processors.disableAnswerForNonQueryRequest)(payload, type);
-    payload = (0, _processors.writeQuestionSourceToPayload)(payload);
-    payload = this._writeQuestionIdToPayload(payload, type);
-    if (payload.answer !== false) {
-      // uses autoQuery params, so we want to apply to this workflow
-      payload = _answerBased.default.prototype._writeWikiLinkTemplateToPayload.call(this, payload);
-    }
-    return payload;
-  }
-  _buildOrderBy(sort) {
-    if (!sort) {
-      return undefined;
-    }
-    // works differently than search
-    return sort.field;
-  }
-  _writeQuestionIdToPayload(payload, type) {
-    if (type === _constants.REQUEST_TYPE.QUERY) {
-      return payload;
-    }
-    const question_id = this._answer.questionId;
-    if (!question_id) {
-      return payload;
-    }
-    return (0, _commons.mergeApiPayloads)(payload, {
-      metadata: {
-        question_id
-      }
-    });
-  }
-
-  // data //
-  _defaultProcessData(data, oldData) {
-    data = super._defaultProcessData(data, oldData);
-    (0, _processors.writeMisoIdToSession)(data);
-    return data;
-  }
-  _updateDataInHub(data, oldData) {
-    this._dispatchDataToAnswerWorkflow(data);
-    data = (0, _processors.carryOverQuestionIdToData)(data, oldData); // TODO: may as well move to process data
-    super._updateDataInHub(data, oldData);
-  }
-  _dispatchDataToAnswerWorkflow(data) {
-    const {
-      request
-    } = data;
-    if (!request) {
-      return;
-    }
-    const {
-      type,
-      payload
-    } = request;
-    if (type !== _constants.REQUEST_TYPE.QUERY || !payload || payload.answer === false) {
-      return;
-    }
-    switch (data.status) {
-      case _constants.STATUS.LOADING:
-        // share the loading status with its sibling
-        this._answer._doLoading(data);
-        break;
-      case _constants.STATUS.READY:
-        // start a query with retrieved question ID, if any
-        this._answer._queryWithQuestionId(data);
-        break;
-    }
-  }
-
-  // interactions //
-  _defaultProcessInteraction(payload, args) {
-    payload = super._defaultProcessInteraction(payload, args);
-    payload = (0, _processors.writeAnswerInfoToInteraction)(payload, args);
-    return payload;
-  }
-
-  // destroy //
-  _destroy() {
-    this._answer.destroy();
-    super._destroy();
-  }
-}
-exports.default = HybridSearch;
-(0, _index2.makeConfigurable)(HybridSearch.prototype, [_constants.WORKFLOW_CONFIGURABLE.PAGINATION, _constants.WORKFLOW_CONFIGURABLE.FILTERS]);
-(0, _autocompletable.makeAutocompletable)(HybridSearch.prototype);

package/dist/cjs/workflow/index.js

@@ -1,41 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "Asks", {
-  enumerable: true,
-  get: function () {
-    return _asks.default;
-  }
-});
-Object.defineProperty(exports, "Explores", {
-  enumerable: true,
-  get: function () {
-    return _explores.default;
-  }
-});
-Object.defineProperty(exports, "HybridSearch", {
-  enumerable: true,
-  get: function () {
-    return _hybridSearch.default;
-  }
-});
-Object.defineProperty(exports, "Recommendations", {
-  enumerable: true,
-  get: function () {
-    return _recommendations.default;
-  }
-});
-Object.defineProperty(exports, "Search", {
-  enumerable: true,
-  get: function () {
-    return _search.default;
-  }
-});
-var _asks = _interopRequireDefault(require("./asks.js"));
-var _hybridSearch = _interopRequireDefault(require("./hybrid-search.js"));
-var _search = _interopRequireDefault(require("./search.js"));
-var _recommendations = _interopRequireDefault(require("./recommendations.js"));
-var _explores = _interopRequireDefault(require("./explores.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }

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

@@ -1,41 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.mergeApiOptions = mergeApiOptions;
-exports.normalizeApiOptions = normalizeApiOptions;
-var _commons = require("@miso.ai/commons");
-var _utils = require("./utils.js");
-function normalizeApiOptions([name, payload] = []) {
-  // TODO: take object form as well
-  if (name === false) {
-    return {
-      actor: false
-    };
-  }
-  if (typeof name === 'object' && payload === undefined) {
-    payload = name;
-    name = undefined;
-  }
-  let group = undefined;
-  if (name && name.indexOf('/') !== -1) {
-    [group, name] = name.split('/');
-  }
-  if (name && typeof name !== 'string' || payload !== undefined && typeof payload !== 'object') {
-    throw new Error(`Invalid arguments for useApi(): ${name}, ${payload}`);
-  }
-  return (0, _commons.trimObj)({
-    group,
-    name,
-    payload
-  });
-}
-function mergeApiOptions(...optionsList) {
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return (0, _utils.mergeOptions)(optionsList, (merged, options) => Object.assign(merged, Object.assign({}, options, {
-    payload: (0, _commons.mergeApiPayloads)(merged.payload, options.payload)
-  })));
-}

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

@@ -1,97 +0,0 @@
-"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;
-exports.updateQueryParametersInUrl = updateQueryParametersInUrl;
-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; }
-// TODO: eliminate browser dependency?
-
-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(_ref = {}) {
-  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(options = {}) {
-  // 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;
-
-  // because it's probably not there yet, but this is an ad-hoc solution
-  setTimeout(() => {
-    for (const view of this._views.getAll(_constants.ROLE.QUERY)) {
-      const {
-        layout
-      } = view;
-      if (q && setValue) {
-        layout.value = q;
-      }
-      if (!q && focus) {
-        layout.focus();
-      }
-    }
-  });
-  if (q) {
-    this.query((0, _commons.trimObj)({
-      q,
-      qs
-    }));
-  }
-}
-function updateQueryParametersInUrl({
-  value,
-  request
-}) {
-  if (!this._autoQuery || !this._autoQuery.updateUrl) {
-    return;
-  }
-  const {
-    param,
-    sourceParam
-  } = this._autoQuery;
-  const query = value && (value.question || value.keyword) || request && request.payload && (request.payload.question || request.payload.q);
-  const querySource = request && request.payload && request.payload.metadata && request.payload.metadata.question_source;
-  if (!query) {
-    return; // at initial phase
-  }
-  const url = new URL(window.location);
-  const currentQuery = url.searchParams.get(param);
-  const currentQuerySource = url.searchParams.get(sourceParam) || _constants.QUESTION_SOURCE.ORGANIC;
-  if (query === currentQuery && querySource === currentQuerySource) {
-    return;
-  }
-  url.searchParams.set(param, query);
-  if (querySource === _constants.QUESTION_SOURCE.ORGANIC) {
-    url.searchParams.delete(sourceParam);
-  } else {
-    url.searchParams.set(sourceParam, querySource);
-  }
-  window.history.replaceState({}, '', url);
-}

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

@@ -1,45 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.makeConfigurable = makeConfigurable;
-var _constants = require("../../constants.js");
-const DEFAULT_FEATURES = [_constants.WORKFLOW_CONFIGURABLE.API, _constants.WORKFLOW_CONFIGURABLE.LAYOUTS, _constants.WORKFLOW_CONFIGURABLE.DATA_PROCESSOR, _constants.WORKFLOW_CONFIGURABLE.TRACKERS, _constants.WORKFLOW_CONFIGURABLE.INTERACTIONS];
-function makeConfigurable(prototype, features = DEFAULT_FEATURES) {
-  for (const feature of features) {
-    injectConfigurableFeature(prototype, feature);
-  }
-}
-function injectConfigurableFeature(prototype, feature) {
-  if (feature === 'api') {
-    Object.assign(prototype, {
-      useApi(...args) {
-        this._options.api.merge(args);
-        return this;
-      },
-      clearApi() {
-        this._options.api.set();
-        return this;
-      }
-    });
-  } else {
-    const upperCased = upperCase(feature);
-    Object.assign(prototype, {
-      [`use${upperCased}`](value) {
-        this._options[feature].merge(value);
-        return this;
-      },
-      [`clear${upperCased}`]() {
-        this._options[feature].set();
-        return this;
-      }
-    });
-  }
-}
-
-// helpers //
-// TODO: move to commons
-function upperCase(str) {
-  return str.charAt(0).toUpperCase() + str.slice(1);
-}

package/dist/cjs/workflow/options/data-processor.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.mergeDataProcessorOptions = mergeDataProcessorOptions;
-exports.normalizeDataProcessorOptions = normalizeDataProcessorOptions;
-var _commons = require("@miso.ai/commons");
-function normalizeDataProcessorOptions(fns) {
-  fns = (0, _commons.asArray)(fns);
-  for (const fn of fns) {
-    if (typeof fn !== 'function') {
-      throw new Error(`Expect data processor options to be a function: ${fn}`);
-    }
-  }
-  return fns;
-}
-function mergeDataProcessorOptions(...optionsList) {
-  return optionsList.flat().filter(Boolean);
-}

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

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.mergeFiltersOptions = mergeFiltersOptions;
-exports.normalizeFiltersOptions = void 0;
-var _utils = require("./utils.js");
-const normalizeFiltersOptions = exports.normalizeFiltersOptions = _utils.normalizeOptions;
-function mergeFiltersOptions(...optionsList) {
-  if (optionsList[optionsList.length - 1] === false) {
-    return false;
-  }
-  return (0, _utils.mergeOptions)(optionsList, (merged, options) => Object.assign(merged, options));
-}