@kensio/pinyinjs 0.1.0-beta.0 → 1.0.0

package/dist/transcription/bopomofo.js

@@ -0,0 +1,371 @@
+/**
+ * Bopomofo (注音符號), in both directions.
+ *
+ * This is the easy half of romanisation interchange, and the reason is
+ * [phonology.ts](../syllable/phonology.ts): a parsed syllable already holds the
+ * underlying initial and final rather than the spelling, and bopomofo writes
+ * exactly those. 就 is
+ * `j` + `iou` and ㄐㄧㄡ; 军 is `j` + `ün` and ㄐㄩㄣ; 中 is `zh` + `ong` and
+ * ㄓㄨㄥ. Nothing here undoes a pinyin spelling rule, because `readSyllable`
+ * never applied one.
+ *
+ * So the mapping is compositional — an initial symbol, a medial symbol and a
+ * rhyme symbol — and it is a bijection over the whole syllable inventory. The
+ * three places it is not quite mechanical are recorded on the tables below.
+ */
+import { toCharacters } from "../script/characters.js";
+import { NEUTRAL_TONE } from "../tone/tone.js";
+/**
+ * The symbol each initial is written with.
+ *
+ * A syllable with no initial has no entry and writes nothing, which is what the
+ * empty string stands for throughout this file.
+ */
+const INITIAL_SYMBOLS = new Map([
+    ["b", "ㄅ"],
+    ["p", "ㄆ"],
+    ["m", "ㄇ"],
+    ["f", "ㄈ"],
+    ["d", "ㄉ"],
+    ["t", "ㄊ"],
+    ["n", "ㄋ"],
+    ["l", "ㄌ"],
+    ["g", "ㄍ"],
+    ["k", "ㄎ"],
+    ["h", "ㄏ"],
+    ["j", "ㄐ"],
+    ["q", "ㄑ"],
+    ["x", "ㄒ"],
+    ["zh", "ㄓ"],
+    ["ch", "ㄔ"],
+    ["sh", "ㄕ"],
+    ["r", "ㄖ"],
+    ["z", "ㄗ"],
+    ["c", "ㄘ"],
+    ["s", "ㄙ"],
+]);
+/**
+ * The symbol each medial is written with.
+ */
+const MEDIAL_SYMBOLS = new Map([
+    ["i", "ㄧ"],
+    ["u", "ㄨ"],
+    ["ü", "ㄩ"],
+]);
+/**
+ * The symbol each rhyme is written with.
+ *
+ * ㄦ is here as a rhyme of its own and also serves as the 儿化 suffix, which is
+ * what bopomofo does with it: 歌儿 gēr is ㄍㄜㄦ.
+ *
+ * The three syllabic nasals at the end are the marginal case. ㄇ and ㄋ are
+ * initial letters doing rhyme duty, as bopomofo writes 呣 and 嗯; ㄫ is the
+ * obsolete letter for a syllabic ng, used here rather than ㄥ so that 嗯 ǹg and
+ * the rare 鞥 ēng do not come out identical.
+ */
+const RHYME_SYMBOLS = new Map([
+    ["a", "ㄚ"],
+    ["o", "ㄛ"],
+    ["e", "ㄜ"],
+    ["ê", "ㄝ"],
+    ["ai", "ㄞ"],
+    ["ei", "ㄟ"],
+    ["ao", "ㄠ"],
+    ["ou", "ㄡ"],
+    ["an", "ㄢ"],
+    ["en", "ㄣ"],
+    ["ang", "ㄤ"],
+    ["eng", "ㄥ"],
+    ["er", "ㄦ"],
+    ["m", "ㄇ"],
+    ["n", "ㄋ"],
+    ["ng", "ㄫ"],
+]);
+/**
+ * How each final divides into a medial and a rhyme.
+ *
+ * Written out rather than split off the front of the spelling, because the
+ * division is phonological and the spelling only mostly follows it: `in` is
+ * ㄧㄣ, an i medial over the ㄣ rhyme rather than over an n of its own, and
+ * `iong` is ㄩㄥ — a ü medial despite the i in the spelling, which is why
+ * 兄 xiōng and 军 jūn share a medial.
+ */
+const FINAL_PARTS = {
+    a: ["", "a"],
+    o: ["", "o"],
+    e: ["", "e"],
+    ê: ["", "ê"],
+    er: ["", "er"],
+    ai: ["", "ai"],
+    ei: ["", "ei"],
+    ao: ["", "ao"],
+    ou: ["", "ou"],
+    an: ["", "an"],
+    en: ["", "en"],
+    ang: ["", "ang"],
+    eng: ["", "eng"],
+    ong: ["u", "eng"],
+    i: ["i", ""],
+    ia: ["i", "a"],
+    io: ["i", "o"],
+    ie: ["i", "ê"],
+    iao: ["i", "ao"],
+    iou: ["i", "ou"],
+    ian: ["i", "an"],
+    in: ["i", "en"],
+    iang: ["i", "ang"],
+    ing: ["i", "eng"],
+    iong: ["ü", "eng"],
+    u: ["u", ""],
+    ua: ["u", "a"],
+    uo: ["u", "o"],
+    uai: ["u", "ai"],
+    uei: ["u", "ei"],
+    uan: ["u", "an"],
+    uen: ["u", "en"],
+    uang: ["u", "ang"],
+    ueng: ["u", "eng"],
+    ü: ["ü", ""],
+    üe: ["ü", "ê"],
+    üan: ["ü", "an"],
+    ün: ["ü", "en"],
+    m: ["", "m"],
+    n: ["", "n"],
+    ng: ["", "ng"],
+};
+/**
+ * The initials whose syllable with an i final is written as the initial alone:
+ * 知 is ㄓ, not ㄓㄧ.
+ *
+ * The i of zhi, chi, shi, ri, zi, ci and si is not the i of ji at all — it is
+ * the syllabic continuation of the initial (空韻), and bopomofo simply does not
+ * write it. This is the one place the correspondence is not one symbol per
+ * part.
+ */
+const EMPTY_RHYME_INITIALS = new Set([
+    "zh",
+    "ch",
+    "sh",
+    "r",
+    "z",
+    "c",
+    "s",
+]);
+/**
+ * The mark each tone takes.
+ *
+ * The neutral tone's dot goes *before* the syllable and the other four go
+ * after, which is where bopomofo puts them.
+ */
+const TONE_MARKS = new Map([
+    [1, "ˉ"],
+    [2, "ˊ"],
+    [3, "ˇ"],
+    [4, "ˋ"],
+    [NEUTRAL_TONE, "˙"],
+]);
+/**
+ * The tone each mark stands for, including the shapes a keyboard produces.
+ *
+ * Tolerant input and standard output, as the rest of the package has: `´` and
+ * `` ` `` are the ASCII neighbours of ˊ and ˋ, and are what text that was typed
+ * rather than composed tends to carry.
+ */
+const TONES_BY_MARK = new Map([
+    ["ˉ", 1],
+    ["¯", 1],
+    ["ˊ", 2],
+    ["´", 2],
+    ["ˇ", 3],
+    ["ˋ", 4],
+    ["`", 4],
+    ["˙", NEUTRAL_TONE],
+    ["·", NEUTRAL_TONE],
+]);
+/**
+ * Write a syllable in bopomofo: 就 jiù becomes ㄐㄧㄡˋ.
+ *
+ * Total over well-formed syllables — every initial and every final has a
+ * symbol — so anything the syllable parser accepts can be written, including
+ * the syllables no dictionary uses.
+ */
+export function writeBopomofo(syllable, options = {}) {
+    const { initial, final, tone } = syllable;
+    const [medial, rhyme] = FINAL_PARTS[final];
+    const isEmptyRhyme = final === "i" && EMPTY_RHYME_INITIALS.has(initial);
+    const written = [
+        INITIAL_SYMBOLS.get(initial) ?? "",
+        isEmptyRhyme ? "" : (MEDIAL_SYMBOLS.get(medial) ?? ""),
+        isEmptyRhyme ? "" : (RHYME_SYMBOLS.get(rhyme) ?? ""),
+        syllable.erhua === true ? "ㄦ" : "",
+    ].join("");
+    const mark = tone === undefined ? undefined : TONE_MARKS.get(tone);
+    if (mark === undefined || (tone === 1 && options.firstTone !== "mark")) {
+        return written;
+    }
+    return tone === NEUTRAL_TONE ? `${mark}${written}` : `${written}${mark}`;
+}
+/**
+ * Write a word in bopomofo, one syllable after another.
+ *
+ * Separated by spaces, as 教育部's dictionaries write them. A syllable boundary
+ * is findable without the space — an initial symbol can only start one — but a
+ * long unbroken run of symbols is hard to read, and the space costs nothing.
+ */
+export function writeBopomofoWord(syllables, options = {}) {
+    return syllables
+        .map((syllable) => writeBopomofo(syllable, options))
+        .join(" ");
+}
+/**
+ * The final each medial and rhyme pair spells, keyed as `medial|rhyme`.
+ */
+const FINALS_BY_PARTS = new Map(Object.entries(FINAL_PARTS).map(([final, [medial, rhyme]]) => [
+    `${medial}|${rhyme}`,
+    final,
+]));
+/**
+ * The initial each symbol stands for.
+ */
+const INITIALS_BY_SYMBOL = new Map([...INITIAL_SYMBOLS].map(([initial, symbol]) => [symbol, initial]));
+/**
+ * The medial each symbol stands for.
+ */
+const MEDIALS_BY_SYMBOL = new Map([...MEDIAL_SYMBOLS].map(([medial, symbol]) => [symbol, medial]));
+/**
+ * The rhyme each symbol stands for.
+ */
+const RHYMES_BY_SYMBOL = new Map([...RHYME_SYMBOLS].map(([rhyme, symbol]) => [symbol, rhyme]));
+/**
+ * Whether one character is a bopomofo letter or tone mark.
+ */
+function isSymbol(symbol) {
+    return (INITIALS_BY_SYMBOL.has(symbol) ||
+        MEDIALS_BY_SYMBOL.has(symbol) ||
+        RHYMES_BY_SYMBOL.has(symbol) ||
+        TONES_BY_MARK.has(symbol));
+}
+/**
+ * Whether a string is written in bopomofo at all.
+ *
+ * This is the one thing bopomofo makes easy that Wade-Giles cannot: it has a
+ * script of its own, so it is never mistaken for pinyin and a caller never has
+ * to be told which system its input is in.
+ */
+export function isBopomofo(text) {
+    const trimmed = text.trim();
+    return (trimmed !== "" && toCharacters(trimmed).every((symbol) => isSymbol(symbol)));
+}
+/**
+ * Take the tone mark off, wherever it was written.
+ *
+ * The neutral dot belongs at the front and the other four at the back, but text
+ * in the wild puts them either side, so both are read. A mark at each end is
+ * rejected rather than resolved, which is the same call `readSyllable` makes
+ * about `běi3`.
+ */
+function splitTone(text) {
+    const leading = TONES_BY_MARK.get(text.slice(0, 1));
+    if (leading !== undefined) {
+        const rest = text.slice(1);
+        return TONES_BY_MARK.has(rest.slice(-1)) ? undefined : [rest, leading];
+    }
+    const trailing = TONES_BY_MARK.get(text.slice(-1));
+    return trailing === undefined
+        ? [text, undefined]
+        : [text.slice(0, -1), trailing];
+}
+/**
+ * Read the symbols of one syllable, in the order bopomofo writes them.
+ *
+ * `hasInitial` is what recovers the syllabic nasals on a second pass: ㄇ is an
+ * initial letter, so 呣 m̄ parses as an m initial with nothing after it and has
+ * to be retried as a rhyme standing alone. `readParts` in
+ * [syllable.ts](../syllable/syllable.ts) retries n and ng the same way, for the
+ * same reason.
+ */
+function parseSymbols(text, hasInitial) {
+    const symbols = toCharacters(text);
+    let at = 0;
+    const initial = hasInitial
+        ? INITIALS_BY_SYMBOL.get(symbols[at] ?? "")
+        : undefined;
+    if (initial !== undefined) {
+        at += 1;
+    }
+    const medial = MEDIALS_BY_SYMBOL.get(symbols[at] ?? "");
+    if (medial !== undefined) {
+        at += 1;
+    }
+    // ㄦ is the 儿化 suffix everywhere except at the very front of a syllable,
+    // where it is the rhyme of 儿 ér itself. That is what separates ㄦ from ㄕㄦ:
+    // 事儿 shìr writes no rhyme at all, so the ㄦ can only be the suffix, and
+    // 二儿 èr with a suffix is ㄦㄦ.
+    const isSuffix = at > 0 && symbols[at] === "ㄦ";
+    const rhyme = isSuffix ? undefined : RHYMES_BY_SYMBOL.get(symbols[at] ?? "");
+    if (rhyme !== undefined) {
+        at += 1;
+    }
+    const hasErhua = at > 0 && symbols[at] === "ㄦ";
+    if (hasErhua) {
+        at += 1;
+    }
+    return at === symbols.length
+        ? {
+            initial: initial ?? "",
+            medial: medial ?? "",
+            rhyme: rhyme ?? "",
+            hasErhua,
+        }
+        : undefined;
+}
+/**
+ * Resolve parsed symbols to an underlying final.
+ *
+ * ㄨㄥ is the one context-dependent rhyme in the system: with an initial it is
+ * `ong` (中 ㄓㄨㄥ) and without one it is `ueng` (翁 ㄨㄥ). Everything else
+ * reads the same wherever it stands.
+ */
+function finalOf(parsed) {
+    const { initial, medial, rhyme } = parsed;
+    if (medial === "" && rhyme === "") {
+        return EMPTY_RHYME_INITIALS.has(initial) ? "i" : undefined;
+    }
+    if (medial === "u" && rhyme === "eng") {
+        return initial === "" ? "ueng" : "ong";
+    }
+    return FINALS_BY_PARTS.get(`${medial}|${rhyme}`);
+}
+/**
+ * Read one parse of a bopomofo string, or nothing if it does not resolve.
+ */
+function readParsed(text, hasInitial) {
+    const parsed = parseSymbols(text, hasInitial);
+    const final = parsed === undefined ? undefined : finalOf(parsed);
+    return parsed === undefined || final === undefined
+        ? undefined
+        : {
+            initial: parsed.initial,
+            final,
+            tone: undefined,
+            ...(parsed.hasErhua && { erhua: true }),
+        };
+}
+/**
+ * Read a bopomofo syllable: ㄐㄧㄡˋ becomes 就 jiù.
+ *
+ * An unmarked syllable is a first tone rather than a toneless one, because
+ * bopomofo marks the first tone by leaving it off — the omission is itself
+ * written, in a way that a bare `bei` typed as pinyin is not. Undefined for
+ * anything that is not exactly one well-formed syllable.
+ */
+export function readBopomofo(text) {
+    const split = splitTone(text.trim().normalize("NFC"));
+    if (split === undefined || split[0] === "") {
+        return undefined;
+    }
+    const [written, tone] = split;
+    const read = readParsed(written, true) ?? readParsed(written, false);
+    return read === undefined ? undefined : { ...read, tone: tone ?? 1 };
+}
+//# sourceMappingURL=bopomofo.js.map

