@stream-mdx/core 0.0.0 → 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @stream-mdx/core
+
+## 0.0.2
+
+### Patch Changes
+
+- 9e94660: Docs and release-quality improvements: ship package READMEs/CHANGELOGs, add pack+install smoke tests, expose MDX parity helper entrypoints, and add a deployable docs site workflow.
+
+## 0.0.1
+
+### Patch Changes
+
+- Release maintenance: CI/build fixes, missing runtime deps (e.g. `rehype-katex`), and improved docs/README wiring for the `stream-mdx` package page.

package/README.md

@@ -1,6 +1,10 @@
 # `@stream-mdx/core`
 
-Pure TypeScript primitives shared across the streaming renderer stack. This package intentionally contains **no DOM/React code**; everything exported is structured-clone-safe so it can cross `postMessage` boundaries without serialization hacks.
+Core types + utilities shared across the StreamMDX stack.
+
+This package is intentionally React-free. It contains structured-clone-safe types and helpers used by both the worker and the renderer.
+
+Most consumers should install `stream-mdx` and follow the main docs. Use `@stream-mdx/core` directly if you’re building tooling or customizing lower-level behavior.
 
 ## Install
 
@@ -8,47 +12,32 @@ Pure TypeScript primitives shared across the streaming renderer stack. This pack
 npm install @stream-mdx/core
 ```
 
-## Exports
+## Entry points
 
-| Module | Description |
-| --- | --- |
-| `types` | `Block`, `InlineNode`, `Patch`, `PatchBatch`, `RendererMetrics`, worker message unions. |
-| `block-snapshot` | Helpers for cloning/mutating block trees in the worker. |
-| `code-highlighting` | Shiki token utilities (`CodeLine`, `flattenHighlights`). |
-| `mixed-content` | Inline HTML/Multi-block parsing helpers. |
-| `inline-parser` | Incremental inline AST parser (Lezer wrappers). |
-| `security` | Sanitization schema + trusted-types friendly helpers. |
-| `utils` | Tree traversal, node ID generation, list depth normalization. |
-| `perf/backpressure` | Back-pressure defaults + smoothing functions shared by worker/renderer. |
-| `worker-html-sanitizer` | Preconfigured DOMPurify-like sanitization for worker context. |
+- `@stream-mdx/core` (root)
+- `@stream-mdx/core/types`
+- `@stream-mdx/core/utils`
+- `@stream-mdx/core/code-highlighting`
+- `@stream-mdx/core/inline-parser`
+- `@stream-mdx/core/mixed-content`
+- `@stream-mdx/core/worker-html-sanitizer`
+- `@stream-mdx/core/security`
+- `@stream-mdx/core/perf/backpressure`
+- `@stream-mdx/core/perf/patch-batching`
+- `@stream-mdx/core/perf/patch-coalescing`
+- `@stream-mdx/core/streaming/custom-matcher`
 
-See `packages/markdown-v2-core/src/index.ts` for the canonical export list.
-
-## Usage
+## Example
 
 ```ts
