@heroiclands/package-build 23.0.0 → 23.1.0

package/engine/content-format.yaml

@@ -7,7 +7,6 @@ types:
             - templatePriority
             - archetypes
             - occupation
-            - social
             - stations
             - lore
             - culture
@@ -44,6 +43,7 @@ types:
     affiliation:
         data:
             - templatePriority
+            - events
             - demonym
             - epithet
             - symbol
@@ -94,6 +94,8 @@ types:
             - value
             - quality
             - durability
+            - made
+            - lost
         subTypes: []
     armorlocation:
         data:
@@ -110,6 +112,8 @@ types:
             - value
             - quality
             - durability
+            - made
+            - lost
             - quantity
             - potency
             - strength
@@ -124,6 +128,8 @@ types:
             - value
             - quality
             - durability
+            - made
+            - lost
             - capacity
         subTypes: []
     miscgear:
@@ -133,6 +139,8 @@ types:
             - value
             - quality
             - durability
+            - made
+            - lost
             - quantity
         subTypes: []
     mystery:
@@ -179,6 +187,8 @@ types:
             - value
             - quality
             - durability
+            - made
+            - lost
             - quantity
         subTypes:
             - none
@@ -231,6 +241,8 @@ types:
             - value
             - quality
             - durability
+            - made
+            - lost
         subTypes: []
     lore:
         data:
@@ -267,21 +279,6 @@ types:
         data:
             - scene
             - fixup
-            - bgImage
-            - scale
-            - dimensions
-            - pxPerGrid
-            - navName
-            - levelName
-            - backgroundColor
-            - overlay
-            - walls
-            - doors
-            - lights
-            - tiles
-            - sounds
-            - regions
-            - notes
             - place
         subTypes:
             - battlemap
@@ -290,6 +287,7 @@ types:
             - totm
     place:
         data:
+            - events
             - calendar
             - demonym
             - purpose
@@ -745,3 +743,68 @@ vocabularies:
         - open-sea
         - river
         - lake
+    eventKind:
+        - arrival
+        - departure
+        - migration
+        - contact
+        - displacement
+        - founding
+        - charter
+        - accession
+        - secession
+        - conquest
+        - treaty
+        - dissolution
+        - battle
+        - war
+        - siege
+        - revolt
+        - fall
+        - catastrophe
+        - plague
+        - famine
+        - raising
+        - ruin
+        - making
+        - loss
+        - discovery
+        - schism
+        - law
+        - council
+        - birth
+        - death
+    depth:
+        - world
+        - region
+        - local
+    standing:
+        - attested
+        - single-source
+        - reconstructed
+        - disputed
+        - legendary
+    knowledge:
+        - named
+        - misattributed
+        - unlinked
+    role:
+        - actor
+        - victim
+        - instrument
+        - witness
+        - founder
+        - ruler
+        - author
+        - signatory
+    followsHow:
+        - caused
+        - enabled
+        - ended
+        - answered
+    agrees:
+        - full
+        - partly
+        - disputes
+        - denies
+        - silent

package/engine/content-images.mjs

@@ -84,6 +84,7 @@ import { positionInBody } from "./diagnostics.mjs";
 import { FOOTNOTE_REFERENCE } from "./content-footnotes.mjs";
 import { foundryAddressProblem, pathnameProblem, servesFoundry } from "./pathnames.mjs";
 import { ASSET_ROLES } from "./asset-index.mjs";
+import { generatedDirectoryProblem } from "./generated-sections.mjs";
 
 /**
  * The width classes an image may carry, and what each means to a renderer.
@@ -503,11 +504,18 @@ export function imageSourcesIn(body) {
  *   without any other pass noticing — see the Foundry address below. Omitted,
  *   the config-free checks run alone, which is what lets a caller with no
  *   repository to resolve still read a body.
+ * @param {boolean} [opts.generated] - Whether `body` is a note's generated
+ *   sections, which name the build's own drawings under `generated/`; an
+ *   author's text may not.
  * @returns {Array<{file: string, line: number, column: number|undefined,
  *   severity: "error", message: string}>} One finding per defect, in source
  *   order.
  */
