@heroiclands/package-build 25.5.4 → 25.6.0

package/types/engine/sql-tables.d.mts

@@ -21,6 +21,23 @@ export function findSqlBlocks(markdown: string): Array<{
     layout: string;
     block: string;
 }>;
+/**
+ * Where a query reads the `file` block of the index record: `file.path`,
+ * `file.folder` or `file.name`, bare or qualified by a relation or its alias.
+ * A note is selected by property, tag or address, so a query that reaches for
+ * the file it was written in is refused. A field of a note's own data that is
+ * named `file` is not the block and is left alone.
+ *
+ * @param {string} sql - One fence's query.
+ * @returns {{line: number, column: number, text: string}|undefined} The first
+ *   reference, its 0-based line within the query and 1-based column, or
+ *   nothing where the query makes none.
+ */
+export function findFileReference(sql: string): {
+    line: number;
+    column: number;
+    text: string;
+} | undefined;
 /**
  * Open a DuckDB view over the content index.
  *
@@ -205,25 +222,35 @@ export function prepareInlineSqlExpressions(db: any, sources: any): Promise<Map<
  * @param {Map<string, Map<string, string>>} [opts.derived] - The derived
  *   lists, from an earlier call over the same records, which are not derived
  *   again.
+ * @param {Map<string,{raw?:string}>} [opts.parsed] - Captured source locators.
  * @param {object[]} [opts.all=records] - Complete records for lexical lineage
  *   traversal through providers outside the surface's audience.
  * @returns {Promise<{sections: Map<string, string>, views: Set<string>,
  *   derived: Map<string, Map<string, string>>,
- *   lexical: Map<string, import("./lexical-sections.mjs").LexicalSection[]>}>} Note file to its sections,
+ *   lexical: Map<string, import("./lexical-sections.mjs").LexicalSection[]>,
+ *   declared: Map<string, Array<{slug:string,heading:string,markdown:string}>>}>} Note file to its sections,
  *   joined in order; the files whose sections hold an event view's fence; and
  *   the derived lists alone.
  */
