@assistant-ui/react-streamdown 0.0.0

package/dist/primitives/StreamdownText.js

@@ -0,0 +1,124 @@
+"use client";
+import { jsx as _jsx } from "react/jsx-runtime";
+import { INTERNAL, useMessagePartText } from "@assistant-ui/react";
+import { harden } from "rehype-harden";
+import rehypeRaw from "rehype-raw";
+import rehypeSanitize from "rehype-sanitize";
+import { Streamdown } from "streamdown";
+import { forwardRef, useMemo } from "react";
+import { useAdaptedComponents } from "../adapters/components-adapter.js";
+import { DEFAULT_SHIKI_THEME, mergePlugins } from "../defaults.js";
+const { useSmoothStatus } = INTERNAL;
+/**
+ * Builds rehypePlugins array with security configuration.
+ */
+function buildSecurityRehypePlugins(security) {
+    return [
+        rehypeRaw,
+        [rehypeSanitize, {}],
+        [
+            harden,
+            {
+                allowedImagePrefixes: security.allowedImagePrefixes ?? ["*"],
+                allowedLinkPrefixes: security.allowedLinkPrefixes ?? ["*"],
+                allowedProtocols: security.allowedProtocols ?? ["*"],
+                allowDataImages: security.allowDataImages ?? true,
+                defaultOrigin: security.defaultOrigin,
+                blockedLinkClass: security.blockedLinkClass,
+                blockedImageClass: security.blockedImageClass,
+            },
+        ],
+    ];
+}
+/**
+ * A primitive component for rendering markdown text using Streamdown.
+ *
+ * Streamdown is optimized for AI-powered streaming with features like:
+ * - Block-based rendering for better streaming performance
+ * - Incomplete markdown handling via remend
+ * - Built-in syntax highlighting via Shiki
+ * - Math, Mermaid, and CJK support via plugins
+ *
+ * @example
+ * ```tsx
+ * // Basic usage
+ * <StreamdownTextPrimitive />
+ *
+ * // With plugins
+ * import { code } from "@streamdown/code";
+ * import { math } from "@streamdown/math";
+ *
+ * <StreamdownTextPrimitive
+ *   plugins={{ code, math }}
+ *   shikiTheme={["github-light", "github-dark"]}
+ * />
+ *
+ * // Disable a specific plugin
+ * <StreamdownTextPrimitive plugins={{ code: false }} />
+ *
+ * // Migration from react-markdown (compatibility mode)
+ * <StreamdownTextPrimitive
+ *   components={{
+ *     SyntaxHighlighter: MySyntaxHighlighter,
+ *     CodeHeader: MyCodeHeader,
+ *   }}
+ *   componentsByLanguage={{
+ *     mermaid: { SyntaxHighlighter: MermaidRenderer }
+ *   }}
+ * />
+ * ```
+ */
+export const StreamdownTextPrimitive = forwardRef(({ 
+// assistant-ui compatibility props
+components, componentsByLanguage, preprocess, 
+// plugin configuration
+plugins: userPlugins, 
+// container props
+containerProps, containerClassName, 
+// streamdown native props (explicitly listed for documentation)
+caret, controls, linkSafety, remend, mermaid, parseIncompleteMarkdown, allowedTags, remarkRehypeOptions, security, BlockComponent, parseMarkdownIntoBlocksFn, 
+// streamdown props
+mode = "streaming", className, shikiTheme, ...streamdownProps }, ref) => {
+    const { text } = useMessagePartText();
+    const status = useSmoothStatus();
+    const processedText = useMemo(() => (preprocess ? preprocess(text) : text), [text, preprocess]);
+    const resolvedPlugins = useMemo(() => {
+        const merged = mergePlugins(userPlugins, {});
+        return Object.keys(merged).length > 0 ? merged : undefined;
+    }, [userPlugins]);
+    const resolvedShikiTheme = useMemo(() => shikiTheme ?? (resolvedPlugins?.code ? DEFAULT_SHIKI_THEME : undefined), [shikiTheme, resolvedPlugins?.code]);
+    const adaptedComponents = useAdaptedComponents({
+        components,
+        componentsByLanguage,
+    });
+    const mergedComponents = useMemo(() => {
+        const { SyntaxHighlighter: _, CodeHeader: __, ...userHtmlComponents } = components ?? {};
+        return { ...userHtmlComponents, ...adaptedComponents };
+    }, [components, adaptedComponents]);
+    const containerClass = useMemo(() => {
+        const classes = [containerClassName, containerProps?.className]
+            .filter(Boolean)
+            .join(" ");
+        return classes || undefined;
+    }, [containerClassName, containerProps?.className]);
+    const rehypePlugins = useMemo(() => (security ? buildSecurityRehypePlugins(security) : undefined), [security]);
+    const optionalProps = {
+        ...(className && { className }),
+        ...(caret && { caret }),
+        ...(controls !== undefined && { controls }),
+        ...(linkSafety && { linkSafety }),
+        ...(remend && { remend }),
+        ...(mermaid && { mermaid }),
+        ...(parseIncompleteMarkdown !== undefined && { parseIncompleteMarkdown }),
+        ...(allowedTags && { allowedTags }),
+        ...(resolvedPlugins && { plugins: resolvedPlugins }),
+        ...(resolvedShikiTheme && { shikiTheme: resolvedShikiTheme }),
+        ...(remarkRehypeOptions && { remarkRehypeOptions }),
+        ...(rehypePlugins && { rehypePlugins }),
+        ...(BlockComponent && { BlockComponent }),
+        ...(parseMarkdownIntoBlocksFn && { parseMarkdownIntoBlocksFn }),
+    };
+    return (_jsx("div", { ref: ref, "data-status": status.type, ...containerProps, className: containerClass, children: _jsx(Streamdown, { mode: mode, isAnimating: status.type === "running", components: mergedComponents, ...optionalProps, ...streamdownProps, children: processedText }) }));
+});
+StreamdownTextPrimitive.displayName = "StreamdownTextPrimitive";
+//# sourceMappingURL=StreamdownText.js.map

