@heroiclands/package-build 25.3.0 → 25.4.0

package/types/engine/verse-regions.d.mts

@@ -0,0 +1,78 @@
+/**
+ * Install the opaque verse-div block rule. Tokens carry raw source regions.
+ * @param {import("markdown-it")} md - Markdown parser.
+ */
+export function verseDivPlugin(md: typeof import("markdown-it")): void;
+/**
+ * Locate complete raw verse divs while leaving literal examples untouched.
+ * @param {string} source - Authored Markdown.
+ * @returns {VerseRegion[]} Regions in source order, including unclosed divs.
+ */
+export function verseRegions(source: string): VerseRegion[];
+/**
+ * Source ranges belonging to inline syntax rather than visible verse text.
+ * @param {string} source - Inline Markdown.
+ * @returns {Array<[number,number]>} Protected UTF-16 ranges.
+ */
+export function inlineSyntaxRanges(source: string): Array<[number, number]>;
+/**
+ * A raw verse div, opaque to ordinary Markdown block syntax.
+ */
+export type VerseRegion = {
+    /**
+     * - Opening line, zero based.
+     */
+    start: number;
+    /**
+     * - Closing line, zero based and inclusive.
+     */
+    end: number;
+    /**
+     * - First offset of the complete region.
+     */
+    from: number;
+    /**
+     * - Offset past the complete region.
+     */
+    to: number;
+    /**
+     * - First body offset.
+     */
+    bodyStart: number;
+    /**
+     * - Offset past body text, excluding its final newline.
+     */
+    bodyEnd: number;
+    /**
+     * - Authored body bytes.
+     */
+    body: string;
+    /**
+     * - Authored values.
+     */
+    attributes: Record<string, string>;
+    /**
+     * - Anchor or empty string.
+     */
+    id: string;
+    /**
+     * - Authored classes including verse.
+     */
+    classes: string[];
+    /**
+     * - Opening indentation.
+     */
+    indent: string;
+    /**
+     * - Region kind.
+     */
+    name: "verse";
+    /**
+     * - Whether a closing delimiter is present.
+     */
+    closed: boolean;
+    /**
+     * - Attribute syntax findings.
+     */
+    problems: string[];
+};

package/types/engine/wikilink-pattern.d.mts

@@ -0,0 +1,17 @@
+/** The dependency-free lexical wikilink pattern. @module */
+/**
+ * A wikilink, as authored.
+ *
+ * **Newlines are excluded deliberately.** A link is written on one line; an
+ * unclosed `[[` is a typo, and the alternative is letting it swallow arbitrary
+ * prose in search of a closer. Erring towards "not a link" leaves the author's
+ * text as written, which is the safe direction for a rewriter.
+ *
+ * **A leading `!` makes it an embed, not a link**, and the lookbehind is what
+ * keeps every reader from seeing one as the other. Stated here rather than in
+ * each reader for the reason the rest of this module exists: the checker, the
+ * resolver and the embed reader all match on this pattern, and a copy of the
+ * exclusion in each is a place for it to be forgotten. An embed's
+ * own grammar is {@link module:engine/content-embeds}.
+ */
+export const WIKILINK: RegExp;

package/types/engine/wikilink-syntax.d.mts

@@ -206,47 +206,7 @@ export function secretDestination(destination: object, anchor?: string): boolean
  * @returns {string} Inline spoiler or visible reference.
  */
 export function presentWikilink(reference: string, parsed: object, destination: object): string;
-/**
- * What a `[[…]]` **is**, before anything decides where it points.
- *
- * One authored link is written three ways — a Foundry `@UUID` content link for
- * the packs, a URL for the web, a cross-reference for the book — and those
- * forms are the *only* thing that legitimately differs. The syntax is the
- * author's, and it is the same syntax whichever build is reading it.
- *
- * So the parse lives here, once, and two readers take it: the link checker
- * (`content-links.mjs`) and the resolver (`wikilinks.mjs`). Each receives the
- * parts and decides only what it is for: which document the address names.
- *
- * The one rule about a link's *shape* also lives here — **a link carries a
- * label** ({@link unlabelledLinkMessage}) — because every build states it
- * through one message and the author reads the same words whichever ran
- * first.
- *
- * For the same reason, so does the **vocabulary of link findings**
- * ({@link LINK_FINDING_REASONS}) and the message each one reports through
- * ({@link linkFindingMessage}). Every build reads one authored link; an author
- * meets whichever ran first, and a consumer switching on a `reason` should not
- * be switching on which build produced it.
- *
- * @module
- */
-/**
- * A wikilink, as authored.
- *
- * **Newlines are excluded deliberately.** A link is written on one line; an
- * unclosed `[[` is a typo, and the alternative is letting it swallow arbitrary
- * prose in search of a closer. Erring towards "not a link" leaves the author's
- * text as written, which is the safe direction for a rewriter.
- *
- * **A leading `!` makes it an embed, not a link**, and the lookbehind is what
- * keeps every reader from seeing one as the other. Stated here rather than in
- * each reader for the reason the rest of this module exists: the checker, the
- * resolver and the embed reader all match on this pattern, and a copy of the
- * exclusion in each is a place for it to be forgotten. An embed's
- * own grammar is {@link module:engine/content-embeds}.
- */
-export const WIKILINK: RegExp;
+export { WIKILINK } from "./wikilink-pattern.mjs";
 /**
  * Every way a link can fail, named once for every reader of a link.
  *