-export function generatedSectionsFor(db: object | undefined, records: object[], contentBase: string, { only, foreignIndex, config, derived: given, all }?: {
+export function generatedSectionsFor(db: object | undefined, records: object[], contentBase: string, { only, foreignIndex, config, derived: given, all, parsed }?: {
     only?: string | undefined;
     foreignIndex?: Map<string, object> | undefined;
     config?: object | undefined;
     derived?: Map<string, Map<string, string>> | undefined;
+    parsed?: Map<string, {
+        raw?: string;
+    }> | undefined;
     all?: object[] | undefined;
 }): Promise<{
     sections: Map<string, string>;
     views: Set<string>;
     derived: Map<string, Map<string, string>>;
     lexical: Map<string, import("./lexical-sections.mjs").LexicalSection[]>;
+    declared: Map<string, Array<{
+        slug: string;
+        heading: string;
+        markdown: string;
+    }>>;
 }>;
 /**
  * Join each note's generated sections to its body among the sources a
@@ -262,13 +289,18 @@ export function joinGeneratedSections(generated: {
  * empty set carrying them.
  *
  * @param {Map<string, object[]>} prepared - From {@link prepareSqlTables}.
- * @param {{sections: Map<string, string>, lexical?: Map<string, import("./lexical-sections.mjs").LexicalSection[]>}} generated - From
+ * @param {{sections: Map<string, string>, lexical?: Map<string, import("./lexical-sections.mjs").LexicalSection[]>, declared?: Map<string, Array<{slug:string,heading:string,markdown:string}>>}} generated - From
  *   {@link generatedSectionsFor}.
  * @returns {void}
  */
 export function attachGeneratedSections(prepared: Map<string, object[]>, generated: {
     sections: Map<string, string>;
     lexical?: Map<string, import("./lexical-sections.mjs").LexicalSection[]>;
+    declared?: Map<string, Array<{
+        slug: string;
+        heading: string;
+        markdown: string;
+    }>>;
 }): void;
 /**
  * Each declared dependency's cached index, as {@link openNotesDatabase} attaches

package/types/engine/standing-terms.d.mts

@@ -20,8 +20,9 @@ export const STANDING_BODY_TYPES: readonly string[];
  * The keys one standing carries, as inner-key declarations.
  *
  * `rank` is the level on the body's own `governance.ranks` ladder, and every
- * membership states one. `office` is a key of its `governance.offices` map, and
- * is stated only where the being holds a post. `societies` names the societies
+ * membership states one. `office` is a key of its `governance.offices` map, or
+ * a list of them where the being holds several posts in that body, and is
+ * stated only where the being holds a post. `societies` names the societies
  * the membership is held in, as a list because a membership can span several.
  *
  * @type {readonly import("./data-keys.mjs").InnerKeySpec[]}

package/types/engine/standings.d.mts

@@ -98,12 +98,24 @@ export function standingsDigest(fm: object): {
     ranks?: Record<string, string>;
     offices?: Record<string, string>;
 } | undefined;
+/**
+ * The posts a standing holds, trimmed, in the order written.
+ *
+ * `office` is one post or a list of them, and every reader — the line on the
+ * being's page, the SoHL item, the derived holders of an office — wants the
+ * same list from both.
+ *
+ * @param {object} [standing] - `{rank, office}`, either or both absent.
+ * @returns {string[]} The posts, blank and non-text entries left out.
+ */
+export function standingOffices(standing?: object): string[];
 /**
  * What a standing says before the body that confers it — `War Chief, Hárár
  * (5), of ` — or `""` where no standing is held.
  *
  * The office leads, because it is the more particular of the two: a reader
- * meeting "War Chief" has been told the rung as well. The rung follows as its
+ * meeting "War Chief" has been told the rung as well. Several posts in one
+ * body lead in the order written, `Treasurer, Chancellor, …`. The rung follows as its
  * title with its level in parentheses, read from the body's own ladder; where
  * the ladder names no rung at that level, or none is available, it reads as
  * `Rank 5` and the number is not repeated. The body closes the phrase, which is
@@ -131,7 +143,7 @@ export function standingLead(standing: object, digest?: {
  * 3. the entry states a standing at all — what a stated standing holds is the
  *    inner-key check's, read from {@link STANDING_FIELDS};
  * 4. a `rank` is a level the named body's `governance.ranks` declares;
- * 5. an `office` is a key of that body's `governance.offices`.
+ * 5. each post an `office` names is a key of that body's `governance.offices`.
  *
  * Both of the last two are read from the named body's own frontmatter as the
  * lint runs, so a rung or a post that does not exist fails on every being pointing

package/types/engine/unique-items.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Report a unique item whose note links no place or being.
+ *
+ * @param {object} note - The note: `file`, `raw`, `body` and parsed `fm`.
+ * @param {{index?: object}} [options] - The lint's options.
+ * @returns {object[]} The finding, located at `unique`, or none.
+ */
+export function checkUniqueItem(note: object, { index }?: {
+    index?: object;
+}): object[];
+/** The note types a unique item's links must reach at least one of. */
+export const UNIQUE_ITEM_LINK_TYPES: readonly string[];

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

@@ -73,7 +73,7 @@ export function metreMessage({ min, max }: {
  * @param {ReadonlyArray<{start: number, end: number, indent: string, attributes: Record<string, string>, classes: string[]}>} blocks -
  *   The divs, from {@link module:engine/content-verse.scanVerse}.
  * @param {string[]} lines - The source's lines.
- * @param {{languages?: Readonly<Record<string, {tag: string}>>, metres?: ReadonlyMap<string, import("./metre-declaration.mjs").Metre>, metreBooks?: ReadonlyMap<string, MetreBook>, lexicons?: ReadonlyMap<string, unknown>, attributeColumns: (line: string, key: string) => {key: number, value: number}}} ctx -
+ * @param {{languages?: Readonly<Record<string, {tag: string}>>, metres?: ReadonlyMap<string, import("./metre-declaration.mjs").Metre>, metreBooks?: ReadonlyMap<string, MetreBook>, lexicons?: ReadonlyMap<string, unknown>, referenceName?: (target: string) => string|undefined, attributeColumns: (line: string, key: string) => {key: number, value: number}}} ctx -
  *   The metres and books, and how the div says its columns and where its
  *   keys sit.
  * @returns {{errors: object[], warnings: object[]}} The findings at 1-based
@@ -92,6 +92,7 @@ export function metreFindings(blocks: ReadonlyArray<{
     metres?: ReadonlyMap<string, import("./metre-declaration.mjs").Metre>;
     metreBooks?: ReadonlyMap<string, MetreBook>;
     lexicons?: ReadonlyMap<string, unknown>;
+    referenceName?: (target: string) => string | undefined;
     attributeColumns: (line: string, key: string) => {
         key: number;
         value: number;

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

@@ -51,6 +51,14 @@ export type VerseRegion = {
      * - Authored body bytes.
      */
     body: string;
+    /**
+     * - Body without Markdown container prefixes.
+     */
+    logicalBody: string;
+    /**
+     * - Logical UTF-16 offsets mapped to authored body offsets, including the end.
+     */
+    bodyOffsets: number[];
     /**
      * - Authored values.
      */