satteri 0.9.3 → 0.9.5

package/README.md

@@ -2,6 +2,8 @@
 
 Native-enhanced Markdown parsing and processing for JavaScript. Parse and compile in Rust, create flexible plugins in JavaScript.
 
+Check out the [documentation](https://satteri.bruits.org/docs/) for [installation instructions](https://satteri.bruits.org/docs/installation/), the [API reference](https://satteri.bruits.org/docs/entry-points/), and [usage examples](https://satteri.bruits.org/docs/quick-start/), try it online on the [playground](https://satteri.bruits.org/playground), or join us on [Discord](https://discord.com/invite/84pd4QtmzA)!
+
 ## Install
 
 ```sh
@@ -51,16 +53,6 @@ const { html } = markdownToHtml("Use `let` instead of `var`.", {
 
 If you're familiar with the unified ecosystem, mdast and hast plugins are similar to remark and rehype plugins, respectively, reusing the same AST shapes.
 
-## Documentation
-
-This README covers the basics. The full documentation covers the complete API, the plugin system, every parser feature, and framework integration:
-
-- **[Documentation home](https://satteri.bruits.org/docs/)** — start here
-- [Quick start](https://satteri.bruits.org/docs/quick-start/)
-- [Compiling](https://satteri.bruits.org/docs/compile/) — functions, options, and MDX settings
-- [Plugins](https://satteri.bruits.org/docs/plugins/) and [Plugin API](https://satteri.bruits.org/docs/plugin-api/)
-- [Features](https://satteri.bruits.org/docs/features/) — GFM, math, directives, and more
-
-## License
+## Development
 
-MIT
+Refer to [CONTRIBUTING.md](https://github.com/bruits/satteri/blob/main/CONTRIBUTING.md) for development setup and workflow details.

package/dist/binding.browser.d.ts

@@ -1 +1 @@
-export { applyCommandsAndConvertToHastHandle, applyCommandsToHandle, applyCommandsToMdastHandle, compileHandle, compileMdx, convertMdastToHastHandle, createHastHandle, createMdastHandle, createMdxHastHandle, createMdxMdastHandle, dropHandle, getHandleSource, getMdastFrontmatter, getNodeData, mdastTextContentHandle, parseEsm, parseExpression, parseToHtml, renderHandle, serializeHandle, setNodeData, textContentHandle, walkHandle, walkMdastHandle, } from "../satteri_napi.wasi-browser.js";
+export { applyCommandsAndConvertToHastHandle, applyCommandsToHandle, applyCommandsToMdastHandle, compileHandle, compileMdx, convertMdastToHastHandle, createHastHandle, createMdastHandle, createMdxHastHandle, createMdxMdastHandle, dropHandle, getHandleSource, getMdastFrontmatter, getNodeData, mdastTextContentHandle, parseEsm, parseExpression, parseToHtml, renderHandle, serializeHandle, setNodeData, textContentHandle, walkHandle, walkMdastHandle, } from "../browser.js";

package/dist/binding.browser.js

@@ -1,2 +1,2 @@
 // @ts-nocheck — WASM browser binding has no type declarations
-export { applyCommandsAndConvertToHastHandle, applyCommandsToHandle, applyCommandsToMdastHandle, compileHandle, compileMdx, convertMdastToHastHandle, createHastHandle, createMdastHandle, createMdxHastHandle, createMdxMdastHandle, dropHandle, getHandleSource, getMdastFrontmatter, getNodeData, mdastTextContentHandle, parseEsm, parseExpression, parseToHtml, renderHandle, serializeHandle, setNodeData, textContentHandle, walkHandle, walkMdastHandle, } from "../satteri_napi.wasi-browser.js";
+export { applyCommandsAndConvertToHastHandle, applyCommandsToHandle, applyCommandsToMdastHandle, compileHandle, compileMdx, convertMdastToHastHandle, createHastHandle, createMdastHandle, createMdxHastHandle, createMdxMdastHandle, dropHandle, getHandleSource, getMdastFrontmatter, getNodeData, mdastTextContentHandle, parseEsm, parseExpression, parseToHtml, renderHandle, serializeHandle, setNodeData, textContentHandle, walkHandle, walkMdastHandle, } from "../browser.js";

package/dist/compile.js

@@ -89,7 +89,7 @@ function warnDroppedTransforms(plugin, dropped, kind) {
     console.warn(`satteri: plugin "${name}" queued ${dropped} ${kind} ${noun} on node(s) that were removed or ` +
         `replaced earlier in the same pass; ${dropped === 1 ? "it was" : "they were"} dropped.`);
 }
-function runMdastPluginsOnHandle(handle, plugins, fileURL, data) {
+function runMdastPluginsOnHandle(handle, plugins, fileURL, data, sourceFormat) {
     // Each plugin runs once over the tree. A transform that passes a child
     // through (returning it inside the replacement) keeps that child's identity,
     // so a patch the same pass queued on it still applies — nesting composes in
@@ -97,7 +97,7 @@ function runMdastPluginsOnHandle(handle, plugins, fileURL, data) {
     // them up front, or hand off to a later plugin that sees the materialized tree.
     const runPlugin = (plugin) => {
         const subs = resolveMdastSubscriptions(plugin);
-        const result = visitMdastHandle(handle, plugin, subs, () => getHandleSource(handle), fileURL, data);
+        const result = visitMdastHandle(handle, plugin, subs, () => getHandleSource(handle), fileURL, data, sourceFormat);
         const apply = (r) => {
             if (!r.hasMutations)
                 return;
@@ -121,7 +121,7 @@ function runMdastPluginsOnHandle(handle, plugins, fileURL, data) {
     };
     return runNext();
 }
-function runHastPluginsOnHandle(handle, plugins, source, fileURL, data) {
+function runHastPluginsOnHandle(handle, plugins, source, fileURL, data, sourceFormat) {
     if (plugins.length === 0)
         return;
     let i = 0;
@@ -131,7 +131,7 @@ function runHastPluginsOnHandle(handle, plugins, source, fileURL, data) {
             i++;
             const plugin = typeof raw === "function" ? raw() : raw;
             const subs = resolveSubscriptions(plugin);
-            const result = visitHastHandle(handle, plugin, subs, source, fileURL, data);
+            const result = visitHastHandle(handle, plugin, subs, source, fileURL, data, sourceFormat);
             const warnIfDropped = (dropped) => {
                 if (dropped)
                     warnDroppedTransforms(plugin, dropped, "hast");
@@ -207,7 +207,7 @@ export function markdownToHtml(source, options = {}) {
     const runHastThenRender = (r) => {
         let hastResult;
         try {
-            hastResult = runHastPluginsOnHandle(r.hastHandle, hastPlugins, source, fileURL, data);
+            hastResult = runHastPluginsOnHandle(r.hastHandle, hastPlugins, source, fileURL, data, "markdown");
         }
         catch (err) {
             releaseHandle(r.hastHandle, hastMayHaveStubs);
@@ -243,7 +243,7 @@ export function mdxToJs(source, options = {}) {
     const runHastThenCompile = (r) => {
         let hastResult;
         try {
-            hastResult = runHastPluginsOnHandle(r.hastHandle, hastPlugins, source, fileURL, data);
+            hastResult = runHastPluginsOnHandle(r.hastHandle, hastPlugins, source, fileURL, data, "mdx");
         }
         catch (err) {
             releaseHandle(r.hastHandle, hastMayHaveStubs);
@@ -296,6 +296,7 @@ nativeConvertOptions, data) {
     const mdastHandle = mdx
         ? createMdxMdastHandle(source, nativeFeatures)
         : createMdastHandle(source, nativeFeatures);
+    const sourceFormat = mdx ? "mdx" : "markdown";
     const mdastMayHaveStubs = mdastPlugins.length > 0;
     // finally{release} is intentional: convertMdastToHastHandle empties the arena
     // on success, but if any step here throws the handle would otherwise leak.
@@ -316,7 +317,7 @@ nativeConvertOptions, data) {
         if (mdastPlugins.length === 0) {
             return finalize({ handle: mdastHandle });
         }
-        const mdastResult = runMdastPluginsOnHandle(mdastHandle, mdastPlugins, fileURL, data);
+        const mdastResult = runMdastPluginsOnHandle(mdastHandle, mdastPlugins, fileURL, data, sourceFormat);
         if (mdastResult instanceof Promise) {
             return mdastResult.then(finalize, (err) => {
                 releaseHandle(mdastHandle, mdastMayHaveStubs);

package/dist/generated/arena-layout.d.ts

@@ -30,8 +30,8 @@ export declare const HEADER: {
     readonly children_offset: 24;
     readonly type_data_len: 28;
     readonly type_data_offset: 32;
-    readonly source_len: 36;
-    readonly source_offset: 40;
+    readonly string_pool_len: 36;
+    readonly string_pool_offset: 40;
     readonly node_data_count: 44;
     readonly node_data_offset: 48;
 };

package/dist/generated/arena-layout.js

@@ -34,8 +34,8 @@ export const HEADER = {
     children_offset: 24,
     type_data_len: 28,
     type_data_offset: 32,
-    source_len: 36,
-    source_offset: 40,
+    string_pool_len: 36,
+    string_pool_offset: 40,
     node_data_count: 44,
     node_data_offset: 48,
 };

package/dist/hast/hast-reader.d.ts

@@ -29,8 +29,9 @@ export declare class HastReader {
     getNodeData(nodeId: number): string | null;
     get nodeCount(): number;
     get header(): BufferHeader;
-    /** Get the full source string (string pool). */
-    getSource(): string;
+    /** The full string pool (original input + interning heap). Not the document
+     * source as written; for that, read `ctx.source` from a plugin. */
+    getStringPool(): string;
     /** Read a substring from the string pool by byte offset and length. */
     getString(offset: number, len: number): string;
     /** Get position data for a node. */

package/dist/hast/hast-reader.js

@@ -19,7 +19,7 @@ export class HastReader {
     #view;
     #header;
     #textDecoder;
-    #sourceCache = null;
+    #stringPoolCache = null;
     constructor(buffer) {
         if (buffer instanceof Uint8Array) {
             this.#view = new DataView(buffer.buffer, buffer.byteOffset, buffer.byteLength);
@@ -49,8 +49,8 @@ export class HastReader {
             childrenOffset: v.getUint32(HEADER.children_offset, true),
             typeDataLen: v.getUint32(HEADER.type_data_len, true),
             typeDataOffset: v.getUint32(HEADER.type_data_offset, true),
-            sourceLen: v.getUint32(HEADER.source_len, true),
-            sourceOffset: v.getUint32(HEADER.source_offset, true),
+            stringPoolLen: v.getUint32(HEADER.string_pool_len, true),
+            stringPoolOffset: v.getUint32(HEADER.string_pool_offset, true),
             nodeDataCount: v.getUint32(HEADER.node_data_count, true),
             nodeDataOffset: v.getUint32(HEADER.node_data_offset, true),
         };
@@ -87,21 +87,22 @@ export class HastReader {
     get header() {
         return { ...this.#header };
     }
-    /** Get the full source string (string pool). */
-    getSource() {
-        if (this.#sourceCache === null) {
-            const { sourceOffset, sourceLen } = this.#header;
-            const bytes = new Uint8Array(this.#view.buffer, this.#view.byteOffset + sourceOffset, sourceLen);
-            this.#sourceCache = this.#textDecoder.decode(bytes);
+    /** The full string pool (original input + interning heap). Not the document
+     * source as written; for that, read `ctx.source` from a plugin. */
+    getStringPool() {
+        if (this.#stringPoolCache === null) {
+            const { stringPoolOffset, stringPoolLen } = this.#header;
+            const bytes = new Uint8Array(this.#view.buffer, this.#view.byteOffset + stringPoolOffset, stringPoolLen);
+            this.#stringPoolCache = this.#textDecoder.decode(bytes);
         }
-        return this.#sourceCache;
+        return this.#stringPoolCache;
     }
     /** Read a substring from the string pool by byte offset and length. */
     getString(offset, len) {
         if (len === 0)
             return "";
-        const { sourceOffset } = this.#header;
-        const bytes = new Uint8Array(this.#view.buffer, this.#view.byteOffset + sourceOffset + offset, len);
+        const { stringPoolOffset } = this.#header;
+        const bytes = new Uint8Array(this.#view.buffer, this.#view.byteOffset + stringPoolOffset + offset, len);
         return this.#textDecoder.decode(bytes);
     }
     /** Get position data for a node. */

package/dist/hast/hast-visitor.d.ts

@@ -1,5 +1,5 @@
 import { type HastNode } from "./hast-materializer.js";
-import type { HastRaw, Data } from "../types.js";
+import type { HastRaw, Data, SourceFormat } from "../types.js";
 import type { Element, Text, Comment, Doctype, Parents as HastParents, Root as HastRoot } from "hast";
 import type { Program } from "estree-jsx";
 import type { MdxJsxFlowElementHast, MdxJsxTextElementHast } from "../mdx-types.js";
@@ -30,6 +30,12 @@ export interface HastVisitorContext {
      * instances. Returned to the caller as `result.data`.
      */
     readonly data: Data;
+    /**
+     * The source format this compile is processing: `"markdown"` for a plain
+     * Markdown compile, `"mdx"` for an MDX one. Lets a plugin shared between both
+     * pipelines branch on which it is handling.
+     */
+    readonly sourceFormat: SourceFormat;
     removeNode(node: Readonly<HastNode>): void;
     replaceNode(node: Readonly<HastNode>, newNode: HastContent): void;
     insertBefore(node: Readonly<HastNode>, newNode: HastContent | HastContent[]): void;
@@ -109,4 +115,4 @@ export declare function resolveSubscriptions(plugin: HastVisitorInstance): Resol
  * replaced earlier in the same pass (the caller warns when non-zero), or a
  * Promise of that count if any visitor is async.
  */
-export declare function visitHastHandle(handle: HastHandle, plugin: HastVisitorInstance, subs: ResolvedSubscription[], source: string | (() => string), fileURL: URL | undefined, data?: Data): number | Promise<number>;
+export declare function visitHastHandle(handle: HastHandle, plugin: HastVisitorInstance, subs: ResolvedSubscription[], source: string | (() => string), fileURL: URL | undefined, data?: Data, sourceFormat?: SourceFormat): number | Promise<number>;

package/dist/hast/hast-visitor.js

@@ -200,12 +200,14 @@ class HastVisitorContextImpl {
     #parentsById = null;
     fileURL;
     data;
-    constructor(handle, getSource, fileURL, resolver, data) {
+    sourceFormat;
+    constructor(handle, getSource, fileURL, resolver, data, sourceFormat) {
         this.#handle = handle;
         this.#getSource = getSource;
         this.fileURL = fileURL;
         this.#resolver = resolver;
         this.data = data;
+        this.sourceFormat = sourceFormat;
     }
     get source() {
         const value = this.#getSource();
@@ -691,10 +693,10 @@ function dispatchMatches(matchBuf, subs, ctx, returnBuffer, resolver) {
  * replaced earlier in the same pass (the caller warns when non-zero), or a
  * Promise of that count if any visitor is async.
  */
-export function visitHastHandle(handle, plugin, subs, source, fileURL, data = {}) {
+export function visitHastHandle(handle, plugin, subs, source, fileURL, data = {}, sourceFormat = "markdown") {
     const getSource = typeof source === "function" ? source : () => source;
     const resolver = new HastLazyChildResolver(handle);
-    const ctx = new HastVisitorContextImpl(handle, getSource, fileURL, resolver, data);
+    const ctx = new HastVisitorContextImpl(handle, getSource, fileURL, resolver, data, sourceFormat);
     const returnBuffer = new CommandBuffer();
     const rustSubs = subs.map((s) => ({ nodeType: s.nodeType, tagFilter: s.tagFilter }));
     const deferred = dispatchMatches(walkHandle(handle, rustSubs), subs, ctx, returnBuffer, resolver);

package/dist/index.d.ts

@@ -3,9 +3,9 @@ export type { CompileOptions, MdxCompileOptions, MdxOnlyOptions, EvaluateOptions
 export { defineMdastPlugin, defineHastPlugin } from "./plugin.js";
 export type { MdastPluginDefinition, HastPluginDefinition, MdastPluginInput, HastPluginInput, } from "./plugin.js";
 export type { HastVisitorInstance, HastVisitorContext, HastFilteredVisitor, HastContent, EstreeProgram, } from "./hast/hast-visitor.js";
-export type { MdastNode, HastNode, DataMap, Data, Position, Point, MdxJsxAttributeNode, MdxJsxExpressionAttributeNode, MdxJsxAttributeValueExpressionNode, MdxJsxAttributeUnion, MdxJsxFlowElement, MdxJsxTextElement, MdxFlowExpression, MdxTextExpression, MdxjsEsm, MdxJsxFlowElementHast, MdxJsxTextElementHast, MdxFlowExpressionHast, MdxTextExpressionHast, MdxjsEsmHast, } from "./types.js";
+export type { MdastNode, HastNode, DataMap, Data, SourceFormat, Position, Point, MdxJsxAttributeNode, MdxJsxExpressionAttributeNode, MdxJsxAttributeValueExpressionNode, MdxJsxAttributeUnion, MdxJsxFlowElement, MdxJsxTextElement, MdxFlowExpression, MdxTextExpression, MdxjsEsm, MdxJsxFlowElementHast, MdxJsxTextElementHast, MdxFlowExpressionHast, MdxTextExpressionHast, MdxjsEsmHast, } from "./types.js";
 export { visitMdastHandle, resolveMdastSubscriptions } from "./mdast/mdast-visitor.js";
-export type { MdastPluginInstance, MdastContent } from "./mdast/mdast-visitor.js";
+export type { MdastPluginInstance, MdastVisitorContext, MdastContent, } from "./mdast/mdast-visitor.js";
 export { visitHastHandle, resolveSubscriptions as resolveHastSubscriptions, } from "./hast/hast-visitor.js";
 export { MdastReader } from "./mdast/mdast-reader.js";
 export { materializeMdastTree } from "./mdast/mdast-materializer.js";

package/dist/mdast/mdast-reader.d.ts

@@ -9,7 +9,9 @@ export declare class MdastReader {
     getNodeData(nodeId: number): string | null;
     get nodeCount(): number;
     get header(): BufferHeader;
-    getSource(): string;
+    /** The full string pool (original input + interning heap). Not the document
+     * source as written; for that, read `ctx.source` from a plugin. */
+    getStringPool(): string;
     getString(offset: number, len: number): string;
     getNode(nodeId: number): MdastNodeRaw;
     /** Fast path: read only the type byte for a node. */

package/dist/mdast/mdast-reader.js

@@ -8,7 +8,7 @@ export class MdastReader {
     #view;
     #header;
     #textDecoder;
-    #sourceCache = null;
+    #stringPoolCache = null;
     constructor(buffer) {
         if (buffer instanceof Uint8Array) {
             this.#view = new DataView(buffer.buffer, buffer.byteOffset, buffer.byteLength);
@@ -38,8 +38,8 @@ export class MdastReader {
             childrenOffset: v.getUint32(HEADER.children_offset, true),
             typeDataLen: v.getUint32(HEADER.type_data_len, true),
             typeDataOffset: v.getUint32(HEADER.type_data_offset, true),
-            sourceLen: v.getUint32(HEADER.source_len, true),
-            sourceOffset: v.getUint32(HEADER.source_offset, true),
+            stringPoolLen: v.getUint32(HEADER.string_pool_len, true),
+            stringPoolOffset: v.getUint32(HEADER.string_pool_offset, true),
             nodeDataCount: v.getUint32(HEADER.node_data_count, true),
             nodeDataOffset: v.getUint32(HEADER.node_data_offset, true),
         };
@@ -73,19 +73,21 @@ export class MdastReader {
     get header() {
         return { ...this.#header };
     }
-    getSource() {
-        if (this.#sourceCache === null) {
-            const { sourceOffset, sourceLen } = this.#header;
-            const bytes = new Uint8Array(this.#view.buffer, this.#view.byteOffset + sourceOffset, sourceLen);
-            this.#sourceCache = this.#textDecoder.decode(bytes);
+    /** The full string pool (original input + interning heap). Not the document
+     * source as written; for that, read `ctx.source` from a plugin. */
+    getStringPool() {
+        if (this.#stringPoolCache === null) {
+            const { stringPoolOffset, stringPoolLen } = this.#header;
+            const bytes = new Uint8Array(this.#view.buffer, this.#view.byteOffset + stringPoolOffset, stringPoolLen);
+            this.#stringPoolCache = this.#textDecoder.decode(bytes);
         }
-        return this.#sourceCache;
+        return this.#stringPoolCache;
     }
     getString(offset, len) {
         if (len === 0)
             return "";
-        const { sourceOffset } = this.#header;
-        const bytes = new Uint8Array(this.#view.buffer, this.#view.byteOffset + sourceOffset + offset, len);
+        const { stringPoolOffset } = this.#header;
+        const bytes = new Uint8Array(this.#view.buffer, this.#view.byteOffset + stringPoolOffset + offset, len);
         return this.#textDecoder.decode(bytes);
     }
     getNode(nodeId) {

package/dist/mdast/mdast-visitor.d.ts

@@ -1,6 +1,6 @@
 import { MdastReader } from "./mdast-reader.js";
 import { CommandBuffer } from "../command-buffer.js";
-import type { MdastNode, Toml, MathNode, InlineMath, Superscript, Subscript, Data } from "../types.js";
+import type { MdastNode, Toml, MathNode, InlineMath, Superscript, Subscript, Data, SourceFormat } from "../types.js";
 import { LazyChildResolver } from "../lazy-child-resolver.js";
 import type { MdastHandle } from "../handles.js";
 import type { Blockquote, Break, Code, Definition, Delete, Emphasis, FootnoteDefinition, FootnoteReference, Heading, Html, Image, ImageReference, InlineCode, Link, LinkReference, List, ListItem, Paragraph, Strong, Table, TableRow, TableCell, Text, ThematicBreak, Yaml, Parents as MdastParents, Root as MdastRoot } from "mdast";
@@ -38,7 +38,13 @@ export declare class MdastVisitorContext {
      * instances. Returned to the caller as `result.data`.
      */
     readonly data: Data;
-    constructor(handle: MdastHandle, getSource: () => string, fileURL: URL | undefined, resolver: LazyChildResolver<MdastReader, MdastNode>, data: Data);
+    /**
+     * The source format this compile is processing: `"markdown"` for a plain
+     * Markdown compile, `"mdx"` for an MDX one. Lets a plugin shared between both
+     * pipelines branch on which it is handling.
+     */
+    readonly sourceFormat: SourceFormat;
+    constructor(handle: MdastHandle, getSource: () => string, fileURL: URL | undefined, resolver: LazyChildResolver<MdastReader, MdastNode>, data: Data, sourceFormat: SourceFormat);
     get source(): string;
     removeNode(node: Readonly<MdastNode>): void;
     insertBefore(node: Readonly<MdastNode>, newNode: MdastContent | MdastContent[]): void;
@@ -154,4 +160,4 @@ export declare function resolveMdastSubscriptions(plugin: MdastPluginInstance):
  * Returns MdastVisitResult synchronously if all visitors are sync,
  * or Promise<MdastVisitResult> if any visitor is async.
  */
-export declare function visitMdastHandle(handle: MdastHandle, plugin: MdastPluginInstance, subs: MdastSubscription[], source: string | (() => string), fileURL: URL | undefined, data?: Data): MdastVisitResult | Promise<MdastVisitResult>;
+export declare function visitMdastHandle(handle: MdastHandle, plugin: MdastPluginInstance, subs: MdastSubscription[], source: string | (() => string), fileURL: URL | undefined, data?: Data, sourceFormat?: SourceFormat): MdastVisitResult | Promise<MdastVisitResult>;

package/dist/mdast/mdast-visitor.js

@@ -49,12 +49,19 @@ export class MdastVisitorContext {
      * instances. Returned to the caller as `result.data`.
      */
     data;
-    constructor(handle, getSource, fileURL, resolver, data) {
+    /**
+     * The source format this compile is processing: `"markdown"` for a plain
+     * Markdown compile, `"mdx"` for an MDX one. Lets a plugin shared between both
+     * pipelines branch on which it is handling.
+     */
+    sourceFormat;
+    constructor(handle, getSource, fileURL, resolver, data, sourceFormat) {
         this.#handle = handle;
         this.#getSource = getSource;
         this.fileURL = fileURL;
         this.#resolver = resolver;
         this.data = data;
+        this.sourceFormat = sourceFormat;
     }
     get source() {
         const value = this.#getSource();
@@ -525,10 +532,10 @@ function applyMdastVisitResult(result, nodeId, returnBuffer, originalNode) {
  * Returns MdastVisitResult synchronously if all visitors are sync,
  * or Promise<MdastVisitResult> if any visitor is async.
  */
-export function visitMdastHandle(handle, plugin, subs, source, fileURL, data = {}) {
+export function visitMdastHandle(handle, plugin, subs, source, fileURL, data = {}, sourceFormat = "markdown") {
     const getSource = typeof source === "function" ? source : () => source;
     const resolver = new MdastLazyChildResolver(handle);
-    const context = new MdastVisitorContext(handle, getSource, fileURL, resolver, data);
+    const context = new MdastVisitorContext(handle, getSource, fileURL, resolver, data, sourceFormat);
     const returnBuffer = new CommandBuffer();
     const rustSubs = subs.map((s) => ({ nodeType: s.nodeType, tagFilter: [] }));
     const matchBuf = walkMdastHandle(handle, rustSubs);

package/dist/types.d.ts

@@ -86,6 +86,12 @@ export interface DataMap {
  * string key holding any value, plus the typed keys registered in {@link DataMap}.
  */
 export type Data = Record<string, unknown> & Partial<DataMap>;
+/**
+ * The source format a plugin is running against, surfaced as `ctx.sourceFormat`:
+ * `"markdown"` for a plain Markdown compile, `"mdx"` for an MDX one. Lets a
+ * plugin shared between both pipelines branch on which it is handling.
+ */
+export type SourceFormat = "markdown" | "mdx";
 export interface StringRefRaw {
     offset: number;
     len: number;
@@ -109,8 +115,8 @@ export interface BufferHeader {
     childrenOffset: number;
     typeDataLen: number;
     typeDataOffset: number;
-    sourceLen: number;
-    sourceOffset: number;
+    stringPoolLen: number;
+    stringPoolOffset: number;
     /** Number of nodes that carry an extra JSON `data` blob. */
     nodeDataCount: number;
     /** Offset of the node-data section: `[id u32][len u32][bytes...]` repeated. */

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "satteri",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "High-performance Markdown and MDX processing",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/bruits/satteri.git"
@@ -11,10 +12,6 @@
     "browser.js",
     "index.js",
     "index.d.ts",
-    "satteri_napi.wasi.cjs",
-    "satteri_napi.wasi-browser.js",
-    "wasi-worker.mjs",
-    "wasi-worker-browser.mjs",
     "webcontainer-fallback.cjs"
   ],
   "type": "module",
@@ -84,15 +81,15 @@
     ]
   },
   "optionalDependencies": {
-    "@bruits/satteri-linux-x64-gnu": "0.9.3",
-    "@bruits/satteri-linux-arm64-gnu": "0.9.3",
-    "@bruits/satteri-linux-x64-musl": "0.9.3",
-    "@bruits/satteri-linux-arm64-musl": "0.9.3",
-    "@bruits/satteri-darwin-x64": "0.9.3",
-    "@bruits/satteri-darwin-arm64": "0.9.3",
-    "@bruits/satteri-win32-x64-msvc": "0.9.3",
-    "@bruits/satteri-win32-arm64-msvc": "0.9.3",
-    "@bruits/satteri-wasm32-wasi": "0.9.3"
+    "@bruits/satteri-linux-x64-gnu": "0.9.5",
+    "@bruits/satteri-linux-arm64-gnu": "0.9.5",
+    "@bruits/satteri-linux-x64-musl": "0.9.5",
+    "@bruits/satteri-linux-arm64-musl": "0.9.5",
+    "@bruits/satteri-darwin-x64": "0.9.5",
+    "@bruits/satteri-darwin-arm64": "0.9.5",
+    "@bruits/satteri-win32-x64-msvc": "0.9.5",
+    "@bruits/satteri-win32-arm64-msvc": "0.9.5",
+    "@bruits/satteri-wasm32-wasi": "0.9.5"
   },
   "scripts": {
     "build:binary:wasm": "napi build --manifest-path ../../crates/satteri-napi-binding/Cargo.toml --output-dir . --platform --release --esm --strip --target wasm32-wasip1-threads",

package/satteri_napi.wasi-browser.js

@@ -1,83 +0,0 @@
-import {
-  createOnMessage as __wasmCreateOnMessageForFsProxy,
-  getDefaultContext as __emnapiGetDefaultContext,
-  instantiateNapiModuleSync as __emnapiInstantiateNapiModuleSync,
-  WASI as __WASI,
-} from '@napi-rs/wasm-runtime'
-
-
-
-const __wasi = new __WASI({
-  version: 'preview1',
-})
-
-const __wasmUrl = new URL('./satteri_napi.wasm32-wasi.wasm', import.meta.url).href
-const __emnapiContext = __emnapiGetDefaultContext()
-
-
-const __sharedMemory = new WebAssembly.Memory({
-  initial: 4000,
-  maximum: 65536,
-  shared: true,
-})
-
-const __wasmFile = await fetch(__wasmUrl).then((res) => res.arrayBuffer())
-
-const {
-  instance: __napiInstance,
-  module: __wasiModule,
-  napiModule: __napiModule,
-} = __emnapiInstantiateNapiModuleSync(__wasmFile, {
-  context: __emnapiContext,
-  asyncWorkPoolSize: 4,
-  wasi: __wasi,
-  onCreateWorker() {
-    const worker = new Worker(new URL('./wasi-worker-browser.mjs', import.meta.url), {
-      type: 'module',
-    })
-
-
-    return worker
-  },
-  overwriteImports(importObject) {
-    importObject.env = {
-      ...importObject.env,
-      ...importObject.napi,
-      ...importObject.emnapi,
-      memory: __sharedMemory,
-    }
-    return importObject
-  },
-  beforeInit({ instance }) {
-    for (const name of Object.keys(instance.exports)) {
-      if (name.startsWith('__napi_register__')) {
-        instance.exports[name]()
-      }
-    }
-  },
-})
-export default __napiModule.exports
-export const applyCommandsAndConvertToHastHandle = __napiModule.exports.applyCommandsAndConvertToHastHandle
-export const applyCommandsToHandle = __napiModule.exports.applyCommandsToHandle
-export const applyCommandsToMdastHandle = __napiModule.exports.applyCommandsToMdastHandle
-export const compileHandle = __napiModule.exports.compileHandle
-export const compileMdx = __napiModule.exports.compileMdx
-export const convertMdastToHastHandle = __napiModule.exports.convertMdastToHastHandle
-export const createHastHandle = __napiModule.exports.createHastHandle
-export const createMdastHandle = __napiModule.exports.createMdastHandle
-export const createMdxHastHandle = __napiModule.exports.createMdxHastHandle
-export const createMdxMdastHandle = __napiModule.exports.createMdxMdastHandle
-export const dropHandle = __napiModule.exports.dropHandle
-export const getHandleSource = __napiModule.exports.getHandleSource
-export const getMdastFrontmatter = __napiModule.exports.getMdastFrontmatter
-export const getNodeData = __napiModule.exports.getNodeData
-export const mdastTextContentHandle = __napiModule.exports.mdastTextContentHandle
-export const parseEsm = __napiModule.exports.parseEsm
-export const parseExpression = __napiModule.exports.parseExpression
-export const parseToHtml = __napiModule.exports.parseToHtml
-export const renderHandle = __napiModule.exports.renderHandle
-export const serializeHandle = __napiModule.exports.serializeHandle
-export const setNodeData = __napiModule.exports.setNodeData
-export const textContentHandle = __napiModule.exports.textContentHandle
-export const walkHandle = __napiModule.exports.walkHandle
-export const walkMdastHandle = __napiModule.exports.walkMdastHandle

package/satteri_napi.wasi.cjs

@@ -1,134 +0,0 @@
-/* eslint-disable */
-/* prettier-ignore */
-
-/* auto-generated by NAPI-RS */
-
-const __nodeFs = require('node:fs')
-const __nodePath = require('node:path')
-const { WASI: __nodeWASI } = require('node:wasi')
-const { Worker } = require('node:worker_threads')
-
-const {
-  createOnMessage: __wasmCreateOnMessageForFsProxy,
-  getDefaultContext: __emnapiGetDefaultContext,
-  instantiateNapiModuleSync: __emnapiInstantiateNapiModuleSync,
-} = require('@napi-rs/wasm-runtime')
-
-const __rootDir = __nodePath.parse(process.cwd()).root
-
-const __wasi = new __nodeWASI({
-  version: 'preview1',
-  env: process.env,
-  preopens: {
-    [__rootDir]: __rootDir,
-  }
-})
-
-const __emnapiContext = __emnapiGetDefaultContext()
-
-const __sharedMemory = new WebAssembly.Memory({
-  initial: 4000,
-  maximum: 65536,
-  shared: true,
-})
-
-let __wasmFilePath = __nodePath.join(__dirname, 'satteri_napi.wasm32-wasi.wasm')
-const __wasmDebugFilePath = __nodePath.join(__dirname, 'satteri_napi.wasm32-wasi.debug.wasm')
-
-if (__nodeFs.existsSync(__wasmDebugFilePath)) {
-  __wasmFilePath = __wasmDebugFilePath
-} else if (!__nodeFs.existsSync(__wasmFilePath)) {
-  try {
-    __wasmFilePath = require.resolve('@bruits/satteri-wasm32-wasi/satteri_napi.wasm32-wasi.wasm')
-  } catch {
-    throw new Error('Cannot find satteri_napi.wasm32-wasi.wasm file, and @bruits/satteri-wasm32-wasi package is not installed.')
-  }
-}
-
-const { instance: __napiInstance, module: __wasiModule, napiModule: __napiModule } = __emnapiInstantiateNapiModuleSync(__nodeFs.readFileSync(__wasmFilePath), {
-  context: __emnapiContext,
-  asyncWorkPoolSize: (function() {
-    const threadsSizeFromEnv = Number(process.env.NAPI_RS_ASYNC_WORK_POOL_SIZE ?? process.env.UV_THREADPOOL_SIZE)
-    // NaN > 0 is false
-    if (threadsSizeFromEnv > 0) {
-      return threadsSizeFromEnv
-    } else {
-      return 4
-    }
-  })(),
-  reuseWorker: true,
-  wasi: __wasi,
-  onCreateWorker() {
-    const worker = new Worker(__nodePath.join(__dirname, 'wasi-worker.mjs'), {
-      env: process.env,
-    })
-    worker.onmessage = ({ data }) => {
-      __wasmCreateOnMessageForFsProxy(__nodeFs)(data)
-    }
-
-    // The main thread of Node.js waits for all the active handles before exiting.
-    // But Rust threads are never waited without `thread::join`.
-    // So here we hack the code of Node.js to prevent the workers from being referenced (active).
-    // According to https://github.com/nodejs/node/blob/19e0d472728c79d418b74bddff588bea70a403d0/lib/internal/worker.js#L415,
-    // a worker is consist of two handles: kPublicPort and kHandle.
-    {
-      const kPublicPort = Object.getOwnPropertySymbols(worker).find(s =>
-        s.toString().includes("kPublicPort")
-      );
-      if (kPublicPort) {
-        worker[kPublicPort].ref = () => {};
-      }
-
-      const kHandle = Object.getOwnPropertySymbols(worker).find(s =>
-        s.toString().includes("kHandle")
-      );
-      if (kHandle) {
-        worker[kHandle].ref = () => {};
-      }
-
-      worker.unref();
-    }
-    return worker
-  },
-  overwriteImports(importObject) {
-    importObject.env = {
-      ...importObject.env,
-      ...importObject.napi,
-      ...importObject.emnapi,
-      memory: __sharedMemory,
-    }
-    return importObject
-  },
-  beforeInit({ instance }) {
-    for (const name of Object.keys(instance.exports)) {
-      if (name.startsWith('__napi_register__')) {
-        instance.exports[name]()
-      }
-    }
-  },
-})
-module.exports = __napiModule.exports
-module.exports.applyCommandsAndConvertToHastHandle = __napiModule.exports.applyCommandsAndConvertToHastHandle
-module.exports.applyCommandsToHandle = __napiModule.exports.applyCommandsToHandle
-module.exports.applyCommandsToMdastHandle = __napiModule.exports.applyCommandsToMdastHandle
-module.exports.compileHandle = __napiModule.exports.compileHandle
-module.exports.compileMdx = __napiModule.exports.compileMdx
-module.exports.convertMdastToHastHandle = __napiModule.exports.convertMdastToHastHandle
-module.exports.createHastHandle = __napiModule.exports.createHastHandle
-module.exports.createMdastHandle = __napiModule.exports.createMdastHandle
-module.exports.createMdxHastHandle = __napiModule.exports.createMdxHastHandle
-module.exports.createMdxMdastHandle = __napiModule.exports.createMdxMdastHandle
-module.exports.dropHandle = __napiModule.exports.dropHandle
-module.exports.getHandleSource = __napiModule.exports.getHandleSource
-module.exports.getMdastFrontmatter = __napiModule.exports.getMdastFrontmatter
-module.exports.getNodeData = __napiModule.exports.getNodeData
-module.exports.mdastTextContentHandle = __napiModule.exports.mdastTextContentHandle
-module.exports.parseEsm = __napiModule.exports.parseEsm
-module.exports.parseExpression = __napiModule.exports.parseExpression
-module.exports.parseToHtml = __napiModule.exports.parseToHtml
-module.exports.renderHandle = __napiModule.exports.renderHandle
-module.exports.serializeHandle = __napiModule.exports.serializeHandle
-module.exports.setNodeData = __napiModule.exports.setNodeData
-module.exports.textContentHandle = __napiModule.exports.textContentHandle
-module.exports.walkHandle = __napiModule.exports.walkHandle
-module.exports.walkMdastHandle = __napiModule.exports.walkMdastHandle

package/wasi-worker-browser.mjs

@@ -1,36 +0,0 @@
-import { instantiateNapiModuleSync, MessageHandler, WASI } from '@napi-rs/wasm-runtime'
-
-const errorOutputs = []
-
-const handler = new MessageHandler({
-  onLoad({ wasmModule, wasmMemory }) {
-    const wasi = new WASI({
-      print: function () {
-        // eslint-disable-next-line no-console
-        console.log.apply(console, arguments)
-      },
-      printErr: function() {
-        // eslint-disable-next-line no-console
-        console.error.apply(console, arguments)
-        
-      },
-    })
-    return instantiateNapiModuleSync(wasmModule, {
-      childThread: true,
-      wasi,
-      overwriteImports(importObject) {
-        importObject.env = {
-          ...importObject.env,
-          ...importObject.napi,
-          ...importObject.emnapi,
-          memory: wasmMemory,
-        }
-      },
-    })
-  },
-  
-})
-
-globalThis.onmessage = function (e) {
-  handler.handle(e)
-}

package/wasi-worker.mjs

@@ -1,63 +0,0 @@
-import fs from "node:fs";
-import { createRequire } from "node:module";
-import { parse } from "node:path";
-import { WASI } from "node:wasi";
-import { parentPort, Worker } from "node:worker_threads";
-
-const require = createRequire(import.meta.url);
-
-const { instantiateNapiModuleSync, MessageHandler, getDefaultContext } = require("@napi-rs/wasm-runtime");
-
-if (parentPort) {
-  parentPort.on("message", (data) => {
-    globalThis.onmessage({ data });
-  });
-}
-
-Object.assign(globalThis, {
-  self: globalThis,
-  require,
-  Worker,
-  importScripts: function (f) {
-    ;(0, eval)(fs.readFileSync(f, "utf8") + "//# sourceURL=" + f);
-  },
-  postMessage: function (msg) {
-    if (parentPort) {
-      parentPort.postMessage(msg);
-    }
-  },
-});
-
-const emnapiContext = getDefaultContext();
-
-const __rootDir = parse(process.cwd()).root;
-
-const handler = new MessageHandler({
-  onLoad({ wasmModule, wasmMemory }) {
-    const wasi = new WASI({
-      version: 'preview1',
-      env: process.env,
-      preopens: {
-        [__rootDir]: __rootDir,
-      },
-    });
-
-    return instantiateNapiModuleSync(wasmModule, {
-      childThread: true,
-      wasi,
-      context: emnapiContext,
-      overwriteImports(importObject) {
-        importObject.env = {
-          ...importObject.env,
-          ...importObject.napi,
-          ...importObject.emnapi,
-          memory: wasmMemory
-        };
-      },
-    });
-  },
-});
-
-globalThis.onmessage = function (e) {
-  handler.handle(e);
-};