satteri 0.9.3 → 0.9.4

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/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/index.d.ts

@@ -5,7 +5,7 @@ export type { MdastPluginDefinition, HastPluginDefinition, MdastPluginInput, Has
 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 { 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/types.d.ts

@@ -109,8 +109,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,6 +1,6 @@
 {
   "name": "satteri",
-  "version": "0.9.3",
+  "version": "0.9.4",
   "description": "High-performance Markdown and MDX processing",
   "repository": {
     "type": "git",
@@ -84,15 +84,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.4",
+    "@bruits/satteri-linux-arm64-gnu": "0.9.4",
+    "@bruits/satteri-linux-x64-musl": "0.9.4",
+    "@bruits/satteri-linux-arm64-musl": "0.9.4",
+    "@bruits/satteri-darwin-x64": "0.9.4",
+    "@bruits/satteri-darwin-arm64": "0.9.4",
+    "@bruits/satteri-win32-x64-msvc": "0.9.4",
+    "@bruits/satteri-win32-arm64-msvc": "0.9.4",
+    "@bruits/satteri-wasm32-wasi": "0.9.4"
   },
   "scripts": {
     "build:binary:wasm": "napi build --manifest-path ../../crates/satteri-napi-binding/Cargo.toml --output-dir . --platform --release --esm --strip --target wasm32-wasip1-threads",