@miso.ai/client-sdk-ui 1.13.2-beta.1 → 1.14.0-beta.3

package/dist/cjs/layout/list/threads.js

@@ -0,0 +1,199 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _clientSdkWorkflow = require("@miso.ai/client-sdk-workflow");
+var _constants = require("../../constants.js");
+var _collection = _interopRequireDefault(require("./collection.js"));
+var _dom = require("../../util/dom.js");
+const _excluded = ["className"];
+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 TYPE = _constants.LAYOUT_TYPE.THREADS;
+const DEFAULT_CLASSNAME = 'miso-threads';
+
+/**
+ * The thread list of the chat history interface: a shell that renders one
+ * <miso-thread-item> container element per thread item, incrementally —
+ * fresh items land at either end of the list: a newly created thread
+ * renders as a prepended item (the list is newest-first), while an older
+ * page fetched by the more flow (infinite scroll: the collection layout's
+ * stock trigger, viewable at the list's bottom, fires the `more` hub
+ * field) renders as appended items — told apart by which boundary the
+ * already-rendered records line up with. The content
+ * of an item is not rendered here: each <miso-thread-item> is assigned its item
+ * subworkflow (workflow._getThreadWorkflow, off the item binding) in the
+ * post-render sync pass, and the role elements inside (the title, and the
+ * context menu's rename/delete buttons) render through that workflow's own
+ * layouts — so a record change re-renders the affected item's roles alone.
+ *
+ * The shell keeps the list-level behaviors. Selection comes with the data:
+ * the history workflow stamps `selectedThreadId` into its value and
+ * decorates each thread record with a `selected` flag, so any selection
+ * change flows down the regular data path; in-place state changes on
+ * existing items (selected, unread, the thread identity of a settled
+ * placeholder) are applied by `_syncItems` after each render, reading the
+ * fresh values off the item bindings — no item re-render needed. Each item
+ * carries a context menu (vertical dots), but that is the thread workflow's
+ * too: its item-container layout inserts and toggles it — the shell only
+ * keeps menu clicks (by their item-menu data-roles) from selecting.
+ */
+class ThreadsLayout extends _collection.default {
+  static get type() {
+    return TYPE;
+  }
+  static get defaultClassName() {
+    return DEFAULT_CLASSNAME;
+  }
+  constructor(_ref = {}) {
+    let {
+        className = DEFAULT_CLASSNAME
+      } = _ref,
+      options = _objectWithoutPropertiesLoose(_ref, _excluded);
+    super(Object.assign({
+      className
+    }, options));
+  }
+
+  // item identity: the thread id, or the local placeholder id standing in
+  // for it while a thread is being created — the workflow adopts the thread
+  // id at the settle, so the element and its workflow survive it
+  _getItemKey(thread) {
+    return thread.thread_id || thread.placeholder_id || thread;
+  }
+
+  // incremental renders cover a pure prepend (a created thread) or a pure
+  // append (an older page) — anything else re-renders in full
+  _shallRenderIncrementally(state, rendered) {
+    if (!super._shallRenderIncrementally(state, rendered)) {
+      return false;
+    }
+    const values = this._getItems(state) || [];
+    const renderedValues = rendered.value;
+    const count = values.length - renderedValues.length;
+    return count === 0 ||
+    // in-place changes only
+    this._getItemKey(values[0]) === this._getItemKey(renderedValues[0]) ||
+    // appended
+    this._getItemKey(values[count]) === this._getItemKey(renderedValues[0]); // prepended
+  }
+
+  // the fresh items land at the head (a newly created thread — the list is
+  // newest-first) or at the tail (an older page fetched by the more flow):
+  // told apart by which boundary the already-rendered records line up with
+  _html(state, rendered, incremental) {
+    if (!incremental) {
+      return this.templates.root(this, state);
+    }
+    const values = this._getItems(state) || [];
+    const renderedValues = rendered.value;
+    const count = values.length - renderedValues.length;
+    if (count === 0) {
+      return '';
+    }
+    if (this._getItemKey(values[0]) === this._getItemKey(renderedValues[0])) {
+      const fresh = values.slice(renderedValues.length);
+      return {
+        position: 'beforeend',
+        items: this.templates.items(this, state, fresh, {
+          offset: renderedValues.length
+        })
+      };
+    }
+    const fresh = values.slice(0, count);
+    return {
+      position: 'afterbegin',
+      items: this.templates.items(this, state, fresh, {
+        offset: 0
+      })
+    };
+  }
+  _render(element, {
+    state
+  }, {
+    notifyUpdate
+  }) {
+    const {
+      incremental,
+      html
+    } = state;
+    if (incremental) {
+      if (html) {
+        this._getListElement(element).insertAdjacentHTML(html.position, html.items);
+      } else {
+        notifyUpdate(false);
+      }
+    } else {
+      element.innerHTML = html;
+    }
+  }
+  _afterRender(element, state) {
+    super._afterRender(element, state); // syncs bindings to the latest values
+    this._syncWorkflows(element);
+    this._syncItems(element);
+  }
+
+  // assign each <miso-thread-item> its item subworkflow, off the item binding
+  _syncWorkflows(element) {
+    const workflow = this._view && this._view.workflow;
+    if (!workflow || typeof workflow._getThreadWorkflow !== 'function') {
+      return;
+    }
+    for (const item of this._getItemElements(element)) {
+      const binding = this._bindings.get(item);
+      if (binding && item.isContainer) {
+        item.workflow = workflow._getThreadWorkflow(binding.value);
+      }
+    }
+  }
+
+  // sync in-place item state changes from the bound values onto the existing
+  // item elements: selection/unread state, and the thread identity of a
+  // placeholder that settled into its real record — the item contents render
+  // through the thread workflows, outside this layout's render cycle
+  _syncItems(element) {
+    for (const item of this._getItemElements(element)) {
+      const binding = this._bindings.get(item);
+      if (!binding) {
+        continue;
+      }
+      const {
+        value
+      } = binding;
+      (0, _dom.setOrRemoveAttribute)(item, 'data-selected', value.selected ? '' : undefined);
+      (0, _dom.setOrRemoveAttribute)(item, 'data-unread', (0, _clientSdkWorkflow.isThreadUnread)(value) ? '' : undefined);
+      (0, _dom.setOrRemoveAttribute)(item, 'data-thread-id', value.thread_id || undefined);
+    }
+  }
+
+  // a click on a thread item means selection — a navigation action, not a
+  // content-engagement click: emit a select view event and skip click tracking
+  _onClick(event) {
+    if (event.target.closest(`[data-role="item-menu-button"], [data-role="item-menu"]`)) {
+      return; // the item's own context menu, owned by its container layout
+    }
+    const element = event.target.closest(`[data-role="item"]`);
+    if (!element) {
+      return;
+    }
+    const binding = this._bindings.get(element);
+    if (!binding) {
+      return;
+    }
+    const {
+      session
+    } = this._view._state;
+    const {
+      value
+    } = binding;
+    this._view._emit('select', {
+      session,
+      value,
+      element: binding.element,
+      domEvent: event
+    });
+  }
+}
+exports.default = ThreadsLayout;

