@stream-mdx/core 0.2.0 → 0.4.0

package/README.md

@@ -39,11 +39,16 @@ export function makeConfig(overrides?: Partial<typeof DEFAULT_BACKPRESSURE_CONFI
 
 ## Docs
 
-- API reference: `docs/PUBLIC_API.md`
-- Security model: `docs/SECURITY_MODEL.md`
+- API reference: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/PUBLIC_API.md
+- Security model: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/SECURITY_MODEL.md
+- Protocol spec (for typed stream events): https://github.com/kmccleary3301/stream-mdx/blob/main/docs/STREAMMDX_JSON_DIFF_SPEC.md
 
 ## Related packages
 
 - `@stream-mdx/react` for the React renderer
 - `@stream-mdx/worker` for hosted worker bundles
+- `@stream-mdx/plugins` for worker-side plugin primitives (advanced)
+- `@stream-mdx/protocol` for stable protocol/event types (e.g. TUIs)
+- `@stream-mdx/tui` for NDJSON helpers + a snapshot store (terminal UIs)
 - `@stream-mdx/mermaid` for Mermaid diagram rendering (optional)
+- `@stream-mdx/theme-tailwind` for an optional Tailwind-friendly theme (optional)

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { Block, NodeSnapshot, InlineNode, Patch } from './types.cjs';
-export { ASTInlinePlugin, CoalescingMetrics, CodeHighlightOutputMode, CodeHighlightingMode, CompiledMdxModule, DiffKind, FormatAnticipationConfig, InlineHtmlDescriptor, InlinePlugin, LANGUAGE_ALIASES, LazyTokenizationPriority, MixedContentSegment, NodePath, PATCH_ROOT_ID, PatchMetrics, PerformanceMetrics, ProtectedRange, ProtectedRangeKind, RegexAnticipationPattern, RegexInlinePlugin, SetPropsBatchEntry, TokenLineV1, TokenSpan, TokenStyle, WorkerErrorPayload, WorkerIn, WorkerOut, WorkerPhase } from './types.cjs';
+export { ASTInlinePlugin, CoalescingMetrics, CodeHighlightOutputMode, CodeHighlightingMode, CompiledMdxModule, DiffBlock, DiffKind, DiffLine, DiffLineKind, FormatAnticipationConfig, InlineHtmlDescriptor, InlinePlugin, LANGUAGE_ALIASES, LazyTokenizationPriority, MixedContentSegment, NodePath, PATCH_ROOT_ID, PatchMetrics, PerformanceMetrics, ProtectedRange, ProtectedRangeKind, RegexAnticipationPattern, RegexInlinePlugin, SetPropsBatchEntry, ThemedLine, ThemedToken, TocHeading, TokenLineV1, TokenSpan, TokenStyle, WorkerErrorPayload, WorkerIn, WorkerOut, WorkerPhase } from './types.cjs';
 export { HighlightedLine, dedentIndentedCode, extractCodeLines, extractCodeWrapperAttributes, extractHighlightedLines, getDefaultCodeWrapperAttributes, normalizeHighlightedLines, stripCodeFence } from './code-highlighting.cjs';
 export { PerformanceTimer, StringBuffer, applyUpdate, debounce, detectMDX, generateBlockId, getBlockKey, normalizeBlockquoteText, normalizeLang, parseCodeFenceInfo, removeHeadingMarkers } from './utils.cjs';
 export { MixedContentAutoCloseHtmlOptions, MixedContentAutoCloseMdxOptions, MixedContentOptions, extractMixedContentSegments, findClosingHtmlTag, isLikelyMdxComponent } from './mixed-content.cjs';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Block, NodeSnapshot, InlineNode, Patch } from './types.js';
-export { ASTInlinePlugin, CoalescingMetrics, CodeHighlightOutputMode, CodeHighlightingMode, CompiledMdxModule, DiffKind, FormatAnticipationConfig, InlineHtmlDescriptor, InlinePlugin, LANGUAGE_ALIASES, LazyTokenizationPriority, MixedContentSegment, NodePath, PATCH_ROOT_ID, PatchMetrics, PerformanceMetrics, ProtectedRange, ProtectedRangeKind, RegexAnticipationPattern, RegexInlinePlugin, SetPropsBatchEntry, TokenLineV1, TokenSpan, TokenStyle, WorkerErrorPayload, WorkerIn, WorkerOut, WorkerPhase } from './types.js';
+export { ASTInlinePlugin, CoalescingMetrics, CodeHighlightOutputMode, CodeHighlightingMode, CompiledMdxModule, DiffBlock, DiffKind, DiffLine, DiffLineKind, FormatAnticipationConfig, InlineHtmlDescriptor, InlinePlugin, LANGUAGE_ALIASES, LazyTokenizationPriority, MixedContentSegment, NodePath, PATCH_ROOT_ID, PatchMetrics, PerformanceMetrics, ProtectedRange, ProtectedRangeKind, RegexAnticipationPattern, RegexInlinePlugin, SetPropsBatchEntry, ThemedLine, ThemedToken, TocHeading, TokenLineV1, TokenSpan, TokenStyle, WorkerErrorPayload, WorkerIn, WorkerOut, WorkerPhase } from './types.js';
 export { HighlightedLine, dedentIndentedCode, extractCodeLines, extractCodeWrapperAttributes, extractHighlightedLines, getDefaultCodeWrapperAttributes, normalizeHighlightedLines, stripCodeFence } from './code-highlighting.js';
 export { PerformanceTimer, StringBuffer, applyUpdate, debounce, detectMDX, generateBlockId, getBlockKey, normalizeBlockquoteText, normalizeLang, parseCodeFenceInfo, removeHeadingMarkers } from './utils.js';
 export { MixedContentAutoCloseHtmlOptions, MixedContentAutoCloseMdxOptions, MixedContentOptions, extractMixedContentSegments, findClosingHtmlTag, isLikelyMdxComponent } from './mixed-content.js';

