@heroiclands/package-build 22.16.0 → 22.17.0

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

@@ -0,0 +1,33 @@
+/** Brackets and braces must close; `[[]` is a literal left bracket. */
+export function calendarFormatSyntaxError(pattern: any): string | null;
+/** Split a Calendaria pattern into tokens and literal text. */
+export function calendarFormatSegments(pattern: any): {
+    token: boolean;
+    value: any;
+}[];
+/** A standard format must identify one calendar day and be readable without context. */
+export function readableCalendarFormatError(pattern: any): string | null;
+/** Whether a selected pattern prints clock components. */
+export function calendarFormatHasClock(pattern: any): boolean;
+/** Keep the fields named by an authored date's precision. */
+export function calendarPatternSegmentsForPrecision(pattern: any, precision?: string, includeClock?: boolean): {
+    token: boolean;
+    value: any;
+}[];
+/** Choose an authored named format, with `std` as the preferred default. */
+export function selectCalendarFormat(calendar: any, name: any): {
+    name: any;
+    pattern: any;
+};
+/** Format calendar date components with Calendaria's documented tokens. */
+export function formatCalendarPattern(pattern: any, parts: any, precision?: string, includeClock?: boolean): string;
+/** Read the invertible date fields of one Calendaria pattern. */
+export function parseCalendarPattern(pattern: any, text: any, calendar: any): {
+    hour: number;
+};
+/** Convert a calendar month/day into its one-based day of year. */
+export function calendarOrdinal(calendar: any, month: any, day: any): number;
+/** Calendaria's bare date, time, week, season, and zone tokens. */
+export const CALENDAR_FORMAT_TOKENS: Readonly<Set<string>>;
+/** Calendaria's named fields inside brackets or braces. */
+export const CALENDAR_CUSTOM_TOKENS: Readonly<Set<string>>;

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

@@ -18,7 +18,7 @@ export function worldInvariants(index?: object): {
     yearNote: object | null;
     moonNote: object | null;
 };
-/** Check each authored format slot and every unescaped letter run in it. */
+/** Check each named pattern and the standard pattern's readable fields. */
 export function checkCalendarDateFormats(note: any): {
     severity: any;
     message: any;
@@ -162,8 +162,7 @@ export const CALENDAR_SUBTYPE: "calendar";
 export const INVARIANT_SUBTYPES: readonly string[];
 /** Calendaria's display locations that a calendar note can format. */
 export const CALENDAR_DATE_FORMAT_KEYS: readonly string[];
-/** Bare date tokens Calendaria substitutes inside authored format strings. */
-export const CALENDAR_FORMAT_TOKENS: Readonly<Set<string>>;
+export { CALENDAR_FORMAT_TOKENS };
 /**
  * The `data:` keys a calendar note may write — the closed list, in authored
  * order.
@@ -185,3 +184,4 @@ export const CALENDAR_FIELDS: readonly object[];
  * @type {readonly object[]}
  */
 export const INVARIANT_FIELDS: readonly object[];
+import { CALENDAR_FORMAT_TOKENS } from "./calendar-format.mjs";

package/types/engine/date-conversion.d.mts

@@ -1,4 +1,4 @@
 /** Convert a day in an addressed calendar to its canonical spelling. */
 export function dateFromCalendar(reference: any, value: any, context: any): string;
 /** Convert a canonical day to the date in the covering era of a calendar. */
-export function dateToCalendar(reference: any, value: any, context: any): any;
+export function dateToCalendar(reference: any, value: any, context: any, formatName: any): any;

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

@@ -60,7 +60,7 @@ export function eraCovering(date: any, eraRows: any, daysPerYear: any): any;
 /** Resolve a calendar or one of its eras from an Address or shortcode. */
 export function calendarEras(reference: any, context: any): any;
 /** Print a resolved date using the era active in one addressed calendar. */
-export function formatDateInCalendar(date: any, reference: any, context: any): {
+export function formatDateInCalendar(date: any, reference: any, context: any, formatName: any): {
     era: null;
     year: number;
     text: any;
@@ -76,7 +76,7 @@ export function formatDateInCalendar(date: any, reference: any, context: any): {
     prose: string | null;
 } | null;
 /** Print a resolved date in one era, retaining its authored precision. */
-export function formatNoteDate(date: any, era: any, daysPerYear: any): {
+export function formatNoteDate(date: any, era: any, daysPerYear: any, formatName: any): {
     era: null;
     year: number;
     text: any;

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

@@ -1,29 +1,14 @@
-/**
- * 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 {{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[];
-};
-/**
- * Read the world's year length and its era markers from one corpus index.
- *
- * @param {{notes?: readonly object[]}|undefined} index - The corpus index.
- * @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[];
+/** Resolve calendar eras on the canonical day axis. */
+export function resolveReckoningMarkers(index: any, daysPerYear: any): {
+    eras: Map<any, any>;
+    markers: Map<any, any>;
+    findings: {
+        severity: string;
+        message: string;
+        line?: number;
+        column?: number;
+        file?: any;
+    }[];
 };
+/** Read the world's year length and resolve every calendar era in one corpus. */
+export function reckoningContext(index: any): any;