package/dist/cjs/layout/mixin/trackable.js

@@ -8,7 +8,7 @@ exports.makeTrackable = makeTrackable;
 var _commons = require("@miso.ai/commons");
 var _bindings = _interopRequireDefault(require("../../util/bindings.js"));
 var _viewables = _interopRequireDefault(require("../../util/viewables.js"));
-var _trackers = require("../../util/trackers.js");
+var _clientSdkWorkflow = require("@miso.ai/client-sdk-workflow");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function makeTrackable(prototype) {
   (0, _commons.mixin)(prototype, TrackableMixin.prototype);
@@ -36,8 +36,7 @@ class TrackableMixin {
     this._onBindingsUpdate(bounds, unbounds);
   }
   _getItemKey(value) {
-    // TODO: ad-hoc!
-    return value.product_id || value.text || value.id || value;
+    return this._view.tracker.getItemKey(value);
   }
   _getItems(state) {
     throw new Error(`Not implemented.`);
@@ -92,8 +91,8 @@ class TrackableMixin {
     const {
       click: options
     } = this._view.tracker.options || {};
-    if ((0, _trackers.validateClick)(options, event, binding)) {
-      (0, _trackers.markAsTracked)(event);
+    if ((0, _clientSdkWorkflow.validateClick)(options, event, binding)) {
+      (0, _clientSdkWorkflow.markAsTracked)(event);
       this._view.tracker.click([binding.value]);
     }
   }

package/dist/cjs/layout/mixin/triggerable.js

@@ -7,7 +7,7 @@ exports.TriggerableMixin = void 0;
 exports.makeTriggerable = makeTriggerable;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../../constants.js");
-var _index = require("../../actor/index.js");
+var _clientSdkWorkflow = require("@miso.ai/client-sdk-workflow");
 function makeTriggerable(prototype) {
   (0, _commons.mixin)(prototype, TriggerableMixin.prototype);
 }
@@ -63,7 +63,7 @@ class TriggerableMixin {
     }
   }
   _onTrigger() {
-    this._view.hub.trigger(_index.fields.more());
+    this._view.hub.trigger(_clientSdkWorkflow.fields.more());
   }
   _untrackTrigger() {
     if (!this._trigger) {

package/dist/cjs/layout/radio/feedback.js

@@ -4,13 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _index = require("../../actor/index.js");
+var _constants = require("../../constants.js");
+var _clientSdkWorkflow = require("@miso.ai/client-sdk-workflow");
 var _radio = _interopRequireDefault(require("./radio.js"));
 var _svgs = require("../svgs.js");
 const _excluded = ["className", "templates"];
 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 TYPE = 'feedback';
+const TYPE = _constants.LAYOUT_TYPE.FEEDBACK;
 const DEFAULT_CLASSNAME = 'miso-feedback';
 const OPTIONS = ['helpful', 'unhelpful'];
 function options(layout) {
@@ -78,7 +79,7 @@ class FeedbackLayout extends _radio.default {
     super(Object.assign({
       className,
       templates: Object.assign({}, DEFAULT_TEMPLATES, templates),
-      field: _index.fields.feedback()
+      field: _clientSdkWorkflow.fields.feedback()
     }, options));
     if (options.text === false && options.icon === false) {
       throw new Error('At least one of options.text or options.icon must be enabled');

package/dist/cjs/layout/templates.js

@@ -22,14 +22,23 @@ exports.image = image;
 exports.imageBlock = imageBlock;
 exports.imageInfoBlock = imageInfoBlock;
 exports.indexBlock = indexBlock;
+exports.message = message;
+exports.messageBody = messageBody;
+exports.messageErrorBlock = messageErrorBlock;
+exports.messageSourcesBlock = messageSourcesBlock;
 exports.priceBlock = priceBlock;
 exports.product = product;
 exports.productInfoBlock = productInfoBlock;
 exports.question = question;
 exports.requiresImplementation = requiresImplementation;
+exports.thread = thread;
+exports.threadBody = threadBody;
+exports.threadMenuBlock = threadMenuBlock;
 exports.titleBlock = titleBlock;
 exports.unimplemented = unimplemented;
 var _commons = require("@miso.ai/commons");
+var _clientSdkWorkflow = require("@miso.ai/client-sdk-workflow");
+var _svgs = require("../asset/svgs.js");
 var _constants = require("../constants.js");
 const _excluded = ["classSuffix", "role"];
 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; }
@@ -55,6 +64,94 @@ function question(layout, state, data) {
   const [openTag, closeTag] = tagPair(layout, data);
   return `${openTag}${data.value || data.text || data}${closeTag}`;
 }
+
+/**
+ * A thread item is a <miso-thread-item> container element hosting the thread
+ * item subworkflow — the threads layout is a shell: it assigns the workflow
+ * (and syncs the item-level attributes) in its post-render pass, and the
+ * content renders through the thread workflow's own layouts: the title role
+ * element in the body, plus the context menu (with the
+ * rename/subscription/delete role elements) inserted as chrome by the workflow's item-container layout. The
+ * item state renders as attributes right in the template (and stays in
+ * sync thereafter): the thread identity, the selection, and the unread
+ * mark.
+ */
+function thread(layout, state, data) {
+  const {
+    className,
+    templates
+  } = layout;
+  const threadId = data.thread_id;
+  const threadIdAttr = threadId ? ` data-thread-id="${threadId}"` : '';
+  const unreadAttr = (0, _clientSdkWorkflow.isThreadUnread)(data) ? ' data-unread' : '';
+  const selectedAttr = data.selected ? ' data-selected' : '';
+  return [`<miso-thread-item class="${className}__item-body" data-role="item"${threadIdAttr}${unreadAttr}${selectedAttr}>`, (templates.threadBody || threadBody)(layout, data), `</miso-thread-item>`].join('');
+}
+function threadBody(layout, data) {
+  const {
+    className,
+    templates
+  } = layout;
+  return `<miso-title class="${className}__title"></miso-title>` + (templates.threadMenuBlock || threadMenuBlock)(layout, data);
+}
+
+// the item-menu data-roles are the contract with the thread workflow's
+// item-container layout, which drives the menu's open/close behavior; the
+// menu items are the thread workflow's own controls, rendered by the
+// generic button layout with a prompt (rename) or a confirm (delete) dialog,
+// and by the checkbox layout (the subscription toggle)
+function threadMenuBlock({
+  className
+}) {
+  return `<button type="button" class="${className}__menu-button" data-role="item-menu-button" aria-label="Thread actions" aria-haspopup="menu">${(0, _svgs.getIcon)('dots-vertical')}</button>` + `<div class="${className}__menu" data-role="item-menu" role="menu" hidden>` + `<miso-rename class="${className}__menu-item"></miso-rename>` + `<miso-subscription class="${className}__menu-item"></miso-subscription>` + `<miso-delete class="${className}__menu-item ${className}__menu-item--danger"></miso-delete>` + `</div>`;
+}
+
+/**
+ * A message item is a <miso-message-item> container element hosting the message
+ * item subworkflow — the messages layout is a shell: it assigns the workflow
+ * (and the item-level attributes) in its post-render sync pass, and the role
+ * elements inside render the actual content through the message workflow's
+ * own layouts.
+ */
+function message(layout, state, data) {
+  const {
+    className,
+    templates
+  } = layout;
+  // miso-circled-citation-index covers both the citation links in the answer
+  // and the indexes on the source cards, as the hybrid-search UI scopes it
+  return [`<miso-message-item class="${className}__item-body miso-circled-citation-index" data-role="item">`, (templates.messageBody || messageBody)(layout, data), `</miso-message-item>`].join('');
+}
+
+// the regular content is packed together, so the erroneous presentation
+// swaps it out wholesale for the error notice (the content wrapper hides by
+// a class rule off the item's status — visible-when suits the notice, but
+// not a wrapper: it forces `display: block !important` and only negates in
+// combination with positive terms)
+function messageBody(layout) {
+  const {
+    className,
+    templates
+  } = layout;
+  return `<div class="${className}__content">` + `<miso-question class="${className}__question" hidden></miso-question>` + `<miso-answer class="${className}__answer"></miso-answer>` + `<miso-feedback class="${className}__feedback"></miso-feedback>` + (templates.messageSourcesBlock || messageSourcesBlock)(layout) + `</div>` + (templates.messageErrorBlock || messageErrorBlock)(layout);
+}
+
+// the sources with their heading, as the hybrid-search UI presents them —
+// shown once the item carries content (visible-when nonempty), so no
+// orphan heading sits over a message still loading
+function messageSourcesBlock({
+  className
+}) {
+  return `<div class="${className}__sources-container" visible-when="nonempty">` + `<h3 class="${className}__sources-phrase">Sources</h3>` + `<miso-sources class="${className}__sources"></miso-sources>` + `</div>`;
+}
+
+// shown by the item's own status (visible-when): a message whose content
+// fetch failed for good presents this in place of its content
+function messageErrorBlock({
+  className
+}) {
+  return `<div class="${className}__error" visible-when="erroneous">This message could not be loaded.</div>`;
+}
 function article(layout, state, data, meta) {
   const {
     templates

package/dist/cjs/layout/text/question.js

@@ -0,0 +1,71 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _commons = require("@miso.ai/commons");
+var _clientSdkWorkflow = require("@miso.ai/client-sdk-workflow");
+var _constants = require("../../constants.js");
+var _dom = require("../../util/dom.js");
+var _text = _interopRequireDefault(require("./text.js"));
+const _excluded = ["className", "tag", "author", "templates"];
+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 TYPE = _constants.LAYOUT_TYPE.QUESTION;
+const DEFAULT_CLASSNAME = 'miso-question';
+
+// the author label: only a question written by the answer-updates monitor is
+// labeled — the user's own questions carry none
+function defaultAuthor(message) {
+  return (0, _clientSdkWorkflow.isUpdateMessage)(message) ? 'Written by Miso' : undefined;
+}
+function content(layout, {
+  value
+}) {
+  const question = value && value.question;
+  return question ? (0, _commons.escapeHtml)(question) : '';
+}
+
+/**
+ * The question of a message: a text layout taking the whole message record —
+ * the text is the `question` field, and the authorship is stamped as data
+ * attributes on the host element (`data-author` drives the CSS label badge,
+ * `data-generated-by` the bubble color), re-applied on every render, since
+ * the metadata arrives with the answers response, after the stub render. The
+ * host element hides while there is no question text to show. The author
+ * label is configurable via the `author` option (message -> label text).
+ */
+class QuestionLayout extends _text.default {
+  static get type() {
+    return TYPE;
+  }
+  static get defaultClassName() {
+    return DEFAULT_CLASSNAME;
+  }
+  constructor(_ref = {}) {
+    let {
+        className = DEFAULT_CLASSNAME,
+        tag = 'div',
+        author = defaultAuthor,
+        templates
+      } = _ref,
+      options = _objectWithoutPropertiesLoose(_ref, _excluded);
+    super(Object.assign({
+      className,
+      tag,
+      author,
+      templates: Object.assign({
+        content
+      }, templates)
+    }, options));
+  }
+  _afterRender(element, state) {
+    super._afterRender(element, state);
+    const message = state.value || {};
+    element.hidden = !message.question;
+    (0, _dom.setOrRemoveAttribute)(element, 'data-author', this.options.author(message));
+    (0, _dom.setOrRemoveAttribute)(element, 'data-generated-by', message.metadata && message.metadata.miso_generated_by || undefined);
+  }
+}
+exports.default = QuestionLayout;

package/dist/cjs/layout/text/text.js

@@ -4,12 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _constants = require("../../constants.js");
 var _commons = require("@miso.ai/commons");
 var _template = _interopRequireDefault(require("../template.js"));
 const _excluded = ["className", "templates", "tag"];
 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 TYPE = 'text';
+const TYPE = _constants.LAYOUT_TYPE.TEXT;
 const DEFAULT_CLASSNAME = 'miso-text';
 function root(layout, state) {
   const {

package/dist/cjs/layout/text/typewriter/index.js

@@ -6,13 +6,14 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
 var _constants = require("../../../constants.js");
+var _dom = require("../../../util/dom.js");
 var _progressive = _interopRequireDefault(require("../../progressive.js"));
 var _plaintext = _interopRequireDefault(require("./plaintext.js"));
 var _utils = require("./utils.js");
 const _excluded = ["className", "tag", "format", "tooltip", "speed", "acceleration", "nextCursorFn"];
 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 TYPE = 'typewriter';
+const TYPE = _constants.LAYOUT_TYPE.TYPEWRITER;
 const DEFAULT_CLASSNAME = 'miso-typewriter';
 class TypewriterLayout extends _progressive.default {
   static get type() {
@@ -72,10 +73,12 @@ class TypewriterLayout extends _progressive.default {
     }
   }
   async _setupForMarkdown() {
-    const context = await this._view._views._extensions.require('markdown');
+    const client = this._view.workflow._client;
+    const plugin = await TypewriterLayout.MisoClient.plugins.install('std:ui-markdown');
     if (!this._view) {
       return; // destroyed
     }
+    const context = plugin.getContext(client);
     const cursorClass = (0, _utils.cursorClassName)(this.className);
     const {
       onDebug,
@@ -158,6 +161,17 @@ class TypewriterLayout extends _progressive.default {
       // new typing streak
       result = this._renderer.clear(container, rendered);
     } else {
+      result = rendered;
+    }
+    if (this.options.instant && state.done && !result.cursor) {
+      // instant mode: content that finishes before any of it was typed —
+      // arrived complete (e.g. a loaded conversation message), or completed
+      // while the cursor was still at the start — renders in one shot; only
+      // content streaming in as it is generated types out
+      result = this._renderer.update(container, result, Object.assign({}, state, {
+        cursor: Infinity
+      }));
+    } else if (!newStreak) {
       const cursor = this._getNextCursor(rendered.cursor, state.doneAt, rendered.timestamp, state.timestamp);
       result = this._renderer.update(container, rendered, Object.assign({}, state, {
         cursor
@@ -226,7 +240,7 @@ class TypewriterLayout extends _progressive.default {
             url: href,
             text: innerText ? innerText.trim() : '',
             className: className || '',
-            attributes: dumpElementAttributes(anchorElement)
+            attributes: (0, _dom.dumpElementAttributes)(anchorElement)
           }));
         }
       }
@@ -234,23 +248,4 @@ class TypewriterLayout extends _progressive.default {
     }
   }
 }
-exports.default = TypewriterLayout;
-function dumpElementAttributes(element) {
-  const {
-    attributes
-  } = element;
-  const attrs = {};
-  for (const {
-    name,
-    value
-  } of attributes) {
-    if (name.startsWith('data-')) {
-      attrs[name] = value;
-    }
-  }
-  try {
-    return JSON.stringify(attrs);
-  } catch (e) {
-    return '{}';
-  }
-}
+exports.default = TypewriterLayout;