@heroiclands/package-build 22.8.0 → 22.9.0

package/engine/calendars.mjs

@@ -52,14 +52,23 @@
  * and off by one on the other, which is invisible in any list that does not
  * span it.
  *
- * ## The month structure is the package's, and an absent bound checks nothing
+ * ## The month structure is the calendar's, and an absent list bounds nothing
  *
- * An era moves where year 1 sits; it does not divide the year differently. So
- * the subdivision is declared once for the package, in `calendar.months` and
- * `calendar.monthDays`, and a package that declares neither is bounded below
- * and not above — a toolchain that invented twelve Gregorian months would
- * refuse `667/2/30`, which is an ordinary date in a year of twelve thirty-day
- * months.
+ * An era moves where year 1 sits; it does not divide the year differently. The
+ * division belongs to the calendar, which is a note declaring an **ordered
+ * list** of months, each with a name and a day count. Position in the list is
+ * position in the year, so a five-day month sits wherever its people put it and
+ * needs no rule of its own.
+ *
+ * A date is bounded by the calendar it is written in, and a calendar whose list
+ * nobody has written down bounds nothing — a toolchain that invented twelve
+ * Gregorian months would refuse `667/2/30`, an ordinary date in a year of
+ * twelve thirty-day months.
+ *
+ * ## The lunar phase takes a floored modulo, not JavaScript's
+ *
+ * `%` takes the dividend's sign, so a day before the epoch yields `-7` where
+ * the phase is 23. {@link lunarPhase} is the one place that is written.
  *
  * @module
  */
@@ -118,15 +127,107 @@ export function dateSortKey(year, month, day) {
 }
 
 /**
- * The bounds a package states for a month, or `null` where it states none.
+ * One month of a calendar, as the note declares it.
  *
- * Separate from the check that reads it so a caller can ask what a package
- * declares without phrasing a finding about it.
+ * @typedef {object} CalendarMonth
+ * @property {string} name - What the month is called.
+ * @property {string} [abbreviation] - A short form, where the note gives one.
+ * @property {number} days - How many days it holds.
+ */
+
+/**
+ * The months a calendar keeps, or `null` where it declares none.
+ *
+ * Separate from the check that reads it so a caller can ask what a calendar
+ * divides its year into without phrasing a finding about it. An empty list
+ * reads as no list: a calendar that declares nothing and one that declares
+ * nothing in a pair of brackets divide the year identically.
  *
- * @param {{months?: number|null, monthDays?: number|null}} [calendar] - The
- *   resolved `calendar:` block.
- * @returns {{months: number|null, monthDays: number|null}} What it declares.
+ * @param {{months?: readonly CalendarMonth[]|null}} [calendar] - The calendar
+ *   the date is written in, as its note declares it.
+ * @returns {{months: readonly CalendarMonth[]|null}} What it divides the year
+ *   into.
  */
 export function calendarStructure(calendar) {
-    return { months: calendar?.months ?? null, monthDays: calendar?.monthDays ?? null };
+    const written = calendar?.months;
+    if (!Array.isArray(written) || written.length === 0) return { months: null };
+    return { months: written };
+}
+
+/**
+ * How long one month of a calendar is, or `null` where the calendar is silent.
+ *
+ * @param {{months?: readonly CalendarMonth[]|null}} [calendar] - The calendar.
+ * @param {number} month - The month, numbered from 1.
+ * @returns {number|null} Its length in days, or `null`.
+ */
+export function daysInMonth(calendar, month) {
+    const { months } = calendarStructure(calendar);
+    if (!months || month < 1 || month > months.length) return null;
+    const days = months[month - 1]?.days;
+    return typeof days === "number" ? days : null;
+}
+
+/**
+ * How many days the months add up to.
+ *
+ * The number a calendar's list claims the year is. Whether that is the year the
+ * world keeps is a question about the world, and is asked elsewhere.
+ *
+ * @param {readonly CalendarMonth[]} months - The ordered month list.
+ * @returns {number} The sum of their day counts.
+ */
+export function daysInYear(months) {
+    return months.reduce((sum, month) => sum + (Number(month?.days) || 0), 0);
+}
+
+/**
+ * The day of the year each month opens on, in order, numbered from 1.
+ *
+ * The sum read as a sequence rather than as a total. Two lists holding the same
+ * numbers in a different order sum alike and open their months on different
+ * days, which is the error a total cannot see.
+ *
+ * @param {readonly CalendarMonth[]} months - The ordered month list.
+ * @returns {number[]} One entry per month: the day of the year it begins on.
+ */
+export function monthStarts(months) {
+    const starts = [];
+    let day = 1;
+    for (const month of months) {
+        starts.push(day);
+        day += Number(month?.days) || 0;
+    }
+    return starts;
+}
+
+/**
+ * Which day of the year a written month and day land on, numbered from 1.
+ *
+ * @param {readonly CalendarMonth[]} months - The ordered month list.
+ * @param {number} month - The month, numbered from 1.
+ * @param {number} day - The day within it, numbered from 1.
+ * @returns {number} The day of the year.
+ */
+export function dayOfYear(months, month, day) {
+    return monthStarts(months)[month - 1] + day - 1;
+}
+
+/**
+ * How far into its cycle a moon is on a given day.
+ *
+ * **Floored, not truncated.** JavaScript's `%` takes the dividend's sign, so a
+ * day seven before the epoch yields `-7` where the phase is 23 — a value that
+ * is right on one side of the epoch and wrong on the other, which is invisible
+ * in any list that does not span it.
+ *
+ * @param {number} dayNumber - The day, on whatever continuous day count the
+ *   caller keeps.
+ * @param {number} epochDay - The day of that same count on which the moon was
+ *   new.
+ * @param {number} cycle - The cycle's length in days.
+ * @returns {number} Days into the cycle, `0` to `cycle - 1`.
+ */
+export function lunarPhase(dayNumber, epochDay, cycle) {
+    return (((dayNumber - epochDay) % cycle) + cycle) % cycle;
 }

