@nicomatt69/streamtty 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nicomatt69
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,471 @@
+# Streamtty
+
+> A drop-in replacement for markdown rendering in TTY environments, designed for AI-powered streaming with blessed.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Streamtty is inspired by [Streamdown](https://github.com/vercel/streamdown) but built specifically for terminal/TTY environments using [blessed](https://github.com/chjj/blessed). It handles the unique challenges of streaming Markdown content from AI models in terminals, providing seamless formatting even with incomplete or unterminated Markdown blocks.
+
+## ✨ Features
+
+### Core Features
+- 🚀 **Streaming-optimized** - Handles incomplete Markdown gracefully during real-time generation
+- 🎨 **Unterminated block parsing** - Styles incomplete bold, italic, code, links, and headings
+- 📊 **GitHub Flavored Markdown** - Tables, task lists, and strikethrough support
+- 📝 **Rich formatting** - Headers, lists, blockquotes, links, and more
+- ⚡ **Performance optimized** - Debounced rendering for efficient updates
+- 🎮 **Interactive** - Built-in keyboard navigation and scrolling
+
+### Enhanced Features (Streamdown Parity) ✨ NEW
+- 📐 **Math Rendering** - LaTeX math expressions converted to Unicode (inline and block)
+- 📊 **Mermaid Diagrams** - Flowcharts, sequence diagrams, and more rendered as ASCII art
+- 🎨 **Shiki Syntax Highlighting** - Advanced code highlighting with multiple themes
+- 📋 **Advanced Tables** - Full table support with alignment, borders, and navigation
+- 🛡️ **Security Layer** - ANSI sanitization, input validation, and injection prevention
+- ⌨️ **Interactive Controls** - Copy code, export diagrams, navigate with keyboard shortcuts
+- 🔌 **Plugin System** - Remark/Rehype compatible plugin architecture
+- 🎭 **Theme Support** - Light/dark themes with auto-detection
+- 🧩 **Component Overrides** - Customize rendering for any token type
+
+## 📦 Installation
+
+```bash
+npm install streamtty
+# or
+yarn add streamtty
+# or
+pnpm add streamtty
+```
+
+> **Note:** `blessed` is included as a dependency and will be installed automatically.
+
+## 🚀 Quick Start
+
+### Basic Usage
+
+```typescript
+import { Streamtty } from 'streamtty';
+
+const markdown = `
+# Hello World
+
+This is **bold** and this is *italic*.
+
+\`\`\`typescript
+console.log('Hello, Streamtty!');
+\`\`\`
+`;
+
+const streamtty = new Streamtty();
+streamtty.setContent(markdown);
+```
+
+### Streaming Usage (AI-like)
+
+```typescript
+import { Streamtty } from 'streamtty';
+
+const streamtty = new Streamtty({
+  parseIncompleteMarkdown: true,
+  autoScroll: true,
+});
+
+// Simulate AI streaming
+const chunks = ['# Hello ', '**World**', '!\n\nThis is ', '`streaming`'];
+for (const chunk of chunks) {
+  streamtty.stream(chunk);
+  await new Promise(resolve => setTimeout(resolve, 100));
+}
+```
+
+### Interactive Chat Example
+
+```typescript
+import blessed from 'blessed';
+import { Streamtty } from 'streamtty';
+
+const screen = blessed.screen({
+  smartCSR: true,
+  title: 'AI Chat',
+});
+
+const streamtty = new Streamtty({ screen });
+
+// Stream AI response character by character
+function streamResponse(response: string) {
+  let index = 0;
+  const interval = setInterval(() => {
+    if (index < response.length) {
+      streamtty.stream(response[index]);
+      index++;
+    } else {
+      clearInterval(interval);
+    }
+  }, 50);
+}
+
+streamResponse('# AI Response\n\nHere is some **formatted** text!');
+```
+
+### Enhanced Features Usage
+
+```typescript
+import { Streamtty } from 'streamtty';
+
+// Enable all enhanced features
+const streamtty = new Streamtty({
+  syntaxHighlight: true,
+  theme: 'dark',
+  shikiLanguages: ['typescript', 'python', 'bash'],
+  enhancedFeatures: {
+    math: true,              // LaTeX math rendering
+    mermaid: true,           // Mermaid diagrams
+    shiki: true,             // Advanced syntax highlighting
+    security: true,          // ANSI sanitization & validation
+    interactiveControls: true, // Keyboard shortcuts
+    advancedTables: true,    // Enhanced table rendering
+  },
+  controls: {
+    code: true,    // Press 'c' to copy code blocks
+    table: true,   // Arrow keys to navigate tables
+    mermaid: true, // Press 'e' to export diagrams
+    math: true,    // Copy math expressions
+  },
+  security: {
+    enabled: true,
+    stripDangerousAnsi: true,
+    allowedLinkPrefixes: ['https://'],
+  },
+});
+
+// Math rendering
+const mathContent = `
+Inline math: $E = mc^2$
+
+Block math:
+$$
+\\int_0^\\infty e^{-x^2} dx = \\frac{\\sqrt{\\pi}}{2}
+$$
+`;
+streamtty.setContent(mathContent);
+
+// Mermaid diagrams
+const diagramContent = `
+\`\`\`mermaid
+graph TD
+    A[Start] --> B{Decision}
+    B -->|Yes| C[Success]
+    B -->|No| D[Retry]
+\`\`\`
+`;
+streamtty.stream(diagramContent);
+
+// Advanced tables
+const tableContent = `
+| Feature | Status | Priority |
+|---------|:------:|----------|
+| Math    | ✅     | High     |
+| Mermaid | ✅     | High     |
+| Tables  | ✅     | Medium   |
+`;
+streamtty.stream(tableContent);
+```
+
+### Plugin System
+
+```typescript
+import { Streamtty, RemarkPlugin, RehypePlugin } from 'streamtty';
+
+// Custom remark plugin (pre-parse)
+const customRemarkPlugin: RemarkPlugin = {
+  name: 'custom-remark',
+  type: 'remark',
+  priority: 50,
+  async process(markdown, context) {
+    // Transform markdown before parsing
+    return markdown.replace(/TODO:/g, '📝 TODO:');
+  },
+};
+
+// Custom rehype plugin (post-parse)
+const customRehypePlugin: RehypePlugin = {
+  name: 'custom-rehype',
+  type: 'rehype',
+  priority: 50,
+  async process(tokens, context) {
+    // Transform tokens after parsing
+    return tokens.map(token => {
+      if (token.type === 'text' && token.content.includes('IMPORTANT')) {
+        token.style = { fg: 'red', bold: true };
+      }
+      return token;
+    });
+  },
+};
+
+const streamtty = new Streamtty({
+  remarkPlugins: [customRemarkPlugin],
+  rehypePlugins: [customRehypePlugin],
+});
+```
+
+## 📖 API Reference
+
+### `Streamtty`
+
+Main class for rendering streamed markdown in TTY.
+
+#### Constructor Options
+
+```typescript
+interface StreamttyOptions {
+  parseIncompleteMarkdown?: boolean;  // Default: true
+  styles?: Partial<MarkdownStyles>;
+  syntaxHighlight?: boolean;          // Default: true
+  showLineNumbers?: boolean;          // Default: false
+  maxWidth?: number;                  // Default: 120
+  gfm?: boolean;                      // Default: true
+  screen?: Widgets.Screen;            // Custom blessed screen
+  autoScroll?: boolean;               // Default: true
+}
+```
+
+#### Methods
+
+##### `stream(chunk: string): void`
+
+Stream a chunk of markdown content. Handles incomplete markdown gracefully.
+
+```typescript
+streamtty.stream('# Hello ');
+streamtty.stream('**World**');
+```
+
+##### `setContent(markdown: string): void`
+
+Set complete markdown content all at once.
+
+```typescript
+streamtty.setContent('# Complete Document\n\nWith **multiple** paragraphs.');
+```
+
+##### `render(): void`
+
+Manually trigger a render. Usually not needed as rendering is automatic.
+
+##### `clear(): void`
+
+Clear all content from the display.
+
+```typescript
+streamtty.clear();
+```
+
+##### `startAutoRender(intervalMs?: number): void`
+
+Start auto-rendering at specified interval (default: 50ms).
+
+##### `stopAutoRender(): void`
+
+Stop auto-rendering.
+
+##### `getScreen(): Widgets.Screen`
+
+Get the blessed screen instance.
+
+##### `getContainer(): Widgets.BoxElement`
+
+Get the blessed container box.
+
+##### `getContent(): string`
+
+Get current buffer content.
+
+##### `destroy(): void`
+
+Cleanup and destroy the instance.
+
+## 🎨 Styling
+
+Streamtty uses blessed's styling system. You can customize styles for different markdown elements:
+
+```typescript
+const streamtty = new Streamtty({
+  styles: {
+    h1: { fg: 'cyan', bold: true },
+    h2: { fg: 'blue', bold: true },
+    code: { fg: 'green', bold: true },
+    codeBlock: { fg: 'white', bg: 'black' },
+    blockquote: { fg: 'gray', italic: true },
+    link: { fg: 'blue', underline: true },
+  },
+});
+```
+
+## ⌨️ Keyboard Shortcuts
+
+Built-in keyboard navigation:
+
+- `↑` / `k` - Scroll up
+- `↓` / `j` - Scroll down
+- `Page Up` - Scroll up one page
+- `Page Down` - Scroll down one page
+- `Home` / `g` - Go to top
+- `End` / `G` - Go to bottom
+- `Escape` / `q` / `Ctrl+C` - Exit
+
+## 📚 Examples
+
+Check out the `examples/` directory for complete examples:
+
+### Basic Example
+
+```bash
+yarn tsx examples/basic.ts
+```
+
+Shows static markdown rendering with various elements.
+
+### Streaming Example
+
+```bash
+yarn tsx examples/streaming.ts
+```
+
+Simulates AI-like streaming of markdown content.
+
+### Chat Example
+
+```bash
+yarn tsx examples/chat.ts
+```
+
+Interactive chat interface with streaming AI responses.
+
+## 🔧 Development
+
+```bash
+# Install dependencies
+yarn install
+
+# Build
+yarn build
+
+# Watch mode
+yarn dev
+
+# Run examples
+yarn example:basic
+yarn example:streaming
+yarn example:chat
+```
+
+## 📝 Markdown Support
+
+Streamtty supports a wide range of markdown features:
+
+### Basic Formatting
+
+- **Bold**: `**text**` or `__text__`
+- *Italic*: `*text*` or `_text_`
+- `Inline code`: `` `code` ``
+- ~~Strikethrough~~: `~~text~~`
+
+### Headers
+
+```markdown
+# H1
+## H2
+### H3
+#### H4
+##### H5
+###### H6
+```
+
+### Lists
+
+```markdown
+- Unordered list
+- Items
+
+1. Ordered list
+2. Items
+```
+
+### Code Blocks
+
+````markdown
+```typescript
+function hello(): void {
+  console.log('Hello!');
+}
+```
+````
+
+### Blockquotes
+
+```markdown
+> This is a blockquote
+> Multiple lines supported
+```
+
+### Links
+
+```markdown
+[Link text](https://example.com)
+```
+
+### Tables
+
+```markdown
+| Column 1 | Column 2 |
+|----------|----------|
+| Data 1   | Data 2   |
+```
+
+### Horizontal Rules
+
+```markdown
+---
+```
+
+### Task Lists
+
+```markdown
+- [x] Completed task
+- [ ] Pending task
+```
+
+## 🆚 Streamdown vs Streamtty
+
+| Feature | Streamdown | Streamtty |
+|---------|-----------|-----------|
+| Environment | React / Web | TTY / Terminal |
+| Rendering | React Components | Blessed Widgets |
+| Output | HTML/JSX | ANSI/Terminal |
+| Use Case | Web Apps | CLI Tools / TUIs |
+| Dependencies | React, ReactDOM | Blessed, Marked |
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 License
+
+MIT © [Your Name]
+
+## 🙏 Credits
+
+- Inspired by [Streamdown](https://github.com/vercel/streamdown) by Vercel
+- Built with [blessed](https://github.com/chjj/blessed)
+- Markdown parsing by [marked](https://github.com/markedjs/marked)
+
+## 🔗 Links
+
+- [Streamdown](https://github.com/vercel/streamdown) - The web/React version
+- [blessed](https://github.com/chjj/blessed) - Terminal UI library
+- [marked](https://github.com/markedjs/marked) - Markdown parser
+
+---
+
+Made with ❤️ for the terminal

package/dist/ai-sdk-adapter.d.ts

@@ -0,0 +1,113 @@
+/**
+ * AI SDK Stream Adapter
+ *
+ * This module provides an adapter that handles AI SDK streaming events
+ * and formats them appropriately for TTY rendering using streamtty.
+ */
+import { StreamEvent, StreamEventOptions } from './types/stream-events';
+export interface AISDKStreamAdapterOptions extends StreamEventOptions {
+    maxToolResultLength?: number;
+    formatToolCalls?: boolean;
+    showThinking?: boolean;
+    renderTimestamps?: boolean;
+}
+export declare class AISDKStreamAdapter {
+    private renderer;
+    private options;
+    constructor(renderer: {
+        stream: (content: string) => void;
+    }, options?: AISDKStreamAdapterOptions);
+    /**
+     * Handle a stream of AI SDK events
+     */
+    handleAISDKStream(stream: AsyncGenerator<StreamEvent>): AsyncGenerator<void>;
+    /**
+     * Process a single stream event
+     */
+    processEvent(event: StreamEvent): Promise<void>;
+    /**
+     * Render a validated stream event
+     */
+    private renderEvent;
+    /**
+     * Render text delta events (streaming text)
+     */
+    private renderTextDelta;
+    /**
+     * Render tool call events
+     */
+    private renderToolCall;
+    /**
+     * Format a tool call event for display
+     */
+    private formatToolCall;
+    /**
+     * Render tool result events
+     */
+    private renderToolResult;
+    /**
+     * Format a tool result event for display
+     */
+    private formatToolResult;
+    /**
+     * Format tool result content for display
+     */
+    private formatToolResultContent;
+    /**
+     * Truncate content to specified length
+     */
+    private truncateContent;
+    /**
+     * Render thinking/reasoning events
+     */
+    private renderThinking;
+    /**
+     * Format thinking events for display
+     */
+    private formatThinking;
+    /**
+     * Render status events
+     */
+    private renderStatus;
+    /**
+     * Format status events for display
+     */
+    private formatStatus;
+    /**
+     * Render error events
+     */
+    private renderError;
+    /**
+     * Format error events for display
+     */
+    private formatError;
+    /**
+     * Render start events
+     */
+    private renderStart;
+    /**
+     * Render complete events
+     */
+    private renderComplete;
+    /**
+     * Get appropriate icon for tool name
+     */
+    private getToolIcon;
+    /**
+     * Get appropriate icon for status
+     */
+    private getStatusIcon;
+    /**
+     * Format tool arguments for display
+     */
+    private formatToolArgs;
+    /**
+     * Update adapter options
+     */
+    updateOptions(options: Partial<AISDKStreamAdapterOptions>): void;
+    /**
+     * Get current options
+     */
+    getOptions(): AISDKStreamAdapterOptions;
+}
+//# sourceMappingURL=ai-sdk-adapter.d.ts.map

package/dist/ai-sdk-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-sdk-adapter.d.ts","sourceRoot":"","sources":["../src/ai-sdk-adapter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,WAAW,EAEX,kBAAkB,EAOnB,MAAM,uBAAuB,CAAA;AAG9B,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;IACnE,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED,qBAAa,kBAAkB;IAI3B,OAAO,CAAC,QAAQ;IAHlB,OAAO,CAAC,OAAO,CAAqC;gBAG1C,QAAQ,EAAE;QAAE,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,EACvD,OAAO,GAAE,yBAA8B;IAazC;;OAEG;IACI,iBAAiB,CACtB,MAAM,EAAE,cAAc,CAAC,WAAW,CAAC,GAClC,cAAc,CAAC,IAAI,CAAC;IAOvB;;OAEG;IACG,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBrD;;OAEG;YACW,WAAW;IA+BzB;;OAEG;YACW,eAAe;IAM7B;;OAEG;YACW,cAAc;IAS5B;;OAEG;IACH,OAAO,CAAC,cAAc;IAWtB;;OAEG;YACW,gBAAgB;IAK9B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAWxB;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAgB/B;;OAEG;IACH,OAAO,CAAC,eAAe;IAQvB;;OAEG;YACW,cAAc;IAS5B;;OAEG;IACH,OAAO,CAAC,cAAc;IAUtB;;OAEG;YACW,YAAY;IAK1B;;OAEG;IACH,OAAO,CAAC,YAAY;IAWpB;;OAEG;YACW,WAAW;IAKzB;;OAEG;IACH,OAAO,CAAC,WAAW;IAUnB;;OAEG;YACW,WAAW;IAQzB;;OAEG;YACW,cAAc;IAQ5B;;OAEG;IACH,OAAO,CAAC,WAAW;IAiCnB;;OAEG;IACH,OAAO,CAAC,aAAa;IAerB;;OAEG;IACH,OAAO,CAAC,cAAc;IAQtB;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,IAAI;IAIhE;;OAEG;IACH,UAAU,IAAI,yBAAyB;CAGxC"}