@heroiclands/package-build 23.6.1 → 23.7.0

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

@@ -63,6 +63,14 @@ export const STRUCTURED_ADDRESSES: readonly ({
     type: string;
     accepts: string[];
     lenient: boolean;
+} | {
+    lenient: boolean;
+    system?: string | string[] | undefined;
+    accepts?: string | string[] | undefined;
+    type?: string | string[] | undefined;
+    noteType: string;
+    path: (string | string[] | undefined)[];
+    shape: string;
 } | {
     path: string[];
     shape: string;
@@ -70,7 +78,6 @@ export const STRUCTURED_ADDRESSES: readonly ({
     accepts: string[];
     system: string;
     noteType?: undefined;
-    lenient?: undefined;
 } | {
     noteType: string;
     path: string[];
@@ -78,14 +85,5 @@ export const STRUCTURED_ADDRESSES: readonly ({
     type: string;
     accepts: string[];
     system?: undefined;
-    lenient?: undefined;
-} | {
-    noteType: string;
-    path: string[];
-    shape: string;
-    lenient: boolean;
-    type?: undefined;
-    accepts?: undefined;
-    system?: undefined;
 })[];
 export { AddressEntries, encodeAddresses, cloneAddressState, publishAddresses, readPublishedAddresses, flattenPublishedAddresses } from "./address-values.mjs";

package/types/engine/sql-tables.d.mts

@@ -7,7 +7,7 @@
  *
  * @param {string} markdown - The note body, frontmatter already stripped.
  * @returns {Array<{line: number, close: number, indent: string, query: string,
- *   allowEmpty: boolean, sectionLevel: number, showKey: boolean, layout: string, block: string}>} One entry per
+ *   allowEmpty: boolean, sectionLevel: number, showKey: boolean|"only", layout: string, block: string}>} One entry per
  *   fence, in document order.
  */
 export function findSqlBlocks(markdown: string): Array<{
@@ -17,7 +17,7 @@ export function findSqlBlocks(markdown: string): Array<{
     query: string;
     allowEmpty: boolean;
     sectionLevel: number;
-    showKey: boolean;
+    showKey: boolean | "only";
     layout: string;
     block: string;
 }>;

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

@@ -0,0 +1,43 @@
+/**
+ * A form as uses are matched against it: diacritics taken off, case folded.
+ *
+ * @param {unknown} text - A form or a use.
+ * @returns {string} The folded form.
+ */
+export function foldForm(text: unknown): string;
+/**
+ * The marked uses in a note's body: the text of every italic span that holds
+ * text alone, in document order.
+ *
+ * @param {string} body - The note's Markdown body.
+ * @returns {string[]} Each span's text.
+ */
+export function markedUses(body: string): string[];
+/**
+ * Each language note's cited words: for every word some note's marked use
+ * spells, the Addresses of the notes citing it.
+ *
+ * @param {Iterable<Record<string, any>>} records - Index records.
+ * @param {Iterable<{record: Record<string, any>, body: string}>} notes - The
+ *   notes whose bodies are read, each with its record.
+ * @returns {Map<string, Map<string, string[]>>} By language Address, by the
+ *   word's form, the citing notes in code-point order.
+ */
+export function wordCitations(records: Iterable<Record<string, any>>, notes: Iterable<{
+    record: Record<string, any>;
+    body: string;
+}>): Map<string, Map<string, string[]>>;
+/**
+ * Set each language record's `citations` from {@link wordCitations}: one entry
+ * per cited word, in the order the words stand, `{ form, notes }`. A language
+ * with no cited word carries no `citations`.
+ *
+ * @param {Record<string, any>[]} records - Index records, written in place.
+ * @param {Iterable<{record: Record<string, any>, body: string}>} notes - The
+ *   notes whose bodies are read.
+ * @returns {void}
+ */
+export function attachCitations(records: Record<string, any>[], notes: Iterable<{
+    record: Record<string, any>;
+    body: string;
+}>): void;

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

@@ -48,6 +48,22 @@ export function languageLineages(records: Iterable<Record<string, any>>): {
  * @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.
  *

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.
  *