markstream-react 0.0.48 → 0.0.49

package/dist/types/context/streamState.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Holds mutable streaming state that updates on every streaming chunk
+ * without triggering React re-renders. TextNode and InlineCodeNode read
+ * from this ref inside effects / callbacks rather than from renderCtx props,
+ * so that the renderCtx object can stay referentially stable during streaming.
+ */
+export interface StreamStateRef {
+    /** Map from node key to last-settled text content (shared across renders). */
+    textStreamState: Map<string, string>;
+    /** Returns the current stream render version counter. */
+    getStreamRenderVersion: () => number;
+}
+/**
+ * React Context that carries a stable StreamStateRef.
+ * The context value itself never changes (same ref object for the lifetime
+ * of the NodeRenderer), so subscribing components do NOT re-render when
+ * the stream version increments.  Consumers read the latest value inside
+ * effects or callbacks via `ref.getStreamRenderVersion()`.
+ */
+export declare const StreamStateRefContext: import('react').Context<StreamStateRef>;
+/**
+ * Hook that returns the nearest StreamStateRef, or null if none is provided.
+ */
+export declare function useStreamStateRef(): StreamStateRef | null;

package/dist/types/hooks/useSmoothMarkdownStream.d.ts

@@ -0,0 +1,20 @@
+import { SmoothMarkdownStreamOptions, SmoothMarkdownStreamSnapshot } from 'markstream-core';
+export type { SmoothMarkdownStreamOptions, SmoothMarkdownStreamSnapshot };
+export declare function useSmoothMarkdownStream(options?: SmoothMarkdownStreamOptions): {
+    enqueue: (chunk: string) => void;
+    finish: (options?: {
+        flush?: boolean;
+    }) => void;
+    flush: () => void;
+    reset: (initialMarkdown?: string) => void;
+    pause: () => void;
+    resume: () => void;
+    getSnapshot: () => SmoothMarkdownStreamSnapshot;
+    source: string;
+    visible: string;
+    done: boolean;
+    paused: boolean;
+    pendingChars: number;
+    caughtUp: boolean;
+    final: boolean;
+};

package/dist/types/index.d.ts

@@ -53,6 +53,8 @@ export type { TooltipPlacement, TooltipProps } from './components/Tooltip/Toolti
 export { VmrContainerNode } from './components/VmrContainerNode/VmrContainerNode';
 export { clearGlobalCustomComponents, getCustomComponentDisplay, getCustomNodeComponents, removeCustomComponents, setCustomComponents, withMarkstreamComponentDisplay, } from './customComponents';
 export type { CustomComponentDisplayMode, MarkstreamCustomComponent, } from './customComponents';
+export { useSmoothMarkdownStream } from './hooks/useSmoothMarkdownStream';
+export type { SmoothMarkdownStreamOptions, SmoothMarkdownStreamSnapshot, } from './hooks/useSmoothMarkdownStream';
 export * from './i18n/useSafeI18n';
 export * from './renderers/renderNode';
 export type { NodeRendererCodeBlockProps, NodeRendererProps } from './types';

package/dist/types/types/node-component.d.ts

@@ -8,5 +8,7 @@ export interface NodeComponentProps<TNode = unknown> {
     customId?: string;
     isDark?: boolean;
     typewriter?: boolean;
+    /** Enable/disable fade animations. Default: true */
+    fade?: boolean;
     children?: React.ReactNode;
 }

package/dist/types/types.d.ts

@@ -1,7 +1,8 @@
 import { default as React } from 'react';
 import { BaseNode, HtmlPolicy, MarkdownIt, ParsedNode, ParseOptions } from 'stream-markdown-parser';
 import { CustomComponentMap } from './customComponents';
