@twentyfourg/chat-kit 1.0.0-beta.1

package/dist/components/AssistantMessage.vue.d.ts

@@ -0,0 +1,35 @@
+import type { ChatEngineMessage } from '../composables/useChatEngine';
+import type { ChatCitation, CitationType, MessageFeedback, ThinkingVariant } from '../types';
+type __VLS_Props = {
+    message: ChatEngineMessage;
+    citationType?: CitationType;
+    /** Offers the reasoning behind this reply in a folded panel. */
+    showThinking?: boolean;
+    /** Which animation plays beside the header while this reply is still arriving. */
+    thinkingVariant?: ThinkingVariant;
+    /** Offers a button that copies the answer. Off by default. */
+    showCopy?: boolean;
+};
+declare var __VLS_39: {
+    message: ChatEngineMessage;
+};
+type __VLS_Slots = {} & {
+    'message-actions'?: (props: typeof __VLS_39) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    rate: (messageId: string, value: MessageFeedback) => any;
+    retry: () => any;
+    citationClick: (messageId: string, citation: ChatCitation) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onRate?: ((messageId: string, value: MessageFeedback) => any) | undefined;
+    onRetry?: (() => any) | undefined;
+    onCitationClick?: ((messageId: string, citation: ChatCitation) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/Chat.vue.d.ts

@@ -0,0 +1,72 @@
+/**
+ * The chat itself: the conversation on top, the question field at the bottom.
+ * The app creates the engine (see useChatEngine) and hands it in, which also
+ * lets the app drive the chat from outside, for example when a suggested
+ * question is clicked.
+ */
+import { type ChatCopyInput } from '../copy';
+import type { ChatEngine, ChatEngineMessage } from '../composables/useChatEngine';
+import type { AutoScrollMode, CitationType, MessageFeedback, ThinkingVariant } from '../types';
+type __VLS_Props = {
+    /**
+     * The conversation to render, from useChatEngine. Required, and not a
+     * setting: everything below is optional and defaults to the behaviour the
+     * kit had before that setting existed.
+     */
+    engine: ChatEngine;
+    /** All of the app's copy text. Anything missing falls back to its default. */
+    copy?: ChatCopyInput;
+    /** Offers voice dictation, in browsers with speech recognition. */
+    showMic?: boolean;
+    /**
+     * How sources are presented: 'inline' turns [^N] markers into numbered
+     * chips with a passage popover, 'list' shows the source documents under
+     * the answer. Defaults to 'inline'.
+     */
+    citationType?: CitationType;
+    /** Which thinking animation plays while retrieving: 'ring' (default) or 'sparkles'. */
+    thinkingVariant?: ThinkingVariant;
+    /**
+     * Steps the waiting label through `copy.status.thinkingSequence` instead of
+     * holding one line, so a long retrieval reads as progress. Off by default.
+     */
+    rotateThinkingLabel?: boolean;
+    /**
+     * Shows the model's reasoning in a collapsible panel: live while an answer
+     * is being retrieved, and folded on the finished reply. Off by default.
+     */
+    showThinking?: boolean;
+    /**
+     * How far the conversation follows a streaming answer. 'reply' (the
+     * default) stops once the answer's header reaches the top, so it can be
+     * read from the beginning; 'bottom' keeps the newest text in view; 'off'
+     * leaves the view to the reader.
+     */
+    autoScroll?: AutoScrollMode;
+    /**
+     * Offers a button under each finished answer that copies it. Off by
+     * default, since a client may not want the action at all.
+     */
+    showCopy?: boolean;
+};
+declare var __VLS_10: {
+    message: ChatEngineMessage;
+}, __VLS_13: {};
+type __VLS_Slots = {} & {
+    'message-actions'?: (props: typeof __VLS_10) => any;
+} & {
+    welcome?: (props: typeof __VLS_13) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    rated: (message: ChatEngineMessage, value: MessageFeedback | null) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onRated?: ((message: ChatEngineMessage, value: MessageFeedback | null) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/CitationPopover.vue.d.ts

@@ -0,0 +1,11 @@
+import type { ChatCitation } from '../types';
+type __VLS_Props = {
+    citation: ChatCitation;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    close: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onClose?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/FeedbackRow.vue.d.ts

@@ -0,0 +1,11 @@
+import type { MessageFeedback } from '../types';
+type __VLS_Props = {
+    feedback: MessageFeedback | null;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    rate: (value: MessageFeedback) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onRate?: ((value: MessageFeedback) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/IconButton.vue.d.ts

@@ -0,0 +1,17 @@
+type __VLS_Props = {
+    /** What the button does, e.g. "Send". Shown in the chip on hover. */
+    label: string;
+};
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/InputBar.vue.d.ts

@@ -0,0 +1,16 @@
+import type { ChatInputMode } from '../types';
+type __VLS_Props = {
+    /** True while an answer is streaming. Swaps the send button for a stop button. */
+    busy?: boolean;
+    /** Offers voice dictation, in browsers with speech recognition. */
+    showMic?: boolean;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    stop: () => any;
+    send: (text: string, mode: ChatInputMode) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onStop?: (() => any) | undefined;
+    onSend?: ((text: string, mode: ChatInputMode) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/KitIcon.vue.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The kit's own small icon set, drawn inline so the package needs no icon
+ * library from the app. Shapes for send, mic, and thumbs come from the
+ * project's Figma file. Color always follows the surrounding text color.
+ */
+type __VLS_Props = {
+    name: 'send' | 'mic' | 'stop' | 'thumb-up' | 'thumb-down' | 'warning' | 'sparkle' | 'copy' | 'external-link' | 'chevron-down';
+    size?: number;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/MessageList.vue.d.ts

@@ -0,0 +1,36 @@
+import type { ChatEngine, ChatEngineMessage } from '../composables/useChatEngine';
+import type { AutoScrollMode, CitationType, MessageFeedback, ThinkingVariant } from '../types';
+type __VLS_Props = {
+    engine: ChatEngine;
+    citationType?: CitationType;
+    thinkingVariant?: ThinkingVariant;
+    /** Steps the waiting label through the copy sequence; see ThinkingIndicator. */
+    rotateThinkingLabel?: boolean;
+    /** Renders the model's reasoning, live and on finished replies. */
+    showThinking?: boolean;
+    /** How far the conversation follows a streaming answer; see AutoScrollMode. */
+    autoScroll?: AutoScrollMode;
+    /** Offers a copy button under each finished answer. */
+    showCopy?: boolean;
+};
+declare var __VLS_1: {}, __VLS_19: {
+    message: ChatEngineMessage;
+};
+type __VLS_Slots = {} & {
+    welcome?: (props: typeof __VLS_1) => any;
+} & {
+    'message-actions'?: (props: typeof __VLS_19) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    rated: (message: ChatEngineMessage, value: MessageFeedback | null) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onRated?: ((message: ChatEngineMessage, value: MessageFeedback | null) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/PageImageModal.vue.d.ts

@@ -0,0 +1,14 @@
+type __VLS_Props = {
+    url: string;
+    /** The document's name, shown above the image. */
+    title: string;
+    /** The page line, as the card already displays it. Empty hides the line. */
+    detail?: string;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    close: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onClose?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/SourceCard.vue.d.ts

@@ -0,0 +1,21 @@
+import type { UsedSource } from '../types';
+type __VLS_Props = {
+    source: UsedSource;
+    /** The card's position in the list, for its "Source N" heading. */
+    index: number;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    viewPage: (payload: {
+        url: string;
+        title: string;
+        detail: string;
+    }) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onViewPage?: ((payload: {
+        url: string;
+        title: string;
+        detail: string;
+    }) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/SourceList.vue.d.ts

@@ -0,0 +1,7 @@
+import type { UsedSource } from '../types';
+type __VLS_Props = {
+    sources: UsedSource[];
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/ThinkingAnimation.vue.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The waiting animation on its own, with no wording around it.
+ *
+ * Used twice: ThinkingIndicator pairs it with a label while an answer is
+ * being retrieved, and the assistant's own header shows it bare while the
+ * answer is still being written.
+ */
+import type { ThinkingVariant } from '../types';
+type __VLS_Props = {
+    /** Which animation plays: the spinning ring (default), stars, or dots. */
+    variant?: ThinkingVariant;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/ThinkingIndicator.vue.d.ts

@@ -0,0 +1,13 @@
+import type { ThinkingVariant } from '../types';
+type __VLS_Props = {
+    /** Which animation plays: the spinning ring (default), stars, or dots. */
+    variant?: ThinkingVariant;
+    /**
+     * Steps through copy.status.thinkingSequence while waiting, instead of
+     * holding the single `thinking` label.
+     */
+    rotateLabel?: boolean;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/ThinkingProcess.vue.d.ts

@@ -0,0 +1,8 @@
+type __VLS_Props = {
+    text: string;
+    /** True for the live panel, which starts open and follows the text as it grows. */
+    streaming?: boolean;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/UserMessage.vue.d.ts

@@ -0,0 +1,7 @@
+import type { ChatEngineMessage } from '../composables/useChatEngine';
+type __VLS_Props = {
+    message: ChatEngineMessage;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/composables/useAutoScroll.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Keeps a scrolling element following new content, without ever fighting the
+ * user.
+ *
+ * Two states. While 'following', new content pulls the element down with a
+ * small glide each frame, so a new line slides up instead of snapping. Any
+ * upward scroll switches to 'manual', which stops all movement until the user
+ * returns to the bottom on their own; that switches back to 'following'.
+ *
+ * Following stops early when an `anchor` is given: the glide will not carry
+ * that element above the top of the view. An answer longer than the window
+ * therefore settles with its own beginning in view and grows out of sight
+ * below, so the reader can start reading rather than chasing the last line.
+ * Reading on past that point hands the view over to them, and following only
+ * takes it back when they reach the bottom.
+ */
+import { type Ref } from 'vue';
+import type { AutoScrollMode } from '../types';
+export interface AutoScrollOptions {
+    /**
+     * How far to follow. Read through a getter rather than taken once, so an
+     * app can change its mind, which is also why the listeners below stay
+     * attached even while following is off. Defaults to 'reply'.
+     */
+    mode?: () => AutoScrollMode;
+    /**
+     * Resolves the element that following must not carry off the top, checked
+     * fresh each frame because the answer it belongs to is still being built.
+     * Returning null follows the bottom, as it did before this existed.
+     */
+    anchor?: () => HTMLElement | null;
+}
+export default function useAutoScroll(elementRef: Ref<HTMLElement | null>, options?: AutoScrollOptions): {
+    glideToBottom: () => void;
+    resetToFollowing: () => void;
+};