package/engine/index.mjs

@@ -130,6 +130,9 @@ export * as calendars from "./calendars.mjs";
 /** A note's dates: one authored string, one grammar, one record shape. */
 export * as noteDates from "./note-dates.mjs";
 
+/** Calendars as notes: what one may declare, and the definition emitted from it. */
+export * as calendarNotes from "./calendar-notes.mjs";
+
 /** The one normalisation this build makes: prose to a URL-safe token. */
 export * as contentSlug from "./content-slug.mjs";
 

package/engine/note-dates.mjs

@@ -27,9 +27,9 @@
  *   `-1` sits immediately before `1`.
  * - `YYYY` — required.
  * - `MM`, `DD` — optional, in that order.
- * - `ERA` — an affiliation's address plus `.<era shortcode>`, in the four
- *   address forms {@link ERA_QUALIFIER_PATTERN} admits. Omitted, the date sits
- *   on the canonical axis and is attributed to nobody.
+ * - `ERA` — a calendar's address plus `.<era shortcode>`, in the four address
+ *   forms {@link ERA_QUALIFIER_PATTERN} admits. Omitted, the date sits on the
+ *   canonical axis and is attributed to nobody.
  *
  * **Precision falls out of how much is written.** `-984` is a year, `689/6` a
  * month, `689/6/19` a day. There is no precision vocabulary, so there is
@@ -98,7 +98,7 @@
  */
 
 import { ADDRESS_SEGMENT_PATTERN } from "./address-charset.mjs";
