@stack-spot/ai-chat-widget 1.0.0-dev.1768423745486 → 1.0.0-dev.1768480603636

package/dist/right-panel/DefaultPanel.js

@@ -0,0 +1,48 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { IconButton, Text } from '@stack-spot/citric-react';
+import { useTranslate } from '@stack-spot/portal-translate';
+import { styled } from 'styled-components';
+const PanelBox = styled.div `
+  padding: 25px;
+  display: flex;
+  flex-direction: column;
+  gap: 25px;
+  flex: 1;
+  overflow: hidden;
+
+  header {
+    display: flex;
+    flex-direction: row;
+    gap: 10px;
+
+    .title {
+      display: flex;
+      flex-direction: column;
+      gap: 10px;
+      flex: 1;
+    }
+  }
+
+  article {
+    flex: 1;
+    display: flex;
+    flex-direction: column;
+    overflow: auto;
+  }
+`;
+/**
+ * Default layout for a right panel.
+ */
+export const DefaultPanel = ({ description, onClose, title, children }) => {
+    const t = useTranslate(dictionary);
+    return (_jsxs(PanelBox, { children: [_jsxs("header", { children: [_jsxs("div", { className: "title", children: [typeof title === 'string' ? _jsx(Text, { appearance: "h5", children: title }) : title, typeof description === 'string' ? _jsx(Text, { color: "light.700", children: description }) : description] }), _jsx(IconButton, { icon: "Times", title: t.close, "aria-label": t.close, onClick: onClose })] }), _jsx("article", { children: children })] }));
+};
+const dictionary = {
+    en: {
+        close: 'Close',
+    },
+    pt: {
+        close: 'Fechar',
+    },
+};
+//# sourceMappingURL=DefaultPanel.js.map

package/dist/right-panel/DefaultPanel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultPanel.js","sourceRoot":"","sources":["../../src/right-panel/DefaultPanel.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAc,YAAY,EAAE,MAAM,8BAA8B,CAAA;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAS1C,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2B1B,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAS,EAAE,EAAE;IAC/E,MAAM,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAA;IAElC,OAAO,CACL,MAAC,QAAQ,eACP,6BACE,eAAK,SAAS,EAAC,OAAO,aACnB,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAC,IAAI,IAAC,UAAU,EAAC,IAAI,YAAE,KAAK,GAAQ,CAAC,CAAC,CAAC,KAAK,EACxE,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAC,IAAI,IAAC,KAAK,EAAC,WAAW,YAAE,WAAW,GAAQ,CAAC,CAAC,CAAC,WAAW,IACzF,EACN,KAAC,UAAU,IAAC,IAAI,EAAC,OAAO,EAAC,KAAK,EAAE,CAAC,CAAC,KAAK,gBAAc,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,GAAI,IAC3E,EACT,4BAAU,QAAQ,GAAW,IACpB,CACZ,CAAA;AACH,CAAC,CAAA;AAED,MAAM,UAAU,GAAG;IACjB,EAAE,EAAE;QACF,KAAK,EAAE,OAAO;KACf;IACD,EAAE,EAAE;QACF,KAAK,EAAE,QAAQ;KAChB;CACmB,CAAA"}

package/dist/right-panel/RightPanel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Renders the content of the right panel.
+ */
+export declare const RightPanel: () => import("react").ReactNode;
+//# sourceMappingURL=RightPanel.d.ts.map

package/dist/right-panel/RightPanel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RightPanel.d.ts","sourceRoot":"","sources":["../../src/right-panel/RightPanel.tsx"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,UAAU,iCAGtB,CAAA"}

package/dist/right-panel/RightPanel.js

@@ -0,0 +1,9 @@
+import { useRightPanelContent } from './hooks.js';
+/**
+ * Renders the content of the right panel.
+ */
+export const RightPanel = () => {
+    const content = useRightPanelContent();
+    return content;
+};
+//# sourceMappingURL=RightPanel.js.map

package/dist/right-panel/RightPanel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RightPanel.js","sourceRoot":"","sources":["../../src/right-panel/RightPanel.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE;IAC7B,MAAM,OAAO,GAAG,oBAAoB,EAAE,CAAA;IACtC,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA"}

package/dist/right-panel/RightPanelProvider.d.ts

