@stream-mdx/react 0.1.1 → 0.3.0

package/dist/streaming-markdown-DSC4L0xR.d.cts

@@ -0,0 +1,157 @@
+import React from 'react';
+import { PatchMetrics, FormatAnticipationConfig, CodeHighlightingMode, Block } from '@stream-mdx/core';
+import { L as LinkSafetyModalProps, B as BlockComponents, T as TableElements, H as HtmlElements, I as InlineComponents } from './index-D7px9jug.cjs';
+import { AdaptiveBudgetState, PatchFlushResult } from './renderer/patch-commit-scheduler.cjs';
+import { RendererStore } from './renderer/store.cjs';
+
+type MdxHydrationStrategy = "immediate" | "staggered" | "visible";
+type MdxHydrationOptions = {
+    strategy?: MdxHydrationStrategy;
+    maxConcurrent?: number;
+    delayMs?: number;
+    rootMargin?: string;
+    idleTimeoutMs?: number;
+    debounceMs?: number;
+};
+
+type DeferredRenderConfig = {
+    rootMargin?: string;
+    idleTimeoutMs?: number;
+    debounceMs?: number;
+};
+declare const DeferredRenderContext: React.Context<DeferredRenderConfig | null>;
+
+type MdxPrefetchSummary = {
+    requested: number;
+    completed: number;
+    error: number;
+    pending: number;
+    avgPrefetchMs: number | null;
+    p95PrefetchMs: number | null;
+    maxPrefetchMs: number | null;
+    lastPrefetchMs: number | null;
+};
+type MdxHydrationSummary = {
+    compiled: number;
+    hydrated: number;
+    error: number;
+    avgHydrationMs: number | null;
+    p95HydrationMs: number | null;
+    maxHydrationMs: number | null;
+    lastHydrationMs: number | null;
+    longTaskTotalMs: number | null;
+    longTaskCount: number | null;
+    p95LongTaskMs: number | null;
+    maxLongTaskMs: number | null;
+    prefetch?: MdxPrefetchSummary | null;
+};
+
+interface StreamingSchedulerOptions {
+    frameBudgetMs?: number;
+    flushTimeoutMs?: number;
+    maxBatchesPerFlush?: number;
+    maxLowPriorityBatchesPerFlush?: number;
+    lowPriorityFrameBudgetMs?: number;
+    urgentQueueThreshold?: number;
+    batch?: "rAF" | "microtask" | "timeout";
+    historyLimit?: number;
+    adaptiveSwitch?: boolean;
+    adaptiveQueueThreshold?: number;
+}
+interface StreamingFeatureFlags {
+    footnotes?: boolean;
+    html?: boolean;
+    mdx?: boolean;
+    tables?: boolean;
+    callouts?: boolean;
+    math?: boolean;
+    formatAnticipation?: FormatAnticipationConfig;
+    codeHighlighting?: CodeHighlightingMode;
+    liveCodeHighlighting?: boolean;
+    liveTokenization?: boolean;
+    emitHighlightTokens?: boolean;
+    emitDiffBlocks?: boolean;
+}
+/**
+ * Metrics emitted after each flush (high-priority + low-priority batches).
+ */
+interface RendererMetrics {
+    tx?: number | null;
+    receivedAt: number;
+    committedAt: number;
+    durationMs: number;
+    patchToDomMs: number;
+    totalPatches: number;
+    appliedPatches: number;
+    queueDepthBefore: number;
+    remainingQueueSize: number;
+    batchCount: number;
+    queueDelay: {
+        avg: number;
+        max: number;
+        p95: number;
+    };
+    priorities: Array<"high" | "low">;
+    workerMetrics?: PatchMetrics;
+    adaptiveBudget?: AdaptiveBudgetState;
+    flush: PatchFlushResult;
+}
+interface RendererStateSnapshot {
+    blocks: ReadonlyArray<Block>;
+    queueDepth: number;
+    pendingBatches: number;
+    isPaused: boolean;
+    workerReady: boolean;
+    rendererVersion: number;
+    store: RendererStore;
+    lastMetrics: RendererMetrics | null;
+    mdxHydration?: MdxHydrationSummary & {
+        pending: number;
+    };
+}
+interface StreamingMarkdownHandle {
+    pause(): void;
+    resume(): void;
+    restart(): void;
+    finalize(): void;
+    append(text: string): void;
+    setCredits(value: number): void;
+    flushPending(): PatchFlushResult | null;
+    waitForIdle(): Promise<void>;
+    onFlush(listener: (result: PatchFlushResult) => void): () => void;
+    getState(): RendererStateSnapshot;
+    getPatchHistory(limit?: number): ReadonlyArray<RendererMetrics>;
+}
+type StreamingCaret = "block" | "circle" | string | false;
+type LinkSafetyCheck = (url: string) => boolean | Promise<boolean>;
+type LinkSafetyConfig = {
+    enabled?: boolean;
+    onLinkCheck?: LinkSafetyCheck;
+    renderModal?: (props: LinkSafetyModalProps) => React.ReactNode;
+};
+interface StreamingMarkdownProps {
+    text?: string;
+    stream?: AsyncIterable<string>;
+    worker?: Worker | URL | (() => Worker) | string;
+    managedWorker?: boolean;
+    prewarmLangs?: string[];
+    features?: StreamingFeatureFlags;
+    components?: Partial<BlockComponents>;
+    tableElements?: Partial<TableElements>;
+    htmlElements?: Partial<HtmlElements>;
+    mdxComponents?: Record<string, React.ComponentType<unknown>>;
+    inlineComponents?: Partial<InlineComponents>;
+    scheduling?: StreamingSchedulerOptions;
+    mdxCompileMode?: "server" | "worker";
+    mdxHydration?: MdxHydrationOptions;
+    onMetrics?: (metrics: RendererMetrics) => void;
+    onError?: (error: Error) => void;
+    className?: string;
+    style?: React.CSSProperties;
+    caret?: StreamingCaret;
+    linkSafety?: LinkSafetyConfig;
+    deferHeavyBlocks?: boolean | DeferredRenderConfig;
+}
+declare const StreamingMarkdown: React.ForwardRefExoticComponent<StreamingMarkdownProps & React.RefAttributes<StreamingMarkdownHandle>>;
+
+export { type DeferredRenderConfig as D, type LinkSafetyCheck as L, type MdxHydrationOptions as M, type RendererMetrics as R, type StreamingSchedulerOptions as S, DeferredRenderContext as a, type StreamingFeatureFlags as b, type RendererStateSnapshot as c, type StreamingMarkdownHandle as d, type StreamingCaret as e, type LinkSafetyConfig as f, type StreamingMarkdownProps as g, StreamingMarkdown as h };

