@heroiclands/package-build 22.15.1 → 22.16.0

package/types/engine/pdf-images.d.mts

@@ -0,0 +1,38 @@
+/**
+ * Optimize staged raster images without changing their authored files.
+ *
+ * @param {Map<string, {from: string, to: string, relative: string, file: string,
+ *   uses: Array<{width: number, height: number}>}>} candidates
+ * @param {string} outDir - PDF staging directory.
+ * @returns {Promise<object[]>} Image reports with the authored file location.
+ */
+export function resamplePdfImages(candidates: Map<string, {
+    from: string;
+    to: string;
+    relative: string;
+    file: string;
+    uses: Array<{
+        width: number;
+        height: number;
+    }>;
+}>, outDir: string): Promise<object[]>;
+/** Print geometry in inches; Typst's default column gutter is 4% of the text width. */
+export const PDF_PAGE: Readonly<{
+    width: 8.5;
+    height: 11;
+    margin: number;
+    dpi: 300;
+    quality: 82;
+}>;
+/** Named image widths in inches, matching the book renderer's Typst sizes. */
+export const PDF_IMAGE_INCHES: Readonly<{
+    small: number;
+    medium: number;
+    large: number;
+    xlarge: number;
+}>;
+/** Usable width of a portrait page in inches. */
+export const pdfTextWidth: number;
+/** Usable height of a portrait page in inches. */
+export const pdfTextHeight: number;
+export function pdfColumnWidth(columns?: number): number;

package/types/engine/populations.d.mts

@@ -1,8 +1,8 @@
 /**
  * Read a fetched index entry into a node, or `null` where it takes no part.
  *
- * A fetched entry carries the structure its record stated and no figure, so
- * a dependency's place sits in the geography and counts nobody.
+ * A fetched entry carries its author's figure when the published index has
+ * one. An older index without a figure contributes no population.
  *
  * @param {string} canonical - The entry's address.
  * @param {object} entry - The entry.

package/types/engine/project-init.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Validate values before creating a target directory.
+ * @param {object} answers
+ */
+export function validateInitAnswers(answers: object): {
+    contentPackage: any;
+};
+/** Format every generated file with the toolchain's own conventions. */
+export function renderProject(answers: any): Promise<Map<any, any>>;
+/** Write a complete scaffold after collision checks; undo this run's files on failure. */
+export function initializeProject(rootDir: any, answers: any): Promise<any[]>;
+/** Report required structure and meaning in an existing package without writes. */
+export function checkProject(rootDir: any): any[];
+/** Package kinds the initializer can create. */
+export const INIT_KINDS: readonly string[];
+/** License templates the initializer can create. */
+export const INIT_LICENSES: readonly string[];

package/types/engine/prose-config.d.mts

@@ -136,7 +136,7 @@ export const PRETTIER_CONFIG: Readonly<object>;
  */
 export const MARKDOWNLINT_CONFIG: Readonly<object>;
 /**
- * The globs `content-build markdown` checks when a consumer names no paths.
+ * The globs `package-build markdown` checks when a consumer names no paths.
  *
  * Every markdown file the repository tracks, which is what a consumer means by
  * "lint my markdown". What to *skip* is the repository's own business and comes

package/types/engine/prose-lint.d.mts

@@ -45,7 +45,7 @@ export function checkFormatting(root: string, opts?: {
  *
  * The no-configuration case is the sharper one and is reported even though the
  * command itself behaves correctly there: with no config file the shared
- * conventions reach `content-build format` and reach *nothing else*, so an
+ * conventions reach `package-build format` and reach *nothing else*, so an
  * editor's format-on-save and a bare `npx prettier --check .` apply Prettier's
  * own defaults to the same tree, and the two take turns rewriting the same
  * lines. That is not hypothetical — it is what the config files in
@@ -84,7 +84,8 @@ export function checkPrettierConventions(root: string, opts?: {
  * and every per-rule option; but its `ignores` *replaces*
  * {@link MARKDOWN_IGNORES} rather than extending it, so such a file must restate
  * every shared entry it still wants. Omitting `CHANGELOG.md` there silently
- * starts linting a generated file.
+ * starts linting a generated file. `node_modules` stays excluded by the
+ * command's glob even when a consumer replaces `ignores`.
  *
  * @param {string} root - Repository to lint.
  * @param {object} [opts]

package/types/engine/readability-lint.d.mts

@@ -0,0 +1,22 @@
+/** Files in a content tree, excluding configured directory names. */
+export function proseFiles(root: any, skipDirectories?: any[]): any[];
+/** Source-aligned findings for one Markdown note. */
+export function analyzeProse(file: any, source: any, { age, threshold, minWords }?: {
+    age?: number | undefined;
+    threshold?: number | undefined;
+    minWords?: number | undefined;
+}): Promise<{
+    file: any;
+    line: any;
+    column: any;
+    severity: string;
+    message: string;
+}[]>;
+/** Analyze one note or the configured corpus without changing source files. */
+export function lintProse(root: any, options: any, skipDirectories?: any[]): Promise<{
+    file: any;
+    line: any;
+    column: any;
+    severity: string;
+    message: string;
+}[]>;

