satteri 0.8.0 → 0.9.0

package/dist/mdast/generated/node-types.js

@@ -0,0 +1,266 @@
+// @generated by `cargo run -p satteri-layout-codegen`. Do not edit by hand.
+/** Node-type tag -> canonical AST name. */
+export const TYPE_NAMES = {
+    0: "root",
+    1: "paragraph",
+    2: "heading",
+    3: "thematicBreak",
+    4: "blockquote",
+    5: "list",
+    6: "listItem",
+    7: "html",
+    8: "code",
+    9: "definition",
+    10: "text",
+    11: "emphasis",
+    12: "strong",
+    13: "inlineCode",
+    14: "break",
+    15: "link",
+    16: "image",
+    17: "linkReference",
+    18: "imageReference",
+    19: "footnoteDefinition",
+    20: "footnoteReference",
+    21: "table",
+    22: "tableRow",
+    23: "tableCell",
+    24: "delete",
+    25: "yaml",
+    26: "toml",
+    27: "math",
+    28: "inlineMath",
+    30: "containerDirective",
+    31: "leafDirective",
+    32: "textDirective",
+    33: "superscript",
+    34: "subscript",
+    100: "mdxJsxFlowElement",
+    101: "mdxJsxTextElement",
+    102: "mdxFlowExpression",
+    103: "mdxTextExpression",
+    104: "mdxjsEsm",
+};
+/** Canonical AST name -> node-type tag. */
+export const NAME_TO_TYPE = {
+    root: 0,
+    paragraph: 1,
+    heading: 2,
+    thematicBreak: 3,
+    blockquote: 4,
+    list: 5,
+    listItem: 6,
+    html: 7,
+    code: 8,
+    definition: 9,
+    text: 10,
+    emphasis: 11,
+    strong: 12,
+    inlineCode: 13,
+    break: 14,
+    link: 15,
+    image: 16,
+    linkReference: 17,
+    imageReference: 18,
+    footnoteDefinition: 19,
+    footnoteReference: 20,
+    table: 21,
+    tableRow: 22,
+    tableCell: 23,
+    delete: 24,
+    yaml: 25,
+    toml: 26,
+    math: 27,
+    inlineMath: 28,
+    containerDirective: 30,
+    leafDirective: 31,
+    textDirective: 32,
+    superscript: 33,
+    subscript: 34,
+    mdxJsxFlowElement: 100,
+    mdxJsxTextElement: 101,
+    mdxFlowExpression: 102,
+    mdxTextExpression: 103,
+    mdxjsEsm: 104,
+};
+/** Node-type tag by Rust enum variant name. */
+export const NodeType = Object.freeze({
+    Root: 0,
+    Paragraph: 1,
+    Heading: 2,
+    ThematicBreak: 3,
+    Blockquote: 4,
+    List: 5,
+    ListItem: 6,
+    Html: 7,
+    Code: 8,
+    Definition: 9,
+    Text: 10,
+    Emphasis: 11,
+    Strong: 12,
+    InlineCode: 13,
+    Break: 14,
+    Link: 15,
+    Image: 16,
+    LinkReference: 17,
+    ImageReference: 18,
+    FootnoteDefinition: 19,
+    FootnoteReference: 20,
+    Table: 21,
+    TableRow: 22,
+    TableCell: 23,
+    Delete: 24,
+    Yaml: 25,
+    Toml: 26,
+    Math: 27,
+    InlineMath: 28,
+    ContainerDirective: 30,
+    LeafDirective: 31,
+    TextDirective: 32,
+    Superscript: 33,
+    Subscript: 34,
+    MdxJsxFlowElement: 100,
+    MdxJsxTextElement: 101,
+    MdxFlowExpression: 102,
+    MdxTextExpression: 103,
+    MdxjsEsm: 104,
+});
+/** Node-type tag -> Rust variant name (`typeName` diagnostics). */
+export const NodeTypeName = {
+    0: "Root",
+    1: "Paragraph",
+    2: "Heading",
+    3: "ThematicBreak",
+    4: "Blockquote",
+    5: "List",
+    6: "ListItem",
+    7: "Html",
+    8: "Code",
+    9: "Definition",
+    10: "Text",
+    11: "Emphasis",
+    12: "Strong",
+    13: "InlineCode",
+    14: "Break",
+    15: "Link",
+    16: "Image",
+    17: "LinkReference",
+    18: "ImageReference",
+    19: "FootnoteDefinition",
+    20: "FootnoteReference",
+    21: "Table",
+    22: "TableRow",
+    23: "TableCell",
+    24: "Delete",
+    25: "Yaml",
+    26: "Toml",
+    27: "Math",
+    28: "InlineMath",
+    30: "ContainerDirective",
+    31: "LeafDirective",
+    32: "TextDirective",
+    33: "Superscript",
+    34: "Subscript",
+    100: "MdxJsxFlowElement",
+    101: "MdxJsxTextElement",
+    102: "MdxFlowExpression",
+    103: "MdxTextExpression",
+    104: "MdxjsEsm",
+};
+/** Names a plugin can subscribe to (every node except `root`). */
+export const VISITOR_KEYS = new Set([
+    "paragraph",
+    "heading",
+    "thematicBreak",
+    "blockquote",
+    "list",
+    "listItem",
+    "html",
+    "code",
+    "definition",
+    "text",
+    "emphasis",
+    "strong",
+    "inlineCode",
+    "break",
+    "link",
+    "image",
+    "linkReference",
+    "imageReference",
+    "footnoteDefinition",
+    "footnoteReference",
+    "table",
+    "tableRow",
+    "tableCell",
+    "delete",
+    "yaml",
+    "toml",
+    "math",
+    "inlineMath",
+    "containerDirective",
+    "leafDirective",
+    "textDirective",
+    "superscript",
+    "subscript",
+    "mdxJsxFlowElement",
+    "mdxJsxTextElement",
+    "mdxFlowExpression",
+    "mdxTextExpression",
+    "mdxjsEsm",
+]);
+/** Name -> tag for the types the op-stream can encode; one lookup gates AND
+ *  resolves the emit-path tag. Excluded names (see `*_OPSTREAM_EXCLUDED` in
+ *  schema.rs) have no encoding — the visitor throws for them. */
+export const MDAST_OPSTREAM_TYPES = {
+    paragraph: 1,
+    heading: 2,
+    thematicBreak: 3,
+    blockquote: 4,
+    list: 5,
+    listItem: 6,
+    html: 7,
+    code: 8,
+    definition: 9,
+    text: 10,
+    emphasis: 11,
+    strong: 12,
+    inlineCode: 13,
+    break: 14,
+    link: 15,
+    image: 16,
+    linkReference: 17,
+    imageReference: 18,
+    footnoteDefinition: 19,
+    footnoteReference: 20,
+    table: 21,
+    tableRow: 22,
+    tableCell: 23,
+    delete: 24,
+    yaml: 25,
+    toml: 26,
+    math: 27,
+    inlineMath: 28,
+    containerDirective: 30,
+    leafDirective: 31,
+    textDirective: 32,
+    superscript: 33,
+    subscript: 34,
+    mdxJsxFlowElement: 100,
+    mdxJsxTextElement: 101,
+    mdxFlowExpression: 102,
+    mdxTextExpression: 103,
+    mdxjsEsm: 104,
+};
+/** Names of the variable-length `custom` node types (hand-written or
+ *  `Tail`-generated codec). The op-stream round-trip oracle asserts it covers
+ *  every one, so a forgotten or drifted encode/decode arm fails loudly. */
+export const MDAST_CUSTOM_TYPES = [
+    "list",
+    "listItem",
+    "table",
+    "containerDirective",
+    "leafDirective",
+    "textDirective",
+    "mdxJsxFlowElement",
+    "mdxJsxTextElement",
+];

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

