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

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.11';
+var _default = exports.default = '1.11.0-beta.12';

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

@@ -12,6 +12,7 @@ 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 }; }
 const DEFAULT_API_OPTIONS = Object.freeze(Object.assign({}, _base.default.DEFAULT_API_OPTIONS, {
   group: _commons.API.GROUP.ASK,
@@ -84,15 +85,6 @@ class AnswerBasedWorkflow extends _base.default {
     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))];
   }
 
-  // configuration //
-  useLink(fn) {
-    if (typeof fn !== 'function' && fn !== false) {
-      throw new Error('useLink(fn) expects fn to be a function or false');
-    }
-    this._linkFn = fn;
-    return this;
-  }
-
   // lifecycle //
   restart() {
     // clear question id from previous session
@@ -166,7 +158,7 @@ class AnswerBasedWorkflow extends _base.default {
   _query() {
     let args = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     if (this._linkFn) {
-      this._submit(args);
+      this._submitToPage(args);
       return;
     }
     // start a new session
@@ -181,14 +173,6 @@ class AnswerBasedWorkflow extends _base.default {
       payload
     });
   }
-  _submit(args) {
-    if (!this._linkFn) {
-      return;
-    }
-    // TODO: we want a submit event, but only with linkFn
-    const url = this._linkFn(args.q);
-    window.open(url, '_blank');
-  }
   _writeQuestionSourceToSession(args) {
     this.session.meta.question_source = args.qs || _constants.ORGANIC_QUESTION_SOURCE; // might be null, not undefined
   }
@@ -323,6 +307,7 @@ class AnswerBasedWorkflow extends _base.default {
   }
 }
 exports.default = AnswerBasedWorkflow;
+(0, _useLink.enableUseLink)(AnswerBasedWorkflow.prototype);
 Object.assign(AnswerBasedWorkflow, {
   DEFAULT_API_OPTIONS,
   DEFAULT_AUTOCOMPLETE_OPTIONS,

package/dist/cjs/workflow/explore.js

@@ -10,6 +10,7 @@ var _index = require("../actor/index.js");
 var _constants = require("../constants.js");
 var _index2 = require("../layout/index.js");
 var _options = require("./options.js");
+var _useLink = require("./use-link.js");
 const _excluded = ["value"];
 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; }
@@ -61,7 +62,7 @@ class Explore extends _base.default {
   }
   _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(), args => this._submit(args))];
+    this._unsubscribes = [...this._unsubscribes, this._views.get(_constants.ROLE.RELATED_QUESTIONS).on('click', event => this._handleRelatedQuestionClick(event)), this._hub.on(_index.fields.query(), args => this._query(args))];
   }
 
   // configuration //
@@ -80,13 +81,6 @@ class Explore extends _base.default {
     }
     return super.useApi(options);
   }
