markdown-codec 3.0.0 → 3.1.0

package/dist/{inline-TuBQ2TUr.d.ts → inline-B_V7bs5j.d.ts}

@@ -1,10 +1,11 @@
-import { g as MarkdownInlineNode } from "./ast-DbjiuYr8.js";
+import { v as MarkdownInlineNode } from "./ast-8XCbjRQT.js";
+import { r as FootnoteLabelSet } from "./footnote-CKk4JbLk.js";
 import { n as LinkReferenceMap } from "./link-Dv4kxVjk.js";
 //#region src/inline/inline.d.ts
 interface InlineParseOptions {
   readonly gfmAutolinks?: boolean;
   readonly gfmStrikethrough?: boolean;
 }
-declare function parseInlines(content: string, references: LinkReferenceMap, options?: InlineParseOptions): MarkdownInlineNode[];
+declare function parseInlines(content: string, references: LinkReferenceMap, footnotes: FootnoteLabelSet, options?: InlineParseOptions): MarkdownInlineNode[];
 //#endregion
 export { parseInlines as n, InlineParseOptions as t };

package/dist/{inline-uVHJ5xzT.d.cts → inline-CXVQWQnW.d.cts}

@@ -1,10 +1,11 @@
-import { g as MarkdownInlineNode } from "./ast-DbjiuYr8.cjs";
+import { v as MarkdownInlineNode } from "./ast-8XCbjRQT.cjs";
+import { r as FootnoteLabelSet } from "./footnote-CKk4JbLk.cjs";
 import { n as LinkReferenceMap } from "./link-Dv4kxVjk.cjs";
 //#region src/inline/inline.d.ts
 interface InlineParseOptions {
   readonly gfmAutolinks?: boolean;
   readonly gfmStrikethrough?: boolean;
 }
-declare function parseInlines(content: string, references: LinkReferenceMap, options?: InlineParseOptions): MarkdownInlineNode[];
+declare function parseInlines(content: string, references: LinkReferenceMap, footnotes: FootnoteLabelSet, options?: InlineParseOptions): MarkdownInlineNode[];
 //#endregion
 export { parseInlines as n, InlineParseOptions as t };

package/dist/lower/front-matter.d.cts

@@ -1,4 +1,4 @@
-import { i as MarkdownDiagnosticSink } from "../diagnostics-B72W0P_E.cjs";
+import { i as MarkdownDiagnosticSink } from "../diagnostics-BuO5-SW1.cjs";
 import { LayoutMetadata } from "document-schema.js";
 //#region src/lower/front-matter.d.ts
 interface FrontMatterResult {

package/dist/lower/front-matter.d.ts

@@ -1,4 +1,4 @@
-import { i as MarkdownDiagnosticSink } from "../diagnostics-B72W0P_E.js";
+import { i as MarkdownDiagnosticSink } from "../diagnostics-BuO5-SW1.js";
 import { LayoutMetadata } from "document-schema.js";
 //#region src/lower/front-matter.d.ts
 interface FrontMatterResult {

package/dist/lower/inline.cjs

@@ -53,6 +53,13 @@ function lowerInlineNode(node, style, context) {
 				message: "inline math (\\( \\)) was preserved as literal raw LaTeX text; it is not parsed as LaTeX or converted to MathML by this package"
 			});
 			return [buildRun(node.literal, style, require_shared_style_constants.MATH_INLINE_FONT_MARKER)];
+		case "footnoteReference":
+			context.sink({
+				code: require_diagnostics_diagnostics.MarkdownDiagnosticCodes.FOOTNOTE_REFERENCE_PRESERVED_AS_TEXT,
+				severity: "info",
+				message: `footnote reference "[^${node.label}]" is preserved as a marked text run rather than an anchor construct: a construct's extent is block-scoped, and a reference site sits between two runs inside a paragraph, which no block-level boundary marker can bracket`
+			});
+			return [buildRun(`[^${node.label}]`, style, require_shared_style_constants.FOOTNOTE_REFERENCE_FONT_MARKER)];
 		case "autolink": {
 			const destination = node.email ? `mailto:${node.destination}` : node.destination;
 			return [buildRun(node.destination, {

package/dist/lower/inline.d.cts

@@ -1,5 +1,5 @@
-import { g as MarkdownInlineNode } from "../ast-DbjiuYr8.cjs";
-import { i as MarkdownDiagnosticSink } from "../diagnostics-B72W0P_E.cjs";
+import { v as MarkdownInlineNode } from "../ast-8XCbjRQT.cjs";
+import { i as MarkdownDiagnosticSink } from "../diagnostics-BuO5-SW1.cjs";
 import { ContentRun } from "document-schema.js";
 //#region src/lower/inline.d.ts
 interface InlineLowerContext {

package/dist/lower/inline.d.ts

@@ -1,5 +1,5 @@
-import { g as MarkdownInlineNode } from "../ast-DbjiuYr8.js";
-import { i as MarkdownDiagnosticSink } from "../diagnostics-B72W0P_E.js";
+import { v as MarkdownInlineNode } from "../ast-8XCbjRQT.js";
+import { i as MarkdownDiagnosticSink } from "../diagnostics-BuO5-SW1.js";
 import { ContentRun } from "document-schema.js";
 //#region src/lower/inline.d.ts
 interface InlineLowerContext {

package/dist/lower/inline.js

@@ -1,5 +1,5 @@
 import { MarkdownDiagnosticCodes } from "../diagnostics/diagnostics.js";
-import { MATH_INLINE_FONT_MARKER, MONOSPACE_FONT_FAMILY } from "../shared/style-constants.js";
+import { FOOTNOTE_REFERENCE_FONT_MARKER, MATH_INLINE_FONT_MARKER, MONOSPACE_FONT_FAMILY } from "../shared/style-constants.js";
 //#region src/lower/inline.ts
 function buildRun(text, style, fontFamily) {
 	return {
@@ -52,6 +52,13 @@ function lowerInlineNode(node, style, context) {
 				message: "inline math (\\( \\)) was preserved as literal raw LaTeX text; it is not parsed as LaTeX or converted to MathML by this package"
 			});
 			return [buildRun(node.literal, style, MATH_INLINE_FONT_MARKER)];
+		case "footnoteReference":
+			context.sink({
+				code: MarkdownDiagnosticCodes.FOOTNOTE_REFERENCE_PRESERVED_AS_TEXT,
+				severity: "info",
+				message: `footnote reference "[^${node.label}]" is preserved as a marked text run rather than an anchor construct: a construct's extent is block-scoped, and a reference site sits between two runs inside a paragraph, which no block-level boundary marker can bracket`
+			});
+			return [buildRun(`[^${node.label}]`, style, FOOTNOTE_REFERENCE_FONT_MARKER)];
 		case "autolink": {
 			const destination = node.email ? `mailto:${node.destination}` : node.destination;
 			return [buildRun(node.destination, {

package/dist/lower/lower.cjs

@@ -230,6 +230,55 @@ function lowerList(node, ancestorNumId, level, context, contentWidthPt) {
 	}
 	return node.children.flatMap((item) => lowerListItem(item, numId, level, context, contentWidthPt));
 }
+function flattenFootnoteBodyHeadings(node, context) {
+	switch (node.type) {
+		case "heading":
+			context.sink({
+				code: require_diagnostics_diagnostics.MarkdownDiagnosticCodes.FOOTNOTE_BODY_HEADING_FLATTENED,
+				severity: "info",
+				message: `a level-${String(node.level)} heading inside a footnote definition's body is carried as literal ATX text: a construct boundary marker's extent may not contain a block that opens or closes a heading scope, so the heading cannot stay a heading inside the anchor construct the definition lowers to`
+			});
+			return {
+				type: "paragraph",
+				children: [{
+					type: "text",
+					value: `${"#".repeat(node.level)} `
+				}, ...node.children]
+			};
+		case "blockquote": return {
+			type: "blockquote",
+			children: node.children.map((child) => flattenFootnoteBodyHeadings(child, context))
+		};
+		case "list": return {
+			...node,
+			children: node.children.map((item) => flattenFootnoteBodyHeadingsInItem(item, context))
+		};
+		case "listItem": return flattenFootnoteBodyHeadingsInItem(node, context);
+		default: return node;
+	}
+}
+function flattenFootnoteBodyHeadingsInItem(item, context) {
+	return {
+		...item,
+		children: item.children.map((child) => flattenFootnoteBodyHeadings(child, context))
+	};
+}
+function lowerFootnoteDefinition(node, context, contentWidthPt) {
+	const descriptor = {
+		kind: "anchor",
+		anchorType: "footnote",
+		name: node.label
+	};
+	const body = node.children.flatMap((child) => lowerBlock(flattenFootnoteBodyHeadings(child, context), context, contentWidthPt));
+	return [
+		{
+			kind: "constructStart",
+			descriptor
+		},
+		...body,
+		{ kind: "constructEnd" }
+	];
+}
 function lowerBlock(node, context, contentWidthPt) {
 	switch (node.type) {
 		case "paragraph": return lowerParagraph(node, context);
@@ -240,6 +289,7 @@ function lowerBlock(node, context, contentWidthPt) {
 		case "thematicBreak": return lowerThematicBreak(context);
 		case "htmlBlock": return lowerHtmlBlock(node, context);
 		case "mathBlock": return lowerMathBlock(node, context);
+		case "footnoteDefinition": return lowerFootnoteDefinition(node, context, contentWidthPt);
 		case "table":
 			if (context.list !== void 0) context.sink({
 				code: require_diagnostics_diagnostics.MarkdownDiagnosticCodes.LIST_ITEM_BLOCK_UNLISTED,
@@ -296,6 +346,7 @@ function lowerMarkdown(source, options = {}) {
 		gfmAutolinks: options.gfmAutolinks,
 		gfmStrikethrough: options.gfmStrikethrough,
 		gfmTaskLists: options.gfmTaskLists,
+		footnotes: options.footnotes,
 		maxNesting: options.maxBlockNesting,
 		sink
 	};

package/dist/lower/lower.js

@@ -229,6 +229,55 @@ function lowerList(node, ancestorNumId, level, context, contentWidthPt) {
 	}
 	return node.children.flatMap((item) => lowerListItem(item, numId, level, context, contentWidthPt));
 }
+function flattenFootnoteBodyHeadings(node, context) {
+	switch (node.type) {
+		case "heading":
+			context.sink({
+				code: MarkdownDiagnosticCodes.FOOTNOTE_BODY_HEADING_FLATTENED,
+				severity: "info",
+				message: `a level-${String(node.level)} heading inside a footnote definition's body is carried as literal ATX text: a construct boundary marker's extent may not contain a block that opens or closes a heading scope, so the heading cannot stay a heading inside the anchor construct the definition lowers to`
+			});
+			return {
+				type: "paragraph",
+				children: [{
+					type: "text",
+					value: `${"#".repeat(node.level)} `
+				}, ...node.children]
+			};
+		case "blockquote": return {
+			type: "blockquote",
+			children: node.children.map((child) => flattenFootnoteBodyHeadings(child, context))
+		};
+		case "list": return {
+			...node,
+			children: node.children.map((item) => flattenFootnoteBodyHeadingsInItem(item, context))
+		};
+		case "listItem": return flattenFootnoteBodyHeadingsInItem(node, context);
+		default: return node;
+	}
+}
+function flattenFootnoteBodyHeadingsInItem(item, context) {
+	return {
+		...item,
+		children: item.children.map((child) => flattenFootnoteBodyHeadings(child, context))
+	};
+}
+function lowerFootnoteDefinition(node, context, contentWidthPt) {
+	const descriptor = {
+		kind: "anchor",
+		anchorType: "footnote",
+		name: node.label
+	};
+	const body = node.children.flatMap((child) => lowerBlock(flattenFootnoteBodyHeadings(child, context), context, contentWidthPt));
+	return [
+		{
+			kind: "constructStart",
+			descriptor
+		},
+		...body,
+		{ kind: "constructEnd" }
+	];
+}
 function lowerBlock(node, context, contentWidthPt) {
 	switch (node.type) {
 		case "paragraph": return lowerParagraph(node, context);
@@ -239,6 +288,7 @@ function lowerBlock(node, context, contentWidthPt) {
 		case "thematicBreak": return lowerThematicBreak(context);
 		case "htmlBlock": return lowerHtmlBlock(node, context);
 		case "mathBlock": return lowerMathBlock(node, context);
+		case "footnoteDefinition": return lowerFootnoteDefinition(node, context, contentWidthPt);
 		case "table":
 			if (context.list !== void 0) context.sink({
 				code: MarkdownDiagnosticCodes.LIST_ITEM_BLOCK_UNLISTED,
@@ -295,6 +345,7 @@ function lowerMarkdown(source, options = {}) {
 		gfmAutolinks: options.gfmAutolinks,
 		gfmStrikethrough: options.gfmStrikethrough,
 		gfmTaskLists: options.gfmTaskLists,
+		footnotes: options.footnotes,
 		maxNesting: options.maxBlockNesting,
 		sink
 	};

package/dist/lower/table.d.cts

@@ -1,4 +1,4 @@
-import { N as MarkdownTableNode } from "../ast-DbjiuYr8.cjs";
+import { F as MarkdownTableNode } from "../ast-8XCbjRQT.cjs";
 import { InlineLowerContext } from "./inline.cjs";
 import { ContentTable } from "document-schema.js";
 //#region src/lower/table.d.ts

package/dist/lower/table.d.ts

@@ -1,4 +1,4 @@
-import { N as MarkdownTableNode } from "../ast-DbjiuYr8.js";
+import { F as MarkdownTableNode } from "../ast-8XCbjRQT.js";
 import { InlineLowerContext } from "./inline.js";
 import { ContentTable } from "document-schema.js";
 //#region src/lower/table.d.ts

package/dist/options/options.d.cts

@@ -1,4 +1,4 @@
-import { i as MarkdownDiagnosticSink } from "../diagnostics-B72W0P_E.cjs";
+import { i as MarkdownDiagnosticSink } from "../diagnostics-BuO5-SW1.cjs";
 import { n as MarkdownImageResolver } from "../image-C4KYmz_L.cjs";
 import { Margins, PageSize } from "document-schema.js";
 //#region src/options/options.d.ts
@@ -14,6 +14,7 @@ interface ReadMarkdownOptions {
   readonly gfmAutolinks?: boolean;
   readonly gfmStrikethrough?: boolean;
   readonly gfmTaskLists?: boolean;
+  readonly footnotes?: boolean;
   readonly maxInputBytes?: number;
   readonly maxBlockNesting?: number;
 }

package/dist/options/options.d.ts

@@ -1,4 +1,4 @@
-import { i as MarkdownDiagnosticSink } from "../diagnostics-B72W0P_E.js";
+import { i as MarkdownDiagnosticSink } from "../diagnostics-BuO5-SW1.js";
 import { n as MarkdownImageResolver } from "../image-Cm3hT5PS.js";
 import { Margins, PageSize } from "document-schema.js";
 //#region src/options/options.d.ts
@@ -14,6 +14,7 @@ interface ReadMarkdownOptions {
   readonly gfmAutolinks?: boolean;
   readonly gfmStrikethrough?: boolean;
   readonly gfmTaskLists?: boolean;
+  readonly footnotes?: boolean;
   readonly maxInputBytes?: number;
   readonly maxBlockNesting?: number;
 }

package/dist/read.d.cts

@@ -1,4 +1,4 @@
-import { t as MarkdownDiagnostic } from "./diagnostics-B72W0P_E.cjs";
+import { t as MarkdownDiagnostic } from "./diagnostics-BuO5-SW1.cjs";
 import { ReadMarkdownOptions } from "./options/options.cjs";
 import { ContentDocument } from "document-schema.js";
 //#region src/read.d.ts

package/dist/read.d.ts

@@ -1,4 +1,4 @@
-import { t as MarkdownDiagnostic } from "./diagnostics-B72W0P_E.js";
+import { t as MarkdownDiagnostic } from "./diagnostics-BuO5-SW1.js";
 import { ReadMarkdownOptions } from "./options/options.js";
 import { ContentDocument } from "document-schema.js";
 //#region src/read.d.ts

package/dist/shared/style-constants.cjs

@@ -19,11 +19,13 @@ const HTML_PREFORMATTED_STYLE_ID = "HTMLPreformatted";
 const MATH_BLOCK_STYLE_ID = "MathBlock";
 const MONOSPACE_FONT_FAMILY = "Courier New";
 const MATH_INLINE_FONT_MARKER = "Cambria Math";
+const FOOTNOTE_REFERENCE_FONT_MARKER = "Footnote Reference";
 const QUOTE_INDENT_PT = 36;
 const TASK_CHECKBOX_UNCHECKED = "☐";
 const TASK_CHECKBOX_CHECKED = "☒";
 //#endregion
 exports.CODE_BLOCK_STYLE_ID = CODE_BLOCK_STYLE_ID;
+exports.FOOTNOTE_REFERENCE_FONT_MARKER = FOOTNOTE_REFERENCE_FONT_MARKER;
 exports.HORIZONTAL_RULE_STYLE_ID = HORIZONTAL_RULE_STYLE_ID;
 exports.HTML_PREFORMATTED_STYLE_ID = HTML_PREFORMATTED_STYLE_ID;
 exports.MATH_BLOCK_STYLE_ID = MATH_BLOCK_STYLE_ID;

package/dist/shared/style-constants.d.cts

@@ -9,8 +9,9 @@ declare const HTML_PREFORMATTED_STYLE_ID = "HTMLPreformatted";
 declare const MATH_BLOCK_STYLE_ID = "MathBlock";
 declare const MONOSPACE_FONT_FAMILY = "Courier New";
 declare const MATH_INLINE_FONT_MARKER = "Cambria Math";
+declare const FOOTNOTE_REFERENCE_FONT_MARKER = "Footnote Reference";
 declare const QUOTE_INDENT_PT = 36;
 declare const TASK_CHECKBOX_UNCHECKED = "☐";
 declare const TASK_CHECKBOX_CHECKED = "☒";
 //#endregion
-export { CODE_BLOCK_STYLE_ID, HORIZONTAL_RULE_STYLE_ID, HTML_PREFORMATTED_STYLE_ID, MATH_BLOCK_STYLE_ID, MATH_INLINE_FONT_MARKER, MAX_HEADING_STYLE_LEVEL, MONOSPACE_FONT_FAMILY, QUOTE_INDENT_PT, QUOTE_STYLE_ID, TASK_CHECKBOX_CHECKED, TASK_CHECKBOX_UNCHECKED, headingStyleId, parseHeadingStyleId };
+export { CODE_BLOCK_STYLE_ID, FOOTNOTE_REFERENCE_FONT_MARKER, HORIZONTAL_RULE_STYLE_ID, HTML_PREFORMATTED_STYLE_ID, MATH_BLOCK_STYLE_ID, MATH_INLINE_FONT_MARKER, MAX_HEADING_STYLE_LEVEL, MONOSPACE_FONT_FAMILY, QUOTE_INDENT_PT, QUOTE_STYLE_ID, TASK_CHECKBOX_CHECKED, TASK_CHECKBOX_UNCHECKED, headingStyleId, parseHeadingStyleId };

package/dist/shared/style-constants.d.ts

@@ -9,8 +9,9 @@ declare const HTML_PREFORMATTED_STYLE_ID = "HTMLPreformatted";
 declare const MATH_BLOCK_STYLE_ID = "MathBlock";
 declare const MONOSPACE_FONT_FAMILY = "Courier New";
 declare const MATH_INLINE_FONT_MARKER = "Cambria Math";
+declare const FOOTNOTE_REFERENCE_FONT_MARKER = "Footnote Reference";
 declare const QUOTE_INDENT_PT = 36;
 declare const TASK_CHECKBOX_UNCHECKED = "☐";
 declare const TASK_CHECKBOX_CHECKED = "☒";
 //#endregion
-export { CODE_BLOCK_STYLE_ID, HORIZONTAL_RULE_STYLE_ID, HTML_PREFORMATTED_STYLE_ID, MATH_BLOCK_STYLE_ID, MATH_INLINE_FONT_MARKER, MAX_HEADING_STYLE_LEVEL, MONOSPACE_FONT_FAMILY, QUOTE_INDENT_PT, QUOTE_STYLE_ID, TASK_CHECKBOX_CHECKED, TASK_CHECKBOX_UNCHECKED, headingStyleId, parseHeadingStyleId };
+export { CODE_BLOCK_STYLE_ID, FOOTNOTE_REFERENCE_FONT_MARKER, HORIZONTAL_RULE_STYLE_ID, HTML_PREFORMATTED_STYLE_ID, MATH_BLOCK_STYLE_ID, MATH_INLINE_FONT_MARKER, MAX_HEADING_STYLE_LEVEL, MONOSPACE_FONT_FAMILY, QUOTE_INDENT_PT, QUOTE_STYLE_ID, TASK_CHECKBOX_CHECKED, TASK_CHECKBOX_UNCHECKED, headingStyleId, parseHeadingStyleId };

package/dist/shared/style-constants.js

@@ -18,8 +18,9 @@ const HTML_PREFORMATTED_STYLE_ID = "HTMLPreformatted";
 const MATH_BLOCK_STYLE_ID = "MathBlock";
 const MONOSPACE_FONT_FAMILY = "Courier New";
 const MATH_INLINE_FONT_MARKER = "Cambria Math";
+const FOOTNOTE_REFERENCE_FONT_MARKER = "Footnote Reference";
 const QUOTE_INDENT_PT = 36;
 const TASK_CHECKBOX_UNCHECKED = "☐";
 const TASK_CHECKBOX_CHECKED = "☒";
 //#endregion
-export { CODE_BLOCK_STYLE_ID, HORIZONTAL_RULE_STYLE_ID, HTML_PREFORMATTED_STYLE_ID, MATH_BLOCK_STYLE_ID, MATH_INLINE_FONT_MARKER, MAX_HEADING_STYLE_LEVEL, MONOSPACE_FONT_FAMILY, QUOTE_INDENT_PT, QUOTE_STYLE_ID, TASK_CHECKBOX_CHECKED, TASK_CHECKBOX_UNCHECKED, headingStyleId, parseHeadingStyleId };
+export { CODE_BLOCK_STYLE_ID, FOOTNOTE_REFERENCE_FONT_MARKER, HORIZONTAL_RULE_STYLE_ID, HTML_PREFORMATTED_STYLE_ID, MATH_BLOCK_STYLE_ID, MATH_INLINE_FONT_MARKER, MAX_HEADING_STYLE_LEVEL, MONOSPACE_FONT_FAMILY, QUOTE_INDENT_PT, QUOTE_STYLE_ID, TASK_CHECKBOX_CHECKED, TASK_CHECKBOX_UNCHECKED, headingStyleId, parseHeadingStyleId };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-codec",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Hand-written CommonMark+GFM <-> ContentDocument codec, built on document-schema.js",
   "type": "module",
   "repository": {
@@ -79,7 +79,7 @@
   "license": "MIT",
   "packageManager": "pnpm@11.6.0",
   "dependencies": {
-    "document-schema.js": "^4.0.0",
+    "document-schema.js": "^4.2.0",
     "zod": "^4.4.3"
   },
   "devDependencies": {