@latentic/live-markdown 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.1.1] - 2026-08-24
+
+### Added
+
+- `inlineScanRulesFacet`, `scanInline`, `escapeText`/`escapeAttr` and their
+  types are exported. 0.1.0 shipped the seam but left it unreachable: a
+  third-party extension could contribute a rule for a construct Lezer parses
+  (`nodeRulesFacet`, public since 0.0.1) but not for one it does not, which is
+  half a contract.
+
 ## [0.1.0] - 2026-08-24
 
 First release from the editor's own repository, and the first with CI on more

package/dist/index.d.ts

@@ -160,6 +160,57 @@ declare function structural(why: string): NodeRule;
  */
 declare const nodeRulesFacet: Facet<Readonly<Record<string, NodeRule>>, Readonly<Record<string, NodeRule>>>;
 
+/**
+ * Constructs Lezer never parses.
+ *
+ * Wikilinks, `==highlight==`, footnote references and `$math$` are not
+ * CommonMark, so no node exists for any of them and the editor finds each by
+ * scanning text (`codeContext.ts` documents the shared code guard). A renderer
+ * that walks the tree is therefore blind to all four — which is how a table cell
+ * came to show `$440 = 2 \times \frac{22}{7} \times r$` as literal source while
+ * the same expression rendered as mathematics in the paragraph above it.
+ *
+ * A feature contributes its pattern and its markup through this facet; the
+ * string renderers consult the facet and stay ignorant of what the constructs
+ * are. The decoration plugins keep their own viewport-scanning path — the two
+ * paths share the pattern, not the machinery, because one produces decorations
+ * over a live document and the other an HTML string.
+ */
+
+interface InlineScanRule {
+    readonly name: string;
+    /** Global-flagged; the scanner drives `exec` and resets `lastIndex`. */
+    readonly pattern: RegExp;
+    /** Markup for one match. Escaping document text is the rule's job. */
+    render(match: RegExpExecArray): string;
+    /**
+     * Upgrade rendered markup to real DOM, after sanitisation. Only for a
+     * construct whose rendering is DOM rather than markup (KaTeX): the generated
+     * nodes bypass the sanitiser, so a hydrate reads inert text from the element
+     * it replaces and never trusts the document.
+     */
+    hydrate?(root: HTMLElement): void;
+}
+declare const inlineScanRulesFacet: Facet<InlineScanRule, readonly InlineScanRule[]>;
+interface InlineScanMatch {
+    readonly from: number;
+    readonly to: number;
+    readonly html: string;
+}
+/**
+ * Every rule's matches in `text`, in document order, offset by `at`.
+ *
+ * Earliest wins, then longest — two constructs cannot both own one span, and
+ * the alternative (rule declaration order) would make the result depend on
+ * extension load order.
+ */
+declare function scanInline(rules: readonly InlineScanRule[], text: string, at?: number): InlineScanMatch[];
+
+/** Entity-escaping for the string renderers (table cells), which build HTML
+ *  text rather than DOM and so must neutralise markup in document content. */
+declare function escapeText(value: string): string;
+declare function escapeAttr(value: string): string;
+
 /**
  * A syntax tree that reaches `pos`.
  *
@@ -801,4 +852,4 @@ interface ResolveWorkspaceLinkOptions {
 }
 declare function resolveWorkspaceLink(href: string, options: ResolveWorkspaceLinkOptions): ResolvedWorkspaceLink | null;
 
-export { type CaretContextSnapshot, type CodeMirrorEditorMode, CodeMirrorMarkdownEditor, type CodeMirrorMarkdownEditorProps, type ComposedExtension, type DocumentTextChange, type EditorSelectionSnapshot, type Frontmatter, type FrontmatterValue, type HighlightedSpan, IMAGE_EDIT_ALT_EVENT, type ImageEditAltEventDetail, type ImageInsertOptions, type ImageInsertResult, type ImageResolveContext, type MarkdownDocument, type MarkdownExtension, type MermaidRenderResult, type NodeContext, type NodeRule, type NodeRules, type OpenExternalUrl, type Paint, type ResolveImageSrc, type ResolveWorkspaceLinkOptions, type ResolvedWorkspaceLink, type SaveImageBytes, type SourceRange, type ToolbarContribution, blockCommands, buildImageMarkdown, composeExtensions, computeFileDir, defaultResolveImageSrc, dirnamePath, editorBaseTheme, extractImageBlobs, extractImageFiles, footnoteExtension, formatCommands, getCachedMermaidPng, hasUriScheme, headingLine, hideAlways, highlightExtension, highlightFenceSpans, imageInsertHandlers, insertImageBlob, isAbsolutePath, isMermaidFenceInfo, joinPath, line, mark, markdownDecorationsPlugin, mathExtension, mermaidExtension, nodeRulesFacet, onEditorUpdate, parseFrontmatter, parseWikilinkBody, pickImageFileForCaret, raw, renderMermaidToSvg, resolveWikilinkTarget, resolveWorkspaceLink, serializeMarkdown, setFrontmatterField, showImageActionMenu, structural, tableExtension, treeAt, warmMermaidPng, wikilinkExtension };
+export { type CaretContextSnapshot, type CodeMirrorEditorMode, CodeMirrorMarkdownEditor, type CodeMirrorMarkdownEditorProps, type ComposedExtension, type DocumentTextChange, type EditorSelectionSnapshot, type Frontmatter, type FrontmatterValue, type HighlightedSpan, IMAGE_EDIT_ALT_EVENT, type ImageEditAltEventDetail, type ImageInsertOptions, type ImageInsertResult, type ImageResolveContext, type InlineScanMatch, type InlineScanRule, type MarkdownDocument, type MarkdownExtension, type MermaidRenderResult, type NodeContext, type NodeRule, type NodeRules, type OpenExternalUrl, type Paint, type ResolveImageSrc, type ResolveWorkspaceLinkOptions, type ResolvedWorkspaceLink, type SaveImageBytes, type SourceRange, type ToolbarContribution, blockCommands, buildImageMarkdown, composeExtensions, computeFileDir, defaultResolveImageSrc, dirnamePath, editorBaseTheme, escapeAttr, escapeText, extractImageBlobs, extractImageFiles, footnoteExtension, formatCommands, getCachedMermaidPng, hasUriScheme, headingLine, hideAlways, highlightExtension, highlightFenceSpans, imageInsertHandlers, inlineScanRulesFacet, insertImageBlob, isAbsolutePath, isMermaidFenceInfo, joinPath, line, mark, markdownDecorationsPlugin, mathExtension, mermaidExtension, nodeRulesFacet, onEditorUpdate, parseFrontmatter, parseWikilinkBody, pickImageFileForCaret, raw, renderMermaidToSvg, resolveWikilinkTarget, resolveWorkspaceLink, scanInline, serializeMarkdown, setFrontmatterField, showImageActionMenu, structural, tableExtension, treeAt, warmMermaidPng, wikilinkExtension };

package/dist/index.js

@@ -5929,6 +5929,6 @@ function CodeMirrorMarkdownEditorInner({
 }
 var CodeMirrorMarkdownEditor = memo(CodeMirrorMarkdownEditorInner);
 
-export { CodeMirrorMarkdownEditor, IMAGE_EDIT_ALT_EVENT, blockCommands, buildImageMarkdown, composeExtensions, computeFileDir, defaultResolveImageSrc, dirnamePath, editorBaseTheme, extractImageBlobs, extractImageFiles, footnoteExtension, formatCommands, getCachedMermaidPng, hasUriScheme, headingLine, hideAlways, highlightExtension, highlightFenceSpans, imageInsertHandlers, insertImageBlob, isAbsolutePath, isMermaidFenceInfo, joinPath, line, mark, markdownDecorationsPlugin, mathExtension, mermaidExtension, nodeRulesFacet, onEditorUpdate, parseFrontmatter, parseWikilinkBody, pickImageFileForCaret, raw, renderMermaidToSvg, resolveWikilinkTarget, resolveWorkspaceLink, serializeMarkdown, setFrontmatterField, showImageActionMenu, structural, tableExtension, treeAt, warmMermaidPng, wikilinkExtension };
+export { CodeMirrorMarkdownEditor, IMAGE_EDIT_ALT_EVENT, blockCommands, buildImageMarkdown, composeExtensions, computeFileDir, defaultResolveImageSrc, dirnamePath, editorBaseTheme, escapeAttr, escapeText, extractImageBlobs, extractImageFiles, footnoteExtension, formatCommands, getCachedMermaidPng, hasUriScheme, headingLine, hideAlways, highlightExtension, highlightFenceSpans, imageInsertHandlers, inlineScanRulesFacet, insertImageBlob, isAbsolutePath, isMermaidFenceInfo, joinPath, line, mark, markdownDecorationsPlugin, mathExtension, mermaidExtension, nodeRulesFacet, onEditorUpdate, parseFrontmatter, parseWikilinkBody, pickImageFileForCaret, raw, renderMermaidToSvg, resolveWikilinkTarget, resolveWorkspaceLink, scanInline, serializeMarkdown, setFrontmatterField, showImageActionMenu, structural, tableExtension, treeAt, warmMermaidPng, wikilinkExtension };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map