-import { CodeBlockPreviewPayload, CodeBlockMonacoOptions, CodeBlockMonacoTheme, CodeBlockNodeProps, D2BlockNodeProps, InfographicBlockNodeProps, MermaidBlockNodeProps } from './types/component-props';
+import { SmoothMarkdownStreamOptions } from './hooks/useSmoothMarkdownStream';
+import { CodeBlockMonacoOptions, CodeBlockMonacoTheme, CodeBlockNodeProps, CodeBlockPreviewPayload, D2BlockNodeProps, InfographicBlockNodeProps, MermaidBlockNodeProps } from './types/component-props';
 export type NodeRendererCodeBlockProps = Partial<Omit<CodeBlockNodeProps, 'node'>> & Record<string, unknown>;
 export interface NodeRendererProps {
     content?: string;
@@ -38,7 +39,20 @@ export interface NodeRendererProps {
     isDark?: boolean;
     customId?: string;
     indexKey?: number | string;
+    /** Show a blinking typewriter cursor while streamed content grows. Default: false */
     typewriter?: boolean;
+    /** Enable/disable non-code-node enter and streamed-text fade animations. Default: true */
+    fade?: boolean;
+    /**
+     * Enable built-in smooth pacing for streaming `content` updates.
+     * - `true`: force-enable smooth streaming (content mode only)
+     * - `false`: force-disable smooth streaming
+     * - `'auto'` (default): enable only when typewriter/incremental mode is active
+     * Applies when rendering from `content` (not `nodes`).
+     */
+    smoothStreaming?: boolean | 'auto';
+    /** Options forwarded to the built-in smooth streaming controller. Read once when the renderer is created. */
+    smoothStreamingOptions?: SmoothMarkdownStreamOptions;
     batchRendering?: boolean;
     initialRenderBatchSize?: number;
     renderBatchSize?: number;
@@ -59,6 +73,8 @@ export interface RenderContext {
     isDark?: boolean;
     indexKey?: string;
     typewriter?: boolean;
+    /** Enable/disable fade animations. Default: true */
+    fade?: boolean;
     textStreamState?: Map<string, string>;
     streamRenderVersion?: number;
     customComponents?: CustomComponentMap;

package/dist/types/utils/streamingTextState.d.ts

@@ -1,23 +1,2 @@
-export interface ResolveStreamingTextStateOptions {
-    nextContent: string;
-    previousContent: string;
-    typewriterEnabled: boolean;
-}
-export interface StreamingTextStateResult {
-    settledContent: string;
-    streamedDelta: string;
-    appended: boolean;
-}
-export interface StreamingRenderState {
-    settledContent: string;
-    streamedDelta: string;
-}
-export interface ResolveStreamingTextUpdateOptions {
-    nextContent: string;
-    persistedContent?: string;
-    currentState: StreamingRenderState;
-    typewriterEnabled: boolean;
-    streamRenderVersionChanged?: boolean;
-}
-export declare function resolveStreamingTextState({ nextContent, previousContent, typewriterEnabled, }: ResolveStreamingTextStateOptions): StreamingTextStateResult;
-export declare function resolveStreamingTextUpdate({ nextContent, persistedContent, currentState, typewriterEnabled, streamRenderVersionChanged, }: ResolveStreamingTextUpdateOptions): StreamingTextStateResult;
+export { resolveStreamingTextState, resolveStreamingTextUpdate } from 'markstream-core';
+export type { ResolveStreamingTextStateOptions, ResolveStreamingTextUpdateOptions, StreamingRenderState, StreamingTextStateResult } from 'markstream-core';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "markstream-react",
   "type": "module",
-  "version": "0.0.48",
+  "version": "0.0.49",
   "description": "React Markdown renderer optimized for large documents with progressive Mermaid rendering, streaming diff code blocks, and fast real-time preview. Built on stream-markdown AST for consistent rendering across frameworks. Perfect for documentation sites, AI chat interfaces, and content management systems.",
   "author": "Simon He",
   "license": "MIT",
@@ -116,7 +116,8 @@
   "dependencies": {
     "@floating-ui/dom": "^1.7.6",
     "clsx": "^2.1.1",
-    "stream-markdown-parser": "0.0.93"
+    "markstream-core": "0.0.1",
+    "stream-markdown-parser": "0.0.95"
   },
   "devDependencies": {
     "@types/react": "^18.3.28",
@@ -133,12 +134,13 @@
   },
   "scripts": {
     "dev": "vite dev",
-    "build": "vite build --mode npm && vite build -c vite.config.tailwind.ts --mode npm && node ./scripts/copy-tailwind-css.mjs && node ../../scripts/generate-px-css.mjs && pnpm run build:dts && node ./scripts/ensure-next-client-directive.mjs",
+    "build": "pnpm --dir ../markstream-core build && vite build --mode npm && vite build -c vite.config.tailwind.ts --mode npm && node ./scripts/copy-tailwind-css.mjs && node ../../scripts/generate-px-css.mjs && pnpm run build:dts && node ./scripts/ensure-next-client-directive.mjs",
     "build:analyze": "ANALYZE=true pnpm build",
     "build:dts": "rollup -c ./scripts/rollup.dts.config.mjs && node ./scripts/clean-dts.cjs",
     "preview": "vite preview",
     "typecheck": "tsc --noEmit",
     "size:check": "node ../../scripts/check-package-size.mjs",
-    "release": "bumpp --commit --no-tag --no-push && pnpm publish --access public && node ../../scripts/tag-package.mjs --package-json package.json --push"
+    "check:core-published": "node ../../scripts/check-core-published.mjs --package-json package.json --core-package-json ../markstream-core/package.json",
+    "release": "pnpm run check:core-published && bumpp --commit --no-tag --no-push && pnpm publish --access public && node ../../scripts/tag-package.mjs --package-json package.json --push"
   }
 }