package/dist/streaming-markdown-Dp1IDgMT.d.ts

@@ -0,0 +1,157 @@
+import React from 'react';
+import { PatchMetrics, FormatAnticipationConfig, CodeHighlightingMode, Block } from '@stream-mdx/core';
+import { L as LinkSafetyModalProps, B as BlockComponents, T as TableElements, H as HtmlElements, I as InlineComponents } from './index-D7px9jug.js';
+import { AdaptiveBudgetState, PatchFlushResult } from './renderer/patch-commit-scheduler.js';
+import { RendererStore } from './renderer/store.js';
+
+type MdxHydrationStrategy = "immediate" | "staggered" | "visible";
+type MdxHydrationOptions = {
+    strategy?: MdxHydrationStrategy;
+    maxConcurrent?: number;
+    delayMs?: number;
+    rootMargin?: string;
+    idleTimeoutMs?: number;
+    debounceMs?: number;
+};
+
+type DeferredRenderConfig = {
+    rootMargin?: string;
+    idleTimeoutMs?: number;
+    debounceMs?: number;
+};
+declare const DeferredRenderContext: React.Context<DeferredRenderConfig | null>;
+
+type MdxPrefetchSummary = {
+    requested: number;
+    completed: number;
+    error: number;
+    pending: number;
+    avgPrefetchMs: number | null;
+    p95PrefetchMs: number | null;
+    maxPrefetchMs: number | null;
+    lastPrefetchMs: number | null;
+};
+type MdxHydrationSummary = {
+    compiled: number;
+    hydrated: number;
+    error: number;
+    avgHydrationMs: number | null;
+    p95HydrationMs: number | null;
+    maxHydrationMs: number | null;
+    lastHydrationMs: number | null;
+    longTaskTotalMs: number | null;
+    longTaskCount: number | null;
+    p95LongTaskMs: number | null;
+    maxLongTaskMs: number | null;
+    prefetch?: MdxPrefetchSummary | null;
+};
+
+interface StreamingSchedulerOptions {
+    frameBudgetMs?: number;
+    flushTimeoutMs?: number;
+    maxBatchesPerFlush?: number;
+    maxLowPriorityBatchesPerFlush?: number;
+    lowPriorityFrameBudgetMs?: number;
+    urgentQueueThreshold?: number;
+    batch?: "rAF" | "microtask" | "timeout";
+    historyLimit?: number;
+    adaptiveSwitch?: boolean;
+    adaptiveQueueThreshold?: number;
+}
+interface StreamingFeatureFlags {
+    footnotes?: boolean;
+    html?: boolean;
+    mdx?: boolean;
+    tables?: boolean;
+    callouts?: boolean;
+    math?: boolean;
+    formatAnticipation?: FormatAnticipationConfig;
+    codeHighlighting?: CodeHighlightingMode;
+    liveCodeHighlighting?: boolean;
+    liveTokenization?: boolean;
+    emitHighlightTokens?: boolean;
+    emitDiffBlocks?: boolean;
+}
+/**
+ * Metrics emitted after each flush (high-priority + low-priority batches).
+ */
+interface RendererMetrics {
+    tx?: number | null;
+    receivedAt: number;
+    committedAt: number;
+    durationMs: number;
+    patchToDomMs: number;
+    totalPatches: number;
+    appliedPatches: number;
+    queueDepthBefore: number;
+    remainingQueueSize: number;
+    batchCount: number;
+    queueDelay: {
+        avg: number;
+        max: number;
+        p95: number;
+    };
+    priorities: Array<"high" | "low">;
+    workerMetrics?: PatchMetrics;
+    adaptiveBudget?: AdaptiveBudgetState;
+    flush: PatchFlushResult;
+}
+interface RendererStateSnapshot {
+    blocks: ReadonlyArray<Block>;
+    queueDepth: number;
+    pendingBatches: number;
+    isPaused: boolean;
+    workerReady: boolean;
+    rendererVersion: number;
+    store: RendererStore;
+    lastMetrics: RendererMetrics | null;
+    mdxHydration?: MdxHydrationSummary & {
+        pending: number;
+    };
+}
+interface StreamingMarkdownHandle {
+    pause(): void;
+    resume(): void;
+    restart(): void;
+    finalize(): void;
+    append(text: string): void;
+    setCredits(value: number): void;
+    flushPending(): PatchFlushResult | null;
+    waitForIdle(): Promise<void>;
+    onFlush(listener: (result: PatchFlushResult) => void): () => void;
+    getState(): RendererStateSnapshot;
+    getPatchHistory(limit?: number): ReadonlyArray<RendererMetrics>;
+}
+type StreamingCaret = "block" | "circle" | string | false;
+type LinkSafetyCheck = (url: string) => boolean | Promise<boolean>;
+type LinkSafetyConfig = {
+    enabled?: boolean;
+    onLinkCheck?: LinkSafetyCheck;
+    renderModal?: (props: LinkSafetyModalProps) => React.ReactNode;
+};
+interface StreamingMarkdownProps {
+    text?: string;
+    stream?: AsyncIterable<string>;
+    worker?: Worker | URL | (() => Worker) | string;
+    managedWorker?: boolean;
+    prewarmLangs?: string[];
+    features?: StreamingFeatureFlags;
+    components?: Partial<BlockComponents>;
+    tableElements?: Partial<TableElements>;
+    htmlElements?: Partial<HtmlElements>;
+    mdxComponents?: Record<string, React.ComponentType<unknown>>;
+    inlineComponents?: Partial<InlineComponents>;
+    scheduling?: StreamingSchedulerOptions;
+    mdxCompileMode?: "server" | "worker";
+    mdxHydration?: MdxHydrationOptions;
+    onMetrics?: (metrics: RendererMetrics) => void;
+    onError?: (error: Error) => void;
+    className?: string;
+    style?: React.CSSProperties;
+    caret?: StreamingCaret;
+    linkSafety?: LinkSafetyConfig;
+    deferHeavyBlocks?: boolean | DeferredRenderConfig;
+}
+declare const StreamingMarkdown: React.ForwardRefExoticComponent<StreamingMarkdownProps & React.RefAttributes<StreamingMarkdownHandle>>;
+
+export { type DeferredRenderConfig as D, type LinkSafetyCheck as L, type MdxHydrationOptions as M, type RendererMetrics as R, type StreamingSchedulerOptions as S, DeferredRenderContext as a, type StreamingFeatureFlags as b, type RendererStateSnapshot as c, type StreamingMarkdownHandle as d, type StreamingCaret as e, type LinkSafetyConfig as f, type StreamingMarkdownProps as g, StreamingMarkdown as h };