-import type { Patch } from "@stream-mdx/core";
-import { applyPatchBatch } from "@stream-mdx/core/block-snapshot";
-
-export function replay(patches: Patch[]) {
-  const snapshot = createInitialSnapshot();
-  for (const patch of patches) {
-    applyPatchBatch(snapshot, [patch]);
-  }
-  return snapshot;
+import { DEFAULT_BACKPRESSURE_CONFIG } from "@stream-mdx/core/perf/backpressure";
+
+export function makeConfig(overrides?: Partial<typeof DEFAULT_BACKPRESSURE_CONFIG>) {
+  return { ...DEFAULT_BACKPRESSURE_CONFIG, ...overrides };
 }
 ```
 
-The worker bundle (`@stream-mdx/worker`) consumes these helpers to build `Patch` batches, and the renderer uses the same types for its store/scheduler.
-
-> For end-to-end math/MDX registration steps (worker + renderer), see [`docs/STREAMING_MARKDOWN_PLUGINS_COOKBOOK.md#5-math--mdx-workerrenderer-registration`](../../docs/STREAMING_MARKDOWN_PLUGINS_COOKBOOK.md#5-math--mdx-workerrenderer-registration).
-
-## Security notes
-
-- Sanitization helpers assume you pass trusted markdown inputs or run the worker in an isolated thread. If you enable raw HTML rendering, ensure you serve KaTeX/MDX assets from trusted origins and set CSP headers accordingly.
-- `worker-html-sanitizer` exports a minimal schema. Override/augment it if you need to allow additional tags/attributes (e.g., custom `data-*` props).
-
-## Roadmap
+## Docs
 
-- Document semver guarantees once `1.0.0` ships.
-- Publish detailed inline docs for every exported type (linkable from `docs/PUBLIC_API.md`).
+- API reference: `docs/PUBLIC_API.md`
+- Security model: `docs/SECURITY_MODEL.md`

package/dist/code-highlighting.cjs

@@ -217,4 +217,3 @@ function filterAllowedAttributes(attrs) {
   extractHighlightedLines,
   stripCodeFence
 });
-//# sourceMappingURL=code-highlighting.cjs.map

package/dist/code-highlighting.mjs

@@ -188,4 +188,3 @@ export {
   extractHighlightedLines,
   stripCodeFence
 };
-//# sourceMappingURL=code-highlighting.mjs.map

package/dist/index.cjs

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   CSP_HEADERS: () => CSP_HEADERS,
+  CustomStreamingMatcher: () => CustomStreamingMatcher,
   DEFAULT_BACKPRESSURE_CONFIG: () => DEFAULT_BACKPRESSURE_CONFIG,
   DEFAULT_COALESCE_CONFIG: () => DEFAULT_COALESCE_CONFIG,
   InlineParser: () => InlineParser,
@@ -1997,7 +1998,7 @@ function createTrustedHTML(html) {
   if (trustedTypesPolicy) {
     return trustedTypesPolicy.createHTML(html);
   }
-  return resolveDOMPurify().sanitize(html, getSanitizationConfig());
+  return sanitizeHTML(html);
 }
 function sanitizeHTML(html) {
   const out = resolveDOMPurify().sanitize(html, getSanitizationConfig());
@@ -2707,9 +2708,101 @@ function coalescePatchesQuadratic(patches, config = DEFAULT_COALESCE_CONFIG) {
   }
   return [...coalesced, ...rest];
 }