package/dist/types.d.cts

@@ -128,6 +128,29 @@ type TokenLineV1 = {
     spans: TokenSpan[];
 };
 type DiffKind = "add" | "remove" | "context" | "hunk" | "meta";
+type DiffLineKind = "meta" | "hunk" | "add" | "del" | "context";
+type ThemedToken = {
+    content: string;
+    color?: string | null;
+    fontStyle?: number | null;
+};
+type ThemedLine = ThemedToken[];
+type DiffLine = {
+    kind: DiffLineKind;
+    oldNo?: number | null;
+    newNo?: number | null;
+    raw: string;
+    tokens?: ThemedLine | null;
+};
+type DiffBlock = {
+    kind: "diff";
+    filePath?: string | null;
+    language?: string | null;
+    lines: DiffLine[];
+    additions?: number | null;
+    deletions?: number | null;
+    unified?: string | null;
+};
 type LazyTokenizationPriority = "visible" | "prefetch";
 /**
  * Worker communication protocol
@@ -147,6 +170,9 @@ type WorkerIn = {
         codeHighlighting?: CodeHighlightingMode;
         outputMode?: CodeHighlightOutputMode;
         liveCodeHighlighting?: boolean;
+        liveTokenization?: boolean;
+        emitHighlightTokens?: boolean;
+        emitDiffBlocks?: boolean;
         mdxComponentNames?: string[];
         lazyTokenization?: {
             enabled?: boolean;
@@ -163,6 +189,8 @@ type WorkerIn = {
     type: "FINALIZE";
 } | {
     type: "DEBUG_STATE";
+} | {
+    type: "DUMP_BLOCKS";
 } | {
     type: "TOKENIZE_RANGE";
     blockId: string;
@@ -190,6 +218,8 @@ interface WorkerErrorPayload {
 type WorkerOut = {
     type: "INITIALIZED";
     blocks: Block[];
+} | {
+    type: "FINALIZED";
 } | {
     type: "PATCH";
     tx: number;
@@ -201,6 +231,10 @@ type WorkerOut = {
 } | {
     type: "METRICS";
     metrics: PerformanceMetrics;
+} | {
+    type: "DUMP_BLOCKS";
+    blocks: Block[];
+    tocHeadings?: TocHeading[];
 } | {
     type: "DEBUG_STATE";
     state: {
@@ -322,6 +356,12 @@ interface NodePath {
     nodeId?: string;
     indexPath?: number[];
 }
+interface TocHeading {
+    id: string;
+    text: string;
+    level: number;
+    blockId: string;
+}
 type Patch = {
     op: "insertChild";
     at: NodePath;
@@ -397,4 +437,4 @@ interface CoalescingMetrics {
     insertChildCoalesced: number;
 }
 
-export { type ASTInlinePlugin, type Block, type CoalescingMetrics, type CodeHighlightOutputMode, type CodeHighlightingMode, type CompiledMdxModule, type DiffKind, type FormatAnticipationConfig, type InlineHtmlDescriptor, type InlineNode, type InlinePlugin, LANGUAGE_ALIASES, type LazyTokenizationPriority, type MixedContentSegment, type NodePath, type NodeSnapshot, PATCH_ROOT_ID, type Patch, type PatchMetrics, type PerformanceMetrics, type ProtectedRange, type ProtectedRangeKind, type RegexAnticipationPattern, type RegexInlinePlugin, type SetPropsBatchEntry, type TokenLineV1, type TokenSpan, type TokenStyle, type WorkerErrorPayload, type WorkerIn, type WorkerOut, type WorkerPhase };
+export { type ASTInlinePlugin, type Block, type CoalescingMetrics, type CodeHighlightOutputMode, type CodeHighlightingMode, type CompiledMdxModule, type DiffBlock, type DiffKind, type DiffLine, type DiffLineKind, type FormatAnticipationConfig, type InlineHtmlDescriptor, type InlineNode, type InlinePlugin, LANGUAGE_ALIASES, type LazyTokenizationPriority, type MixedContentSegment, type NodePath, type NodeSnapshot, PATCH_ROOT_ID, type Patch, type PatchMetrics, type PerformanceMetrics, type ProtectedRange, type ProtectedRangeKind, type RegexAnticipationPattern, type RegexInlinePlugin, type SetPropsBatchEntry, type ThemedLine, type ThemedToken, type TocHeading, type TokenLineV1, type TokenSpan, type TokenStyle, type WorkerErrorPayload, type WorkerIn, type WorkerOut, type WorkerPhase };

package/dist/types.d.ts

@@ -128,6 +128,29 @@ type TokenLineV1 = {
     spans: TokenSpan[];
 };
 type DiffKind = "add" | "remove" | "context" | "hunk" | "meta";
+type DiffLineKind = "meta" | "hunk" | "add" | "del" | "context";
+type ThemedToken = {
+    content: string;
+    color?: string | null;
+    fontStyle?: number | null;
+};
+type ThemedLine = ThemedToken[];
+type DiffLine = {
+    kind: DiffLineKind;
+    oldNo?: number | null;
+    newNo?: number | null;
+    raw: string;
+    tokens?: ThemedLine | null;
+};
+type DiffBlock = {
+    kind: "diff";
+    filePath?: string | null;
+    language?: string | null;
+    lines: DiffLine[];
+    additions?: number | null;
+    deletions?: number | null;
+    unified?: string | null;
+};
 type LazyTokenizationPriority = "visible" | "prefetch";
 /**
  * Worker communication protocol
@@ -147,6 +170,9 @@ type WorkerIn = {
         codeHighlighting?: CodeHighlightingMode;
         outputMode?: CodeHighlightOutputMode;
         liveCodeHighlighting?: boolean;
+        liveTokenization?: boolean;
+        emitHighlightTokens?: boolean;
+        emitDiffBlocks?: boolean;
         mdxComponentNames?: string[];
         lazyTokenization?: {
             enabled?: boolean;
@@ -163,6 +189,8 @@ type WorkerIn = {
     type: "FINALIZE";
 } | {
     type: "DEBUG_STATE";
+} | {
+    type: "DUMP_BLOCKS";
 } | {
     type: "TOKENIZE_RANGE";
     blockId: string;
@@ -190,6 +218,8 @@ interface WorkerErrorPayload {
 type WorkerOut = {
     type: "INITIALIZED";
     blocks: Block[];
+} | {
+    type: "FINALIZED";
 } | {
     type: "PATCH";
     tx: number;
@@ -201,6 +231,10 @@ type WorkerOut = {
 } | {
     type: "METRICS";
     metrics: PerformanceMetrics;
+} | {
+    type: "DUMP_BLOCKS";
+    blocks: Block[];
+    tocHeadings?: TocHeading[];
 } | {
     type: "DEBUG_STATE";
     state: {
@@ -322,6 +356,12 @@ interface NodePath {
     nodeId?: string;
     indexPath?: number[];
 }
+interface TocHeading {
+    id: string;
+    text: string;
+    level: number;
+    blockId: string;
+}
 type Patch = {
     op: "insertChild";
     at: NodePath;
@@ -397,4 +437,4 @@ interface CoalescingMetrics {
     insertChildCoalesced: number;
 }
 
-export { type ASTInlinePlugin, type Block, type CoalescingMetrics, type CodeHighlightOutputMode, type CodeHighlightingMode, type CompiledMdxModule, type DiffKind, type FormatAnticipationConfig, type InlineHtmlDescriptor, type InlineNode, type InlinePlugin, LANGUAGE_ALIASES, type LazyTokenizationPriority, type MixedContentSegment, type NodePath, type NodeSnapshot, PATCH_ROOT_ID, type Patch, type PatchMetrics, type PerformanceMetrics, type ProtectedRange, type ProtectedRangeKind, type RegexAnticipationPattern, type RegexInlinePlugin, type SetPropsBatchEntry, type TokenLineV1, type TokenSpan, type TokenStyle, type WorkerErrorPayload, type WorkerIn, type WorkerOut, type WorkerPhase };
+export { type ASTInlinePlugin, type Block, type CoalescingMetrics, type CodeHighlightOutputMode, type CodeHighlightingMode, type CompiledMdxModule, type DiffBlock, type DiffKind, type DiffLine, type DiffLineKind, type FormatAnticipationConfig, type InlineHtmlDescriptor, type InlineNode, type InlinePlugin, LANGUAGE_ALIASES, type LazyTokenizationPriority, type MixedContentSegment, type NodePath, type NodeSnapshot, PATCH_ROOT_ID, type Patch, type PatchMetrics, type PerformanceMetrics, type ProtectedRange, type ProtectedRangeKind, type RegexAnticipationPattern, type RegexInlinePlugin, type SetPropsBatchEntry, type ThemedLine, type ThemedToken, type TocHeading, type TokenLineV1, type TokenSpan, type TokenStyle, type WorkerErrorPayload, type WorkerIn, type WorkerOut, type WorkerPhase };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-mdx/core",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Core types, snapshot utilities, and perf helpers for the Streaming Markdown V2 stack",
   "license": "MIT",
   "repository": {