@yosina-lib/yosina 0.1.0

package/dist/esm/chars.js

@@ -0,0 +1,37 @@
+export const buildCharArray = (text) => {
+    const retval = [];
+    let offset = 0;
+    let pc;
+    let pcp;
+    for (const c of text) {
+        const cp = c.codePointAt(0);
+        if (pc !== undefined && pcp !== undefined) {
+            if ((cp >= 0xfe00 && cp <= 0xfe0f) || (cp >= 0xe0100 && cp <= 0xe01ef)) {
+                const cc = pc + c;
+                retval.push({ c: cc, offset, source: undefined });
+                offset += cc.length;
+                pc = pcp = undefined;
+                continue;
+            }
+            retval.push({ c: pc, offset, source: undefined });
+            offset += pc.length;
+        }
+        pc = c;
+        pcp = cp;
+    }
+    if (pc !== undefined && pcp !== undefined) {
+        retval.push({ c: pc, offset, source: undefined });
+        offset += pc.length;
+    }
+    // add sentinel
+    retval.push({ c: "", offset: offset, source: undefined });
+    return retval;
+};
+export const fromChars = (chars) => {
+    let result = "";
+    for (const c of chars) {
+        result += c.c;
+    }
+    return result;
+};
+//# sourceMappingURL=chars.js.map

package/dist/esm/chars.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chars.js","sourceRoot":"","sources":["../../src/chars.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE;IACrD,MAAM,MAAM,GAAW,EAAE,CAAC;IAC1B,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,EAAsB,CAAC;IAC3B,IAAI,GAAuB,CAAC;IAC5B,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QACrB,MAAM,EAAE,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAW,CAAC;QACtC,IAAI,EAAE,KAAK,SAAS,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YAC1C,IAAI,CAAC,EAAE,IAAI,MAAM,IAAI,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,OAAO,IAAI,EAAE,IAAI,OAAO,CAAC,EAAE,CAAC;gBACvE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;gBAClB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;gBAClD,MAAM,IAAI,EAAE,CAAC,MAAM,CAAC;gBACpB,EAAE,GAAG,GAAG,GAAG,SAAS,CAAC;gBACrB,SAAS;YACX,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;YAClD,MAAM,IAAI,EAAE,CAAC,MAAM,CAAC;QACtB,CAAC;QACD,EAAE,GAAG,CAAC,CAAC;QACP,GAAG,GAAG,EAAE,CAAC;IACX,CAAC;IACD,IAAI,EAAE,KAAK,SAAS,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QAClD,MAAM,IAAI,EAAE,CAAC,MAAM,CAAC;IACtB,CAAC;IACD,eAAe;IACf,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1D,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAqB,EAAE,EAAE;IACjD,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,35 @@
+import type { TransliterationRecipe } from "./recipes.js";
+import type { TransliteratorConfig } from "./transliterators/index.js";
+export { buildCharArray, fromChars } from "./chars.js";
+export { makeChainedTransliterator } from "./intrinsics.js";
+export type { TransliterationRecipe } from "./recipes.js";
+export { buildTransliteratorConfigsFromRecipe } from "./recipes.js";
+export type { TransliteratorConfig } from "./transliterators/index.js";
+/**
+ * Frontend convenience function to create a string-to-string transliterator from a recipe or a list of configs.
+ *
+ * ```typescript
+ * export const makeTransliterator = async (configsOrRecipe: (TransliteratorConfig | string)[] | TransliterationRecipe) => {
+ *   const tl = await makeChainedTransliterator(
+ *     Array.isArray(configsOrRecipe) ? configsOrRecipe : buildTransliteratorConfigsFromRecipe(configsOrRecipe),
+ *   );
+ *   return (in_: string) => {
+ *     return fromChars(tl(buildCharArray(in_)));
+ *   };
+ * };
+ * ```
+ *
+ * The low-level functions used here are:
+ *
+ * - {@link makeChainedTransliterator}
+ * - {@link fromChars}
+ * - {@link buildCharArray}
+ * - {@link buildTransliteratorConfigsFromRecipe}
+ *
+ * Please refer to the description of {@link buildTransliteratorConfigsFromRecipe} for the preferences that can be specified in a recipe. Also,
+ * refer to the description of {@link makeChainedTransliterator} and {@link TransliteratorConfig} for the details of the configuration objects.
+ *
+ * @param configsOrRecipe A recipe or a list of `TransliteratorConfig`s.
+ * @returns A transliterator function that takes a string and returns a string.
+ */
+export declare const makeTransliterator: (configsOrRecipe: (TransliteratorConfig | string)[] | TransliterationRecipe) => Promise<(in_: string) => string>;