-import { calendarStructure, canonicalYear, dateSortKey } from "./calendars.mjs";
+import { calendarStructure, canonicalYear, dateSortKey, daysInMonth } from "./calendars.mjs";
 import { positionOfFrontmatterPath } from "./diagnostics.mjs";
 
 /**
@@ -120,7 +120,7 @@ const ERA = `(?:${SEGMENT}-){0,3}${SEGMENT}\\.${SEGMENT}`;
 /**
  * What a date's trailing token may look like.
  *
- * An affiliation's address followed by `.<era shortcode>`. The `{0,3}`
+ * A calendar note's address followed by `.<era shortcode>`. The `{0,3}`
  * repetition is the four address forms exactly — bare `shortcode`,
  * `type-shortcode`, `system-type-shortcode` and
  * `package-system-type-shortcode` — so the hyphen separates an address's
@@ -182,9 +182,10 @@ function unknownRecord() {
  * @param {unknown} value - The authored value. A number is what YAML hands
  *   back for a bare year, so it is accepted and stringified.
  * @param {object} [options]
- * @param {{months?: number|null, monthDays?: number|null}} [options.calendar]
- *   The resolved `calendar:` block, whose `months` and `monthDays` bound a
- *   written month and day. An absent bound is not applied.
+ * @param {{months?: readonly object[]|null}} [options.calendar] - The calendar
+ *   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 {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
@@ -246,7 +247,7 @@ export function parseNoteDate(value, options) {
         if (MALFORMED_ERA_PATTERN.test(trimmed)) {
             return refuse(
                 `${subject} — an era is written ` +
-                    `\`<affiliation shortcode>.<era shortcode>\`, lowercase letters ` +
+                    `\`<calendar shortcode>.<era shortcode>\`, lowercase letters ` +
                     `and digits only`,
             );
         }
@@ -256,14 +257,14 @@ export function parseNoteDate(value, options) {
             // the rule rather than guessing a concrete replacement.
             return refuse(
                 `${subject} names no era — a reckoning is written ` +
-                    `\`<affiliation shortcode>.<era shortcode>\`: a year before ` +
+                    `\`<calendar shortcode>.<era shortcode>\`: a year before ` +
                     `an era's epoch is written negative, and a year after it ` +
                     `simply drops the token`,
             );
         }
         return refuse(
             `${subject} is not a date — write ` +
-                `\`[~][-]YYYY[/MM[/DD]] [<affiliation shortcode>.<era shortcode>]\`: ` +
+                `\`[~][-]YYYY[/MM[/DD]] [<calendar shortcode>.<era shortcode>]\`: ` +
                 `a year, negative where it falls before the epoch it is counted ` +
                 `from, optionally a month and a day, and an era where the date is a ` +
                 `reckoning somebody kept`,
@@ -285,26 +286,31 @@ export function parseNoteDate(value, options) {
         );
     }
 
-    const { months, monthDays } = calendarStructure(calendar);
+    const { months } = calendarStructure(calendar);
     if (month !== null && month < 1) {
         return refuse(`${subject} writes month ${month}, and a month is numbered from 1`);
     }
-    // An upper bound is checked only where the package states one. Twelve
-    // Gregorian months assumed here would refuse `667/2/30`, which is a correct
-    // date in a year of twelve thirty-day months.
-    if (month !== null && months !== null && month > months) {
+    // An upper bound is checked only where the calendar states its months.
+    // Twelve Gregorian months assumed here would refuse `667/2/30`, which is a
+    // correct date in a year of twelve thirty-day months.
+    if (month !== null && months !== null && month > months.length) {
         return refuse(
-            `${subject} writes month ${month}, and \`calendar.months\` declares a ` +
-                `year of ${months}`,
+            `${subject} writes month ${month}, and the calendar it is written in ` +
+                `keeps ${months.length} months`,
         );
     }
     if (day !== null && day < 1) {
         return refuse(`${subject} writes day ${day}, and a day is numbered from 1`);
     }
-    if (day !== null && monthDays !== null && day > monthDays) {
+    // Per month, because the months differ: a five-day month sits in the list
+    // wherever its people put it, and a bound taken from the longest month
+    // would accept a date that calendar has no day for.
+    const length = month !== null ? daysInMonth(calendar, month) : null;
+    if (day !== null && length !== null && day > length) {
+        const named = months?.[month - 1]?.name;
         return refuse(
-            `${subject} writes day ${day}, and \`calendar.monthDays\` declares a ` +
-                `month of ${monthDays}`,
+            `${subject} writes day ${day}, and ${named ? `${named}` : `month ${month}`} ` +
+                `is ${length} days long`,
         );
     }
 

package/engine/note-vocabulary.mjs

@@ -85,6 +85,12 @@ import { currentType } from "./ids.mjs";
 // What a place is next to and reachable from — the two relation lists and
 // the checks that hold them to their closed sets and to each other.
 import { checkBorders, checkRoutes } from "./place-relations.mjs";
+import {
+    CALENDAR_FIELDS,
+    INVARIANT_FIELDS,
+    checkCalendarNote,
+    checkWorldFacts,
+} from "./calendar-notes.mjs";
 import { checkHeld } from "./holdings.mjs";
 import { checkCitedPopulations, checkPopulation } from "./populations.mjs";
 // What trade a settlement supports — the scale and the check that holds a
@@ -306,6 +312,22 @@ const CHARGES = Object.freeze([
     { name: "charges.max", ...NUM, describe: "Most charges it can hold; unset means no maximum." },
 ]);
 
+/**
+ * Everything `place` asks of a whole note.
+ *
+ * Two questions about one subject, and they are independent: who holds this
+ * land, and — where the note is a body rather than somewhere within one — what
+ * the body states about itself. A type declares one whole-note check, so the
+ * two are composed here rather than either being folded into the other.
+ *
+ * @param {object} note - The note.
+ * @param {object} [opts] - The lint's options, passed through unchanged.
+ * @returns {object[]} Findings from both.
+ */
+function checkPlace(note, opts) {
+    return [...checkHeld(note, opts), ...checkWorldFacts(note, opts)];
+}
+
 /* --------------------------------------------------------------------- */
 /*  The vocabulary                                                        */
 /* --------------------------------------------------------------------- */
