@heroiclands/package-build 23.5.1 → 23.6.1

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

@@ -0,0 +1,72 @@
+/**
+ * Why a pronunciation is not a respelling, or `undefined` when it is one.
+ *
+ * A respelling is letters and apostrophes in hyphen-separated syllables, with
+ * at most one syllable in capitals.
+ *
+ * @param {string} text
+ * @returns {string|undefined}
+ */
+export function pronunciationProblem(text: string): string | undefined;
+/**
+ * The inner keys of a language note's words, fields and affixes, and of a
+ * culture's or an affiliation's glossary entries, as inner-key declarations.
+ *
+ * A leaf module, importing nothing: the note vocabulary reads these
+ * declarations as it loads, and the checks that judge what the values mean —
+ * a class against the master word classes, a field against the note's own
+ * fields — live in `language-words.mjs` and `glossary-entries.mjs`.
+ *
+ * @module
+ */
+/** The `skill` subType whose notes are languages, and the only one with words. */
+export const LANGUAGE_SUBTYPE: "language";
+/** The `data` keys a language note states its words in, beside `names`. */
+export const WORD_DATA_KEYS: readonly string[];
+/**
+ * Where a word comes from. `borrowed` names the tongue it was taken from;
+ * `inherited`, `kept` and `worn` name the ancient form where the note gives
+ * one; `coined`, `substrate` and `island` name no form.
+ */
+export const WORD_SOURCE_KINDS: readonly string[];
+/** The source kind that requires `language`. */
+export const BORROWED_SOURCE_KIND: "borrowed";
+/**
+ * The keys of a word's `source`.
+ *
+ * @type {readonly import("./data-keys.mjs").InnerKeySpec[]}
+ */
+export const WORD_SOURCE_FIELDS: readonly import("./data-keys.mjs").InnerKeySpec[];
+/**
+ * The keys one word of a language note's `data.words` carries.
+ *
+ * @type {readonly import("./data-keys.mjs").InnerKeySpec[]}
+ */
+export const WORD_FIELDS: readonly import("./data-keys.mjs").InnerKeySpec[];
+/** The keys of {@link WORD_FIELDS}, in declared order. */
+export const WORD_KEYS: readonly string[];
+/**
+ * The keys one entry of a language note's `data.fields` carries.
+ *
+ * @type {readonly import("./data-keys.mjs").InnerKeySpec[]}
+ */
+export const WORD_FIELD_FIELDS: readonly import("./data-keys.mjs").InnerKeySpec[];
+/**
+ * The keys one entry of a language note's `data.affixes` carries.
+ *
+ * @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.
+ *
+ * @type {readonly import("./data-keys.mjs").InnerKeySpec[]}
+ */
+export const GLOSSARY_ENTRY_FIELDS: readonly import("./data-keys.mjs").InnerKeySpec[];
+/** The keys of {@link GLOSSARY_ENTRY_FIELDS}, in declared order. */
+export const GLOSSARY_ENTRY_KEYS: readonly string[];