@@ -0,0 +1,28 @@
+interface ContextValue {
+    /**
+     * The current content of the right panel.
+     */
+    content?: React.ReactNode;
+    /**
+     * Sets the current content of the right panel.
+     */
+    setContent?: (content: React.ReactNode) => void;
+    /**
+     * A reference to the right panel HTML Element.
+     */
+    panel?: React.RefObject<HTMLDivElement>;
+    /**
+     * A reference to the chat window at the left of the right panel.
+     */
+    chatWindow?: React.RefObject<HTMLDivElement>;
+    /**
+     * A function to run when the right panel is closed for the next time.
+     */
+    onCloseNext: React.MutableRefObject<(() => void) | undefined>;
+}
+export declare const RightPanelContext: import("react").Context<ContextValue>;
+export declare const RightPanelProvider: ({ panel, chatWindow, children }: Pick<ContextValue, "panel" | "chatWindow"> & {
+    children: React.ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;
+export {};
+//# sourceMappingURL=RightPanelProvider.d.ts.map

package/dist/right-panel/RightPanelProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RightPanelProvider.d.ts","sourceRoot":"","sources":["../../src/right-panel/RightPanelProvider.tsx"],"names":[],"mappings":"AAEA,UAAU,YAAY;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,SAAS,KAAK,IAAI,CAAC;IAChD;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IACxC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAC7C;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;CAC/D;AAED,eAAO,MAAM,iBAAiB,uCAAuE,CAAA;AAErG,eAAO,MAAM,kBAAkB,oCACI,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,YAAY,CAAC,GAAG;IAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,4CAM5G,CAAA"}

package/dist/right-panel/RightPanelProvider.js

@@ -0,0 +1,10 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useMemo, useRef, useState } from 'react';
+export const RightPanelContext = createContext({ onCloseNext: { current: undefined } });
+export const RightPanelProvider = ({ panel, chatWindow, children }) => {
+    const [content, setContent] = useState();
+    const onCloseNext = useRef();
+    const value = useMemo(() => ({ content, setContent, panel, chatWindow, onCloseNext }), [content, panel, chatWindow]);
+    return _jsx(RightPanelContext.Provider, { value: value, children: children });
+};
+//# sourceMappingURL=RightPanelProvider.js.map

package/dist/right-panel/RightPanelProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RightPanelProvider.js","sourceRoot":"","sources":["../../src/right-panel/RightPanelProvider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAyBhE,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAAa,CAAe,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,CAAA;AAErG,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAA8E,EAC3G,EAAE;IACF,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,EAAmB,CAAA;IACzD,MAAM,WAAW,GAAG,MAAM,EAA4B,CAAA;IACtD,MAAM,KAAK,GAAG,OAAO,CAAe,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAA;IAClI,OAAO,KAAC,iBAAiB,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAA8B,CAAA;AAC1F,CAAC,CAAA"}

package/dist/right-panel/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const panelAnimationTime = 300;
+//# sourceMappingURL=constants.d.ts.map

package/dist/right-panel/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/right-panel/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,MAAM,CAAA"}

package/dist/right-panel/constants.js

@@ -0,0 +1,2 @@
+export const panelAnimationTime = 300;
+//# sourceMappingURL=constants.js.map

package/dist/right-panel/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/right-panel/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA"}

package/dist/right-panel/hooks.d.ts

@@ -0,0 +1,19 @@
+interface RightPanelOptions {
+    title: React.ReactNode;
+    description: React.ReactNode;
+    onClose?: () => void;
+}
+/**
+ * @returns teh current content of the right panel
+ */
+export declare function useRightPanelContent(): import("react").ReactNode;
+/**
+ * Opens, closes or checks the visibility of the right panel.
+ */
+export declare function useRightPanel(): {
+    open: (content: React.ReactNode, options?: RightPanelOptions) => void;
+    close: () => void;
+    isOpen: () => boolean;
+};
+export {};
+//# sourceMappingURL=hooks.d.ts.map

package/dist/right-panel/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/right-panel/hooks.tsx"],"names":[],"mappings":"AAKA,UAAU,iBAAiB;IACzB,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,8BAGnC;AAED;;GAEG;AACH,wBAAgB,aAAa;oBAOF,KAAK,CAAC,SAAS,YAAY,iBAAiB;;;EAwBtE"}

package/dist/right-panel/hooks.js

@@ -0,0 +1,46 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useContext, useMemo } from 'react';
+import { DefaultPanel } from './DefaultPanel.js';
+import { RightPanelContext } from './RightPanelProvider.js';
+import { panelAnimationTime } from './constants.js';
+/**
+ * @returns teh current content of the right panel
+ */
+export function useRightPanelContent() {
+    const { content } = useContext(RightPanelContext);
+    return content;
+}
+/**
+ * Opens, closes or checks the visibility of the right panel.
+ */
+export function useRightPanel() {
+    const ctx = useContext(RightPanelContext);
+    const { panel, chatWindow, setContent } = ctx;
+    return useMemo(() => {
+        if (!setContent)
+            throw new Error('No RightPanelProvider found.');
+        function open(content, options) {
+            if (!panel?.current || !chatWindow?.current || !setContent)
+                return;
+            setContent(options ? _jsx(DefaultPanel, { ...options, onClose: close, children: content }) : content);
+            panel.current.classList.add('visible');
+            chatWindow.current.classList.add('narrow');
+            ctx.onCloseNext.current = options?.onClose;
+        }
+        function close() {
+            if (!panel?.current || !chatWindow?.current || !setContent)
+                return;
+            panel.current.classList.remove('visible');
+            chatWindow.current.classList.remove('narrow');
+            ctx.onCloseNext.current?.();
+            setTimeout(() => {
+                setContent(null);
+            }, panelAnimationTime);
+        }
+        function isOpen() {
+            return !!panel?.current?.classList.contains('visible');
+        }
+        return { open, close, isOpen };
+    }, []);
+}
+//# sourceMappingURL=hooks.js.map

