@heroiclands/package-build 23.6.0 → 23.7.0

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

@@ -1,15 +1,46 @@
 /**
- * A lookup from a built piece to its gloss, over one language's words (stems
- * included) and affixes.
+ * A lookup from a built piece to its gloss, over the words (stems included)
+ * and affixes of one or more languages.
  *
- * A piece matches a word or an affix written exactly as it is, and failing
+ * Languages are given nearest first: a language's own words, then its own
+ * affixes, then the next language's, so a daughter's entry wins over its
+ * parent's. A piece matches an entry written exactly as it is, and failing
  * that one written with the same letters and different joining hyphens, so
- * `wulf-` finds the word `wulf`. A word's own gloss wins over an affix's.
+ * `wulf-` finds the word `wulf`. Within a language a word's own gloss wins over
+ * an affix's.
  *
- * @param {object} data - The language note's `data`.
+ * @param {...object} datas - Each language note's `data`, nearest first.
  * @returns {(piece: string) => string|null} The gloss, or `null` where none resolves.
  */
-export function pieceGlosses(data: object): (piece: string) => string | null;
+export function pieceGlosses(...datas: object[]): (piece: string) => string | null;
+/**
+ * The chain of languages from one up through `data.family`: the language
+ * itself, then its parent, and so on. The chain stops at a parent that is no
+ * language, and before a language it has already reached, so a cycle the lint
+ * refuses still yields a finite chain. `language_lineage`, the dictionary and
+ * the resolution of built pieces all walk it.
+ *
+ * @param {string|undefined} start - The language's key.
+ * @param {object} reader
+ * @param {(key: string) => boolean} reader.has - Whether a key is a language.
+ * @param {(key: string) => string|undefined} reader.parentOf - A language's
+ *   parent key, where it states one.
+ * @returns {string[]} The keys, nearest first.
+ */
+export function lineageChain(start: string | undefined, { has, parentOf }: {
+    has: (key: string) => boolean;
+    parentOf: (key: string) => string | undefined;
+}): string[];
+/**
+ * A lookup of language records by Address, and the chain walk over them.
+ *
+ * @param {Iterable<Record<string, any>>} records - Index records.
+ * @returns {{languages: Map<string, object>, chain: (key: string) => string[]}}
+ */
+export function languageLineages(records: Iterable<Record<string, any>>): {
+    languages: Map<string, object>;
+    chain: (key: string) => string[];
+};
 /**
  * Whether a record is a language note's.
  *
@@ -17,6 +48,22 @@ export function pieceGlosses(data: object): (piece: string) => string | null;
  * @returns {boolean}
  */
 export function isLanguageRecord(record: Record<string, any>): boolean;
+/**
+ * A record's Address as a reference to it is written: in the `note` system,
+ * so it compares equal to the Addresses other notes state.
+ *
+ * @param {Record<string, any>} record - An index record.
+ * @returns {string|null} The Address, or `null` for a record naming no note.
+ */
+export function noteAddressOf(record: Record<string, any>): string | null;
+/**
+ * A lookup of the notes citing a word, from records that carry `citations`.
+ *
+ * @param {Iterable<Record<string, any>>} records - Index records.
+ * @returns {(language: string, form: string) => string[]} The citing notes;
+ *   empty where none cites the word.
+ */
+export function citationLookup(records: Iterable<Record<string, any>>): (language: string, form: string) => string[];
 /**
  * The `words` rows of a set of index records.
  *
@@ -24,9 +71,29 @@ export function isLanguageRecord(record: Record<string, any>): boolean;
  *
  * @param {Iterable<Record<string, any>>} records - Index records, every
  *   Address a string, already narrowed to the audience being published to.
+ * @param {Iterable<Record<string, any>>} [all] - Every record of the package,
+ *   for resolving a built piece through an ancestor the audience does not see.
  * @returns {object[]} One row per word, in record then entry order.
  */
-export function wordRows(records: Iterable<Record<string, any>>): object[];
+export function wordRows(records: Iterable<Record<string, any>>, all?: Iterable<Record<string, any>>): object[];
+/**
+ * The `affixes` rows of a set of index records: one per `data.affixes` entry
+ * of a language note, which is the row's `language`.
+ *
+ * @param {Iterable<Record<string, any>>} records - Index records, every
+ *   Address a string, already narrowed to the audience being published to.
+ * @returns {object[]} One row per affix, in record then entry order.
+ */
+export function affixRows(records: Iterable<Record<string, any>>): object[];
+/**
+ * The `fields` rows of a set of index records: one per `data.fields` entry of
+ * a language note, which is the row's `language`.
+ *
+ * @param {Iterable<Record<string, any>>} records - Index records, every
+ *   Address a string, already narrowed to the audience being published to.
+ * @returns {object[]} One row per field, in record then entry order.
+ */
+export function fieldRows(records: Iterable<Record<string, any>>): object[];
 /**
  * The `glossary` rows of a set of index records: one per entry of a culture's
  * or an affiliation's `data.glossary`, with `name_sort` the name and `common`
@@ -58,6 +125,10 @@ export function lineageRows(records: Iterable<Record<string, any>>, all?: Iterab
 export const WORD_COLUMNS: readonly string[];
 /** Every column of the `glossary` relation, in order. */
 export const GLOSSARY_COLUMNS: readonly string[];
+/** Every column of the `affixes` relation, in order. */
+export const AFFIX_COLUMNS: readonly string[];
+/** Every column of the `fields` relation, in order. */
+export const FIELD_COLUMNS: readonly string[];
 /** Every column of the `language_lineage` relation, in order. */
 export const LINEAGE_COLUMNS: readonly string[];
 /** The columns of any of these relations that hold a whole number. */

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

@@ -1,3 +1,19 @@
+/**
+ * A word's senses: one for a string gloss, one per entry for a list, each
+ * trimmed, blanks dropped.
+ *
+ * @param {unknown} gloss - The word's `gloss`.
+ * @returns {string[]} The senses, in order.
+ */
+export function glossSenses(gloss: unknown): string[];
+/**
+ * A word's gloss as one line of text: its senses joined by `; `, or `null`
+ * where it states none.
+ *
+ * @param {unknown} gloss - The word's `gloss`.
+ * @returns {string|null}
+ */
+export function glossText(gloss: unknown): string | null;
 /**
  * Why a pronunciation is not a respelling, or `undefined` when it is one.
  *
@@ -57,6 +73,10 @@ export const WORD_FIELD_FIELDS: readonly import("./data-keys.mjs").InnerKeySpec[
  * @type {readonly import("./data-keys.mjs").InnerKeySpec[]}
  */
 export const AFFIX_FIELDS: readonly import("./data-keys.mjs").InnerKeySpec[];
+/** The keys of {@link WORD_FIELD_FIELDS}, in declared order. */
+export const FIELD_KEYS: readonly string[];
+/** The keys of {@link AFFIX_FIELDS}, in declared order. */
+export const AFFIX_KEYS: readonly string[];
 /**
  * The keys one entry of a culture's or an affiliation's `data.glossary`
  * carries.