package/dist/esm/index.js

@@ -0,0 +1,40 @@
+import { buildCharArray, fromChars } from "./chars.js";
+import { makeChainedTransliterator } from "./intrinsics.js";
+import { buildTransliteratorConfigsFromRecipe } from "./recipes.js";
+export { buildCharArray, fromChars } from "./chars.js";
+export { makeChainedTransliterator } from "./intrinsics.js";
+export { buildTransliteratorConfigsFromRecipe } from "./recipes.js";
+/**
+ * Frontend convenience function to create a string-to-string transliterator from a recipe or a list of configs.
+ *
+ * ```typescript
+ * export const makeTransliterator = async (configsOrRecipe: (TransliteratorConfig | string)[] | TransliterationRecipe) => {
+ *   const tl = await makeChainedTransliterator(
+ *     Array.isArray(configsOrRecipe) ? configsOrRecipe : buildTransliteratorConfigsFromRecipe(configsOrRecipe),
+ *   );
+ *   return (in_: string) => {
+ *     return fromChars(tl(buildCharArray(in_)));
+ *   };
+ * };
+ * ```
+ *
+ * The low-level functions used here are:
+ *
+ * - {@link makeChainedTransliterator}
+ * - {@link fromChars}
+ * - {@link buildCharArray}
+ * - {@link buildTransliteratorConfigsFromRecipe}
+ *
+ * Please refer to the description of {@link buildTransliteratorConfigsFromRecipe} for the preferences that can be specified in a recipe. Also,
+ * refer to the description of {@link makeChainedTransliterator} and {@link TransliteratorConfig} for the details of the configuration objects.
+ *
+ * @param configsOrRecipe A recipe or a list of `TransliteratorConfig`s.
+ * @returns A transliterator function that takes a string and returns a string.
+ */
+export const makeTransliterator = async (configsOrRecipe) => {
+    const tl = await makeChainedTransliterator(Array.isArray(configsOrRecipe) ? configsOrRecipe : buildTransliteratorConfigsFromRecipe(configsOrRecipe));
+    return (in_) => {
+        return fromChars(tl(buildCharArray(in_)));
+    };
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAE5D,OAAO,EAAE,oCAAoC,EAAE,MAAM,cAAc,CAAC;AAGpE,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAE5D,OAAO,EAAE,oCAAoC,EAAE,MAAM,cAAc,CAAC;AAGpE;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EACrC,eAA0E,EAC1E,EAAE;IACF,MAAM,EAAE,GAAG,MAAM,yBAAyB,CACxC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,oCAAoC,CAAC,eAAe,CAAC,CACzG,CAAC;IACF,OAAO,CAAC,GAAW,EAAE,EAAE;QACrB,OAAO,SAAS,CAAC,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/intrinsics.d.ts

@@ -0,0 +1,4 @@
+import type { TransliteratorConfig } from "./transliterators/index.js";
+import type { Char, Transliterator } from "./types.js";
+export declare const makeChainedTransliterator: (transliteratorConfigs: (TransliteratorConfig | string)[]) => Promise<Transliterator>;
+export declare const isTransliterated: (c: Char) => boolean;

package/dist/esm/intrinsics.js

@@ -0,0 +1,28 @@
+import { getTransliteratorFactory } from "./transliterators/index.js";
+export const makeChainedTransliterator = async (transliteratorConfigs) => {
+    let result;
+    for (const config of transliteratorConfigs) {
+        const t = typeof config === "string"
+            ? (await getTransliteratorFactory(config))({})
+            : (await getTransliteratorFactory(config[0]))(config[1]);
+        result = ((tt) => (tt !== undefined ? (in_) => t(tt(in_)) : t))(result);
+    }
+    if (result === undefined) {
+        throw new Error("at least one transliterator must be specified");
+    }
+    return result;
+};
+export const isTransliterated = (c) => {
+    for (;;) {
+        const s = c.source;
+        if (s === undefined) {
+            break;
+        }
+        if (s.c !== c.c) {
+            return true;
+        }
+        c = s;
+    }
+    return false;
+};
+//# sourceMappingURL=intrinsics.js.map

package/dist/esm/intrinsics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"intrinsics.js","sourceRoot":"","sources":["../../src/intrinsics.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAGtE,MAAM,CAAC,MAAM,yBAAyB,GAAG,KAAK,EAC5C,qBAAwD,EAC/B,EAAE;IAC3B,IAAI,MAAkC,CAAC;IACvC,KAAK,MAAM,MAAM,IAAI,qBAAqB,EAAE,CAAC;QAC3C,MAAM,CAAC,GACL,OAAO,MAAM,KAAK,QAAQ;YACxB,CAAC,CAAC,CAAC,MAAM,wBAAwB,CAAC,MAAkC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1E,CAAC,CAAC,CAAC,MAAM,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7D,MAAM,GAAG,CAAC,CAAC,EAA8B,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAmB,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACtH,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAO,EAAE,EAAE;IAC1C,SAAS,CAAC;QACR,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;QACnB,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YACpB,MAAM;QACR,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,CAAC,GAAG,CAAC,CAAC;IACR,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/dist/esm/recipes.d.ts

@@ -0,0 +1,176 @@
+import type { Mapping } from "./transliterators/hyphens.js";
+import type { TransliteratorConfig } from "./transliterators/index.js";
+import type { Charset } from "./transliterators/ivs-svs-base.js";
+export type TransliterationRecipe = {
+    /**
+     * Replace codepoints that correspond to old-style kanji glyphs (旧字体; kyu-ji-tai) with their modern equivalents (新字体; shin-ji-tai).
+     * @example
+     * ```js
+     * // Input:  "舊字體の變換"
+     * // Output: "旧字体の変換"
+     * ```
+     */
+    kanjiOldNew?: boolean;
+    /**
+     * Convert between hiragana and katakana scripts.
+     * @example
+     * ```js
+     * // Input:  "ひらがな" (with "hira-to-kata")
+     * // Output: "ヒラガナ"
+     * // Input:  "カタカナ" (with "kata-to-hira")
+     * // Output: "かたかな"
+     * ```
+     */
+    hiraKata?: "hira-to-kata" | "kata-to-hira";
+    /**
+     * Replace Japanese iteration marks with the characters they represent.
+     * @example
+     * ```js
+     * // Input:  "時々"
+     * // Output: "時時"
+     * // Input:  "いすゞ"
+     * // Output: "いすず"
+     * ```
+     */
+    replaceJapaneseIterationMarks?: boolean;
+    /**
+     * Replace "suspicious" hyphens with prolonged sound marks, and vice versa.
+     * @example
+     * ```js
+     * // Input:  "スーパ-" (with hyphen-minus)
+     * // Output: "スーパー" (becomes prolonged sound mark)
+     * ```
+     */
+    replaceSuspiciousHyphensToProlongedSoundMarks?: boolean;
+    /**
+     * Replace circled or squared characters with their corresponding templates.
+     * @example
+     * ```js
+     * // Input:  "①②③"
+     * // Output: "(1)(2)(3)"
+     * // Input:  "㊙㊗"
+     * // Output: "(秘)(祝)"
+     * ```
+     */
+    replaceCircledOrSquaredCharacters?: boolean | "exclude-emojis";
+    /**
+     * Replace combined characters with their corresponding characters.
+     * @example
+     * ```js
+     * // Input:  "㍻" (single character for Heisei era)
+     * // Output: "平成"
+     * // Input:  "㈱"
+     * // Output: "(株)"
+     * ```
+     */
+    replaceCombinedCharacters?: boolean;
+    /**
+     * Replace ideographic annotations used in the traditional method of Chinese-to-Japanese translation deviced in the ancient Japan.
+     * @example
+     * ```js
+     * // Input:  "㆖㆘" (ideographic annotations)
+     * // Output: "上下"
+     * ```
+     */
+    replaceIdeographicAnnotations?: boolean;
+    /**
+     * Replace codepoints for the Kang Xi radicals whose glyphs resemble those of CJK ideographs with the CJK ideograph counterparts.
+     * @example
+     * ```js
+     * // Input:  "⾔⾨⾷" (Kangxi radicals)
+     * // Output: "言門食" (CJK ideographs)
+     * ```
+     */
+    replaceRadicals?: boolean;
+    /**
+     * Replace various space characters with plain whitespaces or empty strings.
+     * @example
+     * ```js
+     * // Input:  "A　B" (ideographic space U+3000)
+     * // Output: "A B" (half-width space)
+     * // Input:  "A B" (non-breaking space U+00A0)
+     * // Output: "A B" (regular space)
+     * ```
+     */
+    replaceSpaces?: boolean;
+    /**
+     * Replace various dash or hyphen symbols with those common in Japanese writing.
+     * @example
+     * ```js
+     * // Input:  "2019—2020" (em dash)
+     * // Output: "2019-2020" (hyphen-minus)
+     * // Input:  "A–B" (en dash)
+     * // Output: "A-B"
+     * ```
+     */
+    replaceHyphens?: boolean | Mapping[];
+    /**
+     * Replace mathematical alphanumerics with their plain ASCII equivalents.
+     * @example
+     * ```js
+     * // Input:  "𝐀𝐁𝐂" (mathematical bold)
+     * // Output: "ABC"
+     * // Input:  "𝟏𝟐𝟑" (mathematical bold digits)
+     * // Output: "123"
+     * ```
+     */
+    replaceMathematicalAlphanumerics?: boolean;
+    /**
+     * Combine decomposed hiraganas and katakanas into single counterparts.
+     * @example
+     * ```js
+     * // Input:  "が" (か + ゙)
+     * // Output: "が" (single character)
+     * // Input:  "ヘ゜" (ヘ + ゜)
+     * // Output: "ペ" (single character)
+     * ```
+     */
+    combineDecomposedHiraganasAndKatakanas?: boolean;
+    /**
+     * Replace half-width characters in that they are marked as half-width or ambiguous in the East Asian Width table to the fullwidth equivalents.
+     * Specify `"u005c-as-yen-sign"` instead of a boolean to treat the backslash character (U+005C) as the yen sign in JIS X 0201.
+     * @example
+     * ```js
+     * // Input:  "ABC123"
+     * // Output: "ＡＢＣ１２３"
+     * // Input:  "ｶﾀｶﾅ"
+     * // Output: "カタカナ"
+     * ```
+     */
+    toFullwidth?: boolean | "u005c-as-yen-sign";
+    /**
+     * Replace full-width characters with their half-width equivalents.
+     * Specify `"hankaku-kana"` instead of a boolean to handle half-width katakanas too.
+     * @example
+     * ```js
+     * // Input:  "ＡＢＣ１２３"
+     * // Output: "ABC123"
+     * // Input:  "カタカナ" (with hankaku-kana)
+     * // Output: "ｶﾀｶﾅ"
+     * ```
+     */
+    toHalfwidth?: boolean | "hankaku-kana";
+    /**
+     * Replace CJK ideographs followed by IVSes and SVSes with those without selectors based on Adobe-Japan1 character mappings.
+     * Specify `"drop-all-selectors"` to get rid of all selectors from the result.
+     * @example
+     * ```js
+     * // Input:  "葛󠄀" (葛 + IVS U+E0100)
+     * // Output: "葛" (without selector)
+     * // Input:  "辻󠄀" (辻 + IVS)
+     * // Output: "辻"
+     * ```
+     */
+    removeIVSSVS?: boolean | "drop-all-selectors";
+    /**
+     * Charset assumed during IVS/SVS transliteration. The default is `"unijis_2004"`.
+     */
+    charset?: Charset;
+};
+/**
+ * Builds an array of {@link TransliteratorConfig} from a recipe object.
+ *
+ * @param recipe An object that conforms to {@link TransliterationRecipe}.
+ * @returns An array of {@link TransliteratorConfig} that can be passed to {@link intrinsics.makeChainedTransliterator}.
+ */
+export declare const buildTransliteratorConfigsFromRecipe: (recipe: TransliterationRecipe) => TransliteratorConfig[];

package/dist/esm/recipes.js

@@ -0,0 +1,151 @@
+const applicationOrder = [
+    "kanjiOldNew",
+    "replaceSuspiciousHyphensToProlongedSoundMarks",
+    "replaceCircledOrSquaredCharacters",
+    "replaceCombinedCharacters",
+    "replaceIdeographicAnnotations",
+    "replaceRadicals",
+    "replaceSpaces",
+    "replaceHyphens",
+    "replaceMathematicalAlphanumerics",
+    "combineDecomposedHiraganasAndKatakanas",
+    "toFullwidth",
+    "hiraKata",
+    "replaceJapaneseIterationMarks",
+    "toHalfwidth",
+    "removeIVSSVS",
+];
+const insertHead = (ctx, config, forceReplace) => {
+    const i = ctx.head.findIndex((c) => c[0] === config[0]);
+    if (i >= 0) {
+        return forceReplace
+            ? {
+                ...ctx,
+                head: [...ctx.head.slice(0, i), config, ...ctx.head.slice(i + 1)],
+            }
+            : ctx;
+    }
+    return {
+        ...ctx,
+        head: [config, ...ctx.head],
+    };
+};
+const insertMiddle = (ctx, config, forceReplace) => {
+    const i = ctx.tail.findIndex((c) => c[0] === config[0]);
+    if (i >= 0) {
+        return forceReplace
+            ? {
+                ...ctx,
+                tail: [...ctx.tail.slice(0, i), config, ...ctx.tail.slice(i + 1)],
+            }
+            : ctx;
+    }
+    return {
+        ...ctx,
+        tail: [config, ...ctx.tail],
+    };
+};
+const insertTail = (ctx, config, forceReplace) => {
+    const i = ctx.tail.findIndex((c) => c[0] === config[0]);
+    if (i >= 0) {
+        return forceReplace
+            ? {
+                ...ctx,
+                tail: [...ctx.tail.slice(0, i), ...ctx.tail.slice(i + 1), config],
+            }
+            : ctx;
+    }
+    return {
+        ...ctx,
+        tail: [...ctx.tail, config],
+    };
+};
+const removeIVSSVS = (ctx, dropSelectorsAltogether, charset) => insertTail(insertHead(ctx, ["ivs-svs-base", { mode: "ivs-or-svs" }], true), ["ivs-svs-base", { mode: "base", dropSelectorsAltogether, charset: charset }], true);
+const transliteratorAppliers = {
+    kanjiOldNew: (ctx, recipe) => recipe.kanjiOldNew ? insertMiddle(removeIVSSVS(ctx, false, recipe.charset), ["kanji-old-new", {}]) : ctx,
+    hiraKata: (ctx, recipe) => (recipe.hiraKata ? insertMiddle(ctx, ["hira-kata", { mode: recipe.hiraKata }]) : ctx),
+    replaceJapaneseIterationMarks: (ctx, recipe) => {
+        if (!recipe.replaceJapaneseIterationMarks)
+            return ctx;
+        // Insert HiraKataComposition at head to ensure composed forms
+        ctx = insertHead(ctx, ["hira-kata-composition", { composeNonCombiningMarks: true }]);
+        // Then insert the japanese-iteration-marks in the middle
+        return insertMiddle(ctx, ["japanese-iteration-marks", {}]);
+    },
+    replaceSuspiciousHyphensToProlongedSoundMarks: (ctx, recipe) => recipe.replaceSuspiciousHyphensToProlongedSoundMarks
+        ? insertMiddle(ctx, ["prolonged-sound-marks", { replaceProlongedMarksFollowingAlnums: true }])
+        : ctx,
+    replaceCircledOrSquaredCharacters: (ctx, recipe) => recipe.replaceCircledOrSquaredCharacters
+        ? insertMiddle(ctx, [
+            "circled-or-squared",
+            {
+                includeEmojis: recipe.replaceCircledOrSquaredCharacters !== "exclude-emojis",
+            },
+        ])
+        : ctx,
+    replaceCombinedCharacters: (ctx, recipe) => recipe.replaceCombinedCharacters ? insertMiddle(ctx, ["combined", {}]) : ctx,
+    replaceIdeographicAnnotations: (ctx, recipe) => recipe.replaceIdeographicAnnotations ? insertMiddle(ctx, ["ideographic-annotations", {}]) : ctx,
+    replaceRadicals: (ctx, recipe) => (recipe.replaceRadicals ? insertMiddle(ctx, ["radicals", {}]) : ctx),
+    replaceSpaces: (ctx, recipe) => (recipe.replaceSpaces ? insertMiddle(ctx, ["spaces", {}]) : ctx),
+    replaceHyphens: (ctx, recipe) => recipe.replaceHyphens
+        ? insertMiddle(ctx, [
+            "hyphens",
+            {
+                precedence: typeof recipe.replaceHyphens === "boolean" ? ["jisx0208_90_windows", "jisx0201"] : recipe.replaceHyphens,
+            },
+        ])
+        : ctx,
+    replaceMathematicalAlphanumerics: (ctx, recipe) => recipe.replaceMathematicalAlphanumerics ? insertMiddle(ctx, ["mathematical-alphanumerics", {}]) : ctx,
+    combineDecomposedHiraganasAndKatakanas: (ctx, recipe) => recipe.combineDecomposedHiraganasAndKatakanas
+        ? insertHead(ctx, ["hira-kata-composition", { composeNonCombiningMarks: true }])
+        : ctx,
+    toHalfwidth: (ctx, recipe) => {
+        if (recipe.toHalfwidth && recipe.toFullwidth) {
+            throw ["toHalfwidth and toFullwidth are mutually exclusive"];
+        }
+        return recipe.toHalfwidth
+            ? insertTail(ctx, [
+                "jisx0201-and-alike",
+                { fullwidthToHalfwidth: true, convertGL: true, convertGR: recipe.toHalfwidth === "hankaku-kana" },
+            ])
+            : ctx;
+    },
+    toFullwidth: (ctx, recipe) => {
+        if (recipe.toFullwidth && recipe.toHalfwidth) {
+            throw ["toFullwidth and toHalfwidth are mutually exclusive"];
+        }
+        return recipe.toFullwidth
+            ? insertTail(ctx, [
+                "jisx0201-and-alike",
+                { fullwidthToHalfwidth: false, u005cAsYenSign: recipe.toFullwidth === "u005c-as-yen-sign" },
+            ])
+            : ctx;
+    },
+    removeIVSSVS: (ctx, recipe) => recipe.removeIVSSVS ? removeIVSSVS(ctx, recipe.removeIVSSVS === "drop-all-selectors", recipe.charset) : ctx,
+};
+/**
+ * Builds an array of {@link TransliteratorConfig} from a recipe object.
+ *
+ * @param recipe An object that conforms to {@link TransliterationRecipe}.
+ * @returns An array of {@link TransliteratorConfig} that can be passed to {@link intrinsics.makeChainedTransliterator}.
+ */
+export const buildTransliteratorConfigsFromRecipe = (recipe) => {
+    let ctx = { head: [], tail: [] };
+    const errors = [];
+    for (const k of applicationOrder) {
+        try {
+            ctx = transliteratorAppliers[k](ctx, recipe);
+        }
+        catch (e) {
+            if (!Array.isArray(e)) {
+                throw e;
+            }
+            errors.push([k, e]);
+        }
+    }
+    if (errors.length) {
+        throw new Error(errors.map(([tl, errors]) => `${tl}: ${errors.join(", ")}`).join("; "));
+    }
+    return [...ctx.head, ...ctx.tail];
+};
+//# sourceMappingURL=recipes.js.map

package/dist/esm/recipes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.js","sourceRoot":"","sources":["../../src/recipes.ts"],"names":[],"mappings":"AA8KA,MAAM,gBAAgB,GAAgC;IACpD,aAAa;IACb,+CAA+C;IAC/C,mCAAmC;IACnC,2BAA2B;IAC3B,+BAA+B;IAC/B,iBAAiB;IACjB,eAAe;IACf,gBAAgB;IAChB,kCAAkC;IAClC,wCAAwC;IACxC,aAAa;IACb,UAAU;IACV,+BAA+B;IAC/B,aAAa;IACb,cAAc;CACf,CAAC;AAOF,MAAM,UAAU,GAAG,CACjB,GAAoC,EACpC,MAA4B,EAC5B,YAAsB,EACW,EAAE;IACnC,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACX,OAAO,YAAY;YACjB,CAAC,CAAC;gBACE,GAAG,GAAG;gBACN,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;aAClE;YACH,CAAC,CAAC,GAAG,CAAC;IACV,CAAC;IACD,OAAO;QACL,GAAG,GAAG;QACN,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC;KAC5B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CACnB,GAAoC,EACpC,MAA4B,EAC5B,YAAsB,EACW,EAAE;IACnC,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACX,OAAO,YAAY;YACjB,CAAC,CAAC;gBACE,GAAG,GAAG;gBACN,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;aAClE;YACH,CAAC,CAAC,GAAG,CAAC;IACV,CAAC;IACD,OAAO;QACL,GAAG,GAAG;QACN,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC;KAC5B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CACjB,GAAoC,EACpC,MAA4B,EAC5B,YAAsB,EACW,EAAE;IACnC,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACX,OAAO,YAAY;YACjB,CAAC,CAAC;gBACE,GAAG,GAAG;gBACN,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC;aAClE;YACH,CAAC,CAAC,GAAG,CAAC;IACV,CAAC;IACD,OAAO;QACL,GAAG,GAAG;QACN,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC;KAC5B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,GAAoC,EAAE,uBAAgC,EAAE,OAAiB,EAAE,EAAE,CACjH,UAAU,CACR,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,CAAC,EAC/D,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,uBAAuB,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EAC7E,IAAI,CACL,CAAC;AAEJ,MAAM,sBAAsB,GAKxB;IACF,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAC3B,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;IAC1G,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAChH,6BAA6B,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QAC7C,IAAI,CAAC,MAAM,CAAC,6BAA6B;YAAE,OAAO,GAAG,CAAC;QACtD,8DAA8D;QAC9D,GAAG,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,uBAAuB,EAAE,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACrF,yDAAyD;QACzD,OAAO,YAAY,CAAC,GAAG,EAAE,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC;IACD,6CAA6C,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAC7D,MAAM,CAAC,6CAA6C;QAClD,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,uBAAuB,EAAE,EAAE,oCAAoC,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9F,CAAC,CAAC,GAAG;IACT,iCAAiC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CACjD,MAAM,CAAC,iCAAiC;QACtC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE;YAChB,oBAAoB;YACpB;gBACE,aAAa,EAAE,MAAM,CAAC,iCAAiC,KAAK,gBAAgB;aAC7E;SACF,CAAC;QACJ,CAAC,CAAC,GAAG;IACT,yBAAyB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CACzC,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;IAC9E,6BAA6B,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAC7C,MAAM,CAAC,6BAA6B,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;IACjG,eAAe,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACtG,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAChG,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAC9B,MAAM,CAAC,cAAc;QACnB,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE;YAChB,SAAS;YACT;gBACE,UAAU,EACR,OAAO,MAAM,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,qBAAqB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc;aAC3G;SACF,CAAC;QACJ,CAAC,CAAC,GAAG;IACT,gCAAgC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAChD,MAAM,CAAC,gCAAgC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;IACvG,sCAAsC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CACtD,MAAM,CAAC,sCAAsC;QAC3C,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,uBAAuB,EAAE,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC,CAAC;QAChF,CAAC,CAAC,GAAG;IACT,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QAC3B,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YAC7C,MAAM,CAAC,oDAAoD,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,MAAM,CAAC,WAAW;YACvB,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE;gBACd,oBAAoB;gBACpB,EAAE,oBAAoB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,WAAW,KAAK,cAAc,EAAE;aAClG,CAAC;YACJ,CAAC,CAAC,GAAG,CAAC;IACV,CAAC;IACD,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QAC3B,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YAC7C,MAAM,CAAC,oDAAoD,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,MAAM,CAAC,WAAW;YACvB,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE;gBACd,oBAAoB;gBACpB,EAAE,oBAAoB,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,CAAC,WAAW,KAAK,mBAAmB,EAAE;aAC5F,CAAC;YACJ,CAAC,CAAC,GAAG,CAAC;IACV,CAAC;IACD,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAC5B,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,YAAY,KAAK,oBAAoB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG;CAC9G,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,MAA6B,EAA0B,EAAE;IAC5G,IAAI,GAAG,GAAoC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAClE,MAAM,MAAM,GAAyB,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,gBAAgB,EAAE,CAAC;QACjC,IAAI,CAAC;YACH,GAAG,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtB,MAAM,CAAC,CAAC;YACV,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAa,CAAC,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1F,CAAC;IACD,OAAO,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC,CAAC"}

package/dist/esm/transliterators/circled-or-squared.d.ts

@@ -0,0 +1,27 @@
+/***
+ * Transliterator that replaces circled or squared characters with their corresponding templates.
+ *
+ * @module
+ */
+import type { Char } from "../types.ts";
+export type Options = {
+    /**
+     * Templates used to render circled or squared characters.
+     */
+    templates?: {
+        circle?: string;
+        square?: string;
+    };
+    /**
+     * Whether to include emojis in the transliteration. If false, only non-emoji characters will be processed.
+     */
+    includeEmojis?: boolean;
+};
+/**
+ * A transliterator that replaces circled or squared characters.
+ *
+ * @param options Options for the transliterator.
+ * @returns An iterable that yields transliterated characters.
+ */
+declare const _default: (options: Options) => ((_: Iterable<Char>) => Iterable<Char>);
+export default _default;