-  useLink(fn) {
-    if (typeof fn !== 'function' && fn !== false) {
-      throw new Error('useLink(fn) expects fn to be a function or false');
-    }
-    this._linkFn = fn;
-    return this;
-  }
 
   // lifecycle //
   start() {
@@ -94,7 +88,7 @@ class Explore extends _base.default {
       relatedQuestions = true
     } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     if (this._linkFn === undefined) {
-      throw new Error('Define link mapping function before calling start()');
+      throw new Error('Must define link mapping function with useLink(fn) before calling start()');
     }
     // in explore workflow, start() triggers query
     // TODO: we should still make the query lifecycle
@@ -125,16 +119,24 @@ class Explore extends _base.default {
   }
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
-    let {
+    data = this._addUrlToRelatedQuestions(data);
+    return data;
+  }
+  _addUrlToRelatedQuestions(data) {
+    const {
       value
     } = data;
-    if (!value) {
+    if (!value || !value.related_questions) {
       return data;
     }
-    // patch value with links
-    const related_questions = value.related_questions.map(this._linkFn ? text => ({
+    const linkFn = this._linkFn && this._linkFn[0];
+    const related_questions = value.related_questions.map(linkFn ? text => ({
       text,
-      url: this._getAnswersUrl(text, true)
+      url: this._getSubmitUrl({
+        q: text
+      }, {
+        generated: true
+      })
     }) : text => ({
       text
     }));
@@ -159,26 +161,19 @@ class Explore extends _base.default {
     }
     this._hub.update(_index.fields.query(), args);
   }
-  _submit() {
-    let {
-      q
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    if (!this._linkFn) {
-      return;
-    }
-    const url = this._getAnswersUrl(q);
-    window.open(url, '_blank');
+  _query(args) {
+    this._submitToPage(args);
   }
-  _getAnswersUrl(text) {
-    let generated = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-    if (!this._linkFn) {
-      return;
-    }
-    const url = this._linkFn(text);
+  _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) {
       return url;
     }
     return `${url}&qs=${encodeURIComponent(this._productId)}`;
   }
 }
-exports.default = Explore;
+exports.default = Explore;
+(0, _useLink.enableUseLink)(Explore.prototype);

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

@@ -95,8 +95,8 @@ class HybridSearch extends _base.default {
   }
 
   // configuration //
-  useLink(fn) {
-    this._answer.useLink(fn);
+  useLink(fn, options) {
+    this._answer.useLink(fn, options);
     return this;
   }
 

package/dist/cjs/workflow/use-link.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UseLinkMixin = void 0;
+exports.enableUseLink = enableUseLink;
+var _commons = require("@miso.ai/commons");
+function enableUseLink(prototype) {
+  (0, _commons.mixin)(prototype, UseLinkMixin.prototype);
+}
+class UseLinkMixin {
+  useLink(fn) {
+    let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    if (typeof fn !== 'function' && fn !== false) {
+      throw new Error('useLink(fn) expects fn to be a function or false');
+    }
+    this._linkFn = fn ? [fn, options] : false;
+    return this;
+  }
+  _submitToPage() {
+    let args = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    if (!this._linkFn) {
+      return;
+    }
+    // TODO: we want a submit event
+    const url = this._getSubmitUrl(args);
+    const [_, options = {}] = this._linkFn;
+    if (options.open === false) {
+      window.location.href = url;
+    } else {
+      const target = options.target || '_blank';
+      const windowFeatures = options.windowFeatures || '';
+      window.open(url, target, windowFeatures);
+    }
+  }
+  _getSubmitUrl(args) {
+    if (!this._linkFn) {
+      throw new Error('useLink(fn) must be called before _getSubmitUrl()');
+    }
+    return this._linkFn[0](args.q);
+  }
+}
+exports.UseLinkMixin = UseLinkMixin;

package/package.json

@@ -26,7 +26,7 @@
     "url": "https://github.com/MisoAI/miso-client-js-sdk/issues"
   },
   "dependencies": {
-    "@miso.ai/commons": "1.11.0-beta.11"
+    "@miso.ai/commons": "1.11.0-beta.12"
   },
-  "version": "1.11.0-beta.11"
+  "version": "1.11.0-beta.12"
 }

package/src/version.js

@@ -1 +1 @@
-export default '1.11.0-beta.11';
+export default '1.11.0-beta.12';

package/src/workflow/answer-based.js

@@ -6,6 +6,7 @@ import { SearchBoxLayout, TextLayout, ListLayout, TypewriterLayout, FeedbackLayo
 import { processData as processAffiliationData } from '../affiliation/index.js';
 import { mergeRolesOptions } from './options.js';
 import { writeAnswerStageToMeta, mergeInteraction } from './processors.js';
+import { enableUseLink } from './use-link.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({
   ...Workflow.DEFAULT_API_OPTIONS,
@@ -80,15 +81,6 @@ export default class AnswerBasedWorkflow extends Workflow {
     ];
   }
 
-  // configuration //
-  useLink(fn) {
-    if (typeof fn !== 'function' && fn !== false) {
-      throw new Error('useLink(fn) expects fn to be a function or false');
-    }
-    this._linkFn = fn;
-    return this;
-  }
-
   // lifecycle //
   restart() {
     // clear question id from previous session
@@ -154,7 +146,7 @@ export default class AnswerBasedWorkflow extends Workflow {
 
   _query(args = {}) {
     if (this._linkFn) {
-      this._submit(args);
+      this._submitToPage(args);
       return;
     }
     // start a new session
@@ -168,15 +160,6 @@ export default class AnswerBasedWorkflow extends Workflow {
     this._request({ payload });
   }
 
-  _submit(args) {
-    if (!this._linkFn) {
-      return;
-    }
-    // TODO: we want a submit event, but only with linkFn
-    const url = this._linkFn(args.q);
-    window.open(url, '_blank');
-  }
-
   _writeQuestionSourceToSession(args) {
     this.session.meta.question_source = args.qs || ORGANIC_QUESTION_SOURCE; // might be null, not undefined
   }
@@ -294,6 +277,8 @@ export default class AnswerBasedWorkflow extends Workflow {
 
 }
 
+enableUseLink(AnswerBasedWorkflow.prototype);
+
 Object.assign(AnswerBasedWorkflow, {
   DEFAULT_API_OPTIONS,
   DEFAULT_AUTOCOMPLETE_OPTIONS,

package/src/workflow/explore.js

@@ -4,6 +4,7 @@ import { fields } from '../actor/index.js';
 import { ROLE, EVENT_TYPE } from '../constants.js';
 import { ListLayout, SearchBoxLayout } from '../layout/index.js';
 import { mergeRolesOptions } from './options.js';
+import { enableUseLink, UseLinkMixin } from './use-link.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({
   ...Workflow.DEFAULT_API_OPTIONS,
@@ -61,7 +62,7 @@ export default class Explore extends Workflow {
     this._unsubscribes = [
       ...this._unsubscribes,
       this._views.get(ROLE.RELATED_QUESTIONS).on('click', event => this._handleRelatedQuestionClick(event)),
-      this._hub.on(fields.query(), args => this._submit(args)),
+      this._hub.on(fields.query(), args => this._query(args)),
     ];
   }
 
@@ -81,18 +82,10 @@ export default class Explore extends Workflow {
     return super.useApi(options);
   }
 
-  useLink(fn) {
-    if (typeof fn !== 'function' && fn !== false) {
-      throw new Error('useLink(fn) expects fn to be a function or false');
-    }
-    this._linkFn = fn;
-    return this;
-  }
-
   // lifecycle //
   start({ relatedQuestions = true } = {}) {
     if (this._linkFn === undefined) {
-      throw new Error('Define link mapping function before calling start()');
+      throw new Error('Must define link mapping function with useLink(fn) before calling start()');
     }
     // in explore workflow, start() triggers query
     // TODO: we should still make the query lifecycle
@@ -113,12 +106,17 @@ export default class Explore extends Workflow {
 
   _defaultProcessData(data) {
     data = super._defaultProcessData(data);
-    let { value } = data;
-    if (!value) {
+    data = this._addUrlToRelatedQuestions(data);
+    return data;
+  }
+
+  _addUrlToRelatedQuestions(data) {
+    const { value } = data;
+    if (!value || !value.related_questions) {
       return data;
     }
-    // patch value with links
-    const related_questions = value.related_questions.map(this._linkFn ? (text => ({ text, url: this._getAnswersUrl(text, true) })) : (text => ({ text })));
+    const linkFn = this._linkFn && this._linkFn[0];
+    const related_questions = value.related_questions.map(linkFn ? (text => ({ text, url: this._getSubmitUrl({ q: text }, { generated: true }) })) : (text => ({ text })));
     return {
       ...data,
       value: {
@@ -139,19 +137,12 @@ export default class Explore extends Workflow {
     this._hub.update(fields.query(), args);
   }
 
-  _submit({ q } = {}) {
-    if (!this._linkFn) {
-      return;
-    }
-    const url = this._getAnswersUrl(q);
-    window.open(url, '_blank');
+  _query(args) {
+    this._submitToPage(args);
   }
 
-  _getAnswersUrl(text, generated = false) {
-    if (!this._linkFn) {
-      return;
-    }
-    const url = this._linkFn(text);
+  _getSubmitUrl(args, { generated = false } = {}) {
+    let url = UseLinkMixin.prototype._getSubmitUrl.call(this, args);
     if (!generated || !this._productId) {
       return url;
     }
@@ -159,3 +150,5 @@ export default class Explore extends Workflow {
   }
 
 }
+
+enableUseLink(Explore.prototype);

package/src/workflow/hybrid-search.js

@@ -111,8 +111,8 @@ export default class HybridSearch extends Workflow {
   }
 
   // configuration //
-  useLink(fn) {
-    this._answer.useLink(fn);
+  useLink(fn, options) {
+    this._answer.useLink(fn, options);
     return this;
   }
 

package/src/workflow/use-link.js

@@ -0,0 +1,40 @@
+import { mixin } from '@miso.ai/commons';
+
+export function enableUseLink(prototype) {
+  mixin(prototype, UseLinkMixin.prototype);
+}
+
+export class UseLinkMixin {
+
+  useLink(fn, options = {}) {
+    if (typeof fn !== 'function' && fn !== false) {
+      throw new Error('useLink(fn) expects fn to be a function or false');
+    }
+    this._linkFn = fn ? [fn, options] : false;
+    return this;
+  }
+
+  _submitToPage(args = {}) {
+    if (!this._linkFn) {
+      return;
+    }
+    // TODO: we want a submit event
+    const url = this._getSubmitUrl(args);
+    const [_, options = {}] = this._linkFn;
+    if (options.open === false) {
+      window.location.href = url;
+    } else {
+      const target = options.target || '_blank';
+      const windowFeatures = options.windowFeatures || '';
+      window.open(url, target, windowFeatures);
+    }
+  }
+
+  _getSubmitUrl(args) {
+    if (!this._linkFn) {
+      throw new Error('useLink(fn) must be called before _getSubmitUrl()');
+    }
+    return this._linkFn[0](args.q);
+  }
+
+}