@heroiclands/package-build 24.1.1 → 25.1.0

package/types/engine/run-rows.d.mts

@@ -7,11 +7,8 @@
  *   own `lang=`, else the one the div or fence around it states.
  * @property {string|null} tag - The BCP 47 tag it resolves to, or null.
  * @property {string|null} font - Its explicit font, an inherited ordinary
- *   prose family, or the configured default for an opted-in native run.
- * @property {string|null} map - Its explicit map or the configured map of an
- *   opted-in native run; null for Roman language-only text.
- * @property {boolean} [nativefont] - Explicit native opt-in on this construct;
- *   absent on Roman runs. This internal flag is not a SQL column.
+ *   prose family, or the font of the selected encoding document.
+ * @property {string|null} enc - Its resolved encoding document, or default for Roman text.
  * @property {number} line - 1-based file line of its opening.
  * @property {number} column - 1-based UTF-16 file column of its opening.
  */
@@ -38,22 +35,24 @@ export function recordRuns(body: string, { context, bodyLine, bodyColumn, syntax
     syntax?: import("./content-session.mjs").ContentSyntax | undefined;
 }): RecordRun[];
 /**
- * Give explicitly native recorded runs the map and face their language names in
- * `data.writtenIn`, where the run leaves them unstated, as a run is set. Read
- * once every record exists, since a run's language note may be recorded after
- * the note that marks it.
+ * Resolve recorded encoding Addresses and fill the language and font supplied
+ * by each selected document, once every index record exists.
  *
  * @param {Record<string, any>[]} records - The package's index records; each
  *   note record's `runs` is updated in place.
- * @param {{languages?: Readonly<Record<string, {tag: string, note?: string}>>, contentPackage?: string}} config -
+ * @param {{languages?: Readonly<Record<string, {tag: string, note?: string}>>, contentPackage?: string, rootDir?:string, paths?:{content?:string}}} config -
  *   The configured languages, whose `note` names each language note.
  */
-export function fillWrittenIn(records: Record<string, any>[], config: {
+export function fillEncodingRuns(records: Record<string, any>[], config: {
     languages?: Readonly<Record<string, {
         tag: string;
         note?: string;
     }>>;
     contentPackage?: string;
+    rootDir?: string;
+    paths?: {
+        content?: string;
+    };
 }): void;
 /**
  * The containing page's NOTE identity.
@@ -91,19 +90,13 @@ export type RecordRun = {
     tag: string | null;
     /**
      * - Its explicit font, an inherited ordinary
-     * prose family, or the configured default for an opted-in native run.
+     * prose family, or the font of the selected encoding document.
      */
     font: string | null;
     /**
-     * - Its explicit map or the configured map of an
-     * opted-in native run; null for Roman language-only text.
+     * - Its resolved encoding document, or default for Roman text.
      */
-    map: string | null;
-    /**
-     * - Explicit native opt-in on this construct;
-     * absent on Roman runs. This internal flag is not a SQL column.
-     */
-    nativefont?: boolean | undefined;
+    enc: string | null;
     /**
      * - 1-based file line of its opening.
      */

package/types/engine/script-emphasis-terms.d.mts

@@ -26,3 +26,5 @@ export const LANGUAGE_EMPHASES: readonly string[];
 export const SCRIPT_DIRECTIONS: readonly string[];
 /** The `subType` of a script note. */
 export const SCRIPT_SUBTYPE: "script";
+/** The ordinary prose families accepted by font=. */
+export const GENERIC_FAMILIES: readonly string[];

package/types/engine/script-emphasis.d.mts

@@ -12,7 +12,7 @@ export function emphasesFromRecords(records: Iterable<Record<string, any>> | und
  *
  * @param {ReadonlyMap<string, Record<string, any>>} byName - Each configured
  *   language's note record, by language name, from
- *   {@link module:engine/map-lexicon.languageRecordsByName}.
+ *   {@link module:engine/encoding-lexicon.languageRecordsByName}.
  * @returns {Map<string, LanguageEmphasis>} The conventions, by language name;
  *   a language whose note states none, or one the build does not know, is
  *   absent.

package/types/engine/script-font-delivery.d.mts

@@ -1,9 +1,8 @@
 /**
  * The faces the package's notes set text in, read from the notes
  * themselves: every Markdown file under the content tree that writes `font=`
- * is scanned for its runs, and the face every language note names in
- * `data.writtenIn` counts, since a run marked with the language alone is set
- * in it.
+ * is scanned for its runs, and encoding documents supply the fonts their
+ * encoded runs infer.
  *
  * @param {DeliveryConfig} config - The resolved configuration.
  * @param {import("./script-fonts.mjs").ScriptFonts} installed - The fonts package.

package/types/engine/script-fonts.d.mts

@@ -4,6 +4,7 @@
  * @typedef {object} FaceCodepoint
  * @property {string} codepoint - `U+` and the hexadecimal code point.
  * @property {string} glyph - The glyph's name in the face.
+ * @property {string} [code] - The font's case-sensitive glyph code.
  * @property {string} kind - What it is: `letter`, `numeral`, `mark` and so on.
  */
 /**
@@ -77,6 +78,10 @@ export type FaceCodepoint = {
      * - The glyph's name in the face.
      */
     glyph: string;
+    /**
+     * - The font's case-sensitive glyph code.
+     */
+    code?: string | undefined;
     /**
      * - What it is: `letter`, `numeral`, `mark` and so on.
      */

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

@@ -11,7 +11,7 @@
  * @param {string} text - Markdown, optionally beginning with YAML frontmatter.
  * @param {{dark?: boolean, infobox?: boolean, file?: string, currentDate?: string,
  *   index?: import("./preview-index.mjs").PreviewIndex}} [options] - Explicit palette, profile visibility, diagnostic filename, neutral current date (default "720.1") and the content index, from {@link module:engine/preview-index.previewIndex}.
- * @returns {{ok: boolean, html: string, frontmatter: object, findings: object[]}} HTML and metadata with locally calculable ages; unavailable ages remain absent or null.
+ * @returns {{ok: boolean, html: string, frontmatter: object, findings: object[]}} HTML and metadata with locally calculable ages; unavailable ages remain absent or null. Error findings set `ok` to false while retaining the HTML.
  */
 export function renderPreview(text: string, { dark, infobox, file, currentDate, index }?: {
     dark?: boolean;

package/types/engine/word-inflections.d.mts

@@ -0,0 +1,25 @@
+/**
+ * A noun's stated plural, or the first literal ending replacement that fits.
+ *
+ * @param {{form: string, class?: unknown, plural?: unknown}} word - A word of
+ *   `data.words`.
+ * @param {Record<string, any>|undefined} grammar - Its language's
+ *   `data.grammar`.
+ * @returns {string|null} The plural, or `null` for a word that is no noun or
+ *   that no rule fits.
+ */
+export function pluralOf(word: {
+    form: string;
+    class?: unknown;
+    plural?: unknown;
+}, grammar: Record<string, any> | undefined): string | null;
+/**
+ * The plural a language's `data.grammar.plural` rule gives a form: the first
+ * literal ending replacement that fits, whatever the form's class.
+ *
+ * @param {string} form - The form.
+ * @param {Record<string, any>|undefined} grammar - Its language's
+ *   `data.grammar`.
+ * @returns {string|null} The plural, or `null` where no rule fits.
+ */
+export function pluralByRule(form: string, grammar: Record<string, any> | undefined): string | null;