@heroiclands/package-build 25.1.0 → 25.1.2

package/types/engine/encoding-lexicon.d.mts

@@ -59,24 +59,11 @@ export function languageNoteFindings(config: {
  *   word's 0-based place in `data.words`, `native` the form's in its `native`.
  */
 export function nativeRows(records: Iterable<Record<string, any>>): Array<Record<string, string | number | null>>;
-/** Project only conversion-readable language data to a JSON-safe object. */
-export function serializeLexicon(lexicon: any): {
-    language: any;
-    data: {
-        grammar?: {
-            [k: string]: any;
-        } | undefined;
-        words: {
-            [k: string]: any;
-        }[];
-        affixes: {
-            [k: string]: any;
-        }[];
-        register: {
-            [k: string]: any;
-        }[];
-    };
-} | undefined;
+/**
+ * Project only conversion-readable language data to a JSON-safe object. The
+ * projection of one lexicon is made once and shared, so it must not be modified.
+ */
+export function serializeLexicon(lexicon: any): any;
 /**
  * Resolve encoding, face and optional language input without loading files.
  *
@@ -129,23 +116,7 @@ export function encodingFor(ctx: import("./content-scripts.mjs").RunContext, { e
         };
     }>;
     font: any;
-    lexicon: {
-        language: any;
-        data: {
-            grammar?: {
-                [k: string]: any;
-            } | undefined;
-            words: {
-                [k: string]: any;
-            }[];
-            affixes: {
-                [k: string]: any;
-            }[];
-            register: {
-                [k: string]: any;
-            }[];
-        };
-    } | undefined;
+    lexicon: any;
 } | undefined;
 /** Why a face is incompatible with the selected encoding. */
 export function fontProblem(encoding: any, font: any): string | undefined;

package/types/engine/encoding-template.d.mts

@@ -14,6 +14,7 @@ export function templateProgram(data: any, options: {
         fonts: any[];
         accepts: any[];
         separator: string;
+        roundTrip: string;
         vowels: any;
         rows: Readonly<unknown>[];
         codes: [string, string][];

package/types/engine/encoding-terms.d.mts

@@ -12,6 +12,17 @@ export const ENCODING_RULE_FIELDS: readonly ({
     shape: string;
     describe: any;
     fields: any;
+} | {
+    name: string;
+    kind: string;
+    shape: string;
+    entries: {
+        kind: string;
+        shape: string;
+        describe: string;
+        fields?: undefined;
+    };
+    describe: string;
 } | {
     name: string;
     kind: string;
@@ -20,13 +31,21 @@ export const ENCODING_RULE_FIELDS: readonly ({
     entries: {
         kind: string;
         shape: string;
-        fields: {
+        fields: ({
+            name: any;
+            kind: string;
+            shape: string;
+            describe: any;
+            required: boolean;
+        } | {
+            allowed: string[];
             name: any;
             kind: string;
             shape: string;
             describe: any;
             required: boolean;
-        }[];
+        })[];
+        describe?: undefined;
     };
 })[];
 /** The additional data keys a document may use to define its encoding. */
@@ -82,6 +101,17 @@ export const ENCODING_NOTE_FIELDS: readonly ({
         shape: string;
         describe: any;
         fields: any;
+    } | {
+        name: string;
+        kind: string;
+        shape: string;
+        entries: {
+            kind: string;
+            shape: string;
+            describe: string;
+            fields?: undefined;
+        };
+        describe: string;
     } | {
         name: string;
         kind: string;
@@ -90,13 +120,21 @@ export const ENCODING_NOTE_FIELDS: readonly ({
         entries: {
             kind: string;
             shape: string;
-            fields: {
+            fields: ({
+                name: any;
+                kind: string;
+                shape: string;
+                describe: any;
+                required: boolean;
+            } | {
+                allowed: string[];
                 name: any;
                 kind: string;
                 shape: string;
                 describe: any;
                 required: boolean;
-            }[];
+            })[];
+            describe?: undefined;
         };
     })[];
     describe: string;

package/types/engine/encoding.d.mts

@@ -128,7 +128,7 @@ export function encodeText(enc: ReturnType<typeof compileEncoding>, text: string
     verse?: boolean;
 }): string;
 /**
- * Decode a note's uniquely decodable output, including nonprefix glyph sequences.
+ * Decode exact output or the conventional reading of an explicitly canonical note.
  * @param {ReturnType<typeof compileEncoding>} enc - Compiled encoding note.
  * @param {string} text - Native text with optional literal spans.
  * @param {{font?: string}} [options] - Selected encoding face.

package/types/engine/language-writings.d.mts

@@ -16,7 +16,9 @@
  */
 export function nativeText(natives: unknown, enc: string, font: string | undefined): string | undefined;
 /**
- * The writings of a language's words under one encoding in one face.
+ * The writings of a language's words under one encoding in one face. One
+ * `data` yields one set of writings per encoding and face, and each word's
+ * writing is found once, so `data` must not be modified once it is read here.
  *
  * @param {Record<string, any>|undefined} data - The language note's `data`.
  * @param {string} enc - The encoding's name.

package/types/engine/markdown-blocks.d.mts

@@ -0,0 +1,8 @@
+/**
+ * The block tokens of a Markdown source. The array is shared between callers
+ * and must not be modified; an `inline` token carries no `children`.
+ *
+ * @param {unknown} source - Markdown.
+ * @returns {readonly import("markdown-it").Token[]} The block tokens, in order.
+ */
+export function blockTokens(source: unknown): readonly import("markdown-it").Token[];