@heroiclands/package-build 22.14.3 → 22.15.0

package/types/engine/note-dates.d.mts

@@ -18,6 +18,10 @@
  *   the value is written in, as its note declares it. Its ordered month list
  *   bounds a written month and a written day, the day against the length of
  *   the month it names. A calendar that declares no list bounds nothing.
+ * @param {Map<string, object>} [options.markers] - Resolved era markers from
+ *   the corpus, each carrying its calendar and canonical start.
+ * @param {number} [options.daysPerYear] - The world's year length, required for
+ *   canonical days and marked dates.
  * @param {string} [options.field] - The key that carried it, named in every
  *   message. Omitted, a message names the value alone.
  * @param {boolean} [options.allowUnknown=true] - Whether `"unknown"` is a
@@ -34,6 +38,8 @@ export function parseNoteDate(value: unknown, options?: {
     calendar?: {
         months?: readonly object[] | null;
     } | undefined;
+    markers?: Map<string, object> | undefined;
+    daysPerYear?: number | undefined;
     field?: string | undefined;
     allowUnknown?: boolean | undefined;
     file?: string | undefined;

package/types/engine/note-vocabulary.d.mts

@@ -278,15 +278,15 @@ export type DataFieldSpec = {
      * value — which is the honest answer wherever the specification's stated
      * shape and the shape notes are authored in today disagree.
      */
-    kind?: "string" | "number" | "boolean" | "map" | "list" | "shortcode" | "scalar-or-map" | "address" | undefined;
+    kind?: "string" | "number" | "boolean" | "map" | "address" | "list" | "shortcode" | "scalar-or-map" | undefined;
     /**
      * - Type of each list or pack-map value.
      */
-    entryKind?: "shortcode" | "address" | undefined;
+    entryKind?: "address" | "shortcode" | undefined;
     /**
      * - Type of each map key.
      */
-    keyKind?: "shortcode" | "address" | undefined;
+    keyKind?: "address" | "shortcode" | undefined;
     /**
      * - An alternative `subType:<skill-subtype>` key.
      */

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

@@ -209,9 +209,11 @@ export function bookTypstPreamble(): string;
  *   declared it → the staged file's path, relative to the `.typ`. A declared
  *   banner this map does not carry has no file the compiler can open, so the
  *   plate draws without a picture.
+ * @param {Map<string, {path: string, title: string}>} [opts.maps] - An entry
+ *   anchor to its SVG path and page heading. Each map takes a page after its entry.
  * @returns {string} A complete `.typ` document.
  */
-export function renderBook({ plan, bodies, title, subtitle, front, fonts, version, preamble, banners, }?: {
+export function renderBook({ plan, bodies, title, subtitle, front, fonts, version, preamble, banners, maps, }?: {
     plan: object;
     bodies: Map<string, string>;
     title: string;
@@ -221,6 +223,10 @@ export function renderBook({ plan, bodies, title, subtitle, front, fonts, versio
     version?: string | undefined;
     preamble?: string | undefined;
     banners?: Map<string, string> | undefined;
+    maps?: Map<string, {
+        path: string;
+        title: string;
+    }> | undefined;
 }): string;
 /**
  * Point every internal link at a label the document actually declares.
@@ -252,3 +258,12 @@ export function resolveDanglingLabels(source: string, findings?: object[]): stri
  * @returns {string[]} The names, in order of appearance, with repeats.
  */
 export function iconNamesIn(markdown: string): string[];
+/** Requested print width for every named image size. */
+export const BOOK_IMAGE_WIDTHS: Readonly<{
+    auto: "auto";
+    small: "1.6cm";
+    medium: "3.2cm";
+    large: "5.6cm";
+    xlarge: "8cm";
+    "full-width": "\"full-width\"";
+}>;

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

@@ -0,0 +1,27 @@
+/**
+ * Resolve every declared reckoning marker against its calendar and era start.
+ * The marker names one era, while the calendar supplies the month layout.
+ *
+ * @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.
+ */
+export function resolveReckoningMarkers(index: {
+    notes?: readonly object[];
+}, daysPerYear: number): {
+    markers: Map<string, object>;
+    findings: object[];
+};
+/**
+ * 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[]}}
+ */
+export function reckoningContext(index: {
+    notes?: readonly object[];
+} | undefined): {
+    markers: Map<string, object>;
+    daysPerYear: number | undefined;
+    findings: object[];
+};

package/types/engine/scenes.d.mts

@@ -23,7 +23,7 @@ export function collectKnownActionNames(repoRoot: string): Set<string>;
  * scene's id-based references resolve on import.
  */
 export class Scenes extends BasePackCompiler {
-    constructor({ contentBase, assetsBase, dest, skipDirectories, companionDests, folderResolver, repoRoot, }: {
+    constructor({ contentBase, assetsBase, dest, skipDirectories, companionDests, folderResolver, repoRoot, config, packName, bundleSourceDirs, corpus, }: {
         contentBase: any;
         assetsBase: any;
         dest: any;
@@ -31,6 +31,10 @@ export class Scenes extends BasePackCompiler {
         companionDests?: {} | undefined;
         folderResolver?: (() => null) | undefined;
         repoRoot?: string | undefined;
+        config: any;
+        packName: any;
+        bundleSourceDirs?: {} | undefined;
+        corpus: any;
     });
     /** @type {string} */
     adventureDir: string;
@@ -40,6 +44,9 @@ export class Scenes extends BasePackCompiler {
      * @type {number}
      */
     adventureCount: number;
+    mapConfig: any;
+    packName: any;
+    journalSourceDirs: any;
     index: Map<string, object> | undefined;
     effectsByAddress: Map<string, object> | undefined;
     knownActions: Set<string> | undefined;
@@ -51,7 +58,7 @@ export class Scenes extends BasePackCompiler {
      *
      * @returns {Promise<void>}
      */
-    finish(): Promise<void>;
+    finish(stats: any): Promise<void>;
     /** @inheritdoc */
     reportCompiled(stats: any): void;
     #private;

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

@@ -338,18 +338,14 @@ export function sitePageDecorator(config: any, index: any): (data: any, page: an
  *   {@link module:engine/sql-tables.prepareSqlTables}. A page authoring an
  *   `sql` directive with none prepared is a table error: nothing here runs a
  *   query.
- * @param {(engine: string) => string|undefined} [options.locate] - How a
- *   GraphViz engine's binary is found, for the maps; the real lookup by
- *   default.
  * @returns {{gates: object, stats: object|null, tableErrors: object[],
  *   wikiErrors: object[], imageErrors: object[], mapFindings: object[],
  *   manifests: object|null}} `mapFindings` is what drawing the maps found —
  *   warnings, never a reason to fail the build.
  */
-export function buildSite({ config, sqlTables, locate }?: {
+export function buildSite({ config, sqlTables }?: {
     config?: object | undefined;
     sqlTables?: Map<string, object[]> | undefined;
-    locate?: ((engine: string) => string | undefined) | undefined;
 }): {
     gates: object;
     stats: object | null;

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

@@ -34,21 +34,16 @@ export function inlineSvg(svg: string): string;
  * @param {object} opts.config - The resolved configuration.
  * @param {string} opts.base - The site base every page is served under,
  *   ending in a slash: what every name in a drawing links through.
- * @param {(engine: string) => string|undefined} [opts.locate] - How the
- *   engine's binary is found; the real lookup by default.
  * @returns {{maps: Map<string, SiteMap>, findings: Array<{file: string,
  *   line?: number, column?: number, severity: "error"|"warning",
  *   message: string}>}} The drawings, keyed by the URL of the page each
- *   belongs to, and what the drawing found — one warning naming what to
- *   install when GraphViz is absent, and a warning for each relation that
- *   names no place.
+ *   belongs to, and warnings for relations that name no place.
  */
-export function drawSiteMaps({ records, foreignIndex, config, base, locate }: {
+export function drawSiteMaps({ records, foreignIndex, config, base }: {
     records: Array<Record<string, any>>;
     foreignIndex: Map<string, object>;
     config: object;
     base: string;
-    locate?: ((engine: string) => string | undefined) | undefined;
 }): {
     maps: Map<string, SiteMap>;
     findings: Array<{

package/types/engine/social-tie-terms.d.mts

@@ -3,3 +3,5 @@ export const SOCIAL_TIES: readonly {
     term: string;
     meaning: string;
 }[];
+/** The note types a being can name as a social tie. */
+export const SOCIAL_TIE_TARGET_TYPES: readonly string[];

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

@@ -6,5 +6,6 @@ export function checkSocialTies(note: any, { index }?: {}): {
     column?: number;
     file: any;
 }[];
-export { SOCIAL_TIES };
 import { SOCIAL_TIES } from "./social-tie-terms.mjs";
+import { SOCIAL_TIE_TARGET_TYPES } from "./social-tie-terms.mjs";
+export { SOCIAL_TIES, SOCIAL_TIE_TARGET_TYPES };