-export function checkImages(body, file, { bodyLine = 1, bodyColumn = 1, lineMap, config } = {}) {
+export function checkImages(
+    body,
+    file,
+    { bodyLine = 1, bodyColumn = 1, lineMap, config, generated = false } = {},
+) {
     const text = String(body ?? "");
     if (!text) return [];
 
@@ -532,6 +540,7 @@ export function checkImages(body, file, { bodyLine = 1, bodyColumn = 1, lineMap,
         const problem =
             imageSourceProblem(image.src) ||
             pathnameProblem(image.src) ||
+            (generated ? "" : generatedDirectoryProblem(image.src)) ||
             (foundry ? foundryAddressProblem(image.src, config) : "");
         if (problem) report(image.index, problem);
         if (image.title) {

package/engine/content-index.mjs

@@ -92,7 +92,9 @@ import {
     decodeIndexAddresses,
     noteAddressContext,
     encodeAddresses,
+    publishAddresses,
 } from "./note-addresses.mjs";
+import { AddressLink } from "./address-values.mjs";
 import fs from "node:fs";
 import path from "node:path";
 
@@ -102,14 +104,14 @@ import { metadataFileName } from "./metadata-index.mjs";
 import { collectAssetRecords } from "./asset-index.mjs";
 import { checkForeignAssetBindings } from "./asset-bindings.mjs";
 import { addressSlug, canonicalKey } from "./content-address.mjs";
-import { ownDocumentSystem } from "./address.mjs";
+import { ownDocumentSystem, readCanonicalKey } from "./address.mjs";
 import { NOTE_SYSTEM } from "./systems.mjs";
 import { assetAddressIndex } from "./art-fields.mjs";
 import { embedRole } from "./content-embeds.mjs";
 // One reader for a note's anchors, shared with the link checker and with the
 // builds that emit a link. Re-exported because this is where callers
 // have always addressed it.
-import { collectAnchors } from "./anchors.mjs";
+import { collectAnchors, eventAnchors } from "./anchors.mjs";
 import { NO_SYSTEM } from "./document-subtypes.mjs";
 
 /**
@@ -517,14 +519,28 @@ export function buildIndexRecord({
                 aliasesAscii: asciiAliases(frontmatter?.name?.aliases),
                 // Each anchor carries the link that reaches it, so a section is
                 // addressable from the index without anyone re-deriving how an
-                // anchor is spelled — and its file line, so an editor can jump
-                // there rather than search for the heading.
+                // anchor is spelled — its file line, so an editor can jump
+                // there rather than search for the heading — and its kind, so
+                // a field accepting only an event can tell one from a heading.
+                // The note's events join the body's anchors: one namespace.
                 anchors:
                     stub ? null : (
-                        collectAnchors(body, bodyLine, resolveRole).map((a) => ({
-                            ...a,
-                            link: address ? `${address.slug}#${a.slug}` : null,
-                        }))
+                        [
+                            ...collectAnchors(body, bodyLine, resolveRole),
+                            ...eventAnchors(frontmatter, rawNote(absPath)),
+                        ]
+                            .sort((a, b) => (a.line ?? 0) - (b.line ?? 0))
+                            .map((a) => ({
+                                ...a,
+                                link:
+                                    address ?
+                                        new AddressLink(
+                                            readCanonicalKey(address.canonical),
+                                            a.slug,
+                                            a.kind,
+                                        )
+                                    :   null,
+                            }))
                     ),
                 foundry: foundryBlock(entries?.own, ownDocumentSystem(frontmatter?.type)),
                 // Forward link to the note's documentation journal, which is its
@@ -550,6 +566,18 @@ export function buildIndexRecord({
     );
 }
 
+/**
+ * A note's full text, for the line an event's `id` sits on; `undefined` when
+ * there is no file to read, so the line is dropped rather than guessed.
+ *
+ * @param {string} [absPath] - The note's file.
+ * @returns {string|undefined} Its contents.
+ */
+function rawNote(absPath) {
+    if (!absPath || !fs.existsSync(absPath)) return undefined;
+    return fs.readFileSync(absPath, "utf8");
+}
+
 /**
  * The record for an item note's **documentation journal**.
  *
@@ -848,7 +876,7 @@ export function collectContentIndex(
  */
 export function serializeContentIndex(records) {
     if (records.length === 0) return "";
-    return `${records.map((r) => JSON.stringify(sortKeysDeep(encodeAddresses(r)))).join("\n")}\n`;
+    return `${records.map((r) => JSON.stringify(sortKeysDeep(publishAddresses(r)))).join("\n")}\n`;
 }
 
 /**

package/engine/content-links.mjs

@@ -197,6 +197,8 @@ export function buildLinkIndex(
     /** Canonical address to asset record, for the files this package ships. */
     const byAssetKey = new Map();
     const anchors = new Map();
+    /** Each note to the ids of its events, which a wikilink may not name. */
+    const eventAnchorsOf = new Map();
 
     for (const record of indexRecords) {
         // An asset's record addresses a file rather than a note: there is no
@@ -231,7 +233,14 @@ export function buildLinkIndex(
 
         // The anchors the index recorded, rather than a second reading of the
         // same headings — the disagreement the anchor half removes.
-        anchors.set(note, new Set((record.anchors ?? []).map((a) => a.slug)));
+        anchors.set(
+            note,
+            new Set((record.anchors ?? []).filter((a) => a.kind === "prose").map((a) => a.slug)),
+        );
+        eventAnchorsOf.set(
+            note,
+            new Set((record.anchors ?? []).filter((a) => a.kind === "event").map((a) => a.slug)),
+        );
 
         if (typeof fm.shortcode === "string" && fm.shortcode) {
             // Canonical addresses only. Every written target expands to one
@@ -251,10 +260,11 @@ export function buildLinkIndex(
             // filed where a link cannot reach it and a reference still can.
             const into = record.address ? byKey : byStub;
             into.set(canonical, note);
-            if (hasDocEntry(type)) {
-                // The prose has one `note` Address across all system blocks.
+            // The prose has one `note` Address across all system blocks, and
+            // every note answers to it — whether or not a system compiles the
+            // type into a document of its own, as the site index keys it.
+            if (hasDocEntry(type) || ownDocumentSystem(type) !== NOTE_SYSTEM)
                 into.set(canonicalKey(pkg, NOTE_SYSTEM, type, fm.shortcode), note);
-            }
         }
     }
 
@@ -599,6 +609,7 @@ export function buildLinkIndex(
         notes,
         frontmatterLinks,
         anchors,
+        eventAnchorsOf,
         types,
         packages,
         /** Packages declared `contentIndex: false`, a Foundry dependency only. */
@@ -953,6 +964,10 @@ export function auditLinks(index) {
             if (!dest) continue;
             if (!(anchors.get(dest) ?? new Set()).has(slugify(anchor))) {
                 deadAnchors.push({
+                    reason:
+                        (index.eventAnchorsOf?.get(dest) ?? new Set()).has(anchor) ?
+                            "event-anchor"
+                        :   "unknown-anchor",
                     note,
                     link: `${rawTarget}#${anchor}`,
                     // The two the shared `unknown-anchor` wording reads, in the
@@ -980,7 +995,11 @@ export function auditLinks(index) {
             if (!labelled) {
                 unlabelledLinks.push({
                     note,
-                    target: rawTarget || (anchor ? `#${anchor}` : ""),
+                    // Quoted as written, anchor included — the literal between
+                    // the brackets, as the site build quotes it.
+                    target:
+                        /^!?\[\[([\s\S]*)\]\]$/.exec(text ?? "")?.[1] ??
+                        `${rawTarget ?? ""}${anchor ? `#${anchor}` : ""}`,
                     text,
                     occurrence,
                     // Carried like every other finding's, so a reporter reads

package/engine/content-tables.mjs

@@ -2,6 +2,7 @@
 
 import { FENCE_LINE } from "./code-fences.mjs";
 import { PAGE_LIST_LANGUAGE } from "./page-lists.mjs";
+import { appendGeneratedSections } from "./generated-sections.mjs";
 
 /**
  * Replace prepared SQL fences and page lists with Markdown while retaining
@@ -15,10 +16,23 @@ import { PAGE_LIST_LANGUAGE } from "./page-lists.mjs";
  * @param {string} markdown - The authored body.
  * @param {{source?: string, sqlTables?: object[], pageLists?: object[]}} [context] -
  *   Prepared results.
- * @returns {{markdown: string, errors: object[], warnings: object[], lineMap: object[]}}
+ * A note's generated sections — see {@link module:engine/generated-sections} —
+ * are appended to the body first, from the `generated` text the preparation
+ * set on its results, and expanded with it.
+ *
+ * @returns {{markdown: string, errors: object[], warnings: object[], lineMap: object[],
+ *   generatedFrom?: number}} `generatedFrom` is the 0-based line of the
+ *   expanded body the generated sections start on, where there are any — what
+ *   a surface reads to tell them from the author's text.
  */
 export function expandContentTables(markdown, { source = "", sqlTables, pageLists } = {}) {
-    const lines = String(markdown ?? "").split("\n");
+    // A note's generated sections follow its own text, joined exactly as the
+    // pass that answered their fences joined them.
+    const authored = String(markdown ?? "");
+    const lines = String(appendGeneratedSections(authored, sqlTables?.generated)).split("\n");
+    const sectionsStart =
+        sqlTables?.generated ? authored.replace(/\s+$/, "").split("\n").length + 1 : -1;
+    let generatedFrom;
     const out = [];
     const lineMap = [];
     const errors = [];
@@ -30,6 +44,7 @@ export function expandContentTables(markdown, { source = "", sqlTables, pageList
         lineMap.push({ line, generated });
     };
     for (let i = 0; i < lines.length; i++) {
+        if (i === sectionsStart) generatedFrom = out.length;
         const opening = FENCE_LINE.exec(lines[i]);
         if (!opening) {
             emit(lines[i], i);
@@ -121,5 +136,11 @@ export function expandContentTables(markdown, { source = "", sqlTables, pageList
         if (close + 1 < lines.length && lines[close + 1].trim()) emit("", i, true);
         i = close;
     }
-    return { markdown: out.join("\n"), errors, warnings, lineMap };
+    return {
+        markdown: out.join("\n"),
+        errors,
+        warnings,
+        lineMap,
+        ...(generatedFrom === undefined ? {} : { generatedFrom }),
+    };
 }