package/dist/right-panel/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/right-panel/hooks.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAQhD;;GAEG;AACH,MAAM,UAAU,oBAAoB;IAClC,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;IACjD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,GAAG,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAA;IACzC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,GAAG,CAAA;IAE7C,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,IAAI,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;QAEhE,SAAS,IAAI,CAAC,OAAwB,EAAE,OAA2B;YACjE,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,CAAC,UAAU,EAAE,OAAO,IAAI,CAAC,UAAU;gBAAE,OAAM;YAClE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,KAAC,YAAY,OAAK,OAAO,EAAE,OAAO,EAAE,KAAK,YAAG,OAAO,GAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;YACnG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;YACtC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;YAC1C,GAAG,CAAC,WAAW,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,CAAA;QAC5C,CAAC;QAED,SAAS,KAAK;YACZ,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,CAAC,UAAU,EAAE,OAAO,IAAI,CAAC,UAAU;gBAAE,OAAM;YAClE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;YACzC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC7C,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,CAAA;YAC3B,UAAU,CAAC,GAAG,EAAE;gBACd,UAAU,CAAC,IAAI,CAAC,CAAA;YAClB,CAAC,EAAE,kBAAkB,CAAC,CAAA;QACxB,CAAC;QAED,SAAS,MAAM;YACb,OAAO,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QACxD,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAA;IAChC,CAAC,EAAE,EAAE,CAAC,CAAA;AACR,CAAC"}

package/dist/state/ChatEntry.d.ts