package/dist/primitives/StreamdownText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamdownText.js","sourceRoot":"","sources":["../../src/primitives/StreamdownText.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,cAAc,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAwB,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAqB,UAAU,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,0CAAuC;AACtE,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,uBAAoB;AAGhE,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,CAAC;AAIrC;;GAEG;AACH,SAAS,0BAA0B,CACjC,QAAwB;IAExB,OAAO;QACL,SAAS;QACT,CAAC,cAAc,EAAE,EAAE,CAAC;QACpB;YACE,MAAM;YACN;gBACE,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,IAAI,CAAC,GAAG,CAAC;gBAC5D,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,IAAI,CAAC,GAAG,CAAC;gBAC1D,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,IAAI,CAAC,GAAG,CAAC;gBACpD,eAAe,EAAE,QAAQ,CAAC,eAAe,IAAI,IAAI;gBACjD,aAAa,EAAE,QAAQ,CAAC,aAAa;gBACrC,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;gBAC3C,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB;aAC9C;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,UAAU,CAI/C,CACE;AACE,mCAAmC;AACnC,UAAU,EACV,oBAAoB,EACpB,UAAU;AAEV,uBAAuB;AACvB,OAAO,EAAE,WAAW;AAEpB,kBAAkB;AAClB,cAAc,EACd,kBAAkB;AAElB,gEAAgE;AAChE,KAAK,EACL,QAAQ,EACR,UAAU,EACV,MAAM,EACN,OAAO,EACP,uBAAuB,EACvB,WAAW,EACX,mBAAmB,EACnB,QAAQ,EACR,cAAc,EACd,yBAAyB;AAEzB,mBAAmB;AACnB,IAAI,GAAG,WAAW,EAClB,SAAS,EACT,UAAU,EACV,GAAG,eAAe,EACnB,EACD,GAAG,EACH,EAAE;IACF,MAAM,EAAE,IAAI,EAAE,GAAG,kBAAkB,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;IAEjC,MAAM,aAAa,GAAG,OAAO,CAC3B,GAAG,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAC5C,CAAC,IAAI,EAAE,UAAU,CAAC,CACnB,CAAC;IAEF,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE;QACnC,MAAM,MAAM,GAAG,YAAY,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElB,MAAM,kBAAkB,GAAG,OAAO,CAChC,GAAG,EAAE,CACH,UAAU,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC,EACzE,CAAC,UAAU,EAAE,eAAe,EAAE,IAAI,CAAC,CACpC,CAAC;IAEF,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;QAC7C,UAAU;QACV,oBAAoB;KACrB,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,EAAE;QACpC,MAAM,EACJ,iBAAiB,EAAE,CAAC,EACpB,UAAU,EAAE,EAAE,EACd,GAAG,kBAAkB,EACtB,GAAG,UAAU,IAAI,EAAE,CAAC;QACrB,OAAO,EAAE,GAAG,kBAAkB,EAAE,GAAG,iBAAiB,EAAE,CAAC;IACzD,CAAC,EAAE,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAEpC,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,EAAE;QAClC,MAAM,OAAO,GAAG,CAAC,kBAAkB,EAAE,cAAc,EAAE,SAAS,CAAC;aAC5D,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,OAAO,OAAO,IAAI,SAAS,CAAC;IAC9B,CAAC,EAAE,CAAC,kBAAkB,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC;IAEpD,MAAM,aAAa,GAAG,OAAO,CAC3B,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EACnE,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,MAAM,aAAa,GAAG;QACpB,GAAG,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC;QAC/B,GAAG,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,CAAC;QACvB,GAAG,CAAC,QAAQ,KAAK,SAAS,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC3C,GAAG,CAAC,UAAU,IAAI,EAAE,UAAU,EAAE,CAAC;QACjC,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;QACzB,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;QAC3B,GAAG,CAAC,uBAAuB,KAAK,SAAS,IAAI,EAAE,uBAAuB,EAAE,CAAC;QACzE,GAAG,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,CAAC;QACnC,GAAG,CAAC,eAAe,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;QACpD,GAAG,CAAC,kBAAkB,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC;QAC7D,GAAG,CAAC,mBAAmB,IAAI,EAAE,mBAAmB,EAAE,CAAC;QACnD,GAAG,CAAC,aAAa,IAAI,EAAE,aAAa,EAAE,CAAC;QACvC,GAAG,CAAC,cAAc,IAAI,EAAE,cAAc,EAAE,CAAC;QACzC,GAAG,CAAC,yBAAyB,IAAI,EAAE,yBAAyB,EAAE,CAAC;KAChE,CAAC;IAEF,OAAO,CACL,cACE,GAAG,EAAE,GAAG,iBACK,MAAM,CAAC,IAAI,KACpB,cAAc,EAClB,SAAS,EAAE,cAAc,YAEzB,KAAC,UAAU,IACT,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,MAAM,CAAC,IAAI,KAAK,SAAS,EACtC,UAAU,EAAE,gBAAgB,KACxB,aAAa,KACb,eAAe,YAElB,aAAa,GACH,GACT,CACP,CAAC;AACJ,CAAC,CACF,CAAC;AAEF,uBAAuB,CAAC,WAAW,GAAG,yBAAyB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,356 @@
+import type { Element } from "hast";
+import type { ComponentPropsWithoutRef, ComponentType, ReactNode } from "react";
+import type { Options as RemarkRehypeOptions } from "remark-rehype";
+import type { StreamdownProps, MermaidOptions, MermaidErrorComponentProps } from "streamdown";
+/**
+ * Caret style for streaming indicator.
+ */
+export type CaretStyle = "block" | "circle";
+/**
+ * Controls configuration for interactive elements.
+ */
+export type ControlsConfig = boolean | {
+    table?: boolean;
+    code?: boolean;
+    mermaid?: boolean | {
+        download?: boolean;
+        copy?: boolean;
+        fullscreen?: boolean;
+        panZoom?: boolean;
+    };
+};
+/**
+ * Props passed to the link safety modal component.
+ */
+export type LinkSafetyModalProps = {
+    url: string;
+    isOpen: boolean;
+    onClose: () => void;
+    onConfirm: () => void;
+};
+/**
+ * Configuration for link safety confirmation.
+ */
+export type LinkSafetyConfig = {
+    /** Whether link safety is enabled. */
+    enabled: boolean;
+    /** Custom function to check if a link is safe. */
+    onLinkCheck?: (url: string) => Promise<boolean> | boolean;
+    /** Custom modal component for link confirmation. */
+    renderModal?: (props: LinkSafetyModalProps) => ReactNode;
+};
+/**
+ * Custom handler for incomplete markdown completion.
+ */
+export type RemendHandler = {
+    /** Handler name for identification */
+    name: string;
+    /** Function to transform text */
+    handle: (text: string) => string;
+    /** Priority for handler execution order (lower runs first, default: 100) */
+    priority?: number;
+};
+/**
+ * Configuration for incomplete markdown auto-completion.
+ */
+export type RemendConfig = {
+    /** Complete links (e.g., `[text](url` → `[text](streamdown:incomplete-link)`) */
+    links?: boolean;
+    /** Complete images (e.g., `![alt](url` → removed) */
+    images?: boolean;
+    /** How to handle incomplete links: 'protocol' or 'text-only' */
+    linkMode?: "protocol" | "text-only";
+    /** Complete bold formatting (e.g., `**text` → `**text**`) */
+    bold?: boolean;
+    /** Complete italic formatting (e.g., `*text` → `*text*`) */
+    italic?: boolean;
+    /** Complete bold-italic formatting (e.g., `***text` → `***text***`) */
+    boldItalic?: boolean;
+    /** Complete inline code formatting (e.g., `` `code `` → `` `code` ``) */
+    inlineCode?: boolean;
+    /** Complete strikethrough formatting (e.g., `~~text` → `~~text~~`) */
+    strikethrough?: boolean;
+    /** Complete block KaTeX math (e.g., `$$equation` → `$$equation$$`) */
+    katex?: boolean;
+    /** Handle incomplete setext headings to prevent misinterpretation */
+    setextHeadings?: boolean;
+    /** Custom handlers for incomplete markdown completion */
+    handlers?: RemendHandler[];
+};
+/**
+ * Props for the SyntaxHighlighter component.
+ * Compatible with @assistant-ui/react-markdown API.
+ */
+export type SyntaxHighlighterProps = {
+    node?: Element | undefined;
+    components: {
+        Pre: ComponentType<ComponentPropsWithoutRef<"pre"> & {
+            node?: Element | undefined;
+        }>;
+        Code: ComponentType<ComponentPropsWithoutRef<"code"> & {
+            node?: Element | undefined;
+        }>;
+    };
+    language: string;
+    code: string;
+};
+/**
+ * Props for the CodeHeader component.
+ * Compatible with @assistant-ui/react-markdown API.
+ */
+export type CodeHeaderProps = {
+    node?: Element | undefined;
+    language: string | undefined;
+    code: string;
+};
+/**
+ * Language-specific component overrides.
+ */
+export type ComponentsByLanguage = Record<string, {
+    CodeHeader?: ComponentType<CodeHeaderProps> | undefined;
+    SyntaxHighlighter?: ComponentType<SyntaxHighlighterProps> | undefined;
+}>;
+/**
+ * Extended components prop that includes SyntaxHighlighter and CodeHeader.
+ */
+export type StreamdownTextComponents = NonNullable<StreamdownProps["components"]> & {
+    SyntaxHighlighter?: ComponentType<SyntaxHighlighterProps> | undefined;
+    CodeHeader?: ComponentType<CodeHeaderProps> | undefined;
+};
+/**
+ * Plugin configuration type.
+ * Set to `false` to explicitly disable a plugin.
+ * Set to a plugin instance to use that plugin.
+ *
+ * NOTE: Plugins are NOT auto-detected for tree-shaking optimization.
+ * You must explicitly import and provide them.
+ *
+ * @example
+ * import { code } from "@streamdown/code";
+ * import { math } from "@streamdown/math";
+ * <StreamdownTextPrimitive plugins={{ code, math }} />
+ */
+export type PluginConfig = {
+    /** Code syntax highlighting plugin. Must be explicitly provided. */
+    code?: unknown | false | undefined;
+    /** Math/LaTeX rendering plugin. Must be explicitly provided. */
+    math?: unknown | false | undefined;
+    /** CJK text optimization plugin. Must be explicitly provided. */
+    cjk?: unknown | false | undefined;
+    /** Mermaid diagram plugin. Must be explicitly provided. */
+    mermaid?: unknown | false | undefined;
+};
+/**
+ * Resolved plugin configuration (without false values).
+ * This is the type passed to streamdown after processing.
+ */
+export type ResolvedPluginConfig = NonNullable<StreamdownProps["plugins"]>;
+/**
+ * Allowed HTML tags whitelist.
+ * Maps tag names to allowed attribute names.
+ */
+export type AllowedTags = Record<string, string[]>;
+/**
+ * Security configuration for URL validation via rehype-harden.
+ * Overrides streamdown's permissive defaults (allow-all policy).
+ *
+ * @example
+ * // Restrict to specific domains
+ * security={{
+ *   allowedLinkPrefixes: ["https://example.com", "https://docs.example.com"],
+ *   allowedImagePrefixes: ["https://cdn.example.com"],
+ *   allowedProtocols: ["https", "mailto"],
+ * }}
+ */
+export type SecurityConfig = {
+    /** URL prefixes allowed for links. Default: ["*"] (all) */
+    allowedLinkPrefixes?: string[];
+    /** URL prefixes allowed for images. Default: ["*"] (all) */
+    allowedImagePrefixes?: string[];
+    /** Allowed protocols (e.g., ["http", "https", "mailto"]). Default: ["*"] */
+    allowedProtocols?: string[];
+    /** Allow base64 data images. Default: true */
+    allowDataImages?: boolean;
+    /** Default origin for relative URLs */
+    defaultOrigin?: string;
+    /** CSS class for blocked links */
+    blockedLinkClass?: string;
+    /** CSS class for blocked images */
+    blockedImageClass?: string;
+};
+export type { MermaidOptions, MermaidErrorComponentProps, RemarkRehypeOptions };
+/**
+ * Props for the BlockComponent override.
+ * Used to customize how individual markdown blocks are rendered.
+ *
+ * Note: This is a documentation type. The actual BlockComponent prop
+ * uses StreamdownProps["BlockComponent"] for type compatibility.
+ */
+export type BlockProps = {
+    content: string;
+    shouldParseIncompleteMarkdown: boolean;
+    index: number;
+    components?: StreamdownProps["components"];
+    rehypePlugins?: StreamdownProps["rehypePlugins"];
+    remarkPlugins?: StreamdownProps["remarkPlugins"];
+    remarkRehypeOptions?: RemarkRehypeOptions;
+};
+/**
+ * Props for StreamdownTextPrimitive.
+ */
+export type StreamdownTextPrimitiveProps = Omit<StreamdownProps, "children" | "components" | "plugins" | "caret" | "controls" | "linkSafety" | "remend" | "mermaid" | "BlockComponent" | "parseMarkdownIntoBlocksFn"> & {
+    /**
+     * Custom components for rendering markdown elements.
+     * Includes SyntaxHighlighter and CodeHeader for code block customization.
+     */
+    components?: StreamdownTextComponents | undefined;
+    /**
+     * Language-specific component overrides.
+     * @example { mermaid: { SyntaxHighlighter: MermaidDiagram } }
+     */
+    componentsByLanguage?: ComponentsByLanguage | undefined;
+    /**
+     * Plugin configuration.
+     * Set to `false` to disable a specific plugin when using merged configs.
+     *
+     * @example
+     * // With plugins
+     * import { code } from "@streamdown/code";
+     * import { math } from "@streamdown/math";
+     * plugins={{ code, math }}
+     *
+     * @example
+     * // Disable a plugin in merged config
+     * plugins={{ code: false }}
+     */
+    plugins?: PluginConfig | undefined;
+    /**
+     * Function to transform text before markdown processing.
+     */
+    preprocess?: ((text: string) => string) | undefined;
+    /**
+     * Container element props.
+     */
+    containerProps?: Omit<ComponentPropsWithoutRef<"div">, "children"> | undefined;
+    /**
+     * Additional class name for the container.
+     */
+    containerClassName?: string | undefined;
+    /**
+     * Streaming caret style.
+     * - "block": Block cursor (▋)
+     * - "circle": Circle cursor (●)
+     */
+    caret?: CaretStyle | undefined;
+    /**
+     * Interactive controls configuration.
+     * Set to `true` to enable all controls, `false` to disable all,
+     * or provide an object to configure specific controls.
+     *
+     * @example
+     * // Enable all controls
+     * controls={true}
+     *
+     * @example
+     * // Configure specific controls
+     * controls={{ code: true, table: false, mermaid: { fullscreen: true } }}
+     */
+    controls?: ControlsConfig | undefined;
+    /**
+     * Link safety configuration.
+     * Shows a confirmation dialog before opening external links.
+     *
+     * @example
+     * // Disable link safety
+     * linkSafety={{ enabled: false }}
+     *
+     * @example
+     * // Custom link check
+     * linkSafety={{
+     *   enabled: true,
+     *   onLinkCheck: (url) => url.startsWith('https://trusted.com')
+     * }}
+     */
+    linkSafety?: LinkSafetyConfig | undefined;
+    /**
+     * Incomplete markdown auto-completion configuration.
+     * Controls how streaming markdown with incomplete syntax is handled.
+     *
+     * @example
+     * // Disable link completion
+     * remend={{ links: false }}
+     *
+     * @example
+     * // Use text-only mode for incomplete links
+     * remend={{ linkMode: "text-only" }}
+     */
+    remend?: RemendConfig | undefined;
+    /**
+     * Mermaid diagram configuration.
+     * Allows customization of Mermaid rendering.
+     *
+     * @example
+     * // Custom Mermaid config
+     * mermaid={{ config: { theme: 'dark' } }}
+     *
+     * @example
+     * // Custom error component
+     * mermaid={{ errorComponent: MyMermaidError }}
+     */
+    mermaid?: MermaidOptions | undefined;
+    /**
+     * Whether to parse incomplete markdown during streaming.
+     * When true, incomplete markdown syntax will be processed as-is.
+     * When false (default), remend will complete the syntax first.
+     */
+    parseIncompleteMarkdown?: boolean | undefined;
+    /**
+     * Allowed HTML tags whitelist.
+     * Maps tag names to their allowed attribute names.
+     * Use this to allow specific HTML tags in markdown content.
+     *
+     * @example
+     * allowedTags={{ div: ['class', 'id'], span: ['class'] }}
+     */
+    allowedTags?: AllowedTags | undefined;
+    /**
+     * Options passed to remark-rehype during markdown processing.
+     * Allows customization of the remark to rehype conversion.
+     *
+     * @example
+     * remarkRehypeOptions={{ allowDangerousHtml: true }}
+     */
+    remarkRehypeOptions?: RemarkRehypeOptions | undefined;
+    /**
+     * Security configuration for URL/image validation.
+     * Overrides streamdown's default (allow-all) policy via rehype-harden.
+     *
+     * @example
+     * // Restrict links to trusted domains only
+     * security={{
+     *   allowedLinkPrefixes: ["https://trusted.com"],
+     *   allowedImagePrefixes: ["https://cdn.trusted.com"],
+     *   allowedProtocols: ["https"],
+     * }}
+     */
+    security?: SecurityConfig | undefined;
+    /**
+     * Custom component for rendering individual markdown blocks.
+     * Use this for advanced block-level customization.
+     *
+     * @example
+     * BlockComponent={({ content, index }) => <div key={index}>{content}</div>}
+     */
+    BlockComponent?: StreamdownProps["BlockComponent"] | undefined;
+    /**
+     * Custom function to parse markdown into blocks.
+     * By default, streamdown splits on double newlines.
+     * Use this to implement custom block splitting logic.
+     *
+     * @example
+     * parseMarkdownIntoBlocksFn={(md) => md.split(/\n{2,}/)}
+     */
+    parseMarkdownIntoBlocksFn?: ((markdown: string) => string[]) | undefined;
+};
+export type { StreamdownProps };
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,KAAK,EAAE,wBAAwB,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAChF,OAAO,KAAK,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,0BAA0B,EAC3B,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,OAAO,GACP;IACE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EACJ,OAAO,GACP;QACE,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACP,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,SAAS,EAAE,MAAM,IAAI,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,kDAAkD;IAClD,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;IAC1D,oDAAoD;IACpD,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,SAAS,CAAC;CAC1D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACjC,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,iFAAiF;IACjF,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,qDAAqD;IACrD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,QAAQ,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IACpC,6DAA6D;IAC7D,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,4DAA4D;IAC5D,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,uEAAuE;IACvE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yEAAyE;IACzE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sEAAsE;IACtE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sEAAsE;IACtE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,qEAAqE;IACrE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,UAAU,EAAE;QACV,GAAG,EAAE,aAAa,CAChB,wBAAwB,CAAC,KAAK,CAAC,GAAG;YAAE,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;SAAE,CACjE,CAAC;QACF,IAAI,EAAE,aAAa,CACjB,wBAAwB,CAAC,MAAM,CAAC,GAAG;YAAE,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;SAAE,CAClE,CAAC;KACH,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACvC,MAAM,EACN;IACE,UAAU,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IACxD,iBAAiB,CAAC,EAAE,aAAa,CAAC,sBAAsB,CAAC,GAAG,SAAS,CAAC;CACvE,CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,WAAW,CAChD,eAAe,CAAC,YAAY,CAAC,CAC9B,GAAG;IACF,iBAAiB,CAAC,EAAE,aAAa,CAAC,sBAAsB,CAAC,GAAG,SAAS,CAAC;IACtE,UAAU,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;CACzD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,oEAAoE;IACpE,IAAI,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;IACnC,gEAAgE;IAChE,IAAI,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;IACnC,iEAAiE;IACjE,GAAG,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;IAClC,2DAA2D;IAC3D,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAEnD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,4DAA4D;IAC5D,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,4EAA4E;IAC5E,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,8CAA8C;IAC9C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kCAAkC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,mCAAmC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,YAAY,EAAE,cAAc,EAAE,0BAA0B,EAAE,mBAAmB,EAAE,CAAC;AAEhF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B,EAAE,OAAO,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAC;IAC3C,aAAa,CAAC,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IACjD,aAAa,CAAC,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IACjD,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAC7C,eAAe,EACb,UAAU,GACV,YAAY,GACZ,SAAS,GACT,OAAO,GACP,UAAU,GACV,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,gBAAgB,GAChB,2BAA2B,CAC9B,GAAG;IACF;;;OAGG;IACH,UAAU,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAElD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAExD;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,cAAc,CAAC,EACX,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,GACjD,SAAS,CAAC;IAEd;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC;;;;OAIG;IACH,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAE/B;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAEtC;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAE1C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAElC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAErC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE9C;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEtC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAEtD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAEtC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,eAAe,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;IAE/D;;;;;;;OAOG;IACH,yBAAyB,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC;CAC1E,CAAC;AAEF,YAAY,EAAE,eAAe,EAAE,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@assistant-ui/react-streamdown",
+  "version": "0.0.0",
+  "description": "Streamdown-based markdown rendering for assistant-ui",
+  "keywords": [
+    "markdown",
+    "streamdown",
+    "assistant-ui",
+    "react",
+    "ai",
+    "chat",
+    "streaming"
+  ],
+  "author": "AgentbaseAI Inc.",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "aui-source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "aui-build",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "rehype-harden": "^1.1.7",
+    "rehype-raw": "^7.0.0",
+    "rehype-sanitize": "^6.0.0",
+    "streamdown": "^2.0.0"
+  },
+  "peerDependencies": {
+    "@assistant-ui/react": "^0.12.3",
+    "@streamdown/code": "^1.0.0",
+    "@streamdown/cjk": "^1.0.0",
+    "@streamdown/math": "^1.0.0",
+    "@streamdown/mermaid": "^1.0.0",
+    "@types/react": "*",
+    "react": "^18 || ^19"
+  },
+  "peerDependenciesMeta": {
+    "@types/react": {
+      "optional": true
+    },
+    "@streamdown/code": {
+      "optional": true
+    },
+    "@streamdown/cjk": {
+      "optional": true
+    },
+    "@streamdown/math": {
+      "optional": true
+    },
+    "@streamdown/mermaid": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@assistant-ui/react": "workspace:*",
+    "@assistant-ui/x-buildutils": "workspace:*",
+    "@streamdown/code": "^1.0.0",
+    "@testing-library/react": "^16.3.0",
+    "@types/hast": "^3.0.4",
+    "@types/react": "^19.2.7",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "remark-rehype": "^11.1.2",
+    "vitest": "^4.0.16"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://www.assistant-ui.com/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/assistant-ui/assistant-ui.git",
+    "directory": "packages/react-streamdown"
+  },
+  "bugs": {
+    "url": "https://github.com/assistant-ui/assistant-ui/issues"
+  }
+}