@zsnout/ithkuil
Version:
A set of tools which can generate and parse romanized Ithkuil text and which can generate Ithkuil script from text and JSON data.
99 lines (98 loc) • 3.55 kB
TypeScript
import { type Affiliation, type Configuration, type Context, type Essence, type Extension, type Function, type Perspective, type Specification, type Stem, type Version } from "../../generate/index.js";
/** Information about a primary character. */
export interface PrimaryCharacter {
/** Whether this item is handwritten. */
readonly handwritten?: boolean | undefined;
/** Whether this primary character begins a sentence. */
readonly isSentenceInitial?: boolean | undefined;
/** The specification of this character. */
readonly specification?: Specification | undefined;
/** The context of this character. */
readonly context?: Context | undefined;
/** The bottom value of this character. */
readonly bottom?: "UNF/C" | "UNF/K" | "FRM" | 1 | 2 | undefined;
/** The perspective of this character. */
readonly perspective?: Perspective | undefined;
/** The extension of this character. */
readonly extension?: Extension | undefined;
/** The affiliation of this character. */
readonly affiliation?: Affiliation | undefined;
/** The essence of this character. */
readonly essence?: Essence | undefined;
/** The configuration of this character. */
readonly configuration?: Configuration | undefined;
/** The function of this character. */
readonly function?: Function | undefined;
/** The version of this character. */
readonly version?: Version | undefined;
/** The stem of this character. */
readonly stem?: Stem | undefined;
}
/** An object mapping from perspective and extension into secondary extensions. */
export declare const PRIMARY_TOP_LEFT: {
readonly M: {
readonly DEL: undefined;
readonly PRX: "s";
readonly ICP: "t";
readonly ATV: "d";
readonly GRA: "m";
readonly DPL: "n";
};
readonly G: {
readonly DEL: "p";
readonly PRX: "g";
readonly ICP: "ž";
readonly ATV: "ḑ";
readonly GRA: "v";
readonly DPL: "x";
};
readonly N: {
readonly DEL: "š";
readonly PRX: "EXTENSION_GEMINATE";
readonly ICP: "w";
readonly ATV: "h";
readonly GRA: "f";
readonly DPL: "ř";
};
readonly A: {
readonly DEL: "b";
readonly PRX: "k";
readonly ICP: "c";
readonly ATV: "č";
readonly GRA: "ż";
readonly DPL: "j";
};
};
/**
* An object mapping from function, version, M/D, and stem into secondary
* extensions.
*/
export declare const PRIMARY_BOTTOM_RIGHT: {
readonly STA: {
readonly PRC: {
readonly M: readonly ["b", undefined, "p", "š"];
readonly D: readonly ["c", "z", "p_WITH_LINE", "w"];
};
readonly CPT: {
readonly M: readonly ["k", "l", "g", "EXTENSION_GEMINATE"];
readonly D: readonly ["č", "r_FLIPPED", "g_WITH_LINE", "h"];
};
};
readonly DYN: {
readonly PRC: {
readonly M: readonly ["d", "m", "CORE_GEMINATE", "t"];
readonly D: readonly ["d_WITH_LINE", "n", "ň", "ž"];
};
readonly CPT: {
readonly M: readonly ["ţ", "s", "x", "f"];
readonly D: readonly ["ḑ", "r", "ř", "v"];
};
};
};
/**
* Assembles a primary character as an group of SVG paths.
*
* @param props Properties that modify the character.
* @returns An `SVGGElement` containing the character.
*/
export declare function Primary(primary: PrimaryCharacter): SVGGElement;