@@ -0,0 +1,230 @@
+import { ChatStep, HypothesisPMAgent, OpportunitiesPMAgent, PrfaqPMAgent } from '@stack-spot/portal-network';
+import { ColorPaletteName, ColorSchemeName } from '@stack-spot/portal-theme';
+import { LabeledAgent } from './types.js';
+export interface ActionDataClick {
+    name?: string;
+    value?: string[];
+}
+export interface SerializableAction {
+    /**
+     * The text for the button or anchor.
+     */
+    title: string;
+    /**
+     * Links open new tabs with urls, while commands send text commands in the chat as if they were written by the user.
+     */
+    type: 'link' | 'command';
+    /**
+     * The URL if the action is a link. The content of the user message otherwise.
+     */
+    exec?: string;
+}
+export interface ChatAction extends SerializableAction {
+    /**
+     * @default primary
+     */
+    appearance?: 'primary' | 'secondary';
+    /**
+     * @default inverse
+     */
+    colorScheme?: ColorSchemeName;
+    /**
+     * @default false
+     */
+    hideWhenNotLast?: boolean;
+    /**
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * @default button
+     */
+    buttonType?: 'submit' | 'button';
+    /**
+    * @default lg
+    */
+    size?: 'lg' | 'md' | 'sm';
+}
+export interface KnowledgeSource {
+    name: string;
+    slug: string;
+    documentScore: number;
+    documentId: string;
+}
+export interface ChatTool {
+    id: string;
+    image?: string;
+    name: string;
+    description: string;
+}
+export interface UploadedFile {
+    id: string;
+    name: string;
+    image?: string;
+}
+export interface TextChatEntry {
+    /**
+     * "text" for simple unformatted paragraphs. "md" for markdown.
+     * "input-text" for text inputs, 'input-radio' and "input-checkbox" for radio and checkbox inputs,
+     * "input-phone" for phone formatted inputs and "button-list" for a list of buttons in which only one is selected
+     */
+    type: 'text' | 'md' | 'input-text' | 'input-radio' | 'button-list' | 'input-checkbox' | 'input-phone';
+    /**
+     * If the message was typed by the AI agent (bot), the user or the system (not currently in use).
+     */
+    agentType: 'bot' | 'user' | 'system';
+    /**
+     * A set of buttons to go after the message.
+     */
+    actions?: ChatAction[];
+    /**
+     * The content of the message.
+     */
+    content: string;
+    /**
+     * The actual data to send as a message. This is the "content" if not provided.
+     *
+     * Useful for displaying a text in the chat, via "content", but sending something different to the backend.
+     *
+     * Serialization: if none of your interceptors return false, this will be converted to a JSON in the last interceptor (sendMessage).
+     *
+     * Attention: this is ignored by quick commands, which will always use "content".
+     */
+    data?: any;
+    /**
+     * A content that is not shown to the user, it is used only to share data.
+     *
+     * This is used solely by the onboarding feature (checkboxes and radio button), implemented in the AI Portal. Maybe it shouldn't be
+     * implemented here. This needs a review (fixme).
+     *
+     * This has been implemented because the message rendered is different than the message we wanted to send to the backend.
+     *
+     * @deprecated prefer "data" instead.
+     */
+    hiddenContent?: string[];
+    /**
+     * The knowledge sources used to create the message.
+     */
+    knowledgeSources?: KnowledgeSource[];
+    /**
+     * The date and time of the message. ISO string.
+     */
+    updated?: string;
+    /**
+     * The agent who wrote the message. Undefined for the agentType is "user".
+     */
+    agent?: LabeledAgent;
+    /**
+     * The unique identifier of the message.
+     */
+    messageId?: string;
+    /**
+     * If this is set, only an error message is rendered.
+     */
+    error?: string;
+    /**
+     * A series of badges to display before the content.
+     */
+    badges?: {
+        color?: ColorPaletteName;
+        label: string;
+    }[];
+    /**
+     * Whether or not to show this chat entry as a card.
+     */
+    card?: boolean;
+    /**
+     * This entry may contain steps. If so, specify them in this array.
+     */
+    steps?: ChatStep[];
+    /**
+     * If any tool was used to generate the response, its id is returned in this list.
+     */
+    tools?: string[];
+    /**
+    * If opportunities exists in pm agent, its send in this list.
+    */
+    opportunities?: OpportunitiesPMAgent[];
+    /**
+    * If hypothesis exists in pm agent, its send in this list.
+    */
+    hypothesis?: HypothesisPMAgent[];
+    /**
+    * If prfaq exists in pm agent, its send in this object.
+    */
+    prfaq?: PrfaqPMAgent;
+    options?: {
+        color?: ColorSchemeName;
+        label: string;
+        value?: string;
+        hasInput?: boolean;
+    }[];
+    /**
+     * Name to be used in input type fields.
+     */
+    name?: string;
+    /**
+     * Whether or not a input field is required.
+     */
+    required?: boolean;
+    /**
+     * The validations of input fields.
+     */
+    validations?: {
+        minLength?: number;
+        maxLength?: number;
+        pattern?: string;
+    };
+    /**
+     * Valid for input types.
+     */
+    initialValue?: string[];
+    /**
+     * If this chat entry contains any uploaded file, these are the files being uploaded along the message.
+     */
+    upload?: UploadedFile[];
+    /**
+     * True if the entry is done streaming, false otherwise. Undefined may be used when streaming info is not available.
+     */
+    done?: boolean;
+    /**
+     * True if, at some point, this entry had a planning stage (related to tools).
+     */
+    hasPlanning?: boolean;
+}
+type ChatEntryListener = (value: TextChatEntry) => void;
+/**
+ * A message (entry) in the chat.
+ */
+export declare class ChatEntry {
+    readonly id: number;
+    private value;
+    private listeners;
+    /**
+     * @param value the value of the entry.
+     */
+    constructor(value: TextChatEntry);
+    /**
+     * Utility function to create a user entry.
+     * @param content the message's content.
+     * @param isMd whether or not this should be rendered as markdown.
+     * @param hiddenContent the message's content.
+     * @returns a new ChatEntry.
+     */
+    static createUserEntry(content: string, isMd?: boolean, fieldName?: string, hiddenContent?: string[], data?: any): ChatEntry;
+    /**
+     * Utility function to create a streamed entry from the AI agent.
+     * @returns a new ChatEntry.
+     */
+    static createStreamedBotEntry(): ChatEntry;
+    setValue(value: TextChatEntry): void;
+    getValue(): TextChatEntry;
+    /**
+     * Watches the value of this ChatEntry.
+     * @param listener a function to call whenever the value changes.
+     * @returns a function that removes the listener.
+     */
+    onChange(listener: ChatEntryListener): () => void;
+}
+export {};
+//# sourceMappingURL=ChatEntry.d.ts.map