@@ -1044,16 +1066,27 @@ export const NOTE_VOCABULARY = Object.freeze({
             "bestiary",
             "gathering",
         ]),
-        // Nothing of its own: a lore note is prose, and what it *is* about is
-        // its subType. The specification declares an empty table for it, and
-        // the authored corpus writes no `data:` key on any of the 180.
-        data: Object.freeze([]),
+        // A lore note is prose, and what it *is* about is its subType — with
+        // one exception. A calendar is a division of the year, and a division
+        // is data; the check scopes the family to the subType that means it,
+        // because `DataFieldSpec` declares the keys a type accepts and not the
+        // subType that may write them.
+        check: checkCalendarNote,
+        data: CALENDAR_FIELDS,
     }),
 
     place: Object.freeze({
         stubbable: true,
-        subTypes: Object.freeze(["world", "region", "settlement", "site", "structure", "feature"]),
-        check: checkHeld,
+        subTypes: Object.freeze([
+            "world",
+            "region",
+            "settlement",
+            "site",
+            "structure",
+            "feature",
+            "celestial",
+        ]),
+        check: checkPlace,
         data: Object.freeze([
             {
                 name: "demonym",
@@ -1104,6 +1137,10 @@ export const NOTE_VOCABULARY = Object.freeze({
                     "Journeys from this place's centre — where the destination lies, how " +
                     "it is travelled, and about how many days it takes.",
             },
+            // What a body states about itself: its size, its year, its moon.
+            // Legal on a `world` or a `celestial` and nowhere else, which the
+            // type's own check is what enforces.
+            ...INVARIANT_FIELDS,
         ]),
     }),
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@heroiclands/package-build",
-    "version": "22.8.0",
+    "version": "22.9.0",
     "description": "Shared toolchain for building and shipping a HeroicLands Foundry VTT package — content compilation, manifest, localization, staging, bundle, release and deployment.",
     "license": "GPL-3.0-or-later",
     "type": "module",

package/types/content-config.d.mts

@@ -844,16 +844,6 @@ export type ContentBuildConfig = {
      * each pack followed by its companions.
      */
     packDirectories: readonly string[];
-    /**
-     *                                     How this package's year is divided, and
-     *                                     the date it calls the present. Every
-     *                                     value `null` when none is declared.
-     */
-    calendar: Readonly<{
-        months: number | null;
-        monthDays: number | null;
-        present: string | null;
-    }>;
     /**
      * Passed through
      * frozen, uninterpreted. `{}` when absent.

package/types/engine/calendar-notes.d.mts

@@ -0,0 +1,173 @@
+/**
+ * The world facts a package declares, read from its own notes.
+ *
+ * Nothing here is configured and nothing is assumed: a package with no world
+ * note has no year, and every question that depends on one goes unasked.
+ *
+ * @param {object} [index] - The link index, holding every note in the package.
+ * @returns {{year: object|null, present: unknown, moon: object|null,
+ *   body: object|null, moonName: string|null, yearNote: object|null,
+ *   moonNote: object|null}} What the package's notes state.
+ */
+export function worldInvariants(index?: object): {
+    year: object | null;
+    present: unknown;
+    moon: object | null;
+    body: object | null;
+    moonName: string | null;
+    yearNote: object | null;
+    moonNote: object | null;
+};
+/**
+ * Check a `place` note's world facts.
+ *
+ * Declared on `place` beside its tenure check, so the lint runs both with the
+ * same index. Four rules, and each is a fact about the setting rather than
+ * about the file:
+ *
+ * - a world fact is written on a body — a `world` or a `celestial` — and
+ *   nowhere else;
+ * - a package states **one** year, because two years is two settings and
+ *   nothing can choose between them;
+ * - a package states **one** moon, for the same reason;
+ * - a moon with no year is refused, because a cycle measured in days has
+ *   nothing to be measured against.
+ *
+ * `data.present` is read through the parser a note's dates go through, with the
+ * corpus in hand, so a present written in an era resolves where it is written.
+ *
+ * @param {object} note - The note, as the link index hands it over.
+ * @param {object} [opts]
+ * @param {object} [opts.index] - The link index, holding every note.
+ * @returns {object[]} Findings.
+ */
+export function checkWorldFacts(note: object, { index }?: {
+    index?: object | undefined;
+}): object[];
+/**
+ * Check a `lore` note's calendar declaration.
+ *
+ * Both halves of one sentence, and the second is the half that keeps the family
+ * from leaking: a calendar note must carry its months and its epoch, and a lore
+ * note that is not a calendar must carry none of the family at all.
+ *
+ * The sum is the only arithmetic. It runs where the package states a year and
+ * the note states months, and nowhere else — neither fires on a package that
+ * declared nothing.
+ *
+ * A calendar note **cannot** restate a world fact, and it needs no rule of its
+ * own to stop it: `data.year`, `data.moon`, `data.world` and `data.body` are
+ * declared on `place` and not on `lore`, so the closed `data:` container
+ * already refuses them by the rule it refuses every undeclared key by.
+ *
+ * @param {object} note - The note, as the link index hands it over.
+ * @param {object} [opts]
+ * @param {object} [opts.index] - The link index, for the world's year.
+ * @returns {object[]} Findings.
+ */
+export function checkCalendarNote(note: object, { index }?: {
+    index?: object | undefined;
+}): object[];
+/**
+ * The four days the year turns on, by day of year.
+ *
+ * The year opens on the first of the first month, and the year's length sets
+ * the spacing; nothing else is consulted. A body's tilt is what makes seasons
+ * exist at all, and it is read by nobody — a quarter day is where the calendar
+ * opens plus a quarter of the year, to the nearest whole day, because a day is
+ * the smallest thing a calendar can name.
+ *
+ * @param {number} daysPerYear - The world's year.
+ * @returns {number[]} Four day-of-year numbers, in order from the year's start.
+ */
+export function quarterDays(daysPerYear: number): number[];
+/**
+ * Compile one calendar note and the package's world facts into one definition.
+ *
+ * The object both consumers read: array-shaped for core's `ArrayField`
+ * collections, carrying the keys core prunes and Calendaria keeps.
+ *
+ * @param {object} opts
+ * @param {object} opts.note - The calendar note.
+ * @param {object} opts.invariants - What {@link worldInvariants} read.
+ * @param {string} [opts.contentPackage] - The package shipping the note, which
+ *   is a fact about the tree rather than about the note: a note never declares
+ *   its own package.
+ * @returns {object} The definition.
+ */
+export function compileCalendar({ note, invariants, contentPackage }: {
+    note: object;
+    invariants: object;
+    contentPackage?: string | undefined;
+}): object;
+/**
+ * Wrap a definition in the envelope a Calendaria settings import reads.
+ *
+ * `calendarData` is the definition unchanged — the importer derives an id from
+ * its `name` and creates a custom calendar from it — so the envelope adds a
+ * header and nothing else. That is what makes the two artefacts assertable
+ * against each other rather than merely similar.
+ *
+ * @param {object} definition - What {@link compileCalendar} produced.
+ * @param {object} opts
+ * @param {string} opts.version - The Calendaria version this was generated
+ *   against, which the importer records.
+ * @param {string} opts.exportedAt - When, as an ISO 8601 instant.
+ * @returns {object} The envelope.
+ */
+export function calendariaEnvelope(definition: object, { version, exportedAt }: {
+    version: string;
+    exportedAt: string;
+}): object;
+/**
+ * Every calendar a package declares, compiled.
+ *
+ * A package whose notes state no year declares no calendars and is asked
+ * nothing about one, which is the right answer for a package that builds a
+ * setting somebody else wrote down.
+ *
+ * @param {object} [index] - The link index, holding every note.
+ * @param {object} [opts]
+ * @param {string} [opts.contentPackage] - The package shipping the tree.
+ * @returns {{calendars: object[], invariants: object}} One compiled definition
+ *   per calendar note, and the facts they were compiled against.
+ */
+export function compileCalendars(index?: object, { contentPackage }?: {
+    contentPackage?: string | undefined;
+}): {
+    calendars: object[];
+    invariants: object;
+};
+/** The `lore` subType whose notes are calendars. */
+export const CALENDAR_SUBTYPE: "calendar";
+/**
+ * The `place` subTypes a world fact may be written on.
+ *
+ * `world` is a body people stand on; `celestial` is one they only look at. A
+ * region, a settlement, a site, a structure or a feature is somewhere *in* a
+ * world and states nothing about the world's year.
+ *
+ * @type {readonly string[]}
+ */
+export const INVARIANT_SUBTYPES: readonly string[];
+/**
+ * The `data:` keys a calendar note may write — the closed list, in authored
+ * order.
+ *
+ * Every key in either target schema that is not here is either a world fact,
+ * read from a `place` note and written by the emitters, or omitted because no
+ * calendar has declared one.
+ *
+ * @type {readonly object[]}
+ */
+export const CALENDAR_FIELDS: readonly object[];
+/**
+ * The `data:` keys a world or a celestial body may write.
+ *
+ * Four groups, and which note carries which is a fact about the body rather
+ * than a convention: a planet states its own size, tilt, year and present; a
+ * moon states its own size, orbit and cycle.
+ *
+ * @type {readonly object[]}
+ */
+export const INVARIANT_FIELDS: readonly object[];