streaming-markdown-react 0.1.4

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2024 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,40 @@
+# @stream-md/react
+
+React component for rendering streaming markdown content with proper handling of incomplete code blocks.
+
+## Installation
+
+```bash
+pnpm add @stream-md/react
+```
+
+## Usage
+
+```tsx
+import { StreamingMarkdown } from '@stream-md/react';
+
+function ChatMessage({ content }: { content: string }) {
+  return <StreamingMarkdown content={content} />;
+}
+```
+
+## API
+
+### Props
+
+- `content: string` - Markdown content to render (can be incomplete during streaming)
+- `className?: string` - Optional CSS class name
+- `components?: Partial<Components>` - Custom react-markdown components
+- `onComplete?: () => void` - Callback when streaming completes
+
+## Features
+
+- ✅ Handles incomplete code blocks during streaming
+- ✅ GitHub Flavored Markdown (tables, strikethrough, etc.)
+- ✅ Type-safe with TypeScript
+- ✅ Zero runtime overhead
+- ✅ Customizable rendering via components prop
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,151 @@
+import { ReactNode } from 'react';
+import { Components } from 'react-markdown';
+
+type MessageRole = 'system' | 'user' | 'assistant' | 'tool' | (string & {});
+declare enum MessageStatus {
+    IDLE = "idle",
+    STREAMING = "streaming",
+    SUCCESS = "success",
+    ERROR = "error"
+}
+declare enum MessageBlockStatus {
+    IDLE = "idle",
+    STREAMING = "streaming",
+    SUCCESS = "success",
+    ERROR = "error"
+}
+declare enum MessageBlockType {
+    MAIN_TEXT = "main_text",
+    CODE = "code",
+    IMAGE = "image",
+    FILE = "file",
+    TOOL = "tool",
+    CITATION = "citation",
+    TRANSLATION = "translation",
+    THINKING = "thinking",
+    VIDEO = "video",
+    ERROR = "error",
+    UNKNOWN = "unknown"
+}
+interface MessageMetadata {
+    [key: string]: unknown;
+}
+interface MessageBlockMetadata {
+    [key: string]: unknown;
+}
+interface MessageBlockBase {
+    id: string;
+    messageId: string;
+    type: MessageBlockType;
+    status: MessageBlockStatus;
+    createdAt: string;
+    updatedAt?: string;
+    metadata?: MessageBlockMetadata;
+}
+interface TextMessageBlock extends MessageBlockBase {
+    content: string;
+    type: MessageBlockType.MAIN_TEXT | MessageBlockType.CODE | MessageBlockType.TRANSLATION | MessageBlockType.THINKING | MessageBlockType.ERROR | MessageBlockType.UNKNOWN;
+}
+interface MediaMessageBlock extends MessageBlockBase {
+    type: MessageBlockType.IMAGE | MessageBlockType.VIDEO | MessageBlockType.FILE;
+    url: string;
+    previewUrl?: string;
+    name?: string;
+    mimeType?: string;
+    size?: number;
+    content?: string;
+}
+interface ToolMessageBlock extends MessageBlockBase {
+    type: MessageBlockType.TOOL | MessageBlockType.CITATION;
+    content?: string;
+    payload?: Record<string, unknown>;
+}
+type MessageBlock = TextMessageBlock | MediaMessageBlock | ToolMessageBlock;
+interface Message {
+    id: string;
+    role: MessageRole;
+    blockIds: string[];
+    status: MessageStatus;
+    createdAt: string;
+    updatedAt?: string;
+    askId?: string;
+    metadata?: MessageMetadata;
+}
+type MessageMap = Record<string, Message>;
+type MessageBlockMap = Record<string, MessageBlock>;
+
+declare class MessageBlockStore {
+    private blocks;
+    upsert(block: MessageBlock): void;
+    upsert(blocks: MessageBlock[]): void;
+    selectById(id: string): MessageBlock | undefined;
+    selectMany(ids: string[]): MessageBlock[];
+    remove(id: string): void;
+    remove(ids: string[]): void;
+    clear(): void;
+    selectAll(): MessageBlock[];
+    toJSON(): Record<string, MessageBlock>;
+}
+declare const messageBlockStore: MessageBlockStore;
+
+type StreamingStatus = 'idle' | 'streaming' | 'success' | 'error';
+interface StreamingMarkdownProps {
+    children?: ReactNode;
+    className?: string;
+    components?: Partial<Components>;
+    status?: StreamingStatus;
+    onComplete?: () => void;
+    minDelay?: number;
+    blockId?: string;
+}
+declare function StreamingMarkdown({ children, className, components: customComponents, status, onComplete, minDelay, }: StreamingMarkdownProps): ReactNode;
+
+interface CodeBlockProps {
+    code: string;
+    language?: string;
+    className?: string;
+    theme?: 'light' | 'dark';
+    showLineNumbers?: boolean;
+}
+declare function CodeBlock({ code, language, className, theme, }: CodeBlockProps): ReactNode;
+
+interface MessageBlockRendererProps {
+    block: MessageBlock;
+    className?: string;
+}
+declare function MessageBlockRenderer({ block, className }: MessageBlockRendererProps): ReactNode;
+
+interface MessageItemProps {
+    children?: ReactNode;
+    role?: MessageRole;
+    messageId?: string;
+    className?: string;
+    blockClassName?: string;
+}
+declare function MessageItem({ children, role, messageId, className, blockClassName, }: MessageItemProps): ReactNode;
+
+interface UseSmoothStreamOptions {
+    onUpdate: (text: string) => void;
+    streamDone: boolean;
+    minDelay?: number;
+    initialText?: string;
+    onComplete?: () => void;
+}
+declare function useSmoothStream({ onUpdate, streamDone, minDelay, initialText, onComplete, }: UseSmoothStreamOptions): {
+    addChunk: (chunk: string) => void;
+    reset: (newText?: string) => void;
+};
+
+interface UseShikiHighlightOptions {
+    code: string;
+    language?: string;
+    theme?: 'light' | 'dark';
+}
+interface UseShikiHighlightResult {
+    html: string;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useShikiHighlight({ code, language, theme, }: UseShikiHighlightOptions): UseShikiHighlightResult;
+
+export { CodeBlock, type CodeBlockProps, type MediaMessageBlock, type Message, type MessageBlock, type MessageBlockMap, type MessageBlockMetadata, MessageBlockRenderer, type MessageBlockRendererProps, MessageBlockStatus, MessageBlockStore, MessageBlockType, MessageItem, type MessageItemProps, type MessageMap, type MessageMetadata, type MessageRole, MessageStatus, StreamingMarkdown, type StreamingMarkdownProps, type StreamingStatus, type TextMessageBlock, type ToolMessageBlock, type UseSmoothStreamOptions, messageBlockStore, useShikiHighlight, useSmoothStream };

package/dist/index.d.ts

@@ -0,0 +1,151 @@
+import { ReactNode } from 'react';
+import { Components } from 'react-markdown';
+
+type MessageRole = 'system' | 'user' | 'assistant' | 'tool' | (string & {});
+declare enum MessageStatus {
+    IDLE = "idle",
+    STREAMING = "streaming",
+    SUCCESS = "success",
+    ERROR = "error"
+}
+declare enum MessageBlockStatus {
+    IDLE = "idle",
+    STREAMING = "streaming",
+    SUCCESS = "success",
+    ERROR = "error"
+}
+declare enum MessageBlockType {
+    MAIN_TEXT = "main_text",
+    CODE = "code",
+    IMAGE = "image",
+    FILE = "file",
+    TOOL = "tool",
+    CITATION = "citation",
+    TRANSLATION = "translation",
+    THINKING = "thinking",
+    VIDEO = "video",
+    ERROR = "error",
+    UNKNOWN = "unknown"
+}
+interface MessageMetadata {
+    [key: string]: unknown;
+}
+interface MessageBlockMetadata {
+    [key: string]: unknown;
+}
+interface MessageBlockBase {
+    id: string;
+    messageId: string;
+    type: MessageBlockType;
+    status: MessageBlockStatus;
+    createdAt: string;
+    updatedAt?: string;
+    metadata?: MessageBlockMetadata;
+}
+interface TextMessageBlock extends MessageBlockBase {
+    content: string;
+    type: MessageBlockType.MAIN_TEXT | MessageBlockType.CODE | MessageBlockType.TRANSLATION | MessageBlockType.THINKING | MessageBlockType.ERROR | MessageBlockType.UNKNOWN;
+}
+interface MediaMessageBlock extends MessageBlockBase {
+    type: MessageBlockType.IMAGE | MessageBlockType.VIDEO | MessageBlockType.FILE;
+    url: string;
+    previewUrl?: string;
+    name?: string;
+    mimeType?: string;
+    size?: number;
+    content?: string;
+}
+interface ToolMessageBlock extends MessageBlockBase {
+    type: MessageBlockType.TOOL | MessageBlockType.CITATION;
+    content?: string;
+    payload?: Record<string, unknown>;
+}
+type MessageBlock = TextMessageBlock | MediaMessageBlock | ToolMessageBlock;
+interface Message {
+    id: string;
+    role: MessageRole;
+    blockIds: string[];
+    status: MessageStatus;
+    createdAt: string;
+    updatedAt?: string;
+    askId?: string;
+    metadata?: MessageMetadata;
+}
+type MessageMap = Record<string, Message>;
+type MessageBlockMap = Record<string, MessageBlock>;
+
+declare class MessageBlockStore {
+    private blocks;
+    upsert(block: MessageBlock): void;
+    upsert(blocks: MessageBlock[]): void;
+    selectById(id: string): MessageBlock | undefined;
+    selectMany(ids: string[]): MessageBlock[];
+    remove(id: string): void;
+    remove(ids: string[]): void;
+    clear(): void;
+    selectAll(): MessageBlock[];
+    toJSON(): Record<string, MessageBlock>;
+}
+declare const messageBlockStore: MessageBlockStore;
+
+type StreamingStatus = 'idle' | 'streaming' | 'success' | 'error';
+interface StreamingMarkdownProps {
+    children?: ReactNode;
+    className?: string;
+    components?: Partial<Components>;
+    status?: StreamingStatus;
+    onComplete?: () => void;
+    minDelay?: number;
+    blockId?: string;
+}
+declare function StreamingMarkdown({ children, className, components: customComponents, status, onComplete, minDelay, }: StreamingMarkdownProps): ReactNode;
+
+interface CodeBlockProps {
+    code: string;
+    language?: string;
+    className?: string;
+    theme?: 'light' | 'dark';
+    showLineNumbers?: boolean;
+}
+declare function CodeBlock({ code, language, className, theme, }: CodeBlockProps): ReactNode;
+
+interface MessageBlockRendererProps {
+    block: MessageBlock;
+    className?: string;
+}
+declare function MessageBlockRenderer({ block, className }: MessageBlockRendererProps): ReactNode;
+
+interface MessageItemProps {
+    children?: ReactNode;
+    role?: MessageRole;
+    messageId?: string;
+    className?: string;
+    blockClassName?: string;
+}
+declare function MessageItem({ children, role, messageId, className, blockClassName, }: MessageItemProps): ReactNode;
+
+interface UseSmoothStreamOptions {
+    onUpdate: (text: string) => void;
+    streamDone: boolean;
+    minDelay?: number;
+    initialText?: string;
+    onComplete?: () => void;
+}
+declare function useSmoothStream({ onUpdate, streamDone, minDelay, initialText, onComplete, }: UseSmoothStreamOptions): {
+    addChunk: (chunk: string) => void;
+    reset: (newText?: string) => void;
+};
+
+interface UseShikiHighlightOptions {
+    code: string;
+    language?: string;
+    theme?: 'light' | 'dark';
+}
+interface UseShikiHighlightResult {
+    html: string;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useShikiHighlight({ code, language, theme, }: UseShikiHighlightOptions): UseShikiHighlightResult;
+
+export { CodeBlock, type CodeBlockProps, type MediaMessageBlock, type Message, type MessageBlock, type MessageBlockMap, type MessageBlockMetadata, MessageBlockRenderer, type MessageBlockRendererProps, MessageBlockStatus, MessageBlockStore, MessageBlockType, MessageItem, type MessageItemProps, type MessageMap, type MessageMetadata, type MessageRole, MessageStatus, StreamingMarkdown, type StreamingMarkdownProps, type StreamingStatus, type TextMessageBlock, type ToolMessageBlock, type UseSmoothStreamOptions, messageBlockStore, useShikiHighlight, useSmoothStream };