package/dist/state/ChatEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatEntry.d.ts","sourceRoot":"","sources":["../../src/state/ChatEntry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC5G,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAE5E,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEtC,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAW,SAAQ,kBAAkB;IACpD;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IACjC;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,aAAa,GAAG,aAAa,GAAG,gBAAgB,GAAG,aAAa,CAAC;IACtG;;OAEG;IACH,SAAS,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;IACrC;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,gBAAgB,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACvD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB;;MAEE;IACF,aAAa,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACvC;;MAEE;IACF,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACjC;;MAEE;IACF,KAAK,CAAC,EAAE,YAAY,CAAC;IAIrB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,eAAe,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;IAC3F;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,KAAK,iBAAiB,GAAG,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAA;AAMvD;;GAEG;AACH,qBAAa,SAAS;IACpB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,SAAS,CAA0B;IAE3C;;OAEG;gBACS,KAAK,EAAE,aAAa;IAKhC;;;;;;OAMG;IACH,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,UAAQ,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,GAAG;IAY9G;;;OAGG;IACH,MAAM,CAAC,sBAAsB;IAI7B,QAAQ,CAAC,KAAK,EAAE,aAAa;IAK7B,QAAQ;IAIR;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,iBAAiB;CAMrC"}

package/dist/state/ChatEntry.js

@@ -0,0 +1,63 @@
+import { pull } from 'lodash';
+// this id is unique for each message and used for rendering. The `messageId`, which comes from the backend, is not always available and, 
+// therefore, can't be used for this purpose.
+let nextId = 0;
+/**
+ * A message (entry) in the chat.
+ */
+export class ChatEntry {
+    id;
+    value;
+    listeners = [];
+    /**
+     * @param value the value of the entry.
+     */
+    constructor(value) {
+        this.id = nextId++;
+        this.value = value;
+    }
+    /**
+     * Utility function to create a user entry.
+     * @param content the message's content.
+     * @param isMd whether or not this should be rendered as markdown.
+     * @param hiddenContent the message's content.
+     * @returns a new ChatEntry.
+     */
+    static createUserEntry(content, isMd = false, fieldName, hiddenContent, data) {
+        return new ChatEntry({
+            agentType: 'user',
+            type: isMd ? 'md' : 'text',
+            content,
+            name: fieldName,
+            hiddenContent,
+            data,
+            updated: new Date().toISOString(),
+        });
+    }
+    /**
+     * Utility function to create a streamed entry from the AI agent.
+     * @returns a new ChatEntry.
+     */
+    static createStreamedBotEntry() {
+        return new ChatEntry({ agentType: 'bot', type: 'md', content: '', done: false });
+    }
+    setValue(value) {
+        this.value = value;
+        this.listeners.forEach(l => l(this.value));
+    }
+    getValue() {
+        return this.value;
+    }
+    /**
+     * Watches the value of this ChatEntry.
+     * @param listener a function to call whenever the value changes.
+     * @returns a function that removes the listener.
+     */
+    onChange(listener) {
+        this.listeners.push(listener);
+        return () => {
+            pull(this.listeners, listener);
+        };
+    }
+}
+//# sourceMappingURL=ChatEntry.js.map

package/dist/state/ChatEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatEntry.js","sourceRoot":"","sources":["../../src/state/ChatEntry.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAsM7B,0IAA0I;AAC1I,6CAA6C;AAC7C,IAAI,MAAM,GAAG,CAAC,CAAA;AAEd;;GAEG;AACH,MAAM,OAAO,SAAS;IACX,EAAE,CAAQ;IACX,KAAK,CAAe;IACpB,SAAS,GAAwB,EAAE,CAAA;IAE3C;;OAEG;IACH,YAAY,KAAoB;QAC9B,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,CAAA;QAClB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,eAAe,CAAC,OAAe,EAAE,IAAI,GAAG,KAAK,EAAE,SAAkB,EAAE,aAAwB,EAAE,IAAU;QAC5G,OAAO,IAAI,SAAS,CAAC;YACnB,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;YAC1B,OAAO;YACP,IAAI,EAAE,SAAS;YACf,aAAa;YACb,IAAI;YACJ,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;SAClC,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,sBAAsB;QAC3B,OAAO,IAAI,SAAS,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IAClF,CAAC;IAED,QAAQ,CAAC,KAAoB;QAC3B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IAC5C,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,QAA2B;QAClC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC7B,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;QAChC,CAAC,CAAA;IACH,CAAC;CACF"}