+
+// src/streaming/custom-matcher.ts
+var CustomStreamingMatcher = class {
+  constructor(pattern) {
+    this.buffer = "";
+    this.possibleMatches = [];
+    this.pattern = pattern;
+  }
+  addCharacter(char) {
+    this.buffer += char;
+    const fullMatch = this.buffer.match(this.pattern);
+    if (fullMatch && fullMatch.index === 0) {
+      const match = {
+        matched: true,
+        content: fullMatch[0],
+        length: fullMatch[0].length,
+        isComplete: true
+      };
+      this.buffer = this.buffer.slice(fullMatch[0].length);
+      this.possibleMatches = [];
+      return match;
+    }
+    const confidence = this.calculatePartialConfidence();
+    return {
+      matched: false,
+      content: this.buffer,
+      length: this.buffer.length,
+      isComplete: false,
+      confidence
+    };
+  }
+  addString(str) {
+    const results = [];
+    for (const char of str) {
+      const result = this.addCharacter(char);
+      if (result.matched) {
+        results.push(result);
+      }
+    }
+    if (results.length === 0 && this.buffer.length > 0) {
+      results.push({
+        matched: false,
+        content: this.buffer,
+        length: this.buffer.length,
+        isComplete: false,
+        confidence: this.calculatePartialConfidence()
+      });
+    }
+    return results;
+  }
+  couldMatch() {
+    if (this.buffer.length === 0) return true;
+    const patternSource = this.pattern.source;
+    const flags = this.pattern.flags;
+    try {
+      const partialPattern = new RegExp(`^${patternSource.replace(/\\$$/, "")}`, flags);
+      const testString = this.buffer + "X".repeat(100);
+      return partialPattern.test(testString);
+    } catch {
+      return this.isValidPrefix();
+    }
+  }
+  reset() {
+    this.buffer = "";
+    this.possibleMatches = [];
+  }
+  getBuffer() {
+    return this.buffer;
+  }
+  calculatePartialConfidence() {
+    if (this.buffer.length === 0) return 0;
+    let confidence = 0.1;
+    confidence += Math.min(0.4, this.buffer.length * 0.1);
+    if (this.couldMatch()) {
+      confidence += 0.3;
+    }
+    if (this.buffer.startsWith("$")) confidence += 0.2;
+    if (this.buffer.startsWith("$$")) confidence += 0.3;
+    return Math.min(1, confidence);
+  }
+  isValidPrefix() {
+    const patternStr = this.pattern.source;
+    if (patternStr.includes("\\$\\$") && (this.buffer === "$" || this.buffer === "$$")) {
+      return true;
+    }
+    if (patternStr.includes("\\$") && this.buffer === "$") {
+      return true;
+    }
+    return false;
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CSP_HEADERS,
+  CustomStreamingMatcher,
   DEFAULT_BACKPRESSURE_CONFIG,
   DEFAULT_COALESCE_CONFIG,
   InlineParser,
@@ -2761,4 +2854,3 @@ function coalescePatchesQuadratic(patches, config = DEFAULT_COALESCE_CONFIG) {
   smoothCredit,
   stripCodeFence
 });
-//# sourceMappingURL=index.cjs.map

package/dist/index.d.cts

@@ -8,6 +8,7 @@ export { InlineParseOptions, InlineParser, InlineParserOptions, applyASTPlugin,
 export { sanitizeHtmlInWorker } from './worker-html-sanitizer.cjs';
 export { BackpressureConfig, DEFAULT_BACKPRESSURE_CONFIG, calculateRawCredit, calculateSmoothedCredit, clampCredit, computeHeavyPatchBudget, smoothCredit } from './perf/backpressure.cjs';
 export { CoalesceConfig, DEFAULT_COALESCE_CONFIG, coalescePatches, coalescePatchesLinear, coalescePatchesQuadratic, coalescePatchesWithMetrics } from './perf/patch-coalescing.cjs';
+export { CustomStreamingMatcher, MatchResult } from './streaming/custom-matcher.cjs';
 import 'dompurify';
 
 declare function cloneBlock(block: Block): Block;

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export { InlineParseOptions, InlineParser, InlineParserOptions, applyASTPlugin,
 export { sanitizeHtmlInWorker } from './worker-html-sanitizer.js';
 export { BackpressureConfig, DEFAULT_BACKPRESSURE_CONFIG, calculateRawCredit, calculateSmoothedCredit, clampCredit, computeHeavyPatchBudget, smoothCredit } from './perf/backpressure.js';
 export { CoalesceConfig, DEFAULT_COALESCE_CONFIG, coalescePatches, coalescePatchesLinear, coalescePatchesQuadratic, coalescePatchesWithMetrics } from './perf/patch-coalescing.js';
+export { CustomStreamingMatcher, MatchResult } from './streaming/custom-matcher.js';
 import 'dompurify';
 
 declare function cloneBlock(block: Block): Block;

package/dist/index.mjs

@@ -1911,7 +1911,7 @@ function createTrustedHTML(html) {
   if (trustedTypesPolicy) {
     return trustedTypesPolicy.createHTML(html);
   }
-  return resolveDOMPurify().sanitize(html, getSanitizationConfig());
+  return sanitizeHTML(html);
 }
 function sanitizeHTML(html) {
   const out = resolveDOMPurify().sanitize(html, getSanitizationConfig());
@@ -2621,8 +2621,100 @@ function coalescePatchesQuadratic(patches, config = DEFAULT_COALESCE_CONFIG) {
   }
   return [...coalesced, ...rest];
 }
+
+// src/streaming/custom-matcher.ts
+var CustomStreamingMatcher = class {
+  constructor(pattern) {
+    this.buffer = "";
+    this.possibleMatches = [];
+    this.pattern = pattern;
+  }
+  addCharacter(char) {
+    this.buffer += char;
+    const fullMatch = this.buffer.match(this.pattern);
+    if (fullMatch && fullMatch.index === 0) {
+      const match = {
+        matched: true,
+        content: fullMatch[0],
+        length: fullMatch[0].length,
+        isComplete: true
+      };
+      this.buffer = this.buffer.slice(fullMatch[0].length);
+      this.possibleMatches = [];
+      return match;
+    }
+    const confidence = this.calculatePartialConfidence();
+    return {
+      matched: false,
+      content: this.buffer,
+      length: this.buffer.length,
+      isComplete: false,
+      confidence
+    };
+  }
+  addString(str) {
+    const results = [];
+    for (const char of str) {
+      const result = this.addCharacter(char);
+      if (result.matched) {
+        results.push(result);
+      }
+    }
+    if (results.length === 0 && this.buffer.length > 0) {
+      results.push({
+        matched: false,
+        content: this.buffer,
+        length: this.buffer.length,
+        isComplete: false,
+        confidence: this.calculatePartialConfidence()
+      });
+    }
+    return results;
+  }
+  couldMatch() {
+    if (this.buffer.length === 0) return true;
+    const patternSource = this.pattern.source;
+    const flags = this.pattern.flags;
+    try {
+      const partialPattern = new RegExp(`^${patternSource.replace(/\\$$/, "")}`, flags);
+      const testString = this.buffer + "X".repeat(100);
+      return partialPattern.test(testString);
+    } catch {
+      return this.isValidPrefix();
+    }
+  }
+  reset() {
+    this.buffer = "";
+    this.possibleMatches = [];
+  }
+  getBuffer() {
+    return this.buffer;
+  }
+  calculatePartialConfidence() {
+    if (this.buffer.length === 0) return 0;
+    let confidence = 0.1;
+    confidence += Math.min(0.4, this.buffer.length * 0.1);
+    if (this.couldMatch()) {
+      confidence += 0.3;
+    }
+    if (this.buffer.startsWith("$")) confidence += 0.2;
+    if (this.buffer.startsWith("$$")) confidence += 0.3;
+    return Math.min(1, confidence);
+  }
+  isValidPrefix() {
+    const patternStr = this.pattern.source;
+    if (patternStr.includes("\\$\\$") && (this.buffer === "$" || this.buffer === "$$")) {
+      return true;
+    }
+    if (patternStr.includes("\\$") && this.buffer === "$") {
+      return true;
+    }
+    return false;
+  }
+};
 export {
   CSP_HEADERS,
+  CustomStreamingMatcher,
   DEFAULT_BACKPRESSURE_CONFIG,
   DEFAULT_COALESCE_CONFIG,
   InlineParser,
@@ -2674,4 +2766,3 @@ export {
   smoothCredit,
   stripCodeFence
 };
-//# sourceMappingURL=index.mjs.map

package/dist/inline-parser.cjs

@@ -293,4 +293,3 @@ function splitTextByRegexWithPrecedence(text, regex, toNode) {
   applyASTPlugin,
   applyRegexPlugin
 });
-//# sourceMappingURL=inline-parser.cjs.map

package/dist/inline-parser.mjs

@@ -266,4 +266,3 @@ export {
   applyASTPlugin,
   applyRegexPlugin
 };
-//# sourceMappingURL=inline-parser.mjs.map

package/dist/mixed-content.cjs

@@ -370,4 +370,3 @@ function findClosingHtmlTag(lowerSource, lowerTagName, startIndex) {
   findClosingHtmlTag,
   isLikelyMdxComponent
 });
-//# sourceMappingURL=mixed-content.cjs.map

package/dist/mixed-content.mjs

@@ -331,4 +331,3 @@ export {
   findClosingHtmlTag,
   isLikelyMdxComponent
 };
-//# sourceMappingURL=mixed-content.mjs.map

package/dist/perf/backpressure.cjs

@@ -101,4 +101,3 @@ function clamp01(value) {
   computeHeavyPatchBudget,
   smoothCredit
 });
-//# sourceMappingURL=backpressure.cjs.map

package/dist/perf/backpressure.mjs

@@ -71,4 +71,3 @@ export {
   computeHeavyPatchBudget,
   smoothCredit
 };
-//# sourceMappingURL=backpressure.mjs.map

package/dist/perf/patch-batching.cjs

@@ -135,4 +135,3 @@ function splitPatchBatch(patches, maxLightChunk = DEFAULT_MAX_LIGHT_PATCHES_PER_
   isHeavyPatch,
   splitPatchBatch
 });