package/types/engine/reckoning-markers.d.mts

@@ -4,11 +4,12 @@
  *
  * @param {{notes?: readonly object[]}} index - The corpus link index.
  * @param {number} daysPerYear - The world's year length.
- * @returns {{markers: Map<string, object>, findings: object[]}} Resolved markers and errors.
+ * @returns {{eras: Map<string, object>, markers: Map<string, object>, findings: object[]}} Resolved eras, markers, and errors.
  */
 export function resolveReckoningMarkers(index: {
     notes?: readonly object[];
 }, daysPerYear: number): {
+    eras: Map<string, object>;
     markers: Map<string, object>;
     findings: object[];
 };
@@ -16,11 +17,12 @@ export function resolveReckoningMarkers(index: {
  * Read the world's year length and its era markers from one corpus index.
  *
  * @param {{notes?: readonly object[]}|undefined} index - The corpus index.
- * @returns {{markers: Map<string, object>, daysPerYear: number|undefined, findings: object[]}}
+ * @returns {{eras: Map<string, object>, markers: Map<string, object>, daysPerYear: number|undefined, findings: object[]}}
  */
 export function reckoningContext(index: {
     notes?: readonly object[];
 } | undefined): {
+    eras: Map<string, object>;
     markers: Map<string, object>;
     daysPerYear: number | undefined;
     findings: object[];

package/types/engine/schema-check.d.mts

@@ -159,7 +159,7 @@ export function compareEmittedSystem({ system, artifact, documentType, subtype,
  *
  * - **A system**: its own `schema.json`, generated from its `src/` into
  *   `build/` by `package-build schema`.
- * - **A module**: the copy cached by `content-build deps fetch`, from the
+ * - **A module**: the copy cached by `package-build deps fetch`, from the
  *   archive of the version it pins — which is what makes the comparison happen
  *   at `verified` rather than against whatever the system's `main` holds today.
  *   That distinction is the whole of the `affiliation.subType` case.
@@ -252,7 +252,7 @@ export function emittedUndeclaredMessage(finding: EmissionFinding): string;
  * version released before the artifact existed, or a subtype the artifact does
  * not name, produces no findings — the same stance `compareFields` takes, where
  * an unknown subtype is a routing question rather than a field one. The
- * whole-build check in `content-build lint` is where a missing artifact is said
+ * whole-build check in `package-build lint` is where a missing artifact is said
  * out loud, once, instead of per note.
  *
  * @param {object} fm - The note's frontmatter.
@@ -289,7 +289,7 @@ export function checkAuthoredSystemData(fm: object, { block, documentType, subTy
  * **Silent where there is nothing to check against**, exactly as its two
  * siblings are: a module pinning a system version released before the artifact
  * existed, or a subtype the artifact does not name, produces no findings.
- * `content-build lint` is where a missing artifact is said out loud, once.
+ * `package-build lint` is where a missing artifact is said out loud, once.
  *
  * @param {object} emitted - The `system` block the compiler produced.
  * @param {object} opts

package/types/engine/site-build.d.mts

@@ -16,11 +16,8 @@ export function collectContentPages(contentBase: string, ctx: object): {
 /**
  * The package's homepage notes — the authored page at `/<contentPackage>/`.
  *
- * A separate walk from {@link collectContentPages} rather than a branch inside
- * it, because in homepage-only mode it is the **whole** of the site build: the
- * content tree is never read for pages at all, so the licensing constraint two
- * packages ship under is a property of the code path rather than of a
- * configuration that happens to be empty.
+ * A separate collection from {@link collectContentPages} keeps the homepage
+ * at the package root and leaves content pages at their note addresses.
  *
  * Returned as a list rather than as the one note there should be, because the
  * count is what {@link checkHomepageCount} judges — this walk reports
@@ -28,8 +25,7 @@ export function collectContentPages(contentBase: string, ctx: object): {
  *
  * A homepage that declares no `shortcode` has no address, and is
  * reported rather than written: it is the same finding a content page's missing
- * shortcode produces, and it has to be available in homepage-only mode, where
- * no other gate runs.
+ * shortcode produces, and it is reported even when the tree has no other notes.
  *
  * **It is still counted.** An unaddressable homepage is a homepage — dropping
  * it from the list would make {@link checkHomepageCount} report a tree with one
@@ -50,13 +46,10 @@ export function collectHomepages(contentBase: string, ctx: object): {
  *
  * Its own writer, deliberately small. A homepage is authored markdown published
  * verbatim — no table expansion and no link resolution — so routing it through
- * {@link renderPages} would buy it a pipeline it has no input for, and would
- * make homepage-only mode depend on the index, the foreign manifests and the
- * table universe that mode exists to not build.
+ * {@link renderPages} would give it a pipeline it does not use.
  *
  * **Verbatim is the answer, not a gap.** A homepage's links could not be
- * *resolved* here without giving `homepage` mode the index its licensing fence
- * exists to not build, so they are **checked** instead:
+ * *resolved* here, so they are **checked** instead:
  * {@link auditHomepageLinks} reads the body's markdown links, and reports a
  * wikilink on the page rather than resolving one.
  *
@@ -69,8 +62,8 @@ export function collectHomepages(contentBase: string, ctx: object): {
  * both sides of the link graph: a content page reaches it through
  * `[[homepage-root|Text]]`, and its own markdown links name content pages. So
  * it carries the same `related` block every content page does — handed in by
- * the caller, since the graph is read off the content render and homepage-only
- * mode has none.
+ * the caller, since the graph is read off the content render and a tree with
+ * only a homepage has no such graph.
  *
  * @param {string} outRoot - The package's site root — the content mount's
  *   root, `build/hugo/content`, one level above the mount itself.
@@ -80,7 +73,7 @@ export function collectHomepages(contentBase: string, ctx: object): {
  * @param {object} [options] - Options.
  * @param {import("./related-pages.mjs").Related} [options.related] - The
  *   homepage's backlinks and mentions. Absent where nothing connects to it,
- *   and in homepage-only mode, where no link resolves.
+ *   and when the tree contains only a homepage, where no content link resolves.
  * @returns {number} How many pages were written.
  */
 export function writeHomepages(outRoot: string, pages: readonly object[], config: object, { related }?: {
@@ -109,10 +102,12 @@ export function writeHomepages(outRoot: string, pages: readonly object[], config
  *   collection.
  * @param {object} options
  * @param {object} options.config - The resolved build configuration.
+ * @param {object[]} options.records - Content-index records.
  * @returns {object} The gate results and, when they pass, the built index.
  */
 export function siteGates(pages: object[], findings: object, { config, records }: {
     config: object;
+    records: object[];
 }): object;
 /**
  * The gate result of a build that ran none of them.
@@ -125,8 +120,20 @@ export function siteGates(pages: object[], findings: object, { config, records }
  * @returns {object} An all-clear gate result.
  */
 export function emptyGates(): object;
-/** Whether any gate produced a finding. */
-export function gatesFailed(gates: any): boolean;
+/**
+ * Whether any gate produced a finding.
+ * @param {{homepages: unknown[], frontmatterLinks: unknown[],
+ *   addressErrors: unknown[], staleManifests: unknown[],
+ *   unaddressable: unknown[]}} gates - Results of the site checks.
+ * @returns {boolean} Whether at least one check found an error.
+ */
+export function gatesFailed(gates: {
+    homepages: unknown[];
+    frontmatterLinks: unknown[];
+    addressErrors: unknown[];
+    staleManifests: unknown[];
+    unaddressable: unknown[];
+}): boolean;
 /**
  * The universe a generated table searches, grouped by package.
  *
@@ -219,12 +226,14 @@ export function pageFrontmatter(page: object, { decorate, webSrc, artSrc }: {
  * `_index.md`, and the page's stated `url` keeps its address exactly where the
  * flat file's was.
  *
- * @param {object} page - The page.
+ * @param {{slug: string}} page - The page.
  * @param {object} [opts]
  * @param {boolean} [opts.bundle=false] - Whether the page carries a resource.
  * @returns {string} The file, relative to the mount.
  */
-export function pageDestination(page: object, { bundle }?: {
+export function pageDestination(page: {
+    slug: string;
+}, { bundle }?: {
     bundle?: boolean | undefined;
 }): string;
 /** Transform one content page without writing the site mount. */
@@ -240,22 +249,23 @@ export function renderSitePage(page: any, { index, foreign, universe, pass, deco
     artIndex: any;
 }): {
     page: any;
-    body: string;
+    body: any;
     data: object;
     resolved: any[];
-    tableErrors: {
-        source: string;
-        directive: string;
-        reason: string;
-        line: number;
-        column?: number;
-    }[];
+    tableErrors: object[];
+    expressionErrors: any[];
     secretErrors: {
         file: any;
         line: number;
         column: number;
         message: string;
     }[];
+    captionErrors: {
+        file: any;
+        line: any;
+        column: number;
+        message: string;
+    }[];
     wikiErrors: any[];
     imageErrors: any[];
 };
@@ -266,7 +276,7 @@ export function renderSitePage(page: any, { index, foreign, universe, pass, deco
  * compilers use:
  *
  * 1. **Tables expand first**, and outside code-fence protection. A table is
- *    authored as a fenced `dataview` block, which `protectCode` would otherwise
+ *    authored as a fenced `sql` block, which `protectCode` would otherwise
  *    stash away before the expander saw it. Expanding first leaves an ordinary
  *    markdown table to walk, with every other fence still protected.
  * 2. **Then, inside protection**: the consumer's `beforeLinks` pass, then

package/types/engine/site-config.d.mts

@@ -93,7 +93,7 @@ export function resolveThemesDir(rootDir: string): string;
  * @param {string} options.themesDir - From {@link resolveThemesDir}.
  * @returns {Record<string, any>} The configuration Hugo reads.
  * @throws {TypeError} When `homepage` fails `checkHomepage`, or the
- *   configuration declares no `packageBuild.manifest.title`, no
+ *   configuration declares no `site.title` or `packageBuild.manifest.title`, no
  *   `site.description`, or no `site.assets`.
  */
 export function hugoConfig({ config, navigation, themesDir }: {
@@ -133,7 +133,7 @@ export function writeHugoConfig(config: object, generated?: Record<string, unkno
 };
 /** The Hugo source directory, relative to the repository root. */
 export const HUGO_SOURCE: "build/hugo";
-/** The content mount `content-build site` writes, relative to the repository root. */
+/** The content mount `package-build site` writes, relative to the repository root. */
 export const HUGO_CONTENT: "build/hugo/content";
 /**
  * The directory that is deployed, relative to the repository root.

package/types/engine/site-index.d.mts

@@ -11,6 +11,8 @@
  *   `contentIndex: false` — a Foundry dependency only, with no fetched index.
  *   A link naming one fails naming the key, rather than reading as prose or an
  *   ordinary dead address.
+ * @param {object[]} [options.records] - Content-index records.
+ * @param {Map<string, object>} [options.foreignReferences] - Foreign reference targets.
  * @returns {SiteIndex} The index, and what could not be addressed unambiguously.
  */
 export function buildSiteIndex(entries: readonly SiteEntry[], { foreignIndex, noIndexPackages, package: builderPackage, records, foreignReferences, }?: {
@@ -19,6 +21,8 @@ export function buildSiteIndex(entries: readonly SiteEntry[], { foreignIndex, no
         type?: string;
     }> | undefined;
     noIndexPackages?: Set<string> | undefined;
+    records?: object[] | undefined;
+    foreignReferences?: Map<string, object> | undefined;
 }): SiteIndex;
 /**
  * The per-page context a wikilink resolver takes.

package/types/engine/site-preview.d.mts

@@ -24,7 +24,7 @@ export function prepareSitePreview({ config }?: {
         frontmatter?: undefined;
     } | {
         ok: boolean;
-        markdown: string;
+        markdown: any;
         frontmatter: any;
         findings: never[];
     }>;

package/types/engine/social-ties.d.mts

@@ -1,5 +1,11 @@
-/** Validate a being's map of defining relationships. */
-export function checkSocialTies(note: any, { index }?: {}): {
+/**
+ * Validate a being's map of defining relationships.
+ * @param {object} note
+ * @param {{index?: object}} [options]
+ */
+export function checkSocialTies(note: object, { index }?: {
+    index?: object;
+}): {
     message: string;
     severity: string;
     line?: number;

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

@@ -60,15 +60,20 @@ export function findSqlBlocks(markdown: string): Array<{
  * @param {string} [opts.dir] - Directory for the temporary file.
  * @param {Array<{id: string, file: string}>} [opts.dependencies] - Each
  *   declared dependency's cached index, attached as a schema named `id`.
+ * @param {object} [opts.addressContext] - Address resolution context.
+ * @param {"all"|"public"} [opts.audience] - Whether to exclude GM notes from
+ *   local and dependency relations.
  * @returns {Promise<{query: (sql: string) => Promise<object[]>,
  *   close: () => Promise<void>}>} The open database.
  */
-export function openNotesDatabase(records: object[], { dir, dependencies, addressContext }?: {
+export function openNotesDatabase(records: object[], { dir, dependencies, addressContext, audience }?: {
     dir?: string | undefined;
     dependencies?: {
         id: string;
         file: string;
     }[] | undefined;
+    addressContext?: object | undefined;
+    audience?: "all" | "public" | undefined;
 }): Promise<{
     query: (sql: string) => Promise<object[]>;
     close: () => Promise<void>;
@@ -106,6 +111,7 @@ export function runSqlQuery(db: object, sql: string): Promise<{
  * @param {(ref: string) => boolean} [opts.linkable] - Whether an address can be
  *   linked to; defaults to linking any non-empty `_ref`.
  * @param {number} [opts.sectionLevel=2] - Heading level for `_section`.
+ * @param {object} [opts.addressContext] - Address resolution context.
  * @returns {string} The markdown.
  */
 export function renderSqlTable(result: {
@@ -114,6 +120,7 @@ export function renderSqlTable(result: {
 }, { linkable, sectionLevel, addressContext }?: {
     linkable?: ((ref: string) => boolean) | undefined;
     sectionLevel?: number | undefined;
+    addressContext?: object | undefined;
 }): string;
 /**
  * Run every `sql` directive in a set of note bodies, ahead of expansion.
@@ -150,6 +157,8 @@ export function prepareSqlTables(db: object, sources: Array<{
 }>, { linkable }?: {
     linkable?: ((ref: string) => boolean) | undefined;
 }): Promise<Map<string, object[]>>;
+/** Evaluate scalar SQL calls before synchronous Markdown renderers run. */
+export function prepareInlineSqlExpressions(db: any, sources: any): Promise<Map<any, any>>;
 /**
  * Answer every `sql` directive in a content tree.
  *
@@ -170,13 +179,15 @@ export function prepareSqlTables(db: object, sources: Array<{
  * @param {object[]} [opts.records] - Index records the caller already derived.
  *   A command that also builds a link index holds them already, and deriving
  *   them twice is the duplicated-corpus failure this closes.
+ * @param {"all"|"public"} [opts.audience] - Whether to exclude GM notes.
  * @returns {Promise<Map<string, object[]>|undefined>} Results by note path, or
  *   nothing when the tree has no such directive.
  */
-export function prepareTreeSqlTables(contentBase: string, { config, skipDirectories, records }?: {
+export function prepareTreeSqlTables(contentBase: string, { config, skipDirectories, records, audience }?: {
     config?: object | undefined;
     skipDirectories?: readonly string[] | undefined;
     records?: object[] | undefined;
+    audience?: "all" | "public" | undefined;
 }): Promise<Map<string, object[]> | undefined>;
 /**
  * Aliases the renderer reads rather than printing.

package/types/engine/web-wikilinks.d.mts

@@ -86,7 +86,8 @@ export function frontmatterWikilinks(fm: unknown): Array<{
  *
  * @param {string} body - The markdown body.
  * @param {object} ctx - `{ index, assets, collide, contentTypes,
- *   packages, noIndexPackages, foreign, type, errors, src, file, resolved }`.
+ *   packages, noIndexPackages, foreign, type, errors, src, file, resolved,
+ *   output }`. `output` is `"book"` for PDF Markdown and defaults to HTML.
  *   `packages` is every package an address may name, without which the leading
  *   package segment of a canonical address reads as an unknown type;
  *   `noIndexPackages` is every package declared `contentIndex: false`, so a

package/types/engine/wikilinks.d.mts

@@ -39,6 +39,8 @@ export function anchorPageId(noteId: string, anchorSlug: string): string;
  *   `contentIndex: false` — a Foundry dependency only. A link naming one fails
  *   with `no-content-index` rather than resolving, ambiguously, as either a
  *   typo or an undeclared package.
+ * @param {Map<string, object>} [opts.referenceTargets] - Local reference targets.
+ * @param {Map<string, object>} [opts.foreignReferences] - Foreign reference targets.
  * @returns {{byShortcode: Map<string, object>, types: Set<string>}} `types` is
  *   every type the tree actually contains, so a qualifier naming no real type
  *   can be told apart from a missing target.
@@ -55,6 +57,8 @@ export function buildWikilinkIndex(docs: Array<{
 }>, packageId: string, foreign?: Map<string, object>, contentPackage?: string, { assets, noIndexPackages, referenceTargets, foreignReferences }?: {
     assets?: Map<string, object> | undefined;
     noIndexPackages?: Set<string> | undefined;
+    referenceTargets?: Map<string, object> | undefined;
+    foreignReferences?: Map<string, object> | undefined;
 }): {
     byShortcode: Map<string, object>;
     types: Set<string>;
@@ -86,6 +90,7 @@ export function buildWikilinkIndex(docs: Array<{
  *   entry landed in.
  * @param {{byShortcode: Map, types: Set}} ctx.index - From
  *   {@link buildWikilinkIndex}.
+ * @param {Map<string, string>} [ctx.captionLabels] - Numbered caption references.
  * @returns {{markdown: string, unresolved: Array<{link: string, target: string,
  *   offset: number, reason: string, packages?: string[], anchor?: string}>}}
  *   Each `reason` is one of {@link LINK_FINDING_REASONS}, the vocabulary all
@@ -94,7 +99,7 @@ export function buildWikilinkIndex(docs: Array<{
  *   position in `markdown`, which is what lets a caller report the line and
  *   column it sits on.
  */
-export function convertWikilinks(markdown: string, { type, id, pack, docPack, index }: {
+export function convertWikilinks(markdown: string, { type, id, pack, docPack, index, captionLabels }: {
     type: string;
     id: string;
     pack?: string | undefined;
@@ -103,6 +108,7 @@ export function convertWikilinks(markdown: string, { type, id, pack, docPack, in
         byShortcode: Map<any, any>;
         types: Set<any>;
     };
+    captionLabels?: Map<string, string> | undefined;
 }): {
     markdown: string;
     unresolved: Array<{

package/types/hm3/items.d.mts

@@ -2,7 +2,7 @@
  * HM3's Item compile pass.
  *
  * Declares HM3's note-type → document-subtype map, which decides the notes this
- * pass claims and what each becomes, the one `system` key HM3 writes from prose,
+ * pass claims and what each becomes, the one `system` key HM3 writes as a page pointer,
  * and the template-priority flag HM3's data model has no field for. Everything
  * else is {@link module:engine/item-compiler}'s.
  */
@@ -15,16 +15,15 @@ export class Hm3Items extends SystemItemCompiler {
      */
     static documentSubtypes: import("../engine/document-subtypes.mjs").DocumentSubtypeMap;
     /**
-     * The `system.*` field HM3 writes on an item from the note's prose.
+     * The `system.*` field HM3 writes from the shared item-doc pointer.
      *
      * @param {object} fm - The note's frontmatter.
      * @param {object} at - What the pass already knows about this note.
-     * @param {string} at.markdown - The note body, tables expanded and
-     *   wikilinks resolved.
+     * @param {string} at.description - The resolved JournalEntryPage pointer.
      * @returns {object} The shared `system` fields — `description`, or nothing.
      */
-    commonSystem(fm: object, { markdown }: {
-        markdown: string;
+    commonSystem(fm: object, { description }: {
+        description: string;
     }): object;
 }
 import { SystemItemCompiler } from "../engine/item-compiler.mjs";

package/types/labels.d.mts

@@ -0,0 +1,40 @@
+/**
+ * The label names the documented §3 table lists.
+ *
+ * A registry row is a table row whose first cell is a backticked label name,
+ * which is narrow on purpose: §3 carries prose and other tables, and a looser
+ * match would read a heading or an example as a label.
+ *
+ * @param {string} text - The documentation file's contents.
+ * @returns {{names: Set<string>, found: boolean}} The names, and whether §3 was
+ *   located at all — an absent section is a different failure from an empty one.
+ */
+export function documentedLabels(text: string): {
+    names: Set<string>;
+    found: boolean;
+};
+/**
+ * Check the machine registry against the documented table.
+ *
+ * Findings are returned per file rather than merged, because each names a
+ * position in a different document and the caller reports them against the
+ * file they belong to.
+ *
+ * @param {object} sources
+ * @param {string} sources.registryText - `.github/labels.yml`.
+ * @param {string} sources.docText - `.github/ISSUE_REPORTING.md`.
+ * @param {string} [sources.docPath] - The doc's path, for the message naming it.
+ * @returns {{registry: object[], doc: object[], count: number}} Findings for
+ *   each file, and how many labels the registry declares.
+ */
+export function checkLabelRegistry({ registryText, docText, docPath, }: {
+    registryText: string;
+    docText: string;
+    docPath?: string | undefined;
+}): {
+    registry: object[];
+    doc: object[];
+    count: number;
+};
+/** GitHub rejects a label description beyond this with a 422. */
+export const MAX_DESCRIPTION: 100;

package/types/manifest.d.mts

@@ -177,7 +177,7 @@ export function packFolderFindings({ packFolders, packs }: {
  * unread: a key Foundry adds later should not need a release of this package.
  *
  * @param {Record<string, unknown>} relationships - The declared block, as
- *   content-build resolved it.
+ *   package-build resolved it.
  * @returns {Record<string, unknown>} It, without the build-only keys.
  */
 export function publishedRelationships(relationships: Record<string, unknown>): Record<string, unknown>;
@@ -271,7 +271,7 @@ export const HOMEPAGE_ORIGIN: string;
  * package.
  *
  * `relationships` is the one manifest block with a second reader.
- * `@heroiclands/content-build` consumes it too, and v1.8.0 added
+ * `@heroiclands/package-build` consumes it too, and v1.8.0 added
  * `itemCatalog: true` as an opt-in on a declared dependency: it selects that
  * package's Item packs as a resolution
  * source for the actors pass. That is an instruction to the build, not a fact
@@ -286,7 +286,7 @@ export const HOMEPAGE_ORIGIN: string;
  * unlikely to be the last.
  *
  * A list is enough, and needs no prefix agreed between the two packages,
- * because the input is already closed: content-build normalises a relationship
+ * because the input is already closed: package-build normalises a relationship
  * to `id`, `type`, `manifest`, `compatibility` and its own build keys, and
  * rejects anything else at configuration time. A key that reaches here is one
  * the toolchain itself put there.

package/types/sohl/actors.d.mts

@@ -49,7 +49,7 @@ export class Actors extends SystemActorCompiler {
      */
     openUnopenedSkills(items: object[], ctx: string): void;
     buildBeing(itemsMap: any, fm: any, body: any): {
-        name: any;
+        name: string;
         type: string;
         img: string;
         _id: any;
@@ -61,7 +61,7 @@ export class Actors extends SystemActorCompiler {
         };
         items: object[];
         prototypeToken: {
-            name: any;
+            name: string;
             displayName: number;
             actorLink: boolean;
             texture: {