@@ -1,9 +1,10 @@
+import type { Root } from "mdast";
 import type { MdastNode } from "../types.js";
 import type { MdastReader } from "./mdast-reader.js";
-export declare const TYPE_NAMES: Record<number, string>;
+export declare const LEAF_TYPES: ReadonlySet<number>;
 /**
  * Materialize a single MDAST node from a binary buffer as a lazy JS object.
  */
 export declare function materializeNode(reader: MdastReader, nodeId: number): MdastNode;
 /** Materialize the full tree from root (nodeId=0). */
-export declare function materializeMdastTree(reader: MdastReader): MdastNode;
+export declare function materializeMdastTree(reader: MdastReader): Root;

package/dist/mdast/mdast-materializer.js

@@ -1,86 +1,21 @@
 import { lazyProp, lazyGroup } from "../lazy-props.js";
-export const TYPE_NAMES = {
-    0: "root",
-    1: "paragraph",
-    2: "heading",
-    3: "thematicBreak",
-    4: "blockquote",
-    5: "list",
-    6: "listItem",
-    7: "html",
-    8: "code",
-    9: "definition",
-    10: "text",
-    11: "emphasis",
-    12: "strong",
-    13: "inlineCode",
-    14: "break",
-    15: "link",
-    16: "image",
-    17: "linkReference",
-    18: "imageReference",
-    19: "footnoteDefinition",
-    20: "footnoteReference",
-    21: "table",
-    22: "tableRow",
-    23: "tableCell",
-    24: "delete",
-    25: "yaml",
-    26: "toml",
-    27: "math",
-    28: "inlineMath",
-    30: "containerDirective",
-    31: "leafDirective",
-    32: "textDirective",
-    100: "mdxJsxFlowElement",
-    101: "mdxJsxTextElement",
-    102: "mdxFlowExpression",
-    103: "mdxTextExpression",
-    104: "mdxjsEsm",
-};
+import { TYPE_NAMES } from "./generated/node-types.js";
+import { materializeMdastFields } from "./generated/layout.js";
 // Leaf node types that do NOT have children.
 // Type 9 = `definition`; type 18 = `imageReference` — leaves per mdast spec
 // (imageReference carries `alt` as a string, not children).
-const LEAF_TYPES = new Set([9, 10, 13, 7, 8, 14, 3, 16, 18, 20, 25, 26, 27, 28, 102, 103, 104]);
+export const LEAF_TYPES = new Set([
+    9, 10, 13, 7, 8, 14, 3, 16, 18, 20, 25, 26, 27, 28, 102, 103, 104,
+]);
 /**
  * Add type-specific lazy properties to a node object.
  */
 function addTypeProperties(node, reader, nodeId, nodeType) {
+    // Fixed-field types materialize from the generated layout table; the rest
+    // (variable-length / cross-field) stay in the hand-written switch.
+    if (materializeMdastFields(reader, node, nodeId, nodeType))
+        return;
     switch (nodeType) {
-        case 2: // heading
-            Object.defineProperties(node, {
-                depth: lazyProp("depth", () => reader.getHeadingDepth(nodeId)),
-            });
-            break;
-        case 10: // text
-        case 13: // inlineCode
-        case 7: // html
-        case 25: // yaml
-        case 26: // toml
-            Object.defineProperties(node, {
-                value: lazyProp("value", () => reader.getTextValue(nodeId)),
-            });
-            break;
-        case 8: // code
-            lazyGroup(node, ["lang", "meta", "value"], () => reader.getCodeData(nodeId));
-            break;
-        case 27: // math
-            lazyGroup(node, ["meta", "value"], () => reader.getMathData(nodeId));
-            break;
-        case 28: // inlineMath
-            Object.defineProperties(node, {
-                value: lazyProp("value", () => reader.getMathData(nodeId).value),
-            });
-            break;
-        case 15: // link
-            lazyGroup(node, ["url", "title"], () => reader.getLinkData(nodeId));
-            break;
-        case 9: // definition
-            lazyGroup(node, ["url", "title", "identifier", "label"], () => reader.getDefinitionData(nodeId));
-            break;
-        case 16: // image
-            lazyGroup(node, ["url", "alt", "title"], () => reader.getImageData(nodeId));
-            break;
         case 5: {
             // list
             const resolveList = () => {
@@ -93,18 +28,6 @@ function addTypeProperties(node, reader, nodeId, nodeType) {
         case 6: // listItem
             lazyGroup(node, ["spread", "checked"], () => reader.getListItemData(nodeId));
             break;
-        case 17: // linkReference
-            lazyGroup(node, ["identifier", "label", "referenceType"], () => reader.getReferenceData(nodeId));
-            break;
-        case 20: // footnoteReference — no `referenceType` per mdast spec
-            lazyGroup(node, ["identifier", "label"], () => reader.getReferenceData(nodeId));
-            break;
-        case 18: // imageReference — leaf with alt (remark treats it as a void node)
-            lazyGroup(node, ["identifier", "label", "referenceType", "alt"], () => reader.getImageReferenceData(nodeId));
-            break;
-        case 19: // footnoteDefinition
-            lazyGroup(node, ["identifier", "label"], () => reader.getFootnoteDefinitionData(nodeId));
-            break;
         case 21: // table
             Object.defineProperties(node, {
                 align: lazyProp("align", () => reader.getTableAlign(nodeId)),
@@ -119,13 +42,6 @@ function addTypeProperties(node, reader, nodeId, nodeType) {
         case 101: // mdxJsxTextElement
             lazyGroup(node, ["name", "attributes"], () => reader.getMdxJsxElementData(nodeId));
             break;
-        case 102: // mdxFlowExpression
-        case 103: // mdxTextExpression
-        case 104: // mdxjsEsm
-            Object.defineProperties(node, {
-                value: lazyProp("value", () => reader.getExpressionValue(nodeId)),
-            });
-            break;
         // Nodes with no type-specific props:
         // root(0), paragraph(1), thematicBreak(3), blockquote(4),
         // emphasis(11), strong(12), break(14), tableRow(22), tableCell(23), delete(24)

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

@@ -1,44 +1,5 @@
 import type { MdastNodeRaw, BufferHeader, StringRefRaw, MdxJsxAttributeUnion } from "../types.js";
-export declare const NodeType: Readonly<{
-    readonly Root: 0;
-    readonly Paragraph: 1;
-    readonly Heading: 2;
-    readonly ThematicBreak: 3;
-    readonly Blockquote: 4;
-    readonly List: 5;
-    readonly ListItem: 6;
-    readonly Html: 7;
-    readonly Code: 8;
-    readonly Definition: 9;
-    readonly Text: 10;
-    readonly Emphasis: 11;
-    readonly Strong: 12;
-    readonly InlineCode: 13;
-    readonly Break: 14;
-    readonly Link: 15;
-    readonly Image: 16;
-    readonly LinkReference: 17;
-    readonly ImageReference: 18;
-    readonly FootnoteDefinition: 19;
-    readonly FootnoteReference: 20;
-    readonly Table: 21;
-    readonly TableRow: 22;
-    readonly TableCell: 23;
-    readonly Delete: 24;
-    readonly Yaml: 25;
-    readonly Toml: 26;
-    readonly Math: 27;
-    readonly InlineMath: 28;
-    readonly ContainerDirective: 30;
-    readonly LeafDirective: 31;
-    readonly TextDirective: 32;
-    readonly MdxJsxFlowElement: 100;
-    readonly MdxJsxTextElement: 101;
-    readonly MdxFlowExpression: 102;
-    readonly MdxTextExpression: 103;
-    readonly MdxjsEsm: 104;
-}>;
-export declare const NodeTypeName: Record<number, string>;
+export { NodeType, NodeTypeName } from "./generated/node-types.js";
 export declare class MdastReader {
     #private;
     constructor(buffer: ArrayBuffer | Uint8Array);
@@ -53,63 +14,19 @@ export declare class MdastReader {
     getNode(nodeId: number): MdastNodeRaw;
     /** Fast path: read only the type byte for a node. */
     getNodeType(nodeId: number): number;
+    /** Fast path: read only the parent id for a node (0xffffffff at the root). */
+    getParentId(nodeId: number): number;
     getChildIds(nodeId: number): number[];
     /** Push child node IDs directly onto a stack array (reverse order for depth-first). */
     pushChildIds(nodeId: number, stack: number[]): void;
     getTypeData(nodeId: number): Uint8Array;
     /** Read a StringRef (offset: u32 LE, len: u32 LE) from type data. */
     readStringRef(typeData: Uint8Array, byteOffset?: number): StringRefRaw;
-    /** HeadingData: depth u8 @ 0. */
-    getHeadingDepth(nodeId: number): number;
     /**
-     * StringRef value. Valid for Text, InlineCode, Html, Yaml, Toml, InlineMath nodes.
+     * StringRef value. Valid for Text, InlineCode, Html, Yaml, Toml nodes.
      * These store a single StringRef as their type data.
      */
     getTextValue(nodeId: number): string;
-    /**
-     * LinkData: url(0..8), title(8..16).
-     * Valid for Link nodes.
-     */
-    getLinkData(nodeId: number): {
-        url: string;
-        title: string | null;
-    };
-    /**
-     * ImageData: url(0..8), alt(8..16), title(16..24).
-     * Valid for Image nodes.
-     */
-    getImageData(nodeId: number): {
-        url: string;
-        alt: string;
-        title: string | null;
-    };
-    /**
-     * CodeData #[repr(C)]: lang(0..8), meta(8..16), value(16..24), fence_char(24), _pad(25..28).
-     * Valid for Code nodes.
-     */
-    getCodeData(nodeId: number): {
-        lang: string | null;
-        meta: string | null;
-        value: string;
-    };
-    /**
-     * MathData #[repr(C)]: meta(0..8), value(8..16).
-     * Valid for Math nodes.
-     */
-    getMathData(nodeId: number): {
-        meta: string | null;
-        value: string;
-    };
-    /**
-     * DefinitionData #[repr(C)]: url(0..8), title(8..16), identifier(16..24), label(24..32).
-     * Valid for Definition nodes.
-     */
-    getDefinitionData(nodeId: number): {
-        url: string;
-        title: string | null;
-        identifier: string;
-        label: string;
-    };
     /**
      * ListData #[repr(C)]: start(0..4), ordered(4), spread(5), _pad(6..8).
      * Valid for List nodes.
@@ -127,34 +44,6 @@ export declare class MdastReader {
         checked: boolean | null;
         spread: boolean;
     };
-    /**
-     * ReferenceData #[repr(C)]: identifier(0..8), label(8..16), reference_kind(16), _pad(17..20).
-     * referenceKind: 0=shortcut, 1=collapsed, 2=full.
-     * Valid for LinkReference, ImageReference, FootnoteReference nodes.
-     */
-    getReferenceData(nodeId: number): {
-        identifier: string;
-        label: string;
-        referenceType: string;
-    };
-    /**
-     * ImageReference layout: 20-byte ReferenceData header + 8-byte alt StringRef.
-     * Parser-emitted image references carry alt inline; plugin-created ones
-     * may lack this suffix, in which case `alt` is empty.
-     */
-    getImageReferenceData(nodeId: number): {
-        identifier: string;
-        label: string;
-        referenceType: string;
-        alt: string;
-    };
-    /**
-     * FootnoteDefinitionData #[repr(C)]: identifier(0..8), label(8..16).
-     */
-    getFootnoteDefinitionData(nodeId: number): {
-        identifier: string;
-        label: string;
-    };
     /**
      * TableData #[repr(C)]: align_count(0..4), then align_count bytes.
      * Alignment bytes: 0=none, 1=left, 2=right, 3=center.
@@ -188,11 +77,6 @@ export declare class MdastReader {
         name: string;
         attributes: Record<string, string>;
     };
-    /**
-     * ExpressionData #[repr(C)]: value StringRef (0..8).
-     * Valid for MdxFlowExpression, MdxTextExpression, MdxjsEsm.
-     */
-    getExpressionValue(nodeId: number): string;
     /**
      * Walk the tree depth-first. Return false from visitor to skip children.
      */