-//# sourceMappingURL=patch-batching.cjs.map

package/dist/perf/patch-batching.mjs

@@ -109,4 +109,3 @@ export {
   isHeavyPatch,
   splitPatchBatch
 };
-//# sourceMappingURL=patch-batching.mjs.map

package/dist/perf/patch-coalescing.cjs

@@ -427,4 +427,3 @@ function coalescePatchesQuadratic(patches, config = DEFAULT_COALESCE_CONFIG) {
   coalescePatchesQuadratic,
   coalescePatchesWithMetrics
 });
-//# sourceMappingURL=patch-coalescing.cjs.map

package/dist/perf/patch-coalescing.mjs

@@ -398,4 +398,3 @@ export {
   coalescePatchesQuadratic,
   coalescePatchesWithMetrics
 };
-//# sourceMappingURL=patch-coalescing.mjs.map

package/dist/security.cjs

@@ -154,7 +154,7 @@ function createTrustedHTML(html) {
   if (trustedTypesPolicy) {
     return trustedTypesPolicy.createHTML(html);
   }
-  return resolveDOMPurify().sanitize(html, getSanitizationConfig());
+  return sanitizeHTML(html);
 }
 function sanitizeHTML(html) {
   const out = resolveDOMPurify().sanitize(html, getSanitizationConfig());
@@ -416,4 +416,3 @@ function initializeSecurity() {
   sanitizeMathHTML,
   sanitizeURL
 });
-//# sourceMappingURL=security.cjs.map

package/dist/security.d.cts

@@ -7,7 +7,7 @@ declare function initializeTrustedTypesPolicy(): void;
 /**
  * Create trusted HTML using DOMPurify and Trusted Types
  */
-declare function createTrustedHTML(html: string): TrustedHTML | string;
+declare function createTrustedHTML(html: string): string;
 /**
  * Sanitize HTML content for safe rendering
  */

package/dist/security.d.ts

@@ -7,7 +7,7 @@ declare function initializeTrustedTypesPolicy(): void;
 /**
  * Create trusted HTML using DOMPurify and Trusted Types
  */
-declare function createTrustedHTML(html: string): TrustedHTML | string;
+declare function createTrustedHTML(html: string): string;
 /**
  * Sanitize HTML content for safe rendering
  */

package/dist/security.mjs

@@ -112,7 +112,7 @@ function createTrustedHTML(html) {
   if (trustedTypesPolicy) {
     return trustedTypesPolicy.createHTML(html);
   }
-  return resolveDOMPurify().sanitize(html, getSanitizationConfig());
+  return sanitizeHTML(html);
 }
 function sanitizeHTML(html) {
   const out = resolveDOMPurify().sanitize(html, getSanitizationConfig());
@@ -373,4 +373,3 @@ export {
   sanitizeMathHTML,
   sanitizeURL
 };
-//# sourceMappingURL=security.mjs.map

package/dist/streaming/custom-matcher.cjs

@@ -0,0 +1,118 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/streaming/custom-matcher.ts
+var custom_matcher_exports = {};
+__export(custom_matcher_exports, {
+  CustomStreamingMatcher: () => CustomStreamingMatcher
+});
+module.exports = __toCommonJS(custom_matcher_exports);
+var CustomStreamingMatcher = class {
+  constructor(pattern) {
+    this.buffer = "";
+    this.possibleMatches = [];
+    this.pattern = pattern;
+  }
+  addCharacter(char) {
+    this.buffer += char;
+    const fullMatch = this.buffer.match(this.pattern);
+    if (fullMatch && fullMatch.index === 0) {
+      const match = {
+        matched: true,
+        content: fullMatch[0],
+        length: fullMatch[0].length,
+        isComplete: true
+      };
+      this.buffer = this.buffer.slice(fullMatch[0].length);
+      this.possibleMatches = [];
+      return match;
+    }
+    const confidence = this.calculatePartialConfidence();
+    return {
+      matched: false,
+      content: this.buffer,
+      length: this.buffer.length,
+      isComplete: false,
+      confidence
+    };
+  }
+  addString(str) {
+    const results = [];
+    for (const char of str) {
+      const result = this.addCharacter(char);
+      if (result.matched) {
+        results.push(result);
+      }
+    }
+    if (results.length === 0 && this.buffer.length > 0) {
+      results.push({
+        matched: false,
+        content: this.buffer,
+        length: this.buffer.length,
+        isComplete: false,
+        confidence: this.calculatePartialConfidence()
+      });
+    }
+    return results;
+  }
+  couldMatch() {
+    if (this.buffer.length === 0) return true;
+    const patternSource = this.pattern.source;
+    const flags = this.pattern.flags;
+    try {
+      const partialPattern = new RegExp(`^${patternSource.replace(/\\$$/, "")}`, flags);
+      const testString = this.buffer + "X".repeat(100);
+      return partialPattern.test(testString);
+    } catch {
+      return this.isValidPrefix();
+    }
+  }
+  reset() {
+    this.buffer = "";
+    this.possibleMatches = [];
+  }
+  getBuffer() {
+    return this.buffer;
+  }
+  calculatePartialConfidence() {
+    if (this.buffer.length === 0) return 0;
+    let confidence = 0.1;
+    confidence += Math.min(0.4, this.buffer.length * 0.1);
+    if (this.couldMatch()) {
+      confidence += 0.3;
+    }
+    if (this.buffer.startsWith("$")) confidence += 0.2;
+    if (this.buffer.startsWith("$$")) confidence += 0.3;
+    return Math.min(1, confidence);
+  }
+  isValidPrefix() {
+    const patternStr = this.pattern.source;
+    if (patternStr.includes("\\$\\$") && (this.buffer === "$" || this.buffer === "$$")) {
+      return true;
+    }
+    if (patternStr.includes("\\$") && this.buffer === "$") {
+      return true;
+    }
+    return false;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CustomStreamingMatcher
+});

package/dist/streaming/custom-matcher.d.cts

@@ -0,0 +1,22 @@
+declare class CustomStreamingMatcher {
+    private pattern;
+    private buffer;
+    private possibleMatches;
+    constructor(pattern: RegExp);
+    addCharacter(char: string): MatchResult;
+    addString(str: string): MatchResult[];
+    couldMatch(): boolean;
+    reset(): void;
+    getBuffer(): string;
+    private calculatePartialConfidence;
+    private isValidPrefix;
+}
+interface MatchResult {
+    matched: boolean;
+    content: string;
+    length: number;
+    isComplete: boolean;
+    confidence?: number;
+}
+
+export { CustomStreamingMatcher, type MatchResult };

package/dist/streaming/custom-matcher.d.ts

@@ -0,0 +1,22 @@
+declare class CustomStreamingMatcher {
+    private pattern;
+    private buffer;
+    private possibleMatches;
+    constructor(pattern: RegExp);
+    addCharacter(char: string): MatchResult;
+    addString(str: string): MatchResult[];
+    couldMatch(): boolean;
+    reset(): void;
+    getBuffer(): string;
+    private calculatePartialConfidence;
+    private isValidPrefix;
+}
+interface MatchResult {
+    matched: boolean;
+    content: string;
+    length: number;
+    isComplete: boolean;
+    confidence?: number;
+}
+
+export { CustomStreamingMatcher, type MatchResult };