@simple-mark/model 0.1.0 → 0.2.0

package/index.d.ts

@@ -1,11 +1,40 @@
 import { MarkdownExtension } from "@lezer/markdown";
-import { Tree } from "@lezer/common";
+import { SyntaxNode, Tree } from "@lezer/common";
 //#region packages/model/src/parser.d.ts
 /** The Markdown flavor every SimpleMark renderer parses: CommonMark + GFM + $math$. */
 export declare const markdownExtensions: MarkdownExtension[];
 /** A Lezer parser for that flavor, for hosts without CodeMirror (e.g. a canvas renderer). */
 export declare const markdownParser: import("@lezer/markdown").MarkdownParser;
 //#endregion
+//#region packages/model/src/previews.d.ts
+/** An image as written in the document. */
+interface ImageSource {
+  alt: string;
+  /** The path as written, or null when a reference has no definition. */
+  src: string | null;
+  /** For messages: the path, or the reference label (`[logo]`) that has no definition. */
+  raw: string;
+}
+/** A preview drawn below the line that ends at `at` (an offset in the text). */
+type PreviewBlock = {
+  at: number;
+  images: ImageSource[];
+} | {
+  at: number;
+  tex: string;
+};
+/**
+ * The TeX of a math node (`InlineMath` or `BlockMath`), without delimiters or quote markers;
+ * null while it is not closed. `slice` reads the document.
+ */
+export declare function mathSource(node: SyntaxNode, slice: (from: number, to: number) => string): string | null;
+/**
+ * The previews of a document: the images of each line (one entry per line, in order) and
+ * closed, non-empty `$$` blocks. `text` must use one character per line break ("\n"), so
+ * offsets match the tree.
+ */
+export declare function previewBlocks(tree: Tree, text: string): PreviewBlock[];
+//#endregion
 //#region packages/model/src/styles.d.ts
 /** Styles of whole lines, in precedence order (later wins when two set the same property). */
 export declare const BLOCK_STYLES: readonly ['quote', 'codeblock', 'mathblock', 'table', 'tableHeader', 'tableRowAlt', 'hr', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
@@ -113,4 +142,4 @@ export declare function resolveLineLook(blocks: Iterable<BlockStyle>, theme?: Th
 /** The look of text with these block and inline styles (any order). */
 export declare function resolveLook(blocks: Iterable<BlockStyle>, inline: Iterable<InlineStyle>, theme?: Theme): Look;
 //#endregion
-export type { BlockRange, BlockStyle, ColumnAlign, InlineStyle, LineLook, Look, MarkdownStyles, RenderedTable, RowCell, Span, Table, Theme };
+export type { BlockRange, BlockStyle, ColumnAlign, ImageSource, InlineStyle, LineLook, Look, MarkdownStyles, PreviewBlock, RenderedTable, RowCell, Span, Table, Theme };

package/index.js

@@ -103,6 +103,98 @@ const markdownExtensions = [GFM, {
 /** A Lezer parser for that flavor, for hosts without CodeMirror (e.g. a canvas renderer). */
 const markdownParser = parser.configure(markdownExtensions);
 //#endregion
+//#region packages/model/src/previews.ts
+const normalizeLabel = (label) => label.slice(1, -1).trim().replace(/\s+/g, " ").toLowerCase();
+/** A link destination as written, without the optional angle brackets (`<a b.png>`). */
+const destination = (text, url) => text.slice(url.from, url.to).replace(/^<(.*)>$/, "$1");
+/** Link reference definitions (`[label]: url`) of the document, by normalized label. */
+function linkDefinitions(tree, text) {
+	const definitions = /* @__PURE__ */ new Map();
+	for (let node = tree.topNode.firstChild; node; node = node.nextSibling) {
+		if (node.name !== "LinkReference") continue;
+		const label = node.getChild("LinkLabel");
+		const url = node.getChild("URL");
+		if (label && url) {
+			const key = normalizeLabel(text.slice(label.from, label.to));
+			if (!definitions.has(key)) definitions.set(key, destination(text, url));
+		}
+	}
+	return definitions;
+}
+function imageSource(node, text, definitions) {
+	const marks = node.getChildren("LinkMark");
+	const alt = marks.length >= 2 ? text.slice(marks[0].to, marks[1].from) : "";
+	const url = node.getChild("URL");
+	if (url) {
+		const src = destination(text, url);
+		return {
+			alt,
+			src,
+			raw: src
+		};
+	}
+	const label = node.getChild("LinkLabel");
+	const labelText = label && label.to - label.from > 2 ? text.slice(label.from, label.to) : `[${alt}]`;
+	const src = definitions.get(normalizeLabel(labelText));
+	return src === void 0 ? {
+		alt,
+		src: null,
+		raw: labelText
+	} : {
+		alt,
+		src,
+		raw: src
+	};
+}
+/**
+* The TeX of a math node (`InlineMath` or `BlockMath`), without delimiters or quote markers;
+* null while it is not closed. `slice` reads the document.
+*/
+function mathSource(node, slice) {
+	const marks = node.getChildren("MathMark");
+	if (marks.length < 2) return null;
+	if (node.name === "InlineMath") return slice(marks[0].to, marks[1].from);
+	return node.getChildren("MathText").map((part) => slice(part.from, part.to)).join("\n");
+}
+/**
+* The previews of a document: the images of each line (one entry per line, in order) and
+* closed, non-empty `$$` blocks. `text` must use one character per line break ("\n"), so
+* offsets match the tree.
+*/
+function previewBlocks(tree, text) {
+	const definitions = linkDefinitions(tree, text);
+	const lineEnd = (pos) => {
+		const end = text.indexOf("\n", pos);
+		return end === -1 ? text.length : end;
+	};
+	const imagesByLine = /* @__PURE__ */ new Map();
+	const blocks = [];
+	tree.iterate({ enter(node) {
+		if (node.name === "Image") {
+			const at = lineEnd(node.to);
+			let images = imagesByLine.get(at);
+			if (!images) {
+				imagesByLine.set(at, images = []);
+				blocks.push({
+					at,
+					images
+				});
+			}
+			images.push(imageSource(node.node, text, definitions));
+			return false;
+		}
+		if (node.name === "BlockMath") {
+			const tex = mathSource(node.node, (from, to) => text.slice(from, to));
+			if (tex !== null && tex.trim()) blocks.push({
+				at: lineEnd(node.to),
+				tex
+			});
+			return false;
+		}
+	} });
+	return blocks;
+}
+//#endregion
 //#region packages/model/src/styles.ts
 /** Styles of whole lines, in precedence order (later wins when two set the same property). */
 const BLOCK_STYLES = [
@@ -505,4 +597,4 @@ function resolveLook(blocks, inline, theme = defaultTheme) {
 	return look;
 }
 //#endregion
-export { BLOCK_STYLES, INLINE_STYLES, cellAt, charWidth, defaultTheme, displayWidth, flattenSpans, markdownExtensions, markdownParser, markdownStyles, parseTable, renderTable, resolveLineLook, resolveLook, rowLine, splitRow };
+export { BLOCK_STYLES, INLINE_STYLES, cellAt, charWidth, defaultTheme, displayWidth, flattenSpans, markdownExtensions, markdownParser, markdownStyles, mathSource, parseTable, previewBlocks, renderTable, resolveLineLook, resolveLook, rowLine, splitRow };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simple-mark/model",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Markdown parsing and styling model shared by every renderer. Pure TypeScript, no DOM.",
   "license": "MIT",
   "type": "module",