package/dist/transcription/bopomofo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bopomofo.js","sourceRoot":"","sources":["../../src/transcription/bopomofo.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGvD,OAAO,EAAE,YAAY,EAAa,MAAM,iBAAiB,CAAC;AA8B1D;;;;;GAKG;AACH,MAAM,eAAe,GAAG,IAAI,GAAG,CAAkB;IAC/C,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;CACX,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,GAAG,CAAiB;IAC7C,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;CACX,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,aAAa,GAAG,IAAI,GAAG,CAAgB;IAC3C,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,KAAK,EAAE,GAAG,CAAC;IACZ,CAAC,KAAK,EAAE,GAAG,CAAC;IACZ,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,IAAI,EAAE,GAAG,CAAC;CACZ,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,WAAW,GAA4C;IAC3D,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC;IACZ,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC;IACZ,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC;IACZ,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC;IACZ,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC;IACd,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC;IACd,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC;IACd,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC;IACd,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC;IACd,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC;IACd,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC;IACd,GAAG,EAAE,CAAC,EAAE,EAAE,KAAK,CAAC;IAChB,GAAG,EAAE,CAAC,EAAE,EAAE,KAAK,CAAC;IAChB,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC;IACjB,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC;IACZ,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IACd,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IACd,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IACd,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IAChB,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IAChB,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IAChB,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IACf,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC;IAClB,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC;IACjB,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC;IAClB,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC;IACZ,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IACd,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IACd,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IAChB,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IAChB,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IAChB,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IAChB,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC;IAClB,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC;IAClB,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC;IACZ,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IACd,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IAChB,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC;IACf,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC;IACZ,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC;IACZ,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC;CACf,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAU;IAC5C,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;CACJ,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,UAAU,GAAG,IAAI,GAAG,CAAe;IACvC,CAAC,CAAC,EAAE,GAAG,CAAC;IACR,CAAC,CAAC,EAAE,GAAG,CAAC;IACR,CAAC,CAAC,EAAE,GAAG,CAAC;IACR,CAAC,CAAC,EAAE,GAAG,CAAC;IACR,CAAC,YAAY,EAAE,GAAG,CAAC;CACpB,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,aAAa,GAAG,IAAI,GAAG,CAAe;IAC1C,CAAC,GAAG,EAAE,CAAC,CAAC;IACR,CAAC,GAAG,EAAE,CAAC,CAAC;IACR,CAAC,GAAG,EAAE,CAAC,CAAC;IACR,CAAC,GAAG,EAAE,CAAC,CAAC;IACR,CAAC,GAAG,EAAE,CAAC,CAAC;IACR,CAAC,GAAG,EAAE,CAAC,CAAC;IACR,CAAC,GAAG,EAAE,CAAC,CAAC;IACR,CAAC,GAAG,EAAE,YAAY,CAAC;IACnB,CAAC,GAAG,EAAE,YAAY,CAAC;CACpB,CAAC,CAAC;AAcH;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,QAAkB,EAClB,OAAO,GAAoB,EAAE;IAE7B,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC;IAC1C,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAC3C,MAAM,YAAY,GAAG,KAAK,KAAK,GAAG,IAAI,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAExE,MAAM,OAAO,GAAG;QACd,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE;QAClC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACtD,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACpD,QAAQ,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;KACnC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEX,MAAM,IAAI,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnE,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,OAAO,CAAC,SAAS,KAAK,MAAM,CAAC,EAAE,CAAC;QACvE,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;AAC3E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,SAA8B,EAC9B,OAAO,GAAoB,EAAE;IAE7B,OAAO,SAAS;SACb,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;SACnD,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,eAAe,GAAG,IAAI,GAAG,CAC7B,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;IAC5D,GAAG,MAAM,IAAI,KAAK,EAAE;IACpB,KAAc;CACf,CAAC,CACH,CAAC;AAEF;;GAEG;AACH,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAChC,CAAC,GAAG,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CACnE,CAAC;AAEF;;GAEG;AACH,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAC/B,CAAC,GAAG,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAChE,CAAC;AAEF;;GAEG;AACH,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAC9B,CAAC,GAAG,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAC7D,CAAC;AAEF;;GAEG;AACH,SAAS,QAAQ,CAAC,MAAc;IAC9B,OAAO,CACL,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC;QAC9B,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC;QAC7B,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC;QAC5B,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAC1B,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,OAAO,CACL,OAAO,KAAK,EAAE,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAC5E,CAAC;AACJ,CAAC;AAYD;;;;;;;GAOG;AACH,SAAS,SAAS,CAChB,IAAY;IAEZ,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnD,OAAO,QAAQ,KAAK,SAAS;QAC3B,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,YAAY,CAAC,IAAY,EAAE,UAAmB;IACrD,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,EAAE,GAAG,CAAC,CAAC;IAEX,MAAM,OAAO,GAAG,UAAU;QACxB,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;QAC3C,CAAC,CAAC,SAAS,CAAC;IACd,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,EAAE,IAAI,CAAC,CAAC;IACV,CAAC;IACD,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IACxD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,EAAE,IAAI,CAAC,CAAC;IACV,CAAC;IACD,wEAAwE;IACxE,0EAA0E;IAC1E,uEAAuE;IACvE,6BAA6B;IAC7B,MAAM,QAAQ,GAAG,EAAE,GAAG,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7E,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,EAAE,IAAI,CAAC,CAAC;IACV,CAAC;IACD,MAAM,QAAQ,GAAG,EAAE,GAAG,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC;IAC/C,IAAI,QAAQ,EAAE,CAAC;QACb,EAAE,IAAI,CAAC,CAAC;IACV,CAAC;IAED,OAAO,EAAE,KAAK,OAAO,CAAC,MAAM;QAC1B,CAAC,CAAC;YACE,OAAO,EAAE,OAAO,IAAI,EAAE;YACtB,MAAM,EAAE,MAAM,IAAI,EAAE;YACpB,KAAK,EAAE,KAAK,IAAI,EAAE;YAClB,QAAQ;SACT;QACH,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,OAAO,CAAC,MAAc;IAC7B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IAC1C,IAAI,MAAM,KAAK,EAAE,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;QAClC,OAAO,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;QACtC,OAAO,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IACzC,CAAC;IACD,OAAO,eAAe,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC;AACnD,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,IAAY,EAAE,UAAmB;IACnD,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjE,OAAO,MAAM,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS;QAChD,CAAC,CAAC,SAAS;QACX,CAAC,CAAC;YACE,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,KAAK;YACL,IAAI,EAAE,SAAS;YACf,GAAG,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;SACxC,CAAC;AACR,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;QAC3C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC;IAE9B,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrE,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC;AACvE,CAAC"}

package/dist/transcription/gwoyeu.d.ts

@@ -0,0 +1,32 @@
+import { type Syllable } from "../syllable/syllable.js";
+/**
+ * Write a syllable in Gwoyeu Romatzyh: 就 jiù becomes `jiow`.
+ *
+ * An unwritten tone is written as the basic form, because GR has no other
+ * form to write — which means it reads back as a first tone, exactly as
+ * bopomofo's unmarked syllable does. The neutral tone takes the dot in front,
+ * and the syllable behind it is the basic form rather than the etymological
+ * spelling GR would use, for the reason the module comment gives.
+ */
+export declare function writeGwoyeu(syllable: Syllable): string;
+/**
+ * Write a word in Gwoyeu Romatzyh, one syllable after another.
+ *
+ * Solid, as GR writes a word: 北京 is `Beeijing`, which is the convention
+ * pinyin inherited. GR uses an apostrophe where the join is ambiguous — its own
+ * name for pinyin, `Pin'in`, is the standard example — and that is not written
+ * here, for the same reason `readGwoyeu` takes one syllable at a time: knowing
+ * where the boundary is ambiguous means being able to split the word, and
+ * nothing here splits a GR word.
+ */
+export declare function writeGwoyeuWord(syllables: readonly Syllable[]): string;
+/**
+ * Read a Gwoyeu Romatzyh syllable: `jiow` becomes 就 jiù.
+ *
+ * A leading dot is the neutral tone, and it wins over whatever tone the
+ * spelling behind it carries — `.yeou` is a neutral 友, which is what GR means
+ * by it. Returns every syllable the spelling stands for, and nothing at all for
+ * a spelling no syllable of the inventory writes.
+ */
+export declare function readGwoyeu(text: string): readonly Syllable[];
+//# sourceMappingURL=gwoyeu.d.ts.map

package/dist/transcription/gwoyeu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gwoyeu.d.ts","sourceRoot":"","sources":["../../src/transcription/gwoyeu.ts"],"names":[],"mappings":"AAgCA,OAAO,EAAgB,KAAK,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAkZtE;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAStD;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,GAAG,MAAM,CAEtE;AAqDD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,QAAQ,EAAE,CAS5D"}