hebrew-transliteration 2.6.4 → 2.7.0

package/dist/cjs/schema.js

@@ -98,6 +98,7 @@ class Schema {
     __publicField(this, "allowNoNiqqud");
     __publicField(this, "article");
     __publicField(this, "holemHaser");
+    __publicField(this, "ketivQeres");
     __publicField(this, "longVowels");
     __publicField(this, "qametsQatan");
     __publicField(this, "shevaAfterMeteg");
@@ -105,12 +106,89 @@ class Schema {
     __publicField(this, "sqnmlvy");
     __publicField(this, "strict");
     __publicField(this, "wawShureq");
-    this.VOCAL_SHEVA = schema.VOCAL_SHEVA, this.HATAF_SEGOL = schema.HATAF_SEGOL, this.HATAF_PATAH = schema.HATAF_PATAH, this.HATAF_QAMATS = schema.HATAF_QAMATS, this.HIRIQ = schema.HIRIQ, this.TSERE = schema.TSERE, this.SEGOL = schema.SEGOL, this.PATAH = schema.PATAH, this.QAMATS = schema.QAMATS, this.HOLAM = schema.HOLAM, this.HOLAM_HASER = schema.HOLAM_HASER, this.QUBUTS = schema.QUBUTS, this.DAGESH = schema.DAGESH, this.DAGESH_CHAZAQ = schema.DAGESH_CHAZAQ, this.MAQAF = schema.MAQAF, this.PASEQ = schema.PASEQ, this.SOF_PASUQ = schema.SOF_PASUQ, this.QAMATS_QATAN = schema.QAMATS_QATAN, this.FURTIVE_PATAH = schema.FURTIVE_PATAH, this.HIRIQ_YOD = schema.HIRIQ_YOD, this.TSERE_YOD = schema.TSERE_YOD, this.SEGOL_YOD = schema.SEGOL_YOD, this.SHUREQ = schema.SHUREQ, this.HOLAM_VAV = schema.HOLAM_VAV, this.QAMATS_HE = schema.QAMATS_HE, this.SEGOL_HE = schema.SEGOL_HE, this.TSERE_HE = schema.TSERE_HE, this.MS_SUFX = schema.MS_SUFX, this.ALEF = schema.ALEF, this.BET_DAGESH = schema.BET_DAGESH, this.BET = schema.BET, this.GIMEL = schema.GIMEL, this.GIMEL_DAGESH = schema.GIMEL_DAGESH, this.DALET = schema.DALET, this.DALET_DAGESH = schema.DALET_DAGESH, this.HE = schema.HE, this.VAV = schema.VAV, this.ZAYIN = schema.ZAYIN, this.HET = schema.HET, this.TET = schema.TET, this.YOD = schema.YOD, this.FINAL_KAF = schema.FINAL_KAF, this.KAF = schema.KAF, this.KAF_DAGESH = schema.KAF_DAGESH, this.LAMED = schema.LAMED, this.FINAL_MEM = schema.FINAL_MEM, this.MEM = schema.MEM, this.FINAL_NUN = schema.FINAL_NUN, this.NUN = schema.NUN, this.SAMEKH = schema.SAMEKH, this.AYIN = schema.AYIN, this.FINAL_PE = schema.FINAL_PE, this.PE = schema.PE, this.PE_DAGESH = schema.PE_DAGESH, this.FINAL_TSADI = schema.FINAL_TSADI, this.TSADI = schema.TSADI, this.QOF = schema.QOF, this.RESH = schema.RESH, this.SHIN = schema.SHIN, this.SIN = schema.SIN, this.TAV = schema.TAV, this.TAV_DAGESH = schema.TAV_DAGESH, this.DIVINE_NAME = schema.DIVINE_NAME, this.DIVINE_NAME_ELOHIM = schema.DIVINE_NAME_ELOHIM, this.SYLLABLE_SEPARATOR = schema.SYLLABLE_SEPARATOR, this.ADDITIONAL_FEATURES = schema.ADDITIONAL_FEATURES, this.STRESS_MARKER = schema.STRESS_MARKER, this.longVowels = schema.longVowels, this.qametsQatan = schema.qametsQatan, this.sqnmlvy = schema.sqnmlvy, this.shevaAfterMeteg = schema.shevaAfterMeteg, this.shevaWithMeteg = schema.shevaWithMeteg, this.wawShureq = schema.wawShureq, this.article = schema.article, this.allowNoNiqqud = schema.allowNoNiqqud, this.strict = schema.strict, this.holemHaser = schema.holemHaser;
+    this.VOCAL_SHEVA = schema.VOCAL_SHEVA;
+    this.HATAF_SEGOL = schema.HATAF_SEGOL;
+    this.HATAF_PATAH = schema.HATAF_PATAH;
+    this.HATAF_QAMATS = schema.HATAF_QAMATS;
+    this.HIRIQ = schema.HIRIQ;
+    this.TSERE = schema.TSERE;
+    this.SEGOL = schema.SEGOL;
+    this.PATAH = schema.PATAH;
+    this.QAMATS = schema.QAMATS;
+    this.HOLAM = schema.HOLAM;
+    this.HOLAM_HASER = schema.HOLAM_HASER;
+    this.QUBUTS = schema.QUBUTS;
+    this.DAGESH = schema.DAGESH;
+    this.DAGESH_CHAZAQ = schema.DAGESH_CHAZAQ;
+    this.MAQAF = schema.MAQAF;
+    this.PASEQ = schema.PASEQ;
+    this.SOF_PASUQ = schema.SOF_PASUQ;
+    this.QAMATS_QATAN = schema.QAMATS_QATAN;
+    this.FURTIVE_PATAH = schema.FURTIVE_PATAH;
+    this.HIRIQ_YOD = schema.HIRIQ_YOD;
+    this.TSERE_YOD = schema.TSERE_YOD;
+    this.SEGOL_YOD = schema.SEGOL_YOD;
+    this.SHUREQ = schema.SHUREQ;
+    this.HOLAM_VAV = schema.HOLAM_VAV;
+    this.QAMATS_HE = schema.QAMATS_HE;
+    this.SEGOL_HE = schema.SEGOL_HE;
+    this.TSERE_HE = schema.TSERE_HE;
+    this.MS_SUFX = schema.MS_SUFX;
+    this.ALEF = schema.ALEF;
+    this.BET_DAGESH = schema.BET_DAGESH;
+    this.BET = schema.BET;
+    this.GIMEL = schema.GIMEL;
+    this.GIMEL_DAGESH = schema.GIMEL_DAGESH;
+    this.DALET = schema.DALET;
+    this.DALET_DAGESH = schema.DALET_DAGESH;
+    this.HE = schema.HE;
+    this.VAV = schema.VAV;
+    this.ZAYIN = schema.ZAYIN;
+    this.HET = schema.HET;
+    this.TET = schema.TET;
+    this.YOD = schema.YOD;
+    this.FINAL_KAF = schema.FINAL_KAF;
+    this.KAF = schema.KAF;
+    this.KAF_DAGESH = schema.KAF_DAGESH;
+    this.LAMED = schema.LAMED;
+    this.FINAL_MEM = schema.FINAL_MEM;
+    this.MEM = schema.MEM;
+    this.FINAL_NUN = schema.FINAL_NUN;
+    this.NUN = schema.NUN;
+    this.SAMEKH = schema.SAMEKH;
+    this.AYIN = schema.AYIN;
+    this.FINAL_PE = schema.FINAL_PE;
+    this.PE = schema.PE;
+    this.PE_DAGESH = schema.PE_DAGESH;
+    this.FINAL_TSADI = schema.FINAL_TSADI;
+    this.TSADI = schema.TSADI;
+    this.QOF = schema.QOF;
+    this.RESH = schema.RESH;
+    this.SHIN = schema.SHIN;
+    this.SIN = schema.SIN;
+    this.TAV = schema.TAV;
+    this.TAV_DAGESH = schema.TAV_DAGESH;
+    this.DIVINE_NAME = schema.DIVINE_NAME;
+    this.DIVINE_NAME_ELOHIM = schema.DIVINE_NAME_ELOHIM;
+    this.SYLLABLE_SEPARATOR = schema.SYLLABLE_SEPARATOR;
+    this.ADDITIONAL_FEATURES = schema.ADDITIONAL_FEATURES;
+    this.STRESS_MARKER = schema.STRESS_MARKER;
+    this.longVowels = schema.longVowels;
+    this.qametsQatan = schema.qametsQatan;
+    this.sqnmlvy = schema.sqnmlvy;
+    this.shevaAfterMeteg = schema.shevaAfterMeteg;
+    this.shevaWithMeteg = schema.shevaWithMeteg;
+    this.wawShureq = schema.wawShureq;
+    this.article = schema.article;
+    this.allowNoNiqqud = schema.allowNoNiqqud;
+    this.strict = schema.strict;
+    this.holemHaser = schema.holemHaser;
+    this.ketivQeres = schema.ketivQeres;
   }
 }
 class SBL extends Schema {
   constructor(schema) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B, _C, _D, _E, _F, _G, _H, _I, _J, _K, _L, _M, _N, _O, _P, _Q, _R, _S, _T, _U, _V, _W, _X, _Y, _Z, __, _$, _aa, _ba, _ca, _da, _ea, _fa, _ga, _ha, _ia, _ja, _ka, _la, _ma, _na, _oa, _pa, _qa, _ra, _sa, _ta, _ua, _va;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B, _C, _D, _E, _F, _G, _H, _I, _J, _K, _L, _M, _N, _O, _P, _Q, _R, _S, _T, _U, _V, _W, _X, _Y, _Z, __, _$, _aa, _ba, _ca, _da, _ea, _fa, _ga, _ha, _ia, _ja, _ka, _la, _ma, _na, _oa, _pa, _qa, _ra, _sa, _ta, _ua, _va, _wa, _xa, _ya, _za, _Aa, _Ba, _Ca, _Da, _Ea, _Fa, _Ga, _Ha, _Ia, _Ja, _Ka, _La, _Ma, _Na, _Oa, _Pa, _Qa, _Ra, _Sa, _Ta, _Ua, _Va, _Wa, _Xa, _Ya, _Za, __a, _$a, _ab, _bb, _cb, _db, _eb, _fb, _gb, _hb, _ib, _jb, _kb, _lb, _mb, _nb, _ob, _pb, _qb, _rb, _sb, _tb, _ub, _vb, _wb, _xb, _yb, _zb, _Ab, _Bb, _Cb, _Db, _Eb, _Fb, _Gb, _Hb, _Ib, _Jb, _Kb, _Lb, _Mb, _Nb, _Ob, _Pb, _Qb, _Rb, _Sb, _Tb;
     super({
       VOCAL_SHEVA: (_a = schema.VOCAL_SHEVA) != null ? _a : "\u01DD",
       HATAF_SEGOL: (_b = schema.HATAF_SEGOL) != null ? _b : "\u0115",
@@ -188,8 +266,87 @@ class SBL extends Schema {
       article: (_ta = schema.article) != null ? _ta : true,
       allowNoNiqqud: (_ua = schema.allowNoNiqqud) != null ? _ua : true,
       strict: (_va = schema.strict) != null ? _va : false,
-      holemHaser: schema.holemHaser || "remove"
+      holemHaser: schema.holemHaser || "remove",
+      ketivQeres: schema.ketivQeres || void 0
     });
+    this.VOCAL_SHEVA = (_wa = schema.VOCAL_SHEVA) != null ? _wa : "\u01DD";
+    this.HATAF_SEGOL = (_xa = schema.HATAF_SEGOL) != null ? _xa : "\u0115";
+    this.HATAF_PATAH = (_ya = schema.HATAF_PATAH) != null ? _ya : "\u0103";
+    this.HATAF_QAMATS = (_za = schema.HATAF_QAMATS) != null ? _za : "\u014F";
+    this.HIRIQ = (_Aa = schema.HIRIQ) != null ? _Aa : "i";
+    this.TSERE = (_Ba = schema.TSERE) != null ? _Ba : "\u0113";
+    this.SEGOL = (_Ca = schema.SEGOL) != null ? _Ca : "e";
+    this.PATAH = (_Da = schema.PATAH) != null ? _Da : "a";
+    this.QAMATS = (_Ea = schema.QAMATS) != null ? _Ea : "\u0101";
+    this.HOLAM = (_Fa = schema.HOLAM) != null ? _Fa : "\u014D";
+    this.HOLAM_HASER = (_Ga = schema.HOLAM_HASER) != null ? _Ga : "\u014D";
+    this.QUBUTS = (_Ha = schema.QUBUTS) != null ? _Ha : "\u016B";
+    this.DAGESH = (_Ia = schema.DAGESH) != null ? _Ia : "";
+    this.DAGESH_CHAZAQ = (_Ja = schema.DAGESH_CHAZAQ) != null ? _Ja : true;
+    this.MAQAF = (_Ka = schema.MAQAF) != null ? _Ka : "-";
+    this.PASEQ = (_La = schema.PASEQ) != null ? _La : "";
+    this.SOF_PASUQ = (_Ma = schema.SOF_PASUQ) != null ? _Ma : "";
+    this.QAMATS_QATAN = (_Na = schema.QAMATS_QATAN) != null ? _Na : "o";
+    this.FURTIVE_PATAH = (_Oa = schema.FURTIVE_PATAH) != null ? _Oa : "a";
+    this.HIRIQ_YOD = (_Pa = schema.HIRIQ_YOD) != null ? _Pa : "\xEE";
+    this.TSERE_YOD = (_Qa = schema.TSERE_YOD) != null ? _Qa : "\xEA";
+    this.SEGOL_YOD = (_Ra = schema.SEGOL_YOD) != null ? _Ra : "\xEA";
+    this.SHUREQ = (_Sa = schema.SHUREQ) != null ? _Sa : "\xFB";
+    this.HOLAM_VAV = (_Ta = schema.HOLAM_VAV) != null ? _Ta : "\xF4";
+    this.QAMATS_HE = (_Ua = schema.QAMATS_HE) != null ? _Ua : "\xE2";
+    this.SEGOL_HE = (_Va = schema.SEGOL_HE) != null ? _Va : "\xEA";
+    this.TSERE_HE = (_Wa = schema.TSERE_HE) != null ? _Wa : "\xEA";
+    this.MS_SUFX = (_Xa = schema.MS_SUFX) != null ? _Xa : "\u0101yw";
+    this.ALEF = (_Ya = schema.ALEF) != null ? _Ya : "\u02BE";
+    this.BET = (_Za = schema.BET) != null ? _Za : "b";
+    this.BET_DAGESH = (__a = schema.BET_DAGESH) != null ? __a : void 0;
+    this.GIMEL = (_$a = schema.GIMEL) != null ? _$a : "g";
+    this.GIMEL_DAGESH = (_ab = schema.GIMEL_DAGESH) != null ? _ab : void 0;
+    this.DALET = (_bb = schema.DALET) != null ? _bb : "d";
+    this.DALET_DAGESH = (_cb = schema.DALET_DAGESH) != null ? _cb : void 0;
+    this.HE = (_db = schema.HE) != null ? _db : "h";
+    this.VAV = (_eb = schema.VAV) != null ? _eb : "w";
+    this.ZAYIN = (_fb = schema.ZAYIN) != null ? _fb : "z";
+    this.HET = (_gb = schema.HET) != null ? _gb : "\u1E25";
+    this.TET = (_hb = schema.TET) != null ? _hb : "\u1E6D";
+    this.YOD = (_ib = schema.YOD) != null ? _ib : "y";
+    this.FINAL_KAF = (_jb = schema.FINAL_KAF) != null ? _jb : "k";
+    this.KAF = (_kb = schema.KAF) != null ? _kb : "k";
+    this.KAF_DAGESH = (_lb = schema.KAF_DAGESH) != null ? _lb : void 0;
+    this.LAMED = (_mb = schema.LAMED) != null ? _mb : "l";
+    this.FINAL_MEM = (_nb = schema.FINAL_MEM) != null ? _nb : "m";
+    this.MEM = (_ob = schema.MEM) != null ? _ob : "m";
+    this.FINAL_NUN = (_pb = schema.FINAL_NUN) != null ? _pb : "n";
+    this.NUN = (_qb = schema.NUN) != null ? _qb : "n";
+    this.SAMEKH = (_rb = schema.SAMEKH) != null ? _rb : "s";
+    this.AYIN = (_sb = schema.AYIN) != null ? _sb : "\u02BF";
+    this.FINAL_PE = (_tb = schema.FINAL_PE) != null ? _tb : "p";
+    this.PE = (_ub = schema.PE) != null ? _ub : "p";
+    this.PE_DAGESH = (_vb = schema.PE_DAGESH) != null ? _vb : void 0;
+    this.FINAL_TSADI = (_wb = schema.FINAL_TSADI) != null ? _wb : "\u1E63";
+    this.TSADI = (_xb = schema.TSADI) != null ? _xb : "\u1E63";
+    this.QOF = (_yb = schema.QOF) != null ? _yb : "q";
+    this.RESH = (_zb = schema.RESH) != null ? _zb : "r";
+    this.SHIN = (_Ab = schema.SHIN) != null ? _Ab : "\u0161";
+    this.SIN = (_Bb = schema.SIN) != null ? _Bb : "\u015B";
+    this.TAV = (_Cb = schema.TAV) != null ? _Cb : "t";
+    this.TAV_DAGESH = (_Db = schema.TAV_DAGESH) != null ? _Db : void 0;
+    this.DIVINE_NAME = (_Eb = schema.DIVINE_NAME) != null ? _Eb : "yhwh";
+    this.DIVINE_NAME_ELOHIM = (_Fb = schema.DIVINE_NAME_ELOHIM) != null ? _Fb : void 0;
+    this.SYLLABLE_SEPARATOR = (_Gb = schema.SYLLABLE_SEPARATOR) != null ? _Gb : void 0;
+    this.ADDITIONAL_FEATURES = (_Hb = schema.ADDITIONAL_FEATURES) != null ? _Hb : void 0;
+    this.STRESS_MARKER = (_Ib = schema.STRESS_MARKER) != null ? _Ib : void 0;
+    this.longVowels = (_Jb = schema.longVowels) != null ? _Jb : true;
+    this.qametsQatan = (_Kb = schema.qametsQatan) != null ? _Kb : true;
+    this.shevaAfterMeteg = (_Lb = schema.shevaAfterMeteg) != null ? _Lb : true;
+    this.shevaWithMeteg = (_Mb = schema.shevaWithMeteg) != null ? _Mb : false;
+    this.sqnmlvy = (_Nb = schema.sqnmlvy) != null ? _Nb : true;
+    this.wawShureq = (_Ob = schema.wawShureq) != null ? _Ob : true;
+    this.article = (_Pb = schema.article) != null ? _Pb : true;
+    this.allowNoNiqqud = (_Qb = schema.allowNoNiqqud) != null ? _Qb : true;
+    this.strict = (_Rb = schema.strict) != null ? _Rb : false;
+    this.holemHaser = (_Sb = schema.holemHaser) != null ? _Sb : "remove";
+    this.ketivQeres = (_Tb = schema.ketivQeres) != null ? _Tb : void 0;
   }
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/cjs/schema.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/schema.ts"],
-  "sourcesContent": ["import { Cluster } from \"havarotjs/cluster\";\nimport { SylOpts } from \"havarotjs/text\";\nimport { Syllable } from \"havarotjs/syllable\";\nimport { Word } from \"havarotjs/word\";\nimport { NameToCharMap } from \"havarotjs/utils/vowelMap\";\n\ninterface HebrewFeature {\n  /**\n   * The Hebrew text \u2014 use consonants and vowels; do not use taamim\n   *\n   * The text is parsed as a Regex so special characters like `?` and `|` can be used\n   *\n   */\n  HEBREW: string | RegExp;\n}\n\ninterface PassThrough {\n  /**\n   * if `true` passes the characters of the result of the `TRANSLITERATION` callback to the be mapped to the schema.\n   * If `TRANSLITERATION` is a string, this does nothing.\n   *\n   * @default\n   * true\n   *\n   * @description\n   * This is generally most useful when the callback does not transliterate the entire `FEATURE`\n   *\n   * @example\n   *\n   * ```js\n   * // with PASS_THROUGH true (or undefined), the rest of the characters are passed through\n   * // to regular mapping on the schema\n   * heb.transliterate(\"\u05D1\u05BC\u05B0\u05E8\u05B5\u05D0\u05E9\u05C1\u05B4\u0596\u05D9\u05EA\", {\n   *   ADDITIONAL_FEATURES: [{\n   *     HEBREW: \"(?<![\\u{05B1}-\\u{05BB}\\u{05C7}].*)\\u{05B0}\",\n   *     FEATURE: \"syllable\",\n   *     PASS_THROUGH: true,\n   *     TRANSLITERATION: function (syllable, _hebrew, schema) {\n   *       const next = syllable.next;\n   *       const nextVowel = next.vowelName === \"SHEVA\" ? \"VOCAL_SHEVA\" : next.vowelName\n   *\n   *       if (next && nextVowel) {\n   *         const vowel = schema[nextVowel] || \"\";\n   *         return syllable.text.replace(new RegExp(\"\\u{05B0}\", \"u\"), vowel);\n   *       }\n   *\n   *       return syllable.text;\n   *     }\n   *   }]\n   * });\n   * ```\n   *\n   * @example\n   *\n   * ```js\n   * // with PASS_THROUGH false, a custom mapping needs to be implemented,\n   * // or Hebrew characters are returned for the rest of the `FEATURE`\n   * heb.transliterate(\"\u05D1\u05BC\u05B0\u05E8\u05B5\u05D0\u05E9\u05C1\u05B4\u0596\u05D9\u05EA\", {\n   *   ADDITIONAL_FEATURES: [{\n   *     HEBREW: \"(?<![\\u{05B1}-\\u{05BB}\\u{05C7}].*)\\u{05B0}\",\n   *     FEATURE: \"syllable\",\n   *     PASS_THROUGH: false,\n   *     TRANSLITERATION: function (syllable, _hebrew, schema) {\n   *       const next = syllable.next;\n   *       const nextVowel = next.vowelName === \"SHEVA\" ? \"VOCAL_SHEVA\" : next.vowelName\n   *\n   *       if (next && nextVowel) {\n   *         const vowel = schema[nextVowel] || \"\";\n   *         return syllable.text.replace(new RegExp(\"\\u{05B0}\", \"u\"), vowel);\n   *       }\n   *\n   *       return syllable.text;\n   *     }\n   *   }]\n   * });\n   * // \u05D1\u05BC\u0113r\u0113\u02BE\u0161\u00EEt\n   * ```\n   */\n  PASS_THROUGH?: boolean;\n}\n\n/**\n * @param word the `Word` object that matches the `HEBREW` property\n * @param hebrew the `HEBREW` property\n * @param schema the `Schema` being used\n */\ntype WordCallback = (word: Word, hebrew: string | RegExp, schema: Schema) => string;\n\ninterface WordFeature extends HebrewFeature, PassThrough {\n  /**\n   * additional orthographic feature\n   *\n   * - `\"cluster\"` is any combination of a single character and optionally a _dagesh_ and vowel.\n   * - `\"syllable\"` is any combination of a multiple characters and a single vowel and optionally a _dagesh_\n   * - `\"word\"` covers everything else\n   */\n  FEATURE: \"word\";\n  /**\n   * a string or callback. The callback takes three par\n   *\n   * Using a string\n   * @example\n   *\n   * ```js\n   * transliterate(\"\u05D5\u05B0\u05D0\u05B5\u05A5\u05EA \u05D4\u05B8\u05D0\u05B8\u05BD\u05E8\u05B6\u05E5\", {\n   *  ADDITIONAL_FEATURES: [{\n   *    FEATURE: \"word\",\n   *    HEBREW: \"\u05D4\u05B8\u05D0\u05B8\u05E8\u05B6\u05E5\",\n   *    TRANSLITERATION: \"The Earth\"\n   *  }]\n   * });\n   *\n   * // w\u01DD\u02BE\u0113t The Earth\n   * ```\n   *\n   * Using a callback\n   * @example\n   *\n   * ```js\n   * transliterate(heb, {\n   *  ADDITIONAL_FEATURES: [{\n   *    HEBREW: \"\u05E9\u05C1\u05B0\u05EA\u05BC\u05B7\u05D9\u05B4\u05DD\",\n   *    FEATURE: \"word\",\n   *    TRANSLITERATION: function (_word, _hebrew, schema) {\n   *      return (\n   *        schema[\"SHIN\"] +\n   *        (schema[\"TAV_DAGESH\"] ?? schema[\"TAV\"]) +\n   *        schema[\"PATAH\"] +\n   *        schema[\"YOD\"] +\n   *        schema[\"HIRIQ\"] +\n   *        schema[\"FINAL_MEM\"]\n   *      );\n   *    }\n   *  }]\n   * });\n   *\n   * // \u0161tayim\n   * ```\n   */\n  TRANSLITERATION: string | WordCallback;\n}\n\n/**\n * @param syllable the `Syllable` object that matches the `HEBREW` property\n * @param hebrew the `HEBREW` property\n * @param schema the `Schema` being used\n */\ntype SyllableCallback = (syllable: Syllable, hebrew: string | RegExp, schema: Schema) => string;\n\ninterface SyllableFeature extends HebrewFeature, PassThrough {\n  /**\n   * additional orthographic feature\n   *\n   * - `\"cluster\"` is any combination of a single character and optionally a _dagesh_ and vowel.\n   * - `\"syllable\"` is any combination of a multiple characters and a single vowel and optionally a _dagesh_\n   * - `\"word\"` covers everything else\n   */\n  FEATURE: \"syllable\";\n  /**\n   * a string or callback\n   *\n   * Using a string\n   * @example\n   *\n   * ```js\n   * transliterate(\"\u05D5\u05B0\u05D0\u05B5\u05A5\u05EA \u05D4\u05B8\u05D0\u05B8\u05BD\u05E8\u05B6\u05E5\", {\n   *  ADDITIONAL_FEATURES: [{\n   *    FEATURE: \"syllable\",\n   *    HEBREW: \"\u05D4\u05B8\u05D0\u05B8\u05E8\u05B6\u05E5\",\n   *    TRANSLITERATION: \"The Earth\"\n   *  }]\n   * });\n   *\n   * // w\u01DD\u02BE\u0113t The Earth\n   * ```\n   *\n   * Using a callback\n   * @example\n   *\n   * ```js\n   * transliterate(heb, {\n   *  ADDITIONAL_FEATURES: [{\n   *    HEBREW: \"\u05E9\u05C1\u05B0\u05EA\u05BC\u05B7\u05D9\u05B4\u05DD\",\n   *    FEATURE: \"syllable\",\n   *    TRANSLITERATION: function (_word, _text, schema) {\n   *      return (\n   *        schema[\"SHIN\"] +\n   *        (schema[\"TAV_DAGESH\"] ?? schema[\"TAV\"]) +\n   *        schema[\"PATAH\"] +\n   *        schema[\"YOD\"] +\n   *        schema[\"HIRIQ\"] +\n   *        schema[\"FINAL_MEM\"]\n   *      );\n   *    }\n   *  }]\n   * });\n   *\n   * // \u0161tayim\n   * ```\n   */\n  TRANSLITERATION: string | SyllableCallback;\n}\n\n/**\n * @param cluster the `Cluster` object that matches the `HEBREW` property\n * @param hebrew the `HEBREW` property\n * @param schema the `Schema` being used\n */\ntype ClusterCallback = (cluster: Cluster, hebrew: string | RegExp, schema: Schema) => string;\n\ninterface ClusterFeature extends HebrewFeature, PassThrough {\n  /**\n   * additional orthographic feature\n   *\n   * - `\"cluster\"` is any combination of a single character and optionally a _dagesh_ and vowel.\n   * - `\"syllable\"` is any combination of a multiple characters and a single vowel and optionally a _dagesh_\n   * - `\"word\"` covers everything else\n   */\n  FEATURE: \"cluster\";\n  /**\n   * a string or callback\n   *\n   * Using a string\n   * @example\n   *\n   * ```js\n   * transliterate(\"\u05D1\u05BC\u05B0\u05E8\u05B5\u05D0\u05E9\u05C1\u05B4\u0596\u05D9\u05EA\", {\n   *  ADDITIONAL_FEATURES: [{\n   *    FEATURE: \"cluster\",\n   *    HEBREW: \"\\u{05B0}\",\n   *    TRANSLITERATION: \"The Earth\"\n   *  }]\n   * });\n   *\n   * // w\u01DD\u02BE\u0113t The Earth\n   * ```\n   *\n   * Using a callback\n   * @example\n   *\n   * ```js\n   * transliterate(heb, {\n   *  ADDITIONAL_FEATURES: [{\n   *    HEBREW: \"\u05E9\u05C1\u05B0\u05EA\u05BC\u05B7\u05D9\u05B4\u05DD\",\n   *    FEATURE: \"syllable\",\n   *    TRANSLITERATION: function (_word, _text, schema) {\n   *      return (\n   *        schema[\"SHIN\"] +\n   *        (schema[\"TAV_DAGESH\"] ?? schema[\"TAV\"]) +\n   *        schema[\"PATAH\"] +\n   *        schema[\"YOD\"] +\n   *        schema[\"HIRIQ\"] +\n   *        schema[\"FINAL_MEM\"]\n   *      );\n   *    }\n   *  }]\n   * });\n   *\n   * // \u0161tayim\n   * ```\n   */\n  TRANSLITERATION: string | ClusterCallback;\n}\n\ntype AdditionalFeatures = WordFeature | SyllableFeature | ClusterFeature;\n\ntype SchemaVowels = Record<keyof NameToCharMap, string>;\n\n/*\n * class for defining a schema for transliteration\n */\nexport class Schema implements SylOpts, SchemaVowels {\n  /**\n   * HEBREW POINT SHEVA (U+05B0) \u05B0\u25CC\n   * @example\n   * '\u01DD'\n   */\n  VOCAL_SHEVA: string;\n  /**\n   * HEBREW POINT HATAF SEGOL (U+05B1) \u05B1\u25CC\n   * @example\n   * '\u0115'\n   */\n  HATAF_SEGOL: string;\n  /**\n   * HEBREW POINT HATAF PATAH (U+05B2) \u05B2\u25CC\n   * @example\n   * '\u0103'\n   */\n  HATAF_PATAH: string;\n  /**\n   * HEBREW POINT HATAF QAMATS (U+05B3) \u05B3\u25CC\n   * @example\n   * '\u014F'\n   */\n  HATAF_QAMATS: string;\n  /**\n   * HEBREW POINT HIRIQ (U+05B4) \u05B4\u25CC\n   * @example\n   * 'i'\n   */\n  HIRIQ: string;\n  /**\n   * HEBREW POINT TSERE (U+05B5) \u05B5\u25CC\n   * @example\n   * '\u0113'\n   */\n  TSERE: string;\n  /**\n   * HEBREW POINT SEGOL (U+05B6) \u05B6\u25CC\n   * @example\n   * 'e'\n   */\n  SEGOL: string;\n  /**\n   * HEBREW POINT PATAH (U+05B7) \u05B7\u25CC\n   * @example\n   * 'a'\n   */\n  PATAH: string;\n  /**\n   * HEBREW POINT QAMATS (U+05B8) \u05B8\u25CC\n   * @example\n   * '\u0101'\n   */\n  QAMATS: string;\n  /**\n   * HEBREW POINT HOLAM (U+05B9) \u05B9\u25CC\n   * @example\n   * '\u014D'\n   */\n  HOLAM: string;\n  /**\n   * HEBREW POINT HOLAM (U+05BA) \u05B9\u25CC\n   * @example\n   * '\u014D'\n   */\n  HOLAM_HASER: string;\n  /**\n   * HEBREW POINT QUBUTS (U+05BB) \u05BB\u25CC\n   * @example\n   * 'u'\n   */\n  QUBUTS: string;\n  /**\n   * HEBREW POINT DAGESH OR MAPIQ (U+05BC) \u05BC\u25CC\n   * @description typically, this will be a blank string\n   * @example\n   * ''\n   */\n  DAGESH: string;\n  /**\n   * HEBREW POINT DAGESH OR MAPIQ (U+05BC) \u05BC\u25CC\n   *\n   * @description A string or boolean that if true, repeats the consonant with the dagesh.\n   *\n   * @example string\n   *\n   * ```js\n   * transliterate('\u05E9\u05C1\u05B7\u05D1\u05BC\u05B8\u05EA', { DAGESH_CHAZAQ: \"\\u0301\" });\n   * // '\u0161ab\u0301\u0101t'\n   * ```\n   *\n   * @example boolean\n   * ```js\n   * transliterate('\u05E9\u05C1\u05B7\u05D1\u05BC\u05B8\u05EA', { DAGESH_CHAZAQ: true });\n   * // '\u0161abb\u0101t'\n   * ```\n   */\n  DAGESH_CHAZAQ: boolean | string;\n  /**\n   * HEBREW PUNCTUATION MAQAF (U+05BE) \u05BE\u25CC\n   * @example\n   * '-'\n   */\n  MAQAF: string;\n  /**\n   * HEBREW PUNCTUATION PASEQ (U+05C0) \u05C0 \u25CC\n   * @description if a blank string, two spaces will occur between words\n   * @example\n   * '|' or ''\n   * @example\n   * ```js\n   * transliterate('\u05DB\u05BC\u05B0\u05E9\u05C1\u05B6\u05A3\u05D1\u05B6\u05EA \u05C0 \u05D4\u05B7\u05DE\u05BC\u05B6\u05A3\u05DC\u05B6\u05DA\u05B0', { PASEQ: '' });\n   * // 'k\u01DD\u0161ebet  hammelek'\n   * ```\n   */\n  PASEQ: string;\n  /**\n   * HEBREW PUNCTUATION SOF PASUQ (U+05C3) \u05C3\u25CC\n   * @example\n   * '' or '.'\n   */\n  SOF_PASUQ: string;\n  /**\n   * HEBREW POINT QAMATS QATAN (U+05C7) \u05C7\u25CC\n   * @example\n   * 'o'\n   */\n  QAMATS_QATAN: string;\n  /**\n   * HEBREW POINT PATAH (U+05B7) \u25CC\u05B7\n   * @example\n   * 'a'\n   */\n  FURTIVE_PATAH: string;\n  /**\n   * HEBREW POINT HIRIQ (U+05B4) and YOD (U+05D9) \u05D9\u25CC\u05B4\n   * @example\n   * '\u00EE'\n   */\n  HIRIQ_YOD: string;\n  /**\n   * HEBREW POINT TSERE (U+05B5) and YOD (U+05D9) \u05D9\u25CC\u05B5\n   * @example\n   * '\u00EA'\n   */\n  TSERE_YOD: string;\n  /**\n   * HEBREW POINT SEGOL (U+05B6) and YOD (U+05D9) \u05D9\u25CC\u05B6\n   * @example\n   * '\u00EA'\n   */\n  SEGOL_YOD: string;\n  /**\n   * HEBREW LETTER VAV (U+05D5) and DAGESH (U+05BC) \u05D5\u05BC\n   * @example\n   * '\u00FB'\n   */\n  SHUREQ: string;\n  /**\n   * HEBREW LETTER HOLAM (U+05B9) and VAV (U+05D5) \u05B9\u05D5\u25CC\n   * @example\n   * '\u00F4'\n   */\n  HOLAM_VAV: string;\n  /**\n   * HEBREW POINT QAMATS (U+05B8) and HE (U+05D4) \u05D4\u25CC\u05B8\n   * @example\n   * '\u00E2'\n   */\n  QAMATS_HE: string;\n  /**\n   * HEBREW POINT SEGOL (U+05B6) and HE (U+05D4) \u05D4\u25CC\u05B6\n   * @example\n   * '\u00EA'\n   */\n  SEGOL_HE: string;\n  /**\n   * HEBREW POINT TSERE (U+05B5) and HE (U+05D4) \u05D4\u25CC\u05B5\n   * @example\n   * '\u00EA'\n   */\n  TSERE_HE: string;\n  /**\n   * HEBREW LETTER QAMATS (U+05B8) and YOD (U+05D9) and VAV (U+05D5) \u05D9\u05D5\u25CC\u05B8\n   * @example\n   * '\u0101yw'\n   */\n  MS_SUFX: string;\n  /**\n   * HEBREW LETTER ALEF (U+05D0) \u05D0\n   * @example\n   * '\u02BE'\n   */\n  ALEF: string;\n  /**\n   * HEBREW LETTER BET (U+05D1) \u05D1\n   * @example\n   * 'b' or 'v'\n   */\n  BET: string;\n  /**\n   * HEBREW LETTER BET (U+05D1) and DAGESH (U+05BC) \u05BC\u05D1\n   * @description\n   * the letter bet with a dagesh kal\n   * @description\n   * use when need to distinguish between spirantized forms\n   * @example\n   * 'b'\n   */\n  BET_DAGESH?: string;\n  /**\n   * HEBREW LETTER GIMEL (U+05D2) \u05D2\n   * @example\n   * 'g'\n   */\n  GIMEL: string;\n  /**\n   * HEBREW LETTER GIMEL (U+05D2) and DAGESH (U+05BC) \u05D2\u05BC\n   * @description\n   * the letter gimel with a dagesh kal\n   * @description\n   * use when need to distinguish between spirantized forms\n   * @example\n   * 'g'\n   */\n  GIMEL_DAGESH?: string;\n  /**\n   * HEBREW LETTER DALET (U+05D3) \u05D3\n   * @example\n   * 'd'\n   */\n  DALET: string;\n  /**\n   * HEBREW LETTER DALET (U+05D3) and DAGESH (U+05BC) \u05D3\u05BC\n   * @description\n   * the letter dalet with a dagesh kal\n   * @description\n   * use when need to distinguish between spirantized forms\n   * @example\n   * 'd'\n   */\n  DALET_DAGESH?: string;\n  /**\n   * HEBREW LETTER HE (U+05D4) \u05D4\n   * @example\n   * 'h'\n   */\n  HE: string;\n  /**\n   * HEBREW LETTER VAV (U+05D5) \u05D5\n   * @example\n   * 'w'\n   */\n  VAV: string;\n  /**\n   * HEBREW LETTER ZAYIN (U+05D6) \u05D6\n   * @example\n   * 'z'\n   */\n  ZAYIN: string;\n  /**\n   * HEBREW LETTER HET (U+05D7) \u05D7\n   * @example\n   * '\u1E25'\n   */\n  HET: string;\n  /**\n   * HEBREW LETTER TET (U+05D8) \u05D8\n   * @example\n   * '\u1E6D'\n   */\n  TET: string;\n  /**\n   * HEBREW LETTER YOD (U+05D9) \u05D9\n   * @example\n   * 'y'\n   */\n  YOD: string;\n  /**\n   * HEBREW LETTER FINAL KAF (U+05DA) \u05DA\n   * @example\n   * 'k' or 'kh'\n   */\n  FINAL_KAF: string;\n  /**\n   * HEBREW LETTER KAF (U+05DB) \u05DB\n   * @example\n   * 'k' or 'kh'\n   */\n  KAF: string;\n  /**\n   * HEBREW LETTER KAF (U+05DB) and DAGESH (U+05BC) \u05DB\u05BC\n   * @description\n   * the letter kaf with a dagesh kal\n   * @description\n   * use when need to distinguish between spirantized forms\n   * @example\n   * 'k'\n   */\n  KAF_DAGESH?: string;\n  /**\n   * HEBREW LETTER LAMED (U+05DC) \u05DC\n   * @example\n   * 'l'\n   */\n  LAMED: string;\n  /**\n   * HEBREW LETTER FINAL MEM (U+05DD) \u05DD\n   * @example\n   * 'm'\n   */\n  FINAL_MEM: string;\n  /**\n   * HEBREW LETTER MEM (U+05DE) \u05DE\n   * @example\n   * 'm'\n   */\n  MEM: string;\n  /**\n   * HEBREW LETTER FINAL NUN (U+05DF) \u05DF\n   * @example\n   * 'n'\n   */\n  FINAL_NUN: string;\n  /**\n   * HEBREW LETTER NUN (U+05E0) \u05E0\n   * @example\n   * 'n'\n   */\n  NUN: string;\n  /**\n   * HEBREW LETTER SAMEKH (U+05E1) \u05E1\n   * @example\n   * 's'\n   */\n  SAMEKH: string;\n  /**\n   * HEBREW LETTER AYIN (U+05E2) \u05E2\n   * @example\n   * '\u02BF'\n   */\n  AYIN: string;\n  /**\n   * HEBREW LETTER FINAL PE (U+05E3) \u05E3\n   * @example\n   * 'p' or 'f'\n   */\n  FINAL_PE: string;\n  /**\n   * HEBREW LETTER PE (U+05E4) \u05E4\n   * @example\n   * 'p' or 'f'\n   */\n  PE: string;\n  /**\n   * HEBREW LETTER  PE (U+05E4) and DAGESH (U+05BC) \u05E4\u05BC\n   * @description\n   * the letter pe with a dagesh kal\n   * @description\n   * use when need to distinguish between spirantized forms\n   * @example\n   * 'p'\n   */\n  PE_DAGESH?: string;\n  /**\n   * HEBREW LETTER FINAL TSADI (U+05E5) \u05E5\n   * @example\n   * '\u1E63'\n   */\n  FINAL_TSADI: string;\n  /**\n   * HEBREW LETTER TSADI (U+05E6) \u05E6\n   * @example\n   * '\u1E63'\n   */\n  TSADI: string;\n  /**\n   * HEBREW LETTER QOF (U+05E7) \u05E7\n   * @example\n   * 'q'\n   */\n  QOF: string;\n  /**\n   * HEBREW LETTER RESH (U+05E8) \u05E8\n   * @example\n   * 'r'\n   */\n  RESH: string;\n  /**\n   * HEBREW LETTER SHIN (U+05E9) and SHIN DOT (U+05C1) \u05E9\u05C1\n   * @example\n   * '\u0161'\n   */\n  SHIN: string;\n  /**\n   * HEBREW LETTER SHIN (U+05E9) and SIN DOT (U+05C2) \u05E9\u05C1\n   * @example\n   * '\u015B'\n   */\n  SIN: string;\n  /**\n   * HEBREW LETTER TAV (U+05EA) \u05EA\n   * @example\n   * 't' or 'th'\n   */\n  TAV: string;\n  /**\n   * HEBREW LETTER TAV (U+05EA) and DAGESH (U+05BC) \u05EA\u05BC\n   * @description\n   * the letter tav with a dagesh kal\n   * @description\n   * use when need to distinguish between spirantized forms\n   * @example\n   * 't'\n   */\n  TAV_DAGESH?: string;\n\n  /**\n   * define additional sequences of characters\n   *\n   * \u26A0\uFE0F there may be unpredictable results\n   *\n   * @example\n   * [{\n   *   FEATURE: 'cluster',\n   *   HEBREW: '\u05D6\u05BC',\n   *   TRANSLITERATION: 'tz'\n   * }]\n   */\n  ADDITIONAL_FEATURES?: AdditionalFeatures[];\n  /**\n   * the full form of the divine name - \u05D9\u05D4\u05D5\u05D4\n   * @example\n   * 'yhwh'\n   */\n  DIVINE_NAME: string;\n  /**\n   * the full form of the divine name pointed as 'elohim\n   *\n   * @description\n   * matches on the forms:\n   * - \u05D9\u05B1\u05D4\u05B9\u05D5\u05B4\u05D4\n   * - \u05D9\u05B1\u05D4\u05D5\u05B4\u05D4\n   * - \u05D9\u05B0\u05D4\u05B9\u05D5\u05B4\u05D4\n   * - \u05D9\u05B0\u05D4\u05D5\u05B4\u05D4\n   *\n   * If undefined, defaults to `DIVINE_NAME`\n   *\n   * @example\n   * '\u02BEel\u014Dhim'\n   */\n  DIVINE_NAME_ELOHIM?: string;\n  /**\n   * a syllable separator, usually an empty string\n   *  @example\n   * '' or '-'\n   * @example\n   * ```js\n   * transliterate('\u05D4\u05B8\u05D0\u05B8\u05BD\u05E8\u05B6\u05E5', { SYLLABLE_SEPARATOR: '-' });\n   * // 'h\u0101-\u02BE\u0101-re\u1E63'\n   * ```\n   */\n  SYLLABLE_SEPARATOR?: string;\n  /**\n   * a mark for indentifying the stressed syllable\n   *\n   * @description\n   * taamim are needed in the Hebrew text to correctly identify stress\n   *  @example\n   * '\u02C8' or '\\u0341'\n   * @example\n   * ```js\n   * transliterate('\u05DE\u05B6\u05A3\u05DC\u05B6\u05DA\u05B0', {\n   *   STRESS_MARKER: {\n   *     location: 'after-vowel',\n   *     mark: '\\u0301'\n   *    }\n   * });\n   * // 'me\u0341lek'\n   * ```\n   */\n  STRESS_MARKER?: {\n    /**\n     * the location of the mark\n     */\n    location: \"before-syllable\" | \"after-syllable\" | \"before-vowel\" | \"after-vowel\";\n    /**\n     * a string to use as the marker\n     */\n    mark: string;\n    /**\n     * Whether to exclude the mark on certain syllables\n     *\n     * @default\n     * \"never\"\n     *\n     * @example\n     *\n     * ```js\n     * // undefined and \"never\" are the same\n     * heb.transliterate(\"\u05D1\u05B9\u0596\u05BC\u05E7\u05B6\u05E8 \u05D9\u05A5\u05D5\u05B9\u05DD \u05D0\u05B6\u05D7\u05B8\u05BD\u05D3\u05C3 \", {\n     *   STRESS_MARKER: {\n     *     location: \"after-vowel\",\n     *     mark: \"\\u0301\",\n     *   }\n     * });\n     *\n     * // b\u014D\u0301qer y\u00F4\u0301m \u02BEe\u1E25\u0101\u0301d\n     * ```\n     *\n     * @example\n     *\n     * ```js\n     * // exclude only single syllable words\n     * heb.transliterate(\"\u05D1\u05B9\u0596\u05BC\u05E7\u05B6\u05E8 \u05D9\u05A5\u05D5\u05B9\u05DD \u05D0\u05B6\u05D7\u05B8\u05BD\u05D3\u05C3 \", {\n     *   STRESS_MARKER: {\n     *     location: \"after-vowel\",\n     *     mark: \"\\u0301\",\n     *     exclude: \"single\"\n     *   }\n     * });\n     *\n     * // b\u014D\u0301qer y\u00F4m \u02BEe\u1E25\u0101\u0301d\n     * ```\n     *\n     * @example\n     *\n     * ```js\n     * // exclude when accent is on the final syllable\n     * // implicitly excludes single syllable words\n     * heb.transliterate(\"\u05D1\u05B9\u0596\u05BC\u05E7\u05B6\u05E8 \u05D9\u05A5\u05D5\u05B9\u05DD \u05D0\u05B6\u05D7\u05B8\u05BD\u05D3\u05C3 \", {\n     *   STRESS_MARKER: {\n     *     location: \"after-vowel\",\n     *     mark: \"\\u0301\",\n     *     exclude: \"single\"\n     *   }\n     * });\n     *\n     * // b\u014D\u0301qer y\u00F4m \u02BEe\u1E25\u0101d\n     * ```\n     */\n    exclude?: \"never\" | \"final\" | \"single\";\n  };\n  allowNoNiqqud: SylOpts[\"allowNoNiqqud\"];\n  article: SylOpts[\"article\"];\n  holemHaser: SylOpts[\"holemHaser\"];\n  longVowels: SylOpts[\"longVowels\"];\n  qametsQatan: SylOpts[\"qametsQatan\"];\n  shevaAfterMeteg: SylOpts[\"shevaAfterMeteg\"];\n  shevaWithMeteg?: SylOpts[\"shevaWithMeteg\"];\n  sqnmlvy: SylOpts[\"sqnmlvy\"];\n  strict: SylOpts[\"strict\"];\n  wawShureq: SylOpts[\"wawShureq\"];\n  constructor(schema: Schema) {\n    (this.VOCAL_SHEVA = schema.VOCAL_SHEVA),\n      (this.HATAF_SEGOL = schema.HATAF_SEGOL),\n      (this.HATAF_PATAH = schema.HATAF_PATAH),\n      (this.HATAF_QAMATS = schema.HATAF_QAMATS),\n      (this.HIRIQ = schema.HIRIQ),\n      (this.TSERE = schema.TSERE),\n      (this.SEGOL = schema.SEGOL),\n      (this.PATAH = schema.PATAH),\n      (this.QAMATS = schema.QAMATS),\n      (this.HOLAM = schema.HOLAM),\n      (this.HOLAM_HASER = schema.HOLAM_HASER),\n      (this.QUBUTS = schema.QUBUTS),\n      (this.DAGESH = schema.DAGESH),\n      (this.DAGESH_CHAZAQ = schema.DAGESH_CHAZAQ),\n      (this.MAQAF = schema.MAQAF),\n      (this.PASEQ = schema.PASEQ),\n      (this.SOF_PASUQ = schema.SOF_PASUQ),\n      (this.QAMATS_QATAN = schema.QAMATS_QATAN),\n      (this.FURTIVE_PATAH = schema.FURTIVE_PATAH),\n      (this.HIRIQ_YOD = schema.HIRIQ_YOD),\n      (this.TSERE_YOD = schema.TSERE_YOD),\n      (this.SEGOL_YOD = schema.SEGOL_YOD),\n      (this.SHUREQ = schema.SHUREQ),\n      (this.HOLAM_VAV = schema.HOLAM_VAV),\n      (this.QAMATS_HE = schema.QAMATS_HE),\n      (this.SEGOL_HE = schema.SEGOL_HE),\n      (this.TSERE_HE = schema.TSERE_HE),\n      (this.MS_SUFX = schema.MS_SUFX),\n      (this.ALEF = schema.ALEF),\n      (this.BET_DAGESH = schema.BET_DAGESH),\n      (this.BET = schema.BET),\n      (this.GIMEL = schema.GIMEL),\n      (this.GIMEL_DAGESH = schema.GIMEL_DAGESH),\n      (this.DALET = schema.DALET),\n      (this.DALET_DAGESH = schema.DALET_DAGESH),\n      (this.HE = schema.HE),\n      (this.VAV = schema.VAV),\n      (this.ZAYIN = schema.ZAYIN),\n      (this.HET = schema.HET),\n      (this.TET = schema.TET),\n      (this.YOD = schema.YOD),\n      (this.FINAL_KAF = schema.FINAL_KAF),\n      (this.KAF = schema.KAF),\n      (this.KAF_DAGESH = schema.KAF_DAGESH),\n      (this.LAMED = schema.LAMED),\n      (this.FINAL_MEM = schema.FINAL_MEM),\n      (this.MEM = schema.MEM),\n      (this.FINAL_NUN = schema.FINAL_NUN),\n      (this.NUN = schema.NUN),\n      (this.SAMEKH = schema.SAMEKH),\n      (this.AYIN = schema.AYIN),\n      (this.FINAL_PE = schema.FINAL_PE),\n      (this.PE = schema.PE),\n      (this.PE_DAGESH = schema.PE_DAGESH),\n      (this.FINAL_TSADI = schema.FINAL_TSADI),\n      (this.TSADI = schema.TSADI),\n      (this.QOF = schema.QOF),\n      (this.RESH = schema.RESH),\n      (this.SHIN = schema.SHIN),\n      (this.SIN = schema.SIN),\n      (this.TAV = schema.TAV),\n      (this.TAV_DAGESH = schema.TAV_DAGESH),\n      (this.DIVINE_NAME = schema.DIVINE_NAME),\n      (this.DIVINE_NAME_ELOHIM = schema.DIVINE_NAME_ELOHIM),\n      (this.SYLLABLE_SEPARATOR = schema.SYLLABLE_SEPARATOR),\n      (this.ADDITIONAL_FEATURES = schema.ADDITIONAL_FEATURES),\n      (this.STRESS_MARKER = schema.STRESS_MARKER),\n      (this.longVowels = schema.longVowels),\n      (this.qametsQatan = schema.qametsQatan),\n      (this.sqnmlvy = schema.sqnmlvy),\n      (this.shevaAfterMeteg = schema.shevaAfterMeteg),\n      (this.shevaWithMeteg = schema.shevaWithMeteg),\n      (this.wawShureq = schema.wawShureq),\n      (this.article = schema.article),\n      (this.allowNoNiqqud = schema.allowNoNiqqud),\n      (this.strict = schema.strict),\n      (this.holemHaser = schema.holemHaser);\n  }\n}\n\nexport class SBL extends Schema {\n  constructor(schema: Partial<Schema>) {\n    super({\n      VOCAL_SHEVA: schema.VOCAL_SHEVA ?? \"\u01DD\",\n      HATAF_SEGOL: schema.HATAF_SEGOL ?? \"\u0115\",\n      HATAF_PATAH: schema.HATAF_PATAH ?? \"\u0103\",\n      HATAF_QAMATS: schema.HATAF_QAMATS ?? \"\u014F\",\n      HIRIQ: schema.HIRIQ ?? \"i\",\n      TSERE: schema.TSERE ?? \"\u0113\",\n      SEGOL: schema.SEGOL ?? \"e\",\n      PATAH: schema.PATAH ?? \"a\",\n      QAMATS: schema.QAMATS ?? \"\u0101\",\n      HOLAM: schema.HOLAM ?? \"\u014D\",\n      HOLAM_HASER: schema.HOLAM_HASER ?? \"\u014D\",\n      QUBUTS: schema.QUBUTS ?? \"\u016B\",\n      DAGESH: schema.DAGESH ?? \"\",\n      DAGESH_CHAZAQ: schema.DAGESH_CHAZAQ ?? true,\n      MAQAF: schema.MAQAF ?? \"-\",\n      PASEQ: schema.PASEQ ?? \"\",\n      SOF_PASUQ: schema.SOF_PASUQ ?? \"\",\n      QAMATS_QATAN: schema.QAMATS_QATAN ?? \"o\",\n      FURTIVE_PATAH: schema.FURTIVE_PATAH ?? \"a\",\n      HIRIQ_YOD: schema.HIRIQ_YOD ?? \"\u00EE\",\n      TSERE_YOD: schema.TSERE_YOD ?? \"\u00EA\",\n      SEGOL_YOD: schema.SEGOL_YOD ?? \"\u00EA\",\n      SHUREQ: schema.SHUREQ ?? \"\u00FB\",\n      HOLAM_VAV: schema.HOLAM_VAV ?? \"\u00F4\",\n      QAMATS_HE: schema.QAMATS_HE ?? \"\u00E2\",\n      SEGOL_HE: schema.SEGOL_HE ?? \"\u00EA\",\n      TSERE_HE: schema.TSERE_HE ?? \"\u00EA\",\n      MS_SUFX: schema.MS_SUFX ?? \"\u0101yw\",\n      ALEF: schema.ALEF ?? \"\u02BE\",\n      BET: schema.BET ?? \"b\",\n      BET_DAGESH: schema.BET_DAGESH ?? undefined,\n      GIMEL: schema.GIMEL ?? \"g\",\n      GIMEL_DAGESH: schema.GIMEL_DAGESH ?? undefined,\n      DALET: schema.DALET ?? \"d\",\n      DALET_DAGESH: schema.DALET_DAGESH ?? undefined,\n      HE: schema.HE ?? \"h\",\n      VAV: schema.VAV ?? \"w\",\n      ZAYIN: schema.ZAYIN ?? \"z\",\n      HET: schema.HET ?? \"\u1E25\",\n      TET: schema.TET ?? \"\u1E6D\",\n      YOD: schema.YOD ?? \"y\",\n      FINAL_KAF: schema.FINAL_KAF ?? \"k\",\n      KAF: schema.KAF ?? \"k\",\n      KAF_DAGESH: schema.KAF_DAGESH ?? undefined,\n      LAMED: schema.LAMED ?? \"l\",\n      FINAL_MEM: schema.FINAL_MEM ?? \"m\",\n      MEM: schema.MEM ?? \"m\",\n      FINAL_NUN: schema.FINAL_NUN ?? \"n\",\n      NUN: schema.NUN ?? \"n\",\n      SAMEKH: schema.SAMEKH ?? \"s\",\n      AYIN: schema.AYIN ?? \"\u02BF\",\n      FINAL_PE: schema.FINAL_PE ?? \"p\",\n      PE: schema.PE ?? \"p\",\n      PE_DAGESH: schema.PE_DAGESH ?? undefined,\n      FINAL_TSADI: schema.FINAL_TSADI ?? \"\u1E63\",\n      TSADI: schema.TSADI ?? \"\u1E63\",\n      QOF: schema.QOF ?? \"q\",\n      RESH: schema.RESH ?? \"r\",\n      SHIN: schema.SHIN ?? \"\u0161\",\n      SIN: schema.SIN ?? \"\u015B\",\n      TAV: schema.TAV ?? \"t\",\n      TAV_DAGESH: schema.TAV_DAGESH ?? undefined,\n      DIVINE_NAME: schema.DIVINE_NAME ?? \"yhwh\",\n      DIVINE_NAME_ELOHIM: schema.DIVINE_NAME_ELOHIM ?? undefined,\n      SYLLABLE_SEPARATOR: schema.SYLLABLE_SEPARATOR ?? undefined,\n      ADDITIONAL_FEATURES: schema.ADDITIONAL_FEATURES ?? undefined,\n      STRESS_MARKER: schema.STRESS_MARKER ?? undefined,\n      longVowels: schema.longVowels ?? true,\n      qametsQatan: schema.qametsQatan ?? true,\n      shevaAfterMeteg: schema.shevaAfterMeteg ?? true,\n      shevaWithMeteg: schema.shevaWithMeteg ?? false,\n      sqnmlvy: schema.sqnmlvy ?? true,\n      wawShureq: schema.wawShureq ?? true,\n      article: schema.article ?? true,\n      allowNoNiqqud: schema.allowNoNiqqud ?? true,\n      strict: schema.strict ?? false,\n      holemHaser: schema.holemHaser || \"remove\"\n    });\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;AA4QA;;;;;;AAGM,MAAO,OAAM;EA0iBjB,YAAY,QAAc;AApiB1B;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAOA;AAmBA;AAMA;AAYA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAUA;AAMA;AAUA;AAMA;AAUA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAUA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAUA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAMA;AAUA;AAcA;AAMA;AAgBA;AAWA;AAmBA;AA8DA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEE,IAAC,KAAK,cAAc,OAAO,aACxB,KAAK,cAAc,OAAO,aAC1B,KAAK,cAAc,OAAO,aAC1B,KAAK,eAAe,OAAO,cAC3B,KAAK,QAAQ,OAAO,OACpB,KAAK,QAAQ,OAAO,OACpB,KAAK,QAAQ,OAAO,OACpB,KAAK,QAAQ,OAAO,OACpB,KAAK,SAAS,OAAO,QACrB,KAAK,QAAQ,OAAO,OACpB,KAAK,cAAc,OAAO,aAC1B,KAAK,SAAS,OAAO,QACrB,KAAK,SAAS,OAAO,QACrB,KAAK,gBAAgB,OAAO,eAC5B,KAAK,QAAQ,OAAO,OACpB,KAAK,QAAQ,OAAO,OACpB,KAAK,YAAY,OAAO,WACxB,KAAK,eAAe,OAAO,cAC3B,KAAK,gBAAgB,OAAO,eAC5B,KAAK,YAAY,OAAO,WACxB,KAAK,YAAY,OAAO,WACxB,KAAK,YAAY,OAAO,WACxB,KAAK,SAAS,OAAO,QACrB,KAAK,YAAY,OAAO,WACxB,KAAK,YAAY,OAAO,WACxB,KAAK,WAAW,OAAO,UACvB,KAAK,WAAW,OAAO,UACvB,KAAK,UAAU,OAAO,SACtB,KAAK,OAAO,OAAO,MACnB,KAAK,aAAa,OAAO,YACzB,KAAK,MAAM,OAAO,KAClB,KAAK,QAAQ,OAAO,OACpB,KAAK,eAAe,OAAO,cAC3B,KAAK,QAAQ,OAAO,OACpB,KAAK,eAAe,OAAO,cAC3B,KAAK,KAAK,OAAO,IACjB,KAAK,MAAM,OAAO,KAClB,KAAK,QAAQ,OAAO,OACpB,KAAK,MAAM,OAAO,KAClB,KAAK,MAAM,OAAO,KAClB,KAAK,MAAM,OAAO,KAClB,KAAK,YAAY,OAAO,WACxB,KAAK,MAAM,OAAO,KAClB,KAAK,aAAa,OAAO,YACzB,KAAK,QAAQ,OAAO,OACpB,KAAK,YAAY,OAAO,WACxB,KAAK,MAAM,OAAO,KAClB,KAAK,YAAY,OAAO,WACxB,KAAK,MAAM,OAAO,KAClB,KAAK,SAAS,OAAO,QACrB,KAAK,OAAO,OAAO,MACnB,KAAK,WAAW,OAAO,UACvB,KAAK,KAAK,OAAO,IACjB,KAAK,YAAY,OAAO,WACxB,KAAK,cAAc,OAAO,aAC1B,KAAK,QAAQ,OAAO,OACpB,KAAK,MAAM,OAAO,KAClB,KAAK,OAAO,OAAO,MACnB,KAAK,OAAO,OAAO,MACnB,KAAK,MAAM,OAAO,KAClB,KAAK,MAAM,OAAO,KAClB,KAAK,aAAa,OAAO,YACzB,KAAK,cAAc,OAAO,aAC1B,KAAK,qBAAqB,OAAO,oBACjC,KAAK,qBAAqB,OAAO,oBACjC,KAAK,sBAAsB,OAAO,qBAClC,KAAK,gBAAgB,OAAO,eAC5B,KAAK,aAAa,OAAO,YACzB,KAAK,cAAc,OAAO,aAC1B,KAAK,UAAU,OAAO,SACtB,KAAK,kBAAkB,OAAO,iBAC9B,KAAK,iBAAiB,OAAO,gBAC7B,KAAK,YAAY,OAAO,WACxB,KAAK,UAAU,OAAO,SACtB,KAAK,gBAAgB,OAAO,eAC5B,KAAK,SAAS,OAAO,QACrB,KAAK,aAAa,OAAO;EAC9B;;AAGI,MAAO,YAAY,OAAM;EAC7B,YAAY,QAAuB;AA/nBrC;AAgoBI,UAAM;MACJ,cAAa,YAAO,gBAAP,YAAsB;MACnC,cAAa,YAAO,gBAAP,YAAsB;MACnC,cAAa,YAAO,gBAAP,YAAsB;MACnC,eAAc,YAAO,iBAAP,YAAuB;MACrC,QAAO,YAAO,UAAP,YAAgB;MACvB,QAAO,YAAO,UAAP,YAAgB;MACvB,QAAO,YAAO,UAAP,YAAgB;MACvB,QAAO,YAAO,UAAP,YAAgB;MACvB,SAAQ,YAAO,WAAP,YAAiB;MACzB,QAAO,YAAO,UAAP,YAAgB;MACvB,cAAa,YAAO,gBAAP,YAAsB;MACnC,SAAQ,YAAO,WAAP,YAAiB;MACzB,SAAQ,YAAO,WAAP,YAAiB;MACzB,gBAAe,YAAO,kBAAP,YAAwB;MACvC,QAAO,YAAO,UAAP,YAAgB;MACvB,QAAO,YAAO,UAAP,YAAgB;MACvB,YAAW,YAAO,cAAP,YAAoB;MAC/B,eAAc,YAAO,iBAAP,YAAuB;MACrC,gBAAe,YAAO,kBAAP,YAAwB;MACvC,YAAW,YAAO,cAAP,YAAoB;MAC/B,YAAW,YAAO,cAAP,YAAoB;MAC/B,YAAW,YAAO,cAAP,YAAoB;MAC/B,SAAQ,YAAO,WAAP,YAAiB;MACzB,YAAW,YAAO,cAAP,YAAoB;MAC/B,YAAW,YAAO,cAAP,YAAoB;MAC/B,WAAU,YAAO,aAAP,YAAmB;MAC7B,WAAU,YAAO,aAAP,YAAmB;MAC7B,UAAS,YAAO,YAAP,YAAkB;MAC3B,OAAM,YAAO,SAAP,YAAe;MACrB,MAAK,YAAO,QAAP,YAAc;MACnB,aAAY,YAAO,eAAP,YAAqB;MACjC,QAAO,YAAO,UAAP,YAAgB;MACvB,eAAc,YAAO,iBAAP,YAAuB;MACrC,QAAO,YAAO,UAAP,YAAgB;MACvB,eAAc,YAAO,iBAAP,YAAuB;MACrC,KAAI,YAAO,OAAP,YAAa;MACjB,MAAK,YAAO,QAAP,YAAc;MACnB,QAAO,YAAO,UAAP,YAAgB;MACvB,MAAK,YAAO,QAAP,YAAc;MACnB,MAAK,YAAO,QAAP,YAAc;MACnB,MAAK,YAAO,QAAP,YAAc;MACnB,YAAW,YAAO,cAAP,YAAoB;MAC/B,MAAK,YAAO,QAAP,YAAc;MACnB,aAAY,YAAO,eAAP,YAAqB;MACjC,QAAO,YAAO,UAAP,YAAgB;MACvB,YAAW,YAAO,cAAP,YAAoB;MAC/B,MAAK,YAAO,QAAP,YAAc;MACnB,YAAW,YAAO,cAAP,YAAoB;MAC/B,MAAK,YAAO,QAAP,YAAc;MACnB,SAAQ,YAAO,WAAP,YAAiB;MACzB,OAAM,YAAO,SAAP,YAAe;MACrB,WAAU,YAAO,aAAP,YAAmB;MAC7B,KAAI,YAAO,OAAP,YAAa;MACjB,YAAW,YAAO,cAAP,YAAoB;MAC/B,cAAa,aAAO,gBAAP,aAAsB;MACnC,QAAO,aAAO,UAAP,aAAgB;MACvB,MAAK,aAAO,QAAP,aAAc;MACnB,OAAM,aAAO,SAAP,aAAe;MACrB,OAAM,aAAO,SAAP,aAAe;MACrB,MAAK,aAAO,QAAP,aAAc;MACnB,MAAK,aAAO,QAAP,aAAc;MACnB,aAAY,aAAO,eAAP,aAAqB;MACjC,cAAa,aAAO,gBAAP,aAAsB;MACnC,qBAAoB,aAAO,uBAAP,aAA6B;MACjD,qBAAoB,aAAO,uBAAP,aAA6B;MACjD,sBAAqB,aAAO,wBAAP,aAA8B;MACnD,gBAAe,aAAO,kBAAP,aAAwB;MACvC,aAAY,aAAO,eAAP,aAAqB;MACjC,cAAa,aAAO,gBAAP,aAAsB;MACnC,kBAAiB,aAAO,oBAAP,aAA0B;MAC3C,iBAAgB,aAAO,mBAAP,aAAyB;MACzC,UAAS,aAAO,YAAP,aAAkB;MAC3B,YAAW,aAAO,cAAP,aAAoB;MAC/B,UAAS,aAAO,YAAP,aAAkB;MAC3B,gBAAe,aAAO,kBAAP,aAAwB;MACvC,SAAQ,aAAO,WAAP,aAAiB;MACzB,YAAY,OAAO,cAAc;KAClC;EACH;;",
+  "sourcesContent": ["import { Cluster } from \"havarotjs/cluster\";\nimport { Syllable } from \"havarotjs/syllable\";\nimport { SylOpts } from \"havarotjs/text\";\nimport { NameToCharMap } from \"havarotjs/utils/vowelMap\";\nimport { Word } from \"havarotjs/word\";\n\n// export for documentation\nexport type { SylOpts };\n\nexport interface HebrewFeature {\n  /**\n   * The Hebrew text \u2014 use consonants and vowels; do not use taamim\n   *\n   * @remarks\n   * The text is parsed as a Regex so special characters like `?` and `|` can be used\n   *\n   */\n  HEBREW: string | RegExp;\n}\n\nexport interface PassThrough {\n  /**\n   * If `true` passes the characters of the result of the `TRANSLITERATION` callback to the be mapped to the schema.\n   * If `TRANSLITERATION` is a string, this does nothing.\n   *\n   * @default\n   * true\n   *\n   * @example\n   * ```js\n   * // with PASS_THROUGH true or undefined; the rest of the characters are passed through\n   * // to regular mapping on the schema\n   * heb.transliterate(\"\u05D1\u05BC\u05B0\u05E8\u05B5\u05D0\u05E9\u05C1\u05B4\u0596\u05D9\u05EA\", {\n   *   ADDITIONAL_FEATURES: [{\n   *     HEBREW: \"(?<![\\u{05B1}-\\u{05BB}\\u{05C7}].*)\\u{05B0}\",\n   *     FEATURE: \"syllable\",\n   *     PASS_THROUGH: true,\n   *     TRANSLITERATION: function (syllable, _hebrew, schema) {\n   *       const next = syllable.next;\n   *       const nextVowel = next.vowelName === \"SHEVA\" ? \"VOCAL_SHEVA\" : next.vowelName\n   *\n   *       if (next && nextVowel) {\n   *         const vowel = schema[nextVowel] || \"\";\n   *         return syllable.text.replacenew RegExp(\"\\u{05B0}\", \"u\"; vowel);\n   *       }\n   *\n   *       return syllable.text;\n   *     }\n   *   }]\n   * });\n   * ```\n   *\n   * @example\n   * ```js\n   * // with PASS_THROUGH false, a custom mapping needs to be implemented,\n   * // or Hebrew characters are returned for the rest of the `FEATURE`\n   * heb.transliterate(\"\u05D1\u05BC\u05B0\u05E8\u05B5\u05D0\u05E9\u05C1\u05B4\u0596\u05D9\u05EA\", {\n   *   ADDITIONAL_FEATURES: [{\n   *     HEBREW: \"(?<![\\u{05B1}-\\u{05BB}\\u{05C7}].*)\\u{05B0}\",\n   *     FEATURE: \"syllable\",\n   *     PASS_THROUGH: false,\n   *     TRANSLITERATION: function (syllable, _hebrew, schema) {\n   *       const next = syllable.next;\n   *       const nextVowel = next.vowelName === \"SHEVA\" ? \"VOCAL_SHEVA\" : next.vowelName\n   *\n   *       if (next && nextVowel) {\n   *         const vowel = schema[nextVowel] || \"\";\n   *         return syllable.text.replacenew RegExp(\"\\u{05B0}\", \"u\"; vowel);\n   *       }\n   *\n   *       return syllable.text;\n   *     }\n   *   }]\n   * });\n   * // \u05D1\u05BC\u0113r\u0113\u02BE\u0161\u00EEt\n   * ```\n   *\n   * @remarks\n   * This is generally most useful when the callback does not transliterate the entire `FEATURE`\n   */\n  PASS_THROUGH?: boolean;\n}\n\n/**\n * @param word the `Word` object that matches the `HEBREW` property\n * @param hebrew the `HEBREW` property\n * @param schema the `Schema` being used\n */\nexport type WordCallback = (word: Word, hebrew: string | RegExp, schema: Schema) => string;\n\nexport interface WordFeature extends HebrewFeature, PassThrough {\n  /**\n   * Additional orthographic feature.\n   *\n   * - `\"cluster\"` is any combination of a single character and optionally a _dagesh_ and vowel.\n   * - `\"syllable\"` is any combination of a multiple characters and a single vowel and optionally a _dagesh_\n   * - `\"word\"` covers everything else\n   */\n  FEATURE: \"word\";\n  /**\n   * a string or callback. The callback takes three par\n   *\n   * Using a string\n   * @example\n   *\n   * ```js\n   * transliterate(\"\u05D5\u05B0\u05D0\u05B5\u05A5\u05EA \u05D4\u05B8\u05D0\u05B8\u05BD\u05E8\u05B6\u05E5\", {\n   *  ADDITIONAL_FEATURES: [{\n   *    FEATURE: \"word\",\n   *    HEBREW: \"\u05D4\u05B8\u05D0\u05B8\u05E8\u05B6\u05E5\",\n   *    TRANSLITERATION: \"The Earth\"\n   *  }]\n   * });\n   *\n   * // w\u01DD\u02BE\u0113t The Earth\n   * ```\n   *\n   * Using a callback\n   * @example\n   *\n   * ```js\n   * transliterate(heb, {\n   *  ADDITIONAL_FEATURES: [{\n   *    HEBREW: \"\u05E9\u05C1\u05B0\u05EA\u05BC\u05B7\u05D9\u05B4\u05DD\",\n   *    FEATURE: \"word\",\n   *    TRANSLITERATION: function (_word, _hebrew, schema) {\n   *      return (\n   *        schema[\"SHIN\"] +\n   *       (schema[\"TAV_DAGESH\"] ?? schema[\"TAV\"]) +\n   *        schema[\"PATAH\"] +\n   *        schema[\"YOD\"] +\n   *        schema[\"HIRIQ\"] +\n   *        schema[\"FINAL_MEM\"]\n   *      );\n   *    }\n   *  }]\n   * });\n   *\n   * // \u0161tayim\n   * ```\n   */\n  TRANSLITERATION: string | WordCallback;\n}\n\n/**\n * @param syllable the `Syllable` object that matches the `HEBREW` property\n * @param hebrew the `HEBREW` property\n * @param schema the `Schema` being used\n */\nexport type SyllableCallback = (syllable: Syllable, hebrew: string | RegExp, schema: Schema) => string;\n\nexport interface SyllableFeature extends HebrewFeature, PassThrough {\n  /**\n   * Additional orthographic feature:\n   *\n   * - `\"cluster\"` is any combination of a single character and optionally a _dagesh_ and vowel.\n   * - `\"syllable\"` is any combination of a multiple characters and a single vowel and optionally a _dagesh_\n   * - `\"word\"` covers everything else\n   */\n  FEATURE: \"syllable\";\n  /**\n   * A string or callback to customize output\n   *\n   * @example\n   * Using a string\n   * ```js\n   * transliterate(\"\u05DE\u05B0\u05D7\u05B4\u05D9\u05BC\u05D9\u05B8\u05D0\u05B5\u0597\u05DC\", {\n   *  ADDITIONAL_FEATURES: [{\n   *    FEATURE: \"syllable\",\n   *    HEBREW: /\u05D9\u05BC(?![\\u{05B4}-\\u{05BB}])/u, // a yod with a dagesh, not followed by a vowel character\n   *    TRANSLITERATION: \"Y\"\n   *  }]\n   * });\n   *\n   * m\u01DD\u1E25iYy\u0101\u02BE\u0113l\n   * ```\n   *\n   * @example\n   * Using a callback\n   * ```js\n   * transliterate(\"\u05E0\u05B8\u05E2\u05B3\u05DE\u05B4\u05D9\u0599\", {\n   *  ADDITIONAL_FEATURES: [{\n   *    FEATURE: \"syllable\",\n   *    HEBREW: /\\u{05C7}/u,\n   *    TRANSLITERATION: (syllable) => {\n   *      // If the syllable contains a qamets qatan character (U+05C7), check the text of the next syllable\n   *      const next = syllable?.next?.value?.text;\n   *\n   *      // If the next syllable includes a hateph qamets, then replace the qamets qatan with a regular qamets\n   *      if (next && next.includes(\"\\u05B3\")) {\n   *        return syllable.text.replace(\"\\u{05C7}\", \"\\u{05B8}\");\n   *      }\n   *      return syllable.text;\n   *    }\n   *  }]\n   * });\n   *\n   * // n\u0101\u02BF\u014Fm\u00EE\n   * ```\n   */\n  TRANSLITERATION: string | SyllableCallback;\n}\n\n/**\n * @param cluster the `Cluster` object that matches the `HEBREW` property\n * @param hebrew the `HEBREW` property\n * @param schema the `Schema` being used\n */\nexport type ClusterCallback = (cluster: Cluster, hebrew: string | RegExp, schema: Schema) => string;\n\nexport interface ClusterFeature extends HebrewFeature, PassThrough {\n  /**\n   * Additional orthographic feature.\n   *\n   * - `\"cluster\"` is any combination of a single character and optionally a _dagesh_ and vowel.\n   * - `\"syllable\"` is any combination of a multiple characters and a single vowel and optionally a _dagesh_\n   * - `\"word\"` covers everything else\n   */\n  FEATURE: \"cluster\";\n  /**\n   * A string or callback to customize the output\n   *\n   * @example\n   * Using a string\n   * ```js\n   * transliterate(\"\u05D4\u05B7\u05D6\u05BC\u05B9\u05D0\u05EA\", {\n   *   ADDITIONAL_FEATURES: [{\n   *     FEATURE: \"cluster\",\n   *     HEBREW: \"\u05D6\u05BC\",\n   *     TRANSLITERATION: \"tz\"\n   *   }]\n   * });\n   *\n   * // hatz\u014D\u02BEt\n   * ```\n   *\n   * @example\n   * Using a callback\n   * ```js\n   * transliterate(\"\u05D5\u05B7\u05EA\u05BC\u05B5\u05A8\u05E9\u05C1\u05B6\u05D1\", {\n   *   TAV_DAGESH: \"t\u02B0\",,\n   *   ADDITIONAL_FEATURES: [{\n   *     FEATURE: 'cluster',\n   *     HEBREW: /\u05EA\u05BC(?!\\u{05B0})/u,\n   *     TRANSLITERATION: (cluster, _, schema) => {\n   *       // if there is a dagesh, but it is the beginning of the word\n   *       // we can return the text, as the character w/ the dagesh will not be doubled\n   *       if (!cluster.prev || cluster.prev.value?.isNotHebrew) {\n   *         return cluster.text;\n   *       }\n   *\n   *       // if there is a dagesh, it may be that it is a dagesh qal (i.e. lene)\n   *       // if it is a dagesh lene, then like the beginning of the word,\n   *       // the character w/ the dagesh will not be doubled\n   *       const prevCoda = cluster.syllable?.prev?.value?.codaWithGemination;\n   *       if (!prevCoda?.includes(\"\u05EA\",)) {\n   *         return cluster.text;\n   *       }\n   *\n   *       // because the *_DAGESH value is a digraph, we need to replace the first character\n   *       // or it will be doubled in rules.ts as \"t\u02B0t\u02B0\"\n   *       const noAspiration = schema['TAV_DAGESH']?.replace(\"\u02B0\",, '') ?? '';\n   *       return cluster.text.replace(\"\u05EA\u05BC\",,`${noAspiration + schema['TAV_DAGESH']}`);\n   *     },\n   *   }]\n   * });\n   *\n   * // watt\u02B0\u0113\u0161eb\n   * ```\n   */\n  TRANSLITERATION: string | ClusterCallback;\n}\n\ntype SchemaVowels = Record<keyof NameToCharMap, string>;\n\n/**\n * @categoryDescription Consonants\n * Hebrew characters being used as consonants\n *\n * @categoryDescription Vowels\n * Hebrew characters being used as vowels, including the vocal sheva and ligatures\n *\n * @categoryDescription Taamim\n * Hebrew characters that that are used as taamim (i.e. accents)\n *\n * @categoryDescription Marks\n * Hebrew characters that are not consonants, vowels, or taamim, serving some other purpose, such as the dagesh or the paseq\n *\n * @categoryDescription Orthographic Features\n * Multiple Hebrew characters that form a semantic group, like the 3MS Suffix or a consonant with a dagesh\n *\n * @categoryDescription Syllabification\n * Options from havarotjs for syllabifying words\n */\n\n/**\n * Class for defining a schema for transliteration.\n *\n * @remarks\n * Examples are truncated for brevity.\n */\nexport class Schema implements SylOpts, SchemaVowels {\n  /**\n   * HEBREW POINT SHEVA (U+05B0) \u05B0\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   VOCAL_SHEVA: \"\u01DD\",\n   * });\n   * transliterate(\"\u05E1\u05B0\u05DC\u05B4\u05A3\u05E7\", schema);\n   * // s\u01DDliq\n   * ```\n   */\n  VOCAL_SHEVA: string;\n  /**\n   * HEBREW POINT HATAF SEGOL (U+05B1) \u05B1\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HATAF_SEGOL: \"\u0115\",\n   * });\n   * transliterate(\"\u05D0\u05B1\u05DC\u05B9\u05D4\u05B4\u0591\u05D9\u05DD\", schema);\n   * // \u02BE\u0115l\u014Dh\u00EEm\n   * ```\n   */\n  HATAF_SEGOL: string;\n  /**\n   * HEBREW POINT HATAF PATAH (U+05B2) \u05B2\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HATAF_PATAH: \"\u0103\",\n   * });\n   * transliterate(\"\u05E0\u05B7\u05BD\u05E2\u05B2\u05E9\u05C2\u05B6\u05A5\u05D4\", schema);\n   * // na\u02BF\u0103\u015B\u00EA\n   * ```\n   */\n  HATAF_PATAH: string;\n  /**\n   * HEBREW POINT HATAF QAMATS (U+05B3) \u05B3\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HATAF_QAMATS: \"\u014F\",\n   * });\n   * transliterate(\"\u05D0\u05B3\u05E8\u05B8\u05E0\u05B4\u05D9\u05DD\", schema);\n   * // \u02BE\u014Fr\u0101n\u00EEm\n   * ```\n   */\n  HATAF_QAMATS: string;\n  /**\n   * HEBREW POINT HIRIQ (U+05B4) \u05B4\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HIRIQ: \"i\",\n   * });\n   * transliterate(\"\u05D4\u05B4\u05E0\u05BC\u05B5\u05D4\u05A9\", schema);\n   * // hinn\u00EA\n   * ```\n   */\n  HIRIQ: string;\n  /**\n   * HEBREW POINT TSERE (U+05B5) \u05B5\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   TSERE: \"\u0113\",\n   * });\n   * transliterate(\"\u05D0\u05B5\u05E9\u05C1\", schema);\n   * // \u02BE\u0113\u0161\n   * ```\n   */\n  TSERE: string;\n  /**\n   * HEBREW POINT SEGOL (U+05B6) \u05B6\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   SEGOL: \"e\",\n   * });\n   * transliterate(\"\u05D0\u05B6\u05DC\", schema);\n   * // \u02BEel\n   * ```\n   */\n  SEGOL: string;\n  /**\n   * HEBREW POINT PATAH (U+05B7) \u05B7\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   PATAH: \"a\",\n   * });\n   * transliterate(\"\u05E0\u05B7\u0597\u05E2\u05B7\u05E8\", schema);\n   * // na\u02BFar\n   * ```\n   */\n  PATAH: string;\n  /**\n   * HEBREW POINT QAMATS (U+05B8) \u05B8\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   QAMATS: \"\u0101\",\n   * });\n   * transliterate(\"\u05D3\u05B8\u05D1\u05B8\u05E8\u0599\", schema);\n   * // d\u0101b\u0101r\n   * ```\n   */\n  QAMATS: string;\n  /**\n   * HEBREW POINT HOLAM (U+05B9) \u05B9\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HOLAM: \"\u014D\",\n   * });\n   * transliterate(\"\u05DC\u05B9\u05D0\", schema);\n   * // l\u014D\u02BE\n   * ```\n   */\n  HOLAM: string;\n  /**\n   * HEBREW POINT HOLAM HASER FOR VAV (U+05BA) \u05B9\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HOLAM_HASER: \"\u014D\",\n   * });\n   * transliterate(\"\u05E2\u05B8\u05D5\u05BA\u05DF\u0599\", schema);\n   * // \u02BF\u0101w\u014Dn\n   * ```\n   *\n   * @remarks\n   * See {@link holemHaser} for more about this character\n   */\n  HOLAM_HASER: string;\n  /**\n   * HEBREW POINT QUBUTS (U+05BB) \u05BB\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   QUBUTS: \"u\",\n   * });\n   * transliterate(\"\u05E7\u05BB\u05A3\u05DD\", schema);\n   * // q\u016Bm\n   * ```\n   */\n  QUBUTS: string;\n  /**\n   * HEBREW POINT DAGESH OR MAPIQ (U+05BC) \u05BC\u25CC\n   *\n   * @category Marks\n   *\n   * @example\n   * A blank string\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   DAGESH: \"\",\n   * });\n   * transliterate(\"\u05DB\u05BC\u05B5\u0591\u05DF\", schema);\n   * // k\u0113n\n   * ```\n   *\n   * @example\n   * A character\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   DAGESH: \".\",\n   * });\n   * transliterate(\"\u05DB\u05BC\u05B5\u0591\u05DF\", schema);\n   * // k.\u0113n\n   * ```\n   *\n   * @remarks\n   * Typically, this should be a blank string.\n   */\n  DAGESH: string;\n  /**\n   * HEBREW POINT DAGESH OR MAPIQ (U+05BC) \u05BC\u25CC\n   *\n   * A string or boolean, and if set to `true`, the consonant with the dagesh is repeated.\n   *\n   * @category Marks\n   * @category Orthographic Features\n   *\n   * @example\n   * As a string\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   DAGESH_CHAZAQ: \"\\u0301\",\n   * });\n   * transliterate(\"\u05E9\u05C1\u05B7\u05D1\u05BC\u05B8\u05EA\", schema);\n   * // \u0161ab\u0301\u0101t\n   * ```\n   *\n   * @example\n   * As a boolean\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   DAGESH_CHAZAQ: true,\n   * });\n   * transliterate(\"\u05E9\u05C1\u05B7\u05D1\u05BC\u05B8\u05EA\", schema);\n   * // \u0161abb\u0101t\n   * ```\n   */\n  DAGESH_CHAZAQ: boolean | string;\n  /**\n   * HEBREW PUNCTUATION MAQAF (U+05BE) \u05BE\u25CC\n   *\n   * @category Marks\n   * @category Taamim\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   { MAQAF: \"-\" }\n   * });\n   * transliterate(\"\u05D0\u05B7\u05DC\u05BE\", schema);\n   * // \u02BEal-\n   * ```\n   */\n  MAQAF: string;\n  /**\n   * HEBREW PUNCTUATION PASEQ (U+05C0) \u05C0 \u25CC\n   *\n   * @category Marks\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   PASEQ: \"\",\n   })\n   * transliterate(\"\u05DB\u05BC\u05B0\u05E9\u05C1\u05B6\u05A3\u05D1\u05B6\u05EA \u05C0 \u05D4\u05B7\u05DE\u05BC\u05B6\u05A3\u05DC\u05B6\u05DA\u05B0\", schema);\n   * // k\u01DD\u0161ebet  hammelek\n   * ```\n   *\n   * @remarks\n   * If a blank string, two spaces will occur between words; see example.\n   */\n  PASEQ: string;\n  /**\n   * HEBREW PUNCTUATION SOF PASUQ (U+05C3) \u05C3\u25CC\n   *\n   * @category Marks\n   * @category Taamim\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   SOF_PASUQ: \".\",\n   * });\n   * transliterate(\"\u05D4\u05B8\u05D0\u05B8\u05BD\u05E8\u05B6\u05E5\u05C3\", schema);\n   * // h\u0101\u02BE\u0101re\u1E63.\n   * ```\n   */\n  SOF_PASUQ: string;\n  /**\n   * HEBREW POINT QAMATS QATAN (U+05C7) \u05C7\u25CC\n   *\n   * @category Vowels\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   QAMATS QATAN: \"o\",\n   * });\n   * transliterate(\"\u05DB\u05BC\u05B8\u05DC\u05BE\u05D4\u05B8\u05E2\u05B8\u0596\u05DD\", schema);\n   * // kol-h\u0101\u02BF\u0101m\n   * ```\n   *\n   * @remarks\n   * See {@link qametsQatan} for details about this character.\n   */\n  QAMATS_QATAN: string;\n  /**\n   * HEBREW POINT PATAH (U+05B7) \u25CC\u05B7  as a furtive patah\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   FURTIVE_PATAH: \"a\",\n   * });\n   * transliterate(\"\u05E0\u05B9\u0596\u05D7\u05B7\", schema);\n   * // n\u014Da\u1E25\n   * ```\n   */\n  FURTIVE_PATAH: string;\n  /**\n   * HEBREW POINT HIRIQ (U+05B4) and YOD (U+05D9) \u05D9\u25CC\u05B4\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HIRIQ_YOD: \"\u00EE\",\n   * });\n   * transliterate(\"\u05E2\u05B4\u0594\u05D9\u05E8\", schema);\n   * // \u02BF\u00EEr\n   * ```\n   */\n  HIRIQ_YOD: string;\n  /**\n   * HEBREW POINT TSERE (U+05B5) and YOD (U+05D9) \u05D9\u25CC\u05B5\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   TSERE_YOD: \"\u00EA\",\n   * });\n   * transliterate(\"\u05D0\u05B5\u05A4\u05D9\u05DF\", schema);\n   * // \u02BE\u00EAn\n   * ```\n   */\n  TSERE_YOD: string;\n  /**\n   * HEBREW POINT SEGOL (U+05B6) and YOD (U+05D9) \u05D9\u25CC\u05B6\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   SEGOL_YOD: \"\u00EA\",\n   * });\n   * transliterate(\"\u05D0\u05B1\u05DC\u05B9\u05D4\u05B6\u0591\u05D9\u05DA\u05B8\", schema);\n   * // \u02BE\u0115l\u014Dh\u00EAk\u0101\n   * ```\n   */\n  SEGOL_YOD: string;\n  /**\n   * HEBREW LETTER VAV (U+05D5) and DAGESH (U+05BC) \u05D5\u05BC\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   SHUREQ: \"\u00FB\",\n   * });\n   * transliterate(\"\u05E7\u05D5\u05BC\u05DD\", schema);\n   * // q\u00FBm\n   * ```\n   */\n  SHUREQ: string;\n  /**\n   * HEBREW LETTER HOLAM (U+05B9) and VAV (U+05D5) \u05B9\u05D5\u25CC\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HOLAM_VAV: \"\u00F4\",\n   * });\n   * transliterate(\"\u05E1\u05A3\u05D5\u05B9\u05D0\", schema);\n   * // s\u00F4\u02BE\n   * ```\n   */\n  HOLAM_VAV: string;\n  /**\n   * HEBREW POINT QAMATS (U+05B8) and HE (U+05D4) \u05D4\u25CC\u05B8\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   QAMATS_HE: \"\u00E2\",\n   * });\n   * transliterate(\"\u05E2\u05B5\u05E6\u05B8\u0596\u05D4\", schema);\n   * // \u02BF\u0113\u1E63\u00E2\n   * ```\n   */\n  QAMATS_HE: string;\n  /**\n   * HEBREW POINT SEGOL (U+05B6) and HE (U+05D4) \u05D4\u25CC\u05B6\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   SEGOL_HE: \"\u00EA\",\n   * });\n   * transliterate(\"\u05D9\u05B4\u05E7\u05B0\u05E8\u05B6\u05A5\u05D4\", schema);\n   * // yiqr\u00EA\n   * ```\n   */\n  SEGOL_HE: string;\n  /**\n   * HEBREW POINT TSERE (U+05B5) and HE (U+05D4) \u05D4\u25CC\u05B5\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   TSERE_HE: \"\u00EA\",\n   * });\n   * transliterate(\"\u05D4\u05B8\u05D0\u05B7\u05E8\u05B0\u05D9\u05B5\u0594\u05D4\", schema);\n   * // h\u0101\u02BEary\u00EA\n   * ```\n   */\n  TSERE_HE: string;\n  /**\n   * HEBREW LETTER QAMATS (U+05B8) and YOD (U+05D9) and VAV (U+05D5) \u05D9\u05D5\u25CC\u05B8\n   *\n   * @category Vowels\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   MS_SUFX: \u201D\u0101yw\u201D,\n   * });\n   * transliterate(\"\u05D9\u05B8\u05D3\u05B8\u059B\u05D9\u05D5\", schema);\n   * // y\u0101d\u0101yw\n   * ```\n   */\n  MS_SUFX: string;\n  /**\n   * HEBREW LETTER ALEF (U+05D0) \u05D0\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   ALEF: \"\u02BE\",\n   * });\n   * transliterate(\"\u05D0\u05B8\u05D1\", schema);\n   * // \u02BE\u0101b\n   * ```\n   */\n  ALEF: string;\n  /**\n   * HEBREW LETTER BET (U+05D1) \u05D1\n   *\n   * @category Consonants\n   *\n   * @example\n   *  ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   BET: \"b\",\n   * });\n   * transliterate(\"\u05D1\u05BC\u05B0\u05D1\u05B5\u05D9\u05EA\", schema);\n   * // b\u01DDb\u00EAt\n   * ```\n   */\n  BET: string;\n  /**\n   * HEBREW LETTER BET (U+05D1) and DAGESH (U+05BC) \u05BC\u05D1\n   *\n   * @category Consonants\n   * @category Orthographic Features\n   *\n   * @example\n   * With only `BET` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   BET: \"b\",\n   * });\n   * transliterate(\"\u05D1\u05BC\u05B0\u05D1\u05B5\u05D9\u05EA\", schema);\n   * // b\u01DDb\u00EAt\n   *```\n   *\n   * @example\n   * With `BET` and `BET_DAGESH` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   BET: \"v\",\n   *   BET_DAGESH: \"b\",\n   * });\n   * transliterate(\"\u05D1\u05BC\u05B0\u05D1\u05B5\u05D9\u05EA\", schema);\n   * // b\u01DDv\u00EAt\n   * ```\n   *\n   * @remarks\n   * The letter bet with a dagesh kal.\n   * Use when need to distinguish between spirantized forms\n   */\n  BET_DAGESH?: string;\n  /**\n   * HEBREW LETTER GIMEL (U+05D2) \u05D2\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   GIMEL: \"g\",\n   * });\n   * transliterate(\"\u05D2\u05BC\u05B7\u05A3\u05D2\u05BC\", schema);\n   * // gag\n   * ```\n   */\n  GIMEL: string;\n  /**\n   * HEBREW LETTER GIMEL (U+05D2) and DAGESH (U+05BC) \u05D2\u05BC\n   *\n   * @category Consonants\n   * @category Orthographic Features\n   *\n   * @example\n   * With only `GIMEL` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   GIMEL: \"g\"\n   * });\n   * transliterate(\"\u05D2\u05BC\u05B7\u05A3\u05D2\", schema);\n   * // gag\n   * ```\n   *\n   * @example\n   * With `GIMEL` and `GIMEL_DAGESH` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   GIMEL: \"gh\",\n   *   GIMEL_DAGESH: \"g\",\n   * });\n   * transliterate(\"\u05D2\u05BC\u05B7\u05A3\u05D2\", schema);\n   * // gagh\n   * ```\n   *\n   * @remarks\n   * The letter gimel with a dagesh kal.\n   * Use when need to distinguish between spirantized forms\n   */\n  GIMEL_DAGESH?: string;\n  /**\n   * HEBREW LETTER DALET (U+05D3) \u05D3\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   DALET: \"d\",\n   * });\n   * transliterate(\"\u05D3\u05BC\u05B9\u05A3\u05D3\", schema);\n   * // d\u014Dd\n   * ```\n   */\n  DALET: string;\n  /**\n   * HEBREW LETTER DALET (U+05D3) and DAGESH (U+05BC) \u05D3\u05BC\n   *\n   * @category Consonants\n   * @category Orthographic Features\n   *\n   * @example\n   * With only `DALET` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   DALET: \"d\",\n   * });\n   * transliterate(\"\u05D3\u05BC\u05B9\u05A3\u05D3\", schema);\n   * // d\u014Dd\n   * ```\n   *\n   * @example\n   * With `DALET` and `DALET_DAGESH` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   DALET: \"dh\",\n   *   DALET_DAGESH: \"d\",\n   * });\n   * transliterate(\"\u05D3\u05BC\u05B9\u05A3\u05D3\", schema);\n   * // d\u014Ddh\n   * ```\n   *\n   * @remarks\n   * The letter dalet with a dagesh kal.\n   * Ue when need to distinguish between spirantized forms\n   */\n  DALET_DAGESH?: string;\n  /**\n   * HEBREW LETTER HE (U+05D4) \u05D4\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HE: \"h\",\n   * });\n   * transliterate(\"\u05D4\u05B5\u0597\u05DD\", schema);\n   * // h\u0113m\n   * ```\n   */\n  HE: string;\n  /**\n   * HEBREW LETTER VAV (U+05D5) \u05D5\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   VAV: \"w\",\n   * });\n   * transliterate(\"\u05D5\u05B8\u05D5\u05B4\u0596\u05D9\u05DD\", schema);\n   * // w\u0101w\u00EEm\n   * ```\n   */\n  VAV: string;\n  /**\n   * HEBREW LETTER ZAYIN (U+05D6) \u05D6\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   ZAYIN: \"z\",\n   * });\n   * transliterate(\"\u05D6\u05B5\u05A3\u05D3\", schema);\n   * // z\u0113d\n   * ```\n   */\n  ZAYIN: string;\n  /**\n   * HEBREW LETTER HET (U+05D7) \u05D7\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   HET: \"\u1E25\"\n   * });\n   * transliterate(\"\u05D7\u05B7\u05A3\u05D2\", schema);\n   * // \u1E25ag\n   * ```\n   */\n  HET: string;\n  /**\n   * HEBREW LETTER TET (U+05D8) \u05D8\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   TET: \"\u1E6D\",\n   * });\n   * transliterate(\"\u05D8\u05B4\u05BD\u05D9\u05D8\", schema);\n   * // \u1E6D\u00EE\u1E6D\n   * ```\n   */\n  TET: string;\n  /**\n   * HEBREW LETTER YOD (U+05D9) \u05D9\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   YOD: \"y\",\n   * });\n   * transliterate(\"\u05D9\u05B8\u0597\u05D3\", schema);\n   * // y\u0101d\n   * ```\n   */\n  YOD: string;\n  /**\n   * HEBREW LETTER FINAL KAF (U+05DA) \u05DA\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   FINAL KAF: \"k\",\n   * });\n   * transliterate(\"\u05DC\u05B6\u05DA\u05B0\", schema);\n   * // lek\n   * ```\n   */\n  FINAL_KAF: string;\n  /**\n   * HEBREW LETTER KAF (U+05DB) \u05DB\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   KAF: \"k\",\n   * });\n   * transliterate(\"\u05DB\u05BC\u05B8\u059A\u05DB\u05B8\u05D4\", schema);\n   * // k\u0101k\u00E2\n   * ```\n   */\n  KAF: string;\n  /**\n   * HEBREW LETTER KAF (U+05DB) and DAGESH (U+05BC) \u05DB\u05BC\n   *\n   * @category Consonants\n   * @category Orthographic Features\n   *\n   * @example\n   * With only `KAF` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   KAF: \"k\",\n   * });\n   * transliterate(\"\u05DB\u05BC\u05B8\u059A\u05DB\u05B8\u05D4\", schema);\n   * // k\u0101k\u00E2\n   * ```\n   *\n   * @example\n   * With `KAF` set and `KAF_DAGESH` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   KAF: \"kh\",\n   *   KAF_DAGESH: \"k\",\n   * });\n   * transliterate(\"\u05DB\u05BC\u05B8\u059A\u05DB\u05B8\u05D4\", schema);\n   * // k\u0101kh\u00E2\n   * ```\n   *\n   * @remarks\n   * The letter kaf with a dagesh kal.\n   * Use when need to distinguish between spirantized forms\n   */\n  KAF_DAGESH?: string;\n  /**\n   * HEBREW LETTER LAMED (U+05DC) \u05DC\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   LAMED: \"l\",\n   * });\n   * transliterate(\"\u05E2\u05B7\u05DC\", schema);\n   * // \u02BFal\n   * ```\n   */\n  LAMED: string;\n  /**\n   * HEBREW LETTER FINAL MEM (U+05DD) \u05DD\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   FINAL MEM: \"m\",\n   * });\n   * transliterate(\"\u05DE\u05B7\u0596\u05D9\u05B4\u05DD\", schema);\n   * // mayim\n   * ```\n   */\n  FINAL_MEM: string;\n  /**\n   * HEBREW LETTER MEM (U+05DE) \u05DE\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   MEM: \"m\",\n   * });\n   * transliterate(\"\u05DE\u05B7\u0596\u05D9\u05B4\u05DD\", schema);\n   * // mayim\n   * ```\n   */\n  MEM: string;\n  /**\n   * HEBREW LETTER FINAL NUN (U+05DF) \u05DF\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   FINAL NUN: \"n\",\n   * });\n   * transliterate(\"\u05E0\u0594\u05D5\u05BC\u05DF\", schema);\n   * // n\u00FBn\n   * ```\n   */\n  FINAL_NUN: string;\n  /**\n   * HEBREW LETTER NUN (U+05E0) \u05E0\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   NUN: \"n\",\n   * });\n   * transliterate(\"\u05E0\u0594\u05D5\u05BC\u05DF\", schema);\n   * // n\u00FBn\n   * ```\n   */\n  NUN: string;\n  /**\n   * HEBREW LETTER SAMEKH (U+05E1) \u05E1\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   SAMEKH: \"s\",\n   * });\n   * transliterate(\"\u05E1\u05A5\u05D5\u05BC\u05E1\", schema);\n   * // s\u00FBs\n   * ```\n   */\n  SAMEKH: string;\n  /**\n   * HEBREW LETTER AYIN (U+05E2) \u05E2\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   AYIN: \"\u02BF\",\n   * });\n   * transliterate(\"\u05E2\u05B8\u0591\u05D9\u05B4\u05DF\", schema);\n   * // \u02BF\u0101yin\n   * ```\n   */\n  AYIN: string;\n  /**\n   * HEBREW LETTER FINAL PE (U+05E3) \u05E3\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   FINAL PE: \"p\",\n   * });\n   * transliterate(\"\u05DB\u05BC\u05B7\u05A3\u05E3\", schema);\n   * // kap\n   * ```\n   */\n  FINAL_PE: string;\n  /**\n   * HEBREW LETTER PE (U+05E4) \u05E4\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   PE: \"p\",\n   * });\n   * transliterate(\"\u05E4\u05BC\u05B6\u05A3\u05E8\u05B6\u05D0 \u05D7\u05B8\u05E4\u05B0\u05E9\u05C1\u05B4\u0591\u05D9\", schema);\n   * // pere\u02BE \u1E25op\u0161\u00EE\n   * ```\n   */\n  PE: string;\n  /**\n   * HEBREW LETTER  PE (U+05E4) and DAGESH (U+05BC) \u05E4\u05BC\n   *\n   * @category Consonants\n   * @category Orthographic Features\n   *\n   * @example\n   * With only `PE` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   PE_DAGESH: \"p\",\n   * });\n   * transliterate(\"\u05E4\u05BC\u05B6\u05A3\u05E8\u05B6\u05D0 \u05D7\u05B8\u05E4\u05B0\u05E9\u05C1\u05B4\u0591\u05D9\", schema);\n   * // pere\u02BE \u1E25op\u0161\u00EE\n   * ```\n   *\n   * @example\n   * With `PE` and `PE_DAGESH` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   PE: \"f\",\n   *   PE_DAGESH: \"p\",\n   * });\n   * transliterate(\"\u05E4\u05BC\u05B6\u05A3\u05E8\u05B6\u05D0 \u05D7\u05B8\u05E4\u05B0\u05E9\u05C1\u05B4\u0591\u05D9\", schema);\n   * // pere\u02BE \u1E25of\u0161\u00EE\n   * ```\n   *\n   * @remarks\n   * The letter pe with a dagesh kal\n   * Use when need to distinguish between spirantized forms\n   */\n  PE_DAGESH?: string;\n  /**\n   * HEBREW LETTER FINAL TSADI (U+05E5) \u05E5\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   FINAL TSADI: \"\u1E63\",\n   * });\n   * transliterate(\"\u05E6\u05B8\u059A\u05E5\", schema);\n   * // \u1E63\u0101\u1E63\n   * ```\n   */\n  FINAL_TSADI: string;\n  /**\n   * HEBREW LETTER TSADI (U+05E6) \u05E6\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   TSADI: \"\u1E63\",\n   * });\n   * transliterate(\"\u05E6\u05B8\u059A\u05E5\", schema);\n   * // \u1E63\u0101\u1E63\n   * ```\n   */\n  TSADI: string;\n  /**\n   * HEBREW LETTER QOF (U+05E7) \u05E7\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   QOF: \"q\",\n   * });\n   * transliterate(\"\u05E8\u05B7\u05A5\u05E7\", schema);\n   * // raq\n   * ```\n   */\n  QOF: string;\n  /**\n   * HEBREW LETTER RESH (U+05E8) \u05E8\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   RESH: \"r\",\n   * });\n   * transliterate(\"\u05E8\u05B7\u05A5\u05E7\", schema);\n   * // raq\n   * ```\n   */\n  RESH: string;\n  /**\n   * HEBREW LETTER SHIN (U+05E9) and SHIN DOT (U+05C1) \u05E9\u05C1\n   *\n   * @category Consonants\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   SHIN: \"\u0161\",\n   * });\n   * transliterate(\"\u05E9\u05C1\u05B5\u0596\u05DF\", schema);\n   * // \u0161\u0113n\n   * ```\n   */\n  SHIN: string;\n  /**\n   * HEBREW LETTER SHIN (U+05E9) and SIN DOT (U+05C2) \u05E9\u05C1\n   *\n   * @category Consonants\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   SIN: \"\u015B\",\n   * });\n   * transliterate(\"\u05DB\u05BC\u05B7\u05E9\u05C2\u05B0\u05D3\u05BC\u05B4\u0594\u05D9\u05DD\", schema);\n   * // ka\u015Bd\u00EEm\n   * ```\n   */\n  SIN: string;\n  /**\n   * HEBREW LETTER TAV (U+05EA) \u05EA\n   *\n   * @category Consonants\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   TAV: \"t\",\n   * });\n   * transliterate(\"\u05EA\u05BC\u05B5\u059B\u05EA\", schema);\n   * // t\u0113t\n   * ```\n   */\n  TAV: string;\n  /**\n   * HEBREW LETTER TAV (U+05EA) and DAGESH (U+05BC) \u05EA\u05BC\n   *\n   * @category Consonants\n   * @category Orthographic Features\n   *\n   * @example\n   * With only `TAV` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   TAV: \"t\",\n   * });\n   * transliterate(\"\u05EA\u05BC\u05B5\u059B\u05EA\", schema);\n   * // t\u0113t\n   * ```\n   *\n   * @example\n   * With `TAV` and `TAV_DAGESH` set\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   TAV: \"th\",\n   *   TAV_DAGESH: \"t\",\n   * });\n   * transliterate(\"\u05EA\u05BC\u05B5\u059B\u05EA\", schema);\n   * // t\u0113th\n   * ```\n   *\n   * @remarks\n   * The letter tav with a dagesh kal.\n   * Use when need to distinguish between spirantized forms\n   */\n  TAV_DAGESH?: string;\n  /**\n   * Rules for customized output\n   *\n   * This property is an array of objects with the following properties each:\n   * - `FEATURE`: the type of feature that the rule is checking \u2014 \"word\", \"syllable\", or \"cluster\"\n   * - `HEBREW`: the Hebrew text that the rule matches, given as a string or Regex\n   * - `PASS_THROUGH?`: An optional property; `true` if the rule should pass the characters of the result of the `TRANSLITERATION` callback to the be mapped to the schema\n   * - `TRANSLITERATION`: the output of the rule, either a string or a callback whose properties differ based on the `FEATURE`\n   *\n   * The examples give the best indication of how to use these features, though see the particular types for more details\n   *\n   * @category Orthographic Features\n   *\n   * @example\n   * `FEATURE` is `\"word\"` and `TRANSLITERATION` is a string\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   ADDITIONAL_FEATURES: [{\n   *     FEATURE: \"word\",\n   *     HEBREW: \"\u05D4\u05B8\u05D0\u05B8\u05E8\u05B6\u05E5\",\n   *     TRANSLITERATION: \"The Earth\"\n   *   }]\n   })\n   * transliterate(\"\u05D5\u05B0\u05D0\u05B5\u05A5\u05EA \u05D4\u05B8\u05D0\u05B8\u05BD\u05E8\u05B6\u05E5\", schema);\n   * // w\u01DD\u02BE\u0113t The Earth\n   * ```\n   *\n   * @example\n   * `FEATURE` is `\"word\"` and `TRANSLITERATION` is a callback\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   ADDITIONAL_FEATURES: [{\n   *     HEBREW: \"\u05E9\u05C1\u05B0\u05EA\u05BC\u05B7\u05D9\u05B4\u05DD\",\n   *     FEATURE: \"word\",\n   *     TRANSLITERATION: function (_word, _hebrew, schema) {\n   *       return (\n   *         schema[\"SHIN\"] +\n   *         (schema[\"TAV_DAGESH\"] ?? schema[\"TAV\"]) +\n   *         schema[\"PATAH\"] +\n   *         schema[\"YOD\"] +\n   *         schema[\"HIRIQ\"] +\n   *         schema[\"FINAL_MEM\"]\n   *       );\n   *     }\n   *   }]\n   * });\n   * transliterate(\"\u05E9\u05C1\u05B0\u05EA\u05BC\u05B7\u05D9\u05B4\u05DD\", schema);\n   * // \u0161tayim\n   * ```\n   * @example\n   * `FEATURE` is `\"syllable\"` and `TRANSLITERATION` is a string\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   ADDITIONAL_FEATURES: [{\n   *     FEATURE: \"syllable\",\n   *     HEBREW: /\u05D9\u05BC(?![\\u{05B4}-\\u{05BB}])/u, // a yod with a dagesh, not followed by a vowel character\n   *     TRANSLITERATION: \"Y\"\n   *   }]\n   * });\n   * transliterate(\"\u05DE\u05B0\u05D7\u05B4\u05D9\u05BC\u05D9\u05B8\u05D0\u05B5\u0597\u05DC\", schema);\n   * // m\u01DD\u1E25iYy\u0101\u02BE\u0113l\n   * ```\n   *\n   * @example\n   * `FEATURE` is `\"syllable\"` and `TRANSLITERATION` is a callback\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   ADDITIONAL_FEATURES: [{\n   *     FEATURE: \"syllable\",\n   *     HEBREW: /\\u{05C7}/u,\n   *     TRANSLITERATION: (syllable) => {\n   *       // If the syllable contains a qamets qatan character (U+05C7), check the text of the next syllable\n   *       const next = syllable?.next?.value?.text;\n   *\n   *       // If the next syllable includes a hateph qamets, then replace the qamets qatan with a regular qamets\n   *       if (next && next.includes(\"\\u05B3\")) {\n   *         return syllable.text.replace(\"\\u{05C7}\", \"\\u{05B8}\");\n   *       }\n   *       return syllable.text;\n   *     }\n   *   }]\n   * });\n   * transliterate(\"\u05E0\u05B8\u05E2\u05B3\u05DE\u05B4\u05D9\u0599\", schema);\n   * // n\u0101\u02BF\u014Fm\u00EE\n   * ```\n   *\n   * @example\n   * `FEATURE` is `\"cluster\"` and `TRANSLITERATION` is a string\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   ADDITIONAL_FEATURES: [{\n   *     FEATURE: \"cluster\",\n   *     HEBREW: \"\u05D6\u05BC\",\n   *     TRANSLITERATION: \"tz\"\n   *   }]\n   * });;\n   * transliterate(\"\u05D4\u05B7\u05D6\u05BC\u05B9\u05D0\u05EA\", schema);\n   * // hatz\u014D\u02BEt\n   * ```\n   *\n   * @example\n   * `FEATURE` is \"cluster\" and `TRANSLITERATION` is a callback\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   TAV_DAGESH: \"t\u02B0\",,\n   *   ADDITIONAL_FEATURES: [{\n   *     FEATURE: 'cluster',\n   *     HEBREW: /\u05EA\u05BC(?!\\u{05B0})/u,\n   *     TRANSLITERATION: (cluster, _, schema) => {\n   *       // Because the *_DAGESH value is a digraph, we need to replace the first character\n   *       // or it will be doubled in rules.ts as \"t\u02B0t\u02B0\"\n   *\n   *\n   *       // If there is a dagesh, but it is the beginning of the word\n   *       // we can return the text, as the character w/ the dagesh will not be doubled\n   *       if (!cluster.prev || cluster.prev.value?.isNotHebrew) {\n   *         return cluster.text;\n   *       }\n   *\n   *       // If there is a dagesh, it may be that it is a dagesh qal (i.e. lene)\n   *       // If it is a dagesh lene, then like the beginning of the word,\n   *       // the character w/ the dagesh will not be doubled\n   *       const prevCoda = cluster.syllable?.prev?.value?.codaWithGemination;\n   *       if (!prevCoda?.includes(\"\u05EA\",)) {\n   *         return cluster.text;\n   *       }\n   *\n   *       // convert \"t\u02B0t\u02B0\" to \"tt\u02B0\"\n   *       const noAspiration = schema['TAV_DAGESH']?.replace(\"\u02B0\",, '') ?? '';\n   *       return cluster.text.replace(\"\u05EA\u05BC\",,`${noAspiration + schema['TAV_DAGESH']}`);\n   *     },\n   *   }]\n   * });\n   * transliterate(\"\u05D5\u05B7\u05EA\u05BC\u05B5\u05A8\u05E9\u05C1\u05B6\u05D1\", schema);\n   * // watt\u02B0\u0113\u0161eb\n   * ```\n   *\n   */\n  ADDITIONAL_FEATURES?: (WordFeature | SyllableFeature | ClusterFeature)[];\n  /**\n   * The full form of the divine name - \u05D9\u05D4\u05D5\u05D4\n   *\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   DIVINE_NAME: \"yhwh\",\n   * });\n   * transliterate(\"\u05D9\u05B0\u05D4\u05B9\u05D5\u05B8\u0597\u05D4\", schema);\n   * // yhwh\n   * ```\n   */\n  DIVINE_NAME: string;\n  /**\n   * The full form of the divine name pointed as 'elohim\n   *\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   DIVINE_NAME_ELOHIM: \"\u02BE\u0115l\u014Dh\u00EEm\",\n   * });\n   * transliterate(\"\u05D9\u05B1\u05D4\u05B9\u05D5\u05B4\u05D4\", schema);\n   * // \u02BE\u0115l\u014Dh\u00EEm\n   * ```\n   *\n   * @remarks\n   * Matches on the forms:\n   * - \u05D9\u05B1\u05D4\u05B9\u05D5\u05B4\u05D4\n   * - \u05D9\u05B1\u05D4\u05D5\u05B4\u05D4\n   * - \u05D9\u05B0\u05D4\u05B9\u05D5\u05B4\u05D4\n   * - \u05D9\u05B0\u05D4\u05D5\u05B4\u05D4\n   * If `undefined`, defaults to value of {@link DIVINE_NAME}\n   */\n  DIVINE_NAME_ELOHIM?: string;\n  /**\n   * A syllable separator, usually an empty string\n   *\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   SYLLABLE_SEPARATOR: \"-\",\n   * });\n   * transliterate('\u05D4\u05B8\u05D0\u05B8\u05BD\u05E8\u05B6\u05E5', schema);\n   * // h\u0101-\u02BE\u0101-re\u1E63\n   * ```\n   */\n  SYLLABLE_SEPARATOR?: string;\n  /**\n   * A mark for indentifying the stressed syllable\n   *\n   * @category Orthographic Features\n   *\n   * @example\n   * ```js\n   * const schema = new Schema({\n   *   // truncated for brevity\n   *   STRESS_MARKER: {\n   *     location: \"after-vowel\",\n   *     mark: \"\\u0301\",\n   *    },\n   * });\n   * transliterate(\"\u05DE\u05B6\u05A3\u05DC\u05B6\u05DA\u05B0\", schema);\n   * // me\u0341lek\n   * ```\n   *\n   * @remarks\n   * Taamim are needed in the Hebrew text to correctly identify stress.\n   */\n  STRESS_MARKER?: {\n    /**\n     * The location of the mark\n     */\n    location: \"before-syllable\" | \"after-syllable\" | \"before-vowel\" | \"after-vowel\";\n    /**\n     * A string to use as the marker\n     */\n    mark: string;\n    /**\n     * Whether to exclude the mark on certain syllables\n     *\n     * @default\n     * \"never\"\n     *\n     * @example\n     * `undefined` and `\"never\"` are the same\n     * ```js\n     * const schema = new Schema({\n     *   STRESS_MARKER: {\n     *     location: \"after-vowel\",\n     *     mark: \"\\u0301\",\n     *    },\n     * });\n     * transliterate(\"\u05D1\u05B9\u0596\u05BC\u05E7\u05B6\u05E8 \u05D9\u05A5\u05D5\u05B9\u05DD \u05D0\u05B6\u05D7\u05B8\u05BD\u05D3\u05C3 \", schema);\n     * // b\u014D\u0301qer y\u00F4\u0301m \u02BEe\u1E25\u0101\u0301d\n     * ```\n     *\n     * @example\n     * Exclude only single syllable words using `\"single\"`\n     * ```js\n     * const schema = new Schema({\n     *   STRESS_MARKER: {\n     *     location: \"after-vowel\",\n     *     mark: \"\\u0301\",\n     *     exclude: \"single\",\n     *    },\n     * });\n     * transliterate(\"\u05D1\u05B9\u0596\u05BC\u05E7\u05B6\u05E8 \u05D9\u05A5\u05D5\u05B9\u05DD \u05D0\u05B6\u05D7\u05B8\u05BD\u05D3\u05C3 \", schema);\n     * // b\u014D\u0301qer y\u00F4m \u02BEe\u1E25\u0101\u0301d\n     * ```\n     *\n     * @example\n     * Exclude when accent is on the final syllable, implicitly excluding single syllable words using `\"final\"`\n     * ```js\n     * const schema = new Schema({\n     *   STRESS_MARKER: {\n     *     location: \"after-vowel\",\n     *     mark: \"\\u0301\",\n     *     exclude: \"final\",\n     *    },\n     * });\n     * transliterate(\"\u05D1\u05B9\u0596\u05BC\u05E7\u05B6\u05E8 \u05D9\u05A5\u05D5\u05B9\u05DD \u05D0\u05B6\u05D7\u05B8\u05BD\u05D3\u05C3 \", schema);\n     * // b\u014D\u0301qer y\u00F4m \u02BEe\u1E25\u0101d\n     * ```\n     */\n    exclude?: \"never\" | \"final\" | \"single\";\n  };\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  allowNoNiqqud: SylOpts[\"allowNoNiqqud\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  article: SylOpts[\"article\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  holemHaser: SylOpts[\"holemHaser\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   *\n   */\n  ketivQeres?: SylOpts[\"ketivQeres\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  longVowels: SylOpts[\"longVowels\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  qametsQatan: SylOpts[\"qametsQatan\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  shevaAfterMeteg: SylOpts[\"shevaAfterMeteg\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  shevaWithMeteg?: SylOpts[\"shevaWithMeteg\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  sqnmlvy: SylOpts[\"sqnmlvy\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  strict: SylOpts[\"strict\"];\n  /**\n   * @category Syllabification\n   *\n   * @remarks\n   * See implementation for more details\n   */\n  wawShureq: SylOpts[\"wawShureq\"];\n  /**@category Constructors */\n  constructor(schema: Schema) {\n    this.VOCAL_SHEVA = schema.VOCAL_SHEVA;\n    this.HATAF_SEGOL = schema.HATAF_SEGOL;\n    this.HATAF_PATAH = schema.HATAF_PATAH;\n    this.HATAF_QAMATS = schema.HATAF_QAMATS;\n    this.HIRIQ = schema.HIRIQ;\n    this.TSERE = schema.TSERE;\n    this.SEGOL = schema.SEGOL;\n    this.PATAH = schema.PATAH;\n    this.QAMATS = schema.QAMATS;\n    this.HOLAM = schema.HOLAM;\n    this.HOLAM_HASER = schema.HOLAM_HASER;\n    this.QUBUTS = schema.QUBUTS;\n    this.DAGESH = schema.DAGESH;\n    this.DAGESH_CHAZAQ = schema.DAGESH_CHAZAQ;\n    this.MAQAF = schema.MAQAF;\n    this.PASEQ = schema.PASEQ;\n    this.SOF_PASUQ = schema.SOF_PASUQ;\n    this.QAMATS_QATAN = schema.QAMATS_QATAN;\n    this.FURTIVE_PATAH = schema.FURTIVE_PATAH;\n    this.HIRIQ_YOD = schema.HIRIQ_YOD;\n    this.TSERE_YOD = schema.TSERE_YOD;\n    this.SEGOL_YOD = schema.SEGOL_YOD;\n    this.SHUREQ = schema.SHUREQ;\n    this.HOLAM_VAV = schema.HOLAM_VAV;\n    this.QAMATS_HE = schema.QAMATS_HE;\n    this.SEGOL_HE = schema.SEGOL_HE;\n    this.TSERE_HE = schema.TSERE_HE;\n    this.MS_SUFX = schema.MS_SUFX;\n    this.ALEF = schema.ALEF;\n    this.BET_DAGESH = schema.BET_DAGESH;\n    this.BET = schema.BET;\n    this.GIMEL = schema.GIMEL;\n    this.GIMEL_DAGESH = schema.GIMEL_DAGESH;\n    this.DALET = schema.DALET;\n    this.DALET_DAGESH = schema.DALET_DAGESH;\n    this.HE = schema.HE;\n    this.VAV = schema.VAV;\n    this.ZAYIN = schema.ZAYIN;\n    this.HET = schema.HET;\n    this.TET = schema.TET;\n    this.YOD = schema.YOD;\n    this.FINAL_KAF = schema.FINAL_KAF;\n    this.KAF = schema.KAF;\n    this.KAF_DAGESH = schema.KAF_DAGESH;\n    this.LAMED = schema.LAMED;\n    this.FINAL_MEM = schema.FINAL_MEM;\n    this.MEM = schema.MEM;\n    this.FINAL_NUN = schema.FINAL_NUN;\n    this.NUN = schema.NUN;\n    this.SAMEKH = schema.SAMEKH;\n    this.AYIN = schema.AYIN;\n    this.FINAL_PE = schema.FINAL_PE;\n    this.PE = schema.PE;\n    this.PE_DAGESH = schema.PE_DAGESH;\n    this.FINAL_TSADI = schema.FINAL_TSADI;\n    this.TSADI = schema.TSADI;\n    this.QOF = schema.QOF;\n    this.RESH = schema.RESH;\n    this.SHIN = schema.SHIN;\n    this.SIN = schema.SIN;\n    this.TAV = schema.TAV;\n    this.TAV_DAGESH = schema.TAV_DAGESH;\n    this.DIVINE_NAME = schema.DIVINE_NAME;\n    this.DIVINE_NAME_ELOHIM = schema.DIVINE_NAME_ELOHIM;\n    this.SYLLABLE_SEPARATOR = schema.SYLLABLE_SEPARATOR;\n    this.ADDITIONAL_FEATURES = schema.ADDITIONAL_FEATURES;\n    this.STRESS_MARKER = schema.STRESS_MARKER;\n    this.longVowels = schema.longVowels;\n    this.qametsQatan = schema.qametsQatan;\n    this.sqnmlvy = schema.sqnmlvy;\n    this.shevaAfterMeteg = schema.shevaAfterMeteg;\n    this.shevaWithMeteg = schema.shevaWithMeteg;\n    this.wawShureq = schema.wawShureq;\n    this.article = schema.article;\n    this.allowNoNiqqud = schema.allowNoNiqqud;\n    this.strict = schema.strict;\n    this.holemHaser = schema.holemHaser;\n    this.ketivQeres = schema.ketivQeres;\n  }\n}\n\n/**\n * The default schema according to SBL's academic style guide.\n *\n * Whereas a new {@link Schema} must have all required properties when constructed,\n * this schema is meant to be used as a default so particular properties can be overidden (see example).\n *\n * If the property is not set, the default value will be used. Each property is documented below with their default values.\n *\n * Click into each property's \"Overrides\" for more information about that property.\n *\n * @param schema a {@link Schema | Partial\\<Schema\\>}\n *\n * @example\n * Extend the default schema\n * ```js\n *  transliterate(\"\u05E9\u05C1\u05B8\u05DC\u05D5\u05B9\u05DD\", { SHIN: \"sh\" });\n * // sh\u0101l\u00F4m\n * ```\n *\n * @privateRemarks\n * In order for documentation output to be the way I wanted, the properties are all redefined with their type from the Schema.\n * This is not necessary for the implementation, just the docs.\n */\nexport class SBL extends Schema {\n  /** @category Vowels @default \"\u01DD\" */\n  declare VOCAL_SHEVA: Schema[\"VOCAL_SHEVA\"];\n  /** @category Vowels @default \"\u0115\" */\n  declare HATAF_SEGOL: Schema[\"HATAF_SEGOL\"];\n  /** @category Vowels @default \"\u0103\" */\n  declare HATAF_PATAH: Schema[\"HATAF_PATAH\"];\n  /** @category Vowels @default \"\u014F\" */\n  declare HATAF_QAMATS: Schema[\"HATAF_QAMATS\"];\n  /** @category Vowels @default \"i\" */\n  declare HIRIQ: Schema[\"HIRIQ\"];\n  /** @category Vowels @default \"\u0113\" */\n  declare TSERE: Schema[\"TSERE\"];\n  /** @category Vowels @default \"e\" */\n  declare SEGOL: Schema[\"SEGOL\"];\n  /** @category Vowels @default \"a\" */\n  declare PATAH: Schema[\"PATAH\"];\n  /** @category Vowels @default \"\u0101\" */\n  declare QAMATS: Schema[\"QAMATS\"];\n  /** @category Vowels @default \"\u014D\" */\n  declare HOLAM: Schema[\"HOLAM\"];\n  /** @category Vowels @default \"\u014D\" */\n  declare HOLAM_HASER: Schema[\"HOLAM_HASER\"];\n  /** @category Vowels @default \"\u016B\" */\n  declare QUBUTS: Schema[\"QUBUTS\"];\n  /** @category Marks @default \"\" */\n  declare DAGESH: Schema[\"DAGESH\"];\n  /** @category Marks @category Orthographic Features @default true */\n  declare DAGESH_CHAZAQ: Schema[\"DAGESH_CHAZAQ\"];\n  /** @category Marks @category Taamim @default \"-\" */\n  declare MAQAF: Schema[\"MAQAF\"];\n  /** @category Marks @default \"\" */\n  declare PASEQ: Schema[\"PASEQ\"];\n  /** @category Marks @category Taamim @default \"\" */\n  declare SOF_PASUQ: Schema[\"SOF_PASUQ\"];\n  /** @category Vowels @default \"o\" */\n  declare QAMATS_QATAN: Schema[\"QAMATS_QATAN\"];\n  /** @category Vowels @category Orthographic Features @default \"a\" */\n  declare FURTIVE_PATAH: Schema[\"FURTIVE_PATAH\"];\n  /** @category Vowels @category Orthographic Features @default \"\u00EE\" */\n  declare HIRIQ_YOD: Schema[\"HIRIQ_YOD\"];\n  /** @category Vowels @category Orthographic Features @default \"\u00EA\" */\n  declare TSERE_YOD: Schema[\"TSERE_YOD\"];\n  /** @category Vowels @category Orthographic Features @default \"\u00EA\" */\n  declare SEGOL_YOD: Schema[\"SEGOL_YOD\"];\n  /** @category Vowels @category Orthographic Features @default \"\u00FB\" */\n  declare SHUREQ: Schema[\"SHUREQ\"];\n  /** @category Vowels @category Orthographic Features @default \"\u00F4\" */\n  declare HOLAM_VAV: Schema[\"HOLAM_VAV\"];\n  /** @category Vowels @category Orthographic Features @default \"\u00E2\" */\n  declare QAMATS_HE: Schema[\"QAMATS_HE\"];\n  /** @category Vowels @category Orthographic Features @default \"\u00EA\" */\n  declare SEGOL_HE: Schema[\"SEGOL_HE\"];\n  /** @category Vowels @category Orthographic Features @default \"\u00EA\" */\n  declare TSERE_HE: Schema[\"TSERE_HE\"];\n  /** @category Vowel @category Orthographic Features @default \"\u0101yw\" */\n  declare MS_SUFX: Schema[\"MS_SUFX\"];\n  /** @category Consonants @default \"\u02BE\" */\n  declare ALEF: Schema[\"ALEF\"];\n  /** @category Consonants @default \"b\" */\n  declare BET: Schema[\"BET\"];\n  /** @category Consonants @category Orthographic Features @default undefined */\n  declare BET_DAGESH: Schema[\"BET_DAGESH\"];\n  /** @category Consonants @default \"g\" */\n  declare GIMEL: Schema[\"GIMEL\"];\n  /** @category Consonants @category Orthographic Features @default undefined */\n  declare GIMEL_DAGESH: Schema[\"GIMEL_DAGESH\"];\n  /** @category Consonants @default \"d\" */\n  declare DALET: Schema[\"DALET\"];\n  /** @category Consonants @category Orthographic Features @default undefined */\n  declare DALET_DAGESH: Schema[\"DALET_DAGESH\"];\n  /** @category Consonants @default \"h\" */\n  declare HE: Schema[\"HE\"];\n  /** @category Consonants @default \"w\" */\n  declare VAV: Schema[\"VAV\"];\n  /** @category Consonants @default \"z\" */\n  declare ZAYIN: Schema[\"ZAYIN\"];\n  /** @category Consonants @default \"\u1E25\" */\n  declare HET: Schema[\"HET\"];\n  /** @category Consonants @default \"\u1E6D\" */\n  declare TET: Schema[\"TET\"];\n  /** @category Consonants @default \"y\" */\n  declare YOD: Schema[\"YOD\"];\n  /** @category Consonants @default \"k\" */\n  declare FINAL_KAF: Schema[\"FINAL_KAF\"];\n  /** @category Consonants @default \"k\" */\n  declare KAF: Schema[\"KAF\"];\n  /** @category Consonants @category Orthographic Features @default undefined */\n  declare KAF_DAGESH: Schema[\"KAF_DAGESH\"];\n  /** @category Consonants @default \"l\" */\n  declare LAMED: Schema[\"LAMED\"];\n  /** @category Consonants @default \"m\" */\n  declare FINAL_MEM: Schema[\"FINAL_MEM\"];\n  /** @category Consonants @default \"m\" */\n  declare MEM: Schema[\"MEM\"];\n  /** @category Consonants @default \"n\" */\n  declare FINAL_NUN: Schema[\"FINAL_NUN\"];\n  /** @category Consonants @default \"n\" */\n  declare NUN: Schema[\"NUN\"];\n  /** @category Consonants @default \"s\" */\n  declare SAMEKH: Schema[\"SAMEKH\"];\n  /** @category Consonants @default \"\u02BF\" */\n  declare AYIN: Schema[\"AYIN\"];\n  /** @category Consonants @default \"p\" */\n  declare FINAL_PE: Schema[\"FINAL_PE\"];\n  /** @category Consonants @default \"p\" */\n  declare PE: Schema[\"PE\"];\n  /** @category Consonants @category Orthographic Features @default undefined */\n  declare PE_DAGESH: Schema[\"PE_DAGESH\"];\n  /** @category Consonants @default \"\u1E63\" */\n  declare FINAL_TSADI: Schema[\"FINAL_TSADI\"];\n  /** @category Consonants @default \"\u1E63\" */\n  declare TSADI: Schema[\"TSADI\"];\n  /** @category Consonants @default \"q\" */\n  declare QOF: Schema[\"QOF\"];\n  /** @category Consonants @default \"r\" */\n  declare RESH: Schema[\"RESH\"];\n  /** @category Consonants @category Orthographic Features @default \"\u0161\" */\n  declare SHIN: Schema[\"SHIN\"];\n  /** @category Consonants @category Orthographic Features @default \"\u015B\" */\n  declare SIN: Schema[\"SIN\"];\n  /** @category Consonants @default \"t\" */\n  declare TAV: Schema[\"TAV\"];\n  /** @category Consonants @category Orthographic Features @default undefined */\n  declare TAV_DAGESH: Schema[\"TAV_DAGESH\"];\n  /** @category Orthographic Features @default \"yhwh\" */\n  declare DIVINE_NAME: Schema[\"DIVINE_NAME\"];\n  /** @category Orthographic Features @default undefined */\n  declare DIVINE_NAME_ELOHIM: Schema[\"DIVINE_NAME_ELOHIM\"];\n  /** @category Orthographic Features @default undefined */\n  declare SYLLABLE_SEPARATOR: Schema[\"SYLLABLE_SEPARATOR\"];\n  /** @category Orthographic Features @default undefined  */\n  declare ADDITIONAL_FEATURES: Schema[\"ADDITIONAL_FEATURES\"];\n  /** @category Orthographic Features @default undefined */\n  declare STRESS_MARKER: Schema[\"STRESS_MARKER\"];\n  /** @category Syllabification @default true */\n  declare longVowels: Schema[\"longVowels\"];\n  /** @category Syllabification @default true */\n  declare qametsQatan: Schema[\"qametsQatan\"];\n  /** @category Syllabification @default true */\n  declare shevaAfterMeteg: Schema[\"shevaAfterMeteg\"];\n  /** @category Syllabification @default false */\n  declare shevaWithMeteg: Schema[\"shevaWithMeteg\"];\n  /** @category Syllabification @default true */\n  declare sqnmlvy: Schema[\"sqnmlvy\"];\n  /** @category Syllabification @default true */\n  declare wawShureq: Schema[\"wawShureq\"];\n  /** @category Syllabification @default true */\n  declare article: Schema[\"article\"];\n  /** @category Syllabification @default true */\n  declare allowNoNiqqud: Schema[\"allowNoNiqqud\"];\n  /** @category Syllabification @default false */\n  declare strict: Schema[\"strict\"];\n  /** @category Syllabification @default \"remove\" */\n  declare holemHaser: Schema[\"holemHaser\"];\n  /** @category Syllabification @default undefined */\n  declare ketivQeres: Schema[\"ketivQeres\"];\n  constructor(schema: Partial<Schema>) {\n    super({\n      VOCAL_SHEVA: schema.VOCAL_SHEVA ?? \"\u01DD\",\n      HATAF_SEGOL: schema.HATAF_SEGOL ?? \"\u0115\",\n      HATAF_PATAH: schema.HATAF_PATAH ?? \"\u0103\",\n      HATAF_QAMATS: schema.HATAF_QAMATS ?? \"\u014F\",\n      HIRIQ: schema.HIRIQ ?? \"i\",\n      TSERE: schema.TSERE ?? \"\u0113\",\n      SEGOL: schema.SEGOL ?? \"e\",\n      PATAH: schema.PATAH ?? \"a\",\n      QAMATS: schema.QAMATS ?? \"\u0101\",\n      HOLAM: schema.HOLAM ?? \"\u014D\",\n      HOLAM_HASER: schema.HOLAM_HASER ?? \"\u014D\",\n      QUBUTS: schema.QUBUTS ?? \"\u016B\",\n      DAGESH: schema.DAGESH ?? \"\",\n      DAGESH_CHAZAQ: schema.DAGESH_CHAZAQ ?? true,\n      MAQAF: schema.MAQAF ?? \"-\",\n      PASEQ: schema.PASEQ ?? \"\",\n      SOF_PASUQ: schema.SOF_PASUQ ?? \"\",\n      QAMATS_QATAN: schema.QAMATS_QATAN ?? \"o\",\n      FURTIVE_PATAH: schema.FURTIVE_PATAH ?? \"a\",\n      HIRIQ_YOD: schema.HIRIQ_YOD ?? \"\u00EE\",\n      TSERE_YOD: schema.TSERE_YOD ?? \"\u00EA\",\n      SEGOL_YOD: schema.SEGOL_YOD ?? \"\u00EA\",\n      SHUREQ: schema.SHUREQ ?? \"\u00FB\",\n      HOLAM_VAV: schema.HOLAM_VAV ?? \"\u00F4\",\n      QAMATS_HE: schema.QAMATS_HE ?? \"\u00E2\",\n      SEGOL_HE: schema.SEGOL_HE ?? \"\u00EA\",\n      TSERE_HE: schema.TSERE_HE ?? \"\u00EA\",\n      MS_SUFX: schema.MS_SUFX ?? \"\u0101yw\",\n      ALEF: schema.ALEF ?? \"\u02BE\",\n      BET: schema.BET ?? \"b\",\n      BET_DAGESH: schema.BET_DAGESH ?? undefined,\n      GIMEL: schema.GIMEL ?? \"g\",\n      GIMEL_DAGESH: schema.GIMEL_DAGESH ?? undefined,\n      DALET: schema.DALET ?? \"d\",\n      DALET_DAGESH: schema.DALET_DAGESH ?? undefined,\n      HE: schema.HE ?? \"h\",\n      VAV: schema.VAV ?? \"w\",\n      ZAYIN: schema.ZAYIN ?? \"z\",\n      HET: schema.HET ?? \"\u1E25\",\n      TET: schema.TET ?? \"\u1E6D\",\n      YOD: schema.YOD ?? \"y\",\n      FINAL_KAF: schema.FINAL_KAF ?? \"k\",\n      KAF: schema.KAF ?? \"k\",\n      KAF_DAGESH: schema.KAF_DAGESH ?? undefined,\n      LAMED: schema.LAMED ?? \"l\",\n      FINAL_MEM: schema.FINAL_MEM ?? \"m\",\n      MEM: schema.MEM ?? \"m\",\n      FINAL_NUN: schema.FINAL_NUN ?? \"n\",\n      NUN: schema.NUN ?? \"n\",\n      SAMEKH: schema.SAMEKH ?? \"s\",\n      AYIN: schema.AYIN ?? \"\u02BF\",\n      FINAL_PE: schema.FINAL_PE ?? \"p\",\n      PE: schema.PE ?? \"p\",\n      PE_DAGESH: schema.PE_DAGESH ?? undefined,\n      FINAL_TSADI: schema.FINAL_TSADI ?? \"\u1E63\",\n      TSADI: schema.TSADI ?? \"\u1E63\",\n      QOF: schema.QOF ?? \"q\",\n      RESH: schema.RESH ?? \"r\",\n      SHIN: schema.SHIN ?? \"\u0161\",\n      SIN: schema.SIN ?? \"\u015B\",\n      TAV: schema.TAV ?? \"t\",\n      TAV_DAGESH: schema.TAV_DAGESH ?? undefined,\n      DIVINE_NAME: schema.DIVINE_NAME ?? \"yhwh\",\n      DIVINE_NAME_ELOHIM: schema.DIVINE_NAME_ELOHIM ?? undefined,\n      SYLLABLE_SEPARATOR: schema.SYLLABLE_SEPARATOR ?? undefined,\n      ADDITIONAL_FEATURES: schema.ADDITIONAL_FEATURES ?? undefined,\n      STRESS_MARKER: schema.STRESS_MARKER ?? undefined,\n      longVowels: schema.longVowels ?? true,\n      qametsQatan: schema.qametsQatan ?? true,\n      shevaAfterMeteg: schema.shevaAfterMeteg ?? true,\n      shevaWithMeteg: schema.shevaWithMeteg ?? false,\n      sqnmlvy: schema.sqnmlvy ?? true,\n      wawShureq: schema.wawShureq ?? true,\n      article: schema.article ?? true,\n      allowNoNiqqud: schema.allowNoNiqqud ?? true,\n      strict: schema.strict ?? false,\n      holemHaser: schema.holemHaser || \"remove\",\n      ketivQeres: schema.ketivQeres || undefined\n    });\n\n    this.VOCAL_SHEVA = schema.VOCAL_SHEVA ?? \"\u01DD\";\n    this.HATAF_SEGOL = schema.HATAF_SEGOL ?? \"\u0115\";\n    this.HATAF_PATAH = schema.HATAF_PATAH ?? \"\u0103\";\n    this.HATAF_QAMATS = schema.HATAF_QAMATS ?? \"\u014F\";\n    this.HIRIQ = schema.HIRIQ ?? \"i\";\n    this.TSERE = schema.TSERE ?? \"\u0113\";\n    this.SEGOL = schema.SEGOL ?? \"e\";\n    this.PATAH = schema.PATAH ?? \"a\";\n    this.QAMATS = schema.QAMATS ?? \"\u0101\";\n    this.HOLAM = schema.HOLAM ?? \"\u014D\";\n    this.HOLAM_HASER = schema.HOLAM_HASER ?? \"\u014D\";\n    this.QUBUTS = schema.QUBUTS ?? \"\u016B\";\n    this.DAGESH = schema.DAGESH ?? \"\";\n    this.DAGESH_CHAZAQ = schema.DAGESH_CHAZAQ ?? true;\n    this.MAQAF = schema.MAQAF ?? \"-\";\n    this.PASEQ = schema.PASEQ ?? \"\";\n    this.SOF_PASUQ = schema.SOF_PASUQ ?? \"\";\n    this.QAMATS_QATAN = schema.QAMATS_QATAN ?? \"o\";\n    this.FURTIVE_PATAH = schema.FURTIVE_PATAH ?? \"a\";\n    this.HIRIQ_YOD = schema.HIRIQ_YOD ?? \"\u00EE\";\n    this.TSERE_YOD = schema.TSERE_YOD ?? \"\u00EA\";\n    this.SEGOL_YOD = schema.SEGOL_YOD ?? \"\u00EA\";\n    this.SHUREQ = schema.SHUREQ ?? \"\u00FB\";\n    this.HOLAM_VAV = schema.HOLAM_VAV ?? \"\u00F4\";\n    this.QAMATS_HE = schema.QAMATS_HE ?? \"\u00E2\";\n    this.SEGOL_HE = schema.SEGOL_HE ?? \"\u00EA\";\n    this.TSERE_HE = schema.TSERE_HE ?? \"\u00EA\";\n    this.MS_SUFX = schema.MS_SUFX ?? \"\u0101yw\";\n    this.ALEF = schema.ALEF ?? \"\u02BE\";\n    this.BET = schema.BET ?? \"b\";\n    this.BET_DAGESH = schema.BET_DAGESH ?? undefined;\n    this.GIMEL = schema.GIMEL ?? \"g\";\n    this.GIMEL_DAGESH = schema.GIMEL_DAGESH ?? undefined;\n    this.DALET = schema.DALET ?? \"d\";\n    this.DALET_DAGESH = schema.DALET_DAGESH ?? undefined;\n    this.HE = schema.HE ?? \"h\";\n    this.VAV = schema.VAV ?? \"w\";\n    this.ZAYIN = schema.ZAYIN ?? \"z\";\n    this.HET = schema.HET ?? \"\u1E25\";\n    this.TET = schema.TET ?? \"\u1E6D\";\n    this.YOD = schema.YOD ?? \"y\";\n    this.FINAL_KAF = schema.FINAL_KAF ?? \"k\";\n    this.KAF = schema.KAF ?? \"k\";\n    this.KAF_DAGESH = schema.KAF_DAGESH ?? undefined;\n    this.LAMED = schema.LAMED ?? \"l\";\n    this.FINAL_MEM = schema.FINAL_MEM ?? \"m\";\n    this.MEM = schema.MEM ?? \"m\";\n    this.FINAL_NUN = schema.FINAL_NUN ?? \"n\";\n    this.NUN = schema.NUN ?? \"n\";\n    this.SAMEKH = schema.SAMEKH ?? \"s\";\n    this.AYIN = schema.AYIN ?? \"\u02BF\";\n    this.FINAL_PE = schema.FINAL_PE ?? \"p\";\n    this.PE = schema.PE ?? \"p\";\n    this.PE_DAGESH = schema.PE_DAGESH ?? undefined;\n    this.FINAL_TSADI = schema.FINAL_TSADI ?? \"\u1E63\";\n    this.TSADI = schema.TSADI ?? \"\u1E63\";\n    this.QOF = schema.QOF ?? \"q\";\n    this.RESH = schema.RESH ?? \"r\";\n    this.SHIN = schema.SHIN ?? \"\u0161\";\n    this.SIN = schema.SIN ?? \"\u015B\";\n    this.TAV = schema.TAV ?? \"t\";\n    this.TAV_DAGESH = schema.TAV_DAGESH ?? undefined;\n    this.DIVINE_NAME = schema.DIVINE_NAME ?? \"yhwh\";\n    this.DIVINE_NAME_ELOHIM = schema.DIVINE_NAME_ELOHIM ?? undefined;\n    this.SYLLABLE_SEPARATOR = schema.SYLLABLE_SEPARATOR ?? undefined;\n    this.ADDITIONAL_FEATURES = schema.ADDITIONAL_FEATURES ?? undefined;\n    this.STRESS_MARKER = schema.STRESS_MARKER ?? undefined;\n    this.longVowels = schema.longVowels ?? true;\n    this.qametsQatan = schema.qametsQatan ?? true;\n    this.shevaAfterMeteg = schema.shevaAfterMeteg ?? true;\n    this.shevaWithMeteg = schema.shevaWithMeteg ?? false;\n    this.sqnmlvy = schema.sqnmlvy ?? true;\n    this.wawShureq = schema.wawShureq ?? true;\n    this.article = schema.article ?? true;\n    this.allowNoNiqqud = schema.allowNoNiqqud ?? true;\n    this.strict = schema.strict ?? false;\n    this.holemHaser = schema.holemHaser ?? \"remove\";\n    this.ketivQeres = schema.ketivQeres ?? undefined;\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;AAmRA;;;;;;AA0BM,MAAO,OAAM;EAy+CjB,YAAY,QAAc;AAz9C1B;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAmBA;AAgBA;AA+BA;AA+BA;AAiBA;AAmBA;AAiBA;AAmBA;AAiBA;AAiBA;AAiBA;AAiBA;AAiBA;AAiBA;AAiBA;AAiBA;AAiBA;AAiBA;AAgBA;AAgBA;AAkCA;AAgBA;AAkCA;AAgBA;AAkCA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAkCA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAgBA;AAkCA;AAgBA;AAgBA;AAgBA;AAgBA;AAiBA;AAiBA;AAgBA;AAkCA;AAiJA;AAgBA;AAwBA;AAgBA;AAsBA;AAgEA;AAOA;AAOA;AAQA;AAOA;AAOA;AAOA;AAOA;AAOA;AAOA;AAOA;AAGE,SAAK,cAAc,OAAO;AAC1B,SAAK,cAAc,OAAO;AAC1B,SAAK,cAAc,OAAO;AAC1B,SAAK,eAAe,OAAO;AAC3B,SAAK,QAAQ,OAAO;AACpB,SAAK,QAAQ,OAAO;AACpB,SAAK,QAAQ,OAAO;AACpB,SAAK,QAAQ,OAAO;AACpB,SAAK,SAAS,OAAO;AACrB,SAAK,QAAQ,OAAO;AACpB,SAAK,cAAc,OAAO;AAC1B,SAAK,SAAS,OAAO;AACrB,SAAK,SAAS,OAAO;AACrB,SAAK,gBAAgB,OAAO;AAC5B,SAAK,QAAQ,OAAO;AACpB,SAAK,QAAQ,OAAO;AACpB,SAAK,YAAY,OAAO;AACxB,SAAK,eAAe,OAAO;AAC3B,SAAK,gBAAgB,OAAO;AAC5B,SAAK,YAAY,OAAO;AACxB,SAAK,YAAY,OAAO;AACxB,SAAK,YAAY,OAAO;AACxB,SAAK,SAAS,OAAO;AACrB,SAAK,YAAY,OAAO;AACxB,SAAK,YAAY,OAAO;AACxB,SAAK,WAAW,OAAO;AACvB,SAAK,WAAW,OAAO;AACvB,SAAK,UAAU,OAAO;AACtB,SAAK,OAAO,OAAO;AACnB,SAAK,aAAa,OAAO;AACzB,SAAK,MAAM,OAAO;AAClB,SAAK,QAAQ,OAAO;AACpB,SAAK,eAAe,OAAO;AAC3B,SAAK,QAAQ,OAAO;AACpB,SAAK,eAAe,OAAO;AAC3B,SAAK,KAAK,OAAO;AACjB,SAAK,MAAM,OAAO;AAClB,SAAK,QAAQ,OAAO;AACpB,SAAK,MAAM,OAAO;AAClB,SAAK,MAAM,OAAO;AAClB,SAAK,MAAM,OAAO;AAClB,SAAK,YAAY,OAAO;AACxB,SAAK,MAAM,OAAO;AAClB,SAAK,aAAa,OAAO;AACzB,SAAK,QAAQ,OAAO;AACpB,SAAK,YAAY,OAAO;AACxB,SAAK,MAAM,OAAO;AAClB,SAAK,YAAY,OAAO;AACxB,SAAK,MAAM,OAAO;AAClB,SAAK,SAAS,OAAO;AACrB,SAAK,OAAO,OAAO;AACnB,SAAK,WAAW,OAAO;AACvB,SAAK,KAAK,OAAO;AACjB,SAAK,YAAY,OAAO;AACxB,SAAK,cAAc,OAAO;AAC1B,SAAK,QAAQ,OAAO;AACpB,SAAK,MAAM,OAAO;AAClB,SAAK,OAAO,OAAO;AACnB,SAAK,OAAO,OAAO;AACnB,SAAK,MAAM,OAAO;AAClB,SAAK,MAAM,OAAO;AAClB,SAAK,aAAa,OAAO;AACzB,SAAK,cAAc,OAAO;AAC1B,SAAK,qBAAqB,OAAO;AACjC,SAAK,qBAAqB,OAAO;AACjC,SAAK,sBAAsB,OAAO;AAClC,SAAK,gBAAgB,OAAO;AAC5B,SAAK,aAAa,OAAO;AACzB,SAAK,cAAc,OAAO;AAC1B,SAAK,UAAU,OAAO;AACtB,SAAK,kBAAkB,OAAO;AAC9B,SAAK,iBAAiB,OAAO;AAC7B,SAAK,YAAY,OAAO;AACxB,SAAK,UAAU,OAAO;AACtB,SAAK,gBAAgB,OAAO;AAC5B,SAAK,SAAS,OAAO;AACrB,SAAK,aAAa,OAAO;AACzB,SAAK,aAAa,OAAO;EAC3B;;AA0BI,MAAO,YAAY,OAAM;EA6J7B,YAAY,QAAuB;AAzwDrC;AA0wDI,UAAM;MACJ,cAAa,YAAO,gBAAP,YAAsB;MACnC,cAAa,YAAO,gBAAP,YAAsB;MACnC,cAAa,YAAO,gBAAP,YAAsB;MACnC,eAAc,YAAO,iBAAP,YAAuB;MACrC,QAAO,YAAO,UAAP,YAAgB;MACvB,QAAO,YAAO,UAAP,YAAgB;MACvB,QAAO,YAAO,UAAP,YAAgB;MACvB,QAAO,YAAO,UAAP,YAAgB;MACvB,SAAQ,YAAO,WAAP,YAAiB;MACzB,QAAO,YAAO,UAAP,YAAgB;MACvB,cAAa,YAAO,gBAAP,YAAsB;MACnC,SAAQ,YAAO,WAAP,YAAiB;MACzB,SAAQ,YAAO,WAAP,YAAiB;MACzB,gBAAe,YAAO,kBAAP,YAAwB;MACvC,QAAO,YAAO,UAAP,YAAgB;MACvB,QAAO,YAAO,UAAP,YAAgB;MACvB,YAAW,YAAO,cAAP,YAAoB;MAC/B,eAAc,YAAO,iBAAP,YAAuB;MACrC,gBAAe,YAAO,kBAAP,YAAwB;MACvC,YAAW,YAAO,cAAP,YAAoB;MAC/B,YAAW,YAAO,cAAP,YAAoB;MAC/B,YAAW,YAAO,cAAP,YAAoB;MAC/B,SAAQ,YAAO,WAAP,YAAiB;MACzB,YAAW,YAAO,cAAP,YAAoB;MAC/B,YAAW,YAAO,cAAP,YAAoB;MAC/B,WAAU,YAAO,aAAP,YAAmB;MAC7B,WAAU,YAAO,aAAP,YAAmB;MAC7B,UAAS,YAAO,YAAP,YAAkB;MAC3B,OAAM,YAAO,SAAP,YAAe;MACrB,MAAK,YAAO,QAAP,YAAc;MACnB,aAAY,YAAO,eAAP,YAAqB;MACjC,QAAO,YAAO,UAAP,YAAgB;MACvB,eAAc,YAAO,iBAAP,YAAuB;MACrC,QAAO,YAAO,UAAP,YAAgB;MACvB,eAAc,YAAO,iBAAP,YAAuB;MACrC,KAAI,YAAO,OAAP,YAAa;MACjB,MAAK,YAAO,QAAP,YAAc;MACnB,QAAO,YAAO,UAAP,YAAgB;MACvB,MAAK,YAAO,QAAP,YAAc;MACnB,MAAK,YAAO,QAAP,YAAc;MACnB,MAAK,YAAO,QAAP,YAAc;MACnB,YAAW,YAAO,cAAP,YAAoB;MAC/B,MAAK,YAAO,QAAP,YAAc;MACnB,aAAY,YAAO,eAAP,YAAqB;MACjC,QAAO,YAAO,UAAP,YAAgB;MACvB,YAAW,YAAO,cAAP,YAAoB;MAC/B,MAAK,YAAO,QAAP,YAAc;MACnB,YAAW,YAAO,cAAP,YAAoB;MAC/B,MAAK,YAAO,QAAP,YAAc;MACnB,SAAQ,YAAO,WAAP,YAAiB;MACzB,OAAM,YAAO,SAAP,YAAe;MACrB,WAAU,YAAO,aAAP,YAAmB;MAC7B,KAAI,YAAO,OAAP,YAAa;MACjB,YAAW,YAAO,cAAP,YAAoB;MAC/B,cAAa,aAAO,gBAAP,aAAsB;MACnC,QAAO,aAAO,UAAP,aAAgB;MACvB,MAAK,aAAO,QAAP,aAAc;MACnB,OAAM,aAAO,SAAP,aAAe;MACrB,OAAM,aAAO,SAAP,aAAe;MACrB,MAAK,aAAO,QAAP,aAAc;MACnB,MAAK,aAAO,QAAP,aAAc;MACnB,aAAY,aAAO,eAAP,aAAqB;MACjC,cAAa,aAAO,gBAAP,aAAsB;MACnC,qBAAoB,aAAO,uBAAP,aAA6B;MACjD,qBAAoB,aAAO,uBAAP,aAA6B;MACjD,sBAAqB,aAAO,wBAAP,aAA8B;MACnD,gBAAe,aAAO,kBAAP,aAAwB;MACvC,aAAY,aAAO,eAAP,aAAqB;MACjC,cAAa,aAAO,gBAAP,aAAsB;MACnC,kBAAiB,aAAO,oBAAP,aAA0B;MAC3C,iBAAgB,aAAO,mBAAP,aAAyB;MACzC,UAAS,aAAO,YAAP,aAAkB;MAC3B,YAAW,aAAO,cAAP,aAAoB;MAC/B,UAAS,aAAO,YAAP,aAAkB;MAC3B,gBAAe,aAAO,kBAAP,aAAwB;MACvC,SAAQ,aAAO,WAAP,aAAiB;MACzB,YAAY,OAAO,cAAc;MACjC,YAAY,OAAO,cAAc;KAClC;AAED,SAAK,eAAc,aAAO,gBAAP,aAAsB;AACzC,SAAK,eAAc,aAAO,gBAAP,aAAsB;AACzC,SAAK,eAAc,aAAO,gBAAP,aAAsB;AACzC,SAAK,gBAAe,aAAO,iBAAP,aAAuB;AAC3C,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,UAAS,aAAO,WAAP,aAAiB;AAC/B,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,eAAc,aAAO,gBAAP,aAAsB;AACzC,SAAK,UAAS,aAAO,WAAP,aAAiB;AAC/B,SAAK,UAAS,aAAO,WAAP,aAAiB;AAC/B,SAAK,iBAAgB,aAAO,kBAAP,aAAwB;AAC7C,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,gBAAe,aAAO,iBAAP,aAAuB;AAC3C,SAAK,iBAAgB,aAAO,kBAAP,aAAwB;AAC7C,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,UAAS,aAAO,WAAP,aAAiB;AAC/B,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,YAAW,aAAO,aAAP,aAAmB;AACnC,SAAK,YAAW,aAAO,aAAP,aAAmB;AACnC,SAAK,WAAU,aAAO,YAAP,aAAkB;AACjC,SAAK,QAAO,aAAO,SAAP,aAAe;AAC3B,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,cAAa,aAAO,eAAP,aAAqB;AACvC,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,gBAAe,aAAO,iBAAP,aAAuB;AAC3C,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,gBAAe,aAAO,iBAAP,aAAuB;AAC3C,SAAK,MAAK,aAAO,OAAP,aAAa;AACvB,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,cAAa,aAAO,eAAP,aAAqB;AACvC,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,UAAS,aAAO,WAAP,aAAiB;AAC/B,SAAK,QAAO,aAAO,SAAP,aAAe;AAC3B,SAAK,YAAW,aAAO,aAAP,aAAmB;AACnC,SAAK,MAAK,aAAO,OAAP,aAAa;AACvB,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,eAAc,aAAO,gBAAP,aAAsB;AACzC,SAAK,SAAQ,aAAO,UAAP,aAAgB;AAC7B,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,QAAO,aAAO,SAAP,aAAe;AAC3B,SAAK,QAAO,aAAO,SAAP,aAAe;AAC3B,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,OAAM,aAAO,QAAP,aAAc;AACzB,SAAK,cAAa,aAAO,eAAP,aAAqB;AACvC,SAAK,eAAc,aAAO,gBAAP,aAAsB;AACzC,SAAK,sBAAqB,aAAO,uBAAP,aAA6B;AACvD,SAAK,sBAAqB,aAAO,uBAAP,aAA6B;AACvD,SAAK,uBAAsB,aAAO,wBAAP,aAA8B;AACzD,SAAK,iBAAgB,aAAO,kBAAP,aAAwB;AAC7C,SAAK,cAAa,aAAO,eAAP,aAAqB;AACvC,SAAK,eAAc,aAAO,gBAAP,aAAsB;AACzC,SAAK,mBAAkB,aAAO,oBAAP,aAA0B;AACjD,SAAK,kBAAiB,aAAO,mBAAP,aAAyB;AAC/C,SAAK,WAAU,aAAO,YAAP,aAAkB;AACjC,SAAK,aAAY,aAAO,cAAP,aAAoB;AACrC,SAAK,WAAU,aAAO,YAAP,aAAkB;AACjC,SAAK,iBAAgB,aAAO,kBAAP,aAAwB;AAC7C,SAAK,UAAS,aAAO,WAAP,aAAiB;AAC/B,SAAK,cAAa,aAAO,eAAP,aAAqB;AACvC,SAAK,cAAa,aAAO,eAAP,aAAqB;EACzC;;",
   "names": []
 }

package/dist/cjs/schemas/jss.js

@@ -87,7 +87,7 @@ const jss = {
   ADDITIONAL_FEATURES: [
     {
       FEATURE: "syllable",
-      HEBREW: /\u{05C7}/,
+      HEBREW: /\u{05C7}/u,
       TRANSLITERATION: (syllable) => {
         var _a, _b;
         const next = (_b = (_a = syllable == null ? void 0 : syllable.next) == null ? void 0 : _a.value) == null ? void 0 : _b.text;

package/dist/cjs/schemas/jss.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/schemas/jss.ts"],
-  "sourcesContent": ["import { Schema } from \"../schema\";\n\nexport const jss: Schema = {\n  VOCAL_SHEVA: \"\u01DD\",\n  HATAF_SEGOL: \"\u025B\u0306\",\n  HATAF_PATAH: \"\u0103\",\n  HATAF_QAMATS: \"\u00E5\u0306\",\n  HIRIQ: \"i\",\n  TSERE: \"\u0113\",\n  SEGOL: \"\u025B\",\n  PATAH: \"a\",\n  QAMATS: \"\u00E5\u0304\",\n  HOLAM: \"\u014D\",\n  HOLAM_HASER: \"\u014D\",\n  QUBUTS: \"u\",\n  DAGESH: \"\",\n  DAGESH_CHAZAQ: true,\n  MAQAF: \" \",\n  PASEQ: \"\",\n  SOF_PASUQ: \"\",\n  QAMATS_QATAN: \"\u00E5\",\n  FURTIVE_PATAH: \"a\",\n  HIRIQ_YOD: \"\u012B\",\n  TSERE_YOD: \"\u0113\",\n  SEGOL_YOD: \"\u025B\",\n  SHUREQ: \"\u016B\",\n  HOLAM_VAV: \"\u014D\",\n  QAMATS_HE: \"\u00E5\u0304\",\n  SEGOL_HE: \"\u025B\",\n  TSERE_HE: \"\u0113\",\n  MS_SUFX: \"\u00E5\u0304yw\",\n  ALEF: \"\u02BE\",\n  BET_DAGESH: \"b\",\n  BET: \"b\u0331\",\n  GIMEL: \"g\u0304\",\n  GIMEL_DAGESH: \"g\",\n  DALET: \"d\u0331\",\n  DALET_DAGESH: \"d\",\n  HE: \"h\",\n  VAV: \"w\",\n  ZAYIN: \"z\",\n  HET: \"\u1E25\",\n  TET: \"\u1E6D\",\n  YOD: \"y\",\n  FINAL_KAF: \"k\u0331\",\n  KAF: \"k\u0331\",\n  KAF_DAGESH: \"k\",\n  LAMED: \"l\",\n  FINAL_MEM: \"m\",\n  MEM: \"m\",\n  FINAL_NUN: \"n\",\n  NUN: \"n\",\n  SAMEKH: \"s\",\n  AYIN: \"\u02BF\",\n  FINAL_PE: \"p\u0304\",\n  PE: \"p\u0304\",\n  PE_DAGESH: \"p\",\n  FINAL_TSADI: \"\u1E63\",\n  TSADI: \"\u1E63\",\n  QOF: \"q\",\n  RESH: \"r\",\n  SHIN: \"\u0161\",\n  SIN: \"\u015B\",\n  TAV: \"t\u0331\",\n  TAV_DAGESH: \"t\",\n  DIVINE_NAME: \"yhwh\",\n  ADDITIONAL_FEATURES: [\n    {\n      FEATURE: \"syllable\",\n      // if the syllable contains a qamets qatan character\n      HEBREW: /\\u{05C7}/,\n      TRANSLITERATION: (syllable) => {\n        const next = syllable?.next?.value?.text;\n        // if the next syllable includes a hateph qamets, then replace the qamets qatan with a regular qamets\n        if (next && next.includes(\"\\u05B3\")) {\n          return syllable.text.replace(\"\\u{05C7}\", \"\\u{05B8}\");\n        }\n        return syllable.text;\n      }\n    }\n  ],\n  longVowels: true,\n  qametsQatan: true,\n  sqnmlvy: true,\n  wawShureq: true,\n  article: true,\n  allowNoNiqqud: true,\n  strict: false,\n  holemHaser: \"remove\",\n  shevaAfterMeteg: true\n};\n"],
+  "sourcesContent": ["import { Schema } from \"../schema\";\n\nexport const jss: Schema = {\n  VOCAL_SHEVA: \"\u01DD\",\n  HATAF_SEGOL: \"\u025B\u0306\",\n  HATAF_PATAH: \"\u0103\",\n  HATAF_QAMATS: \"\u00E5\u0306\",\n  HIRIQ: \"i\",\n  TSERE: \"\u0113\",\n  SEGOL: \"\u025B\",\n  PATAH: \"a\",\n  QAMATS: \"\u00E5\u0304\",\n  HOLAM: \"\u014D\",\n  HOLAM_HASER: \"\u014D\",\n  QUBUTS: \"u\",\n  DAGESH: \"\",\n  DAGESH_CHAZAQ: true,\n  MAQAF: \" \",\n  PASEQ: \"\",\n  SOF_PASUQ: \"\",\n  QAMATS_QATAN: \"\u00E5\",\n  FURTIVE_PATAH: \"a\",\n  HIRIQ_YOD: \"\u012B\",\n  TSERE_YOD: \"\u0113\",\n  SEGOL_YOD: \"\u025B\",\n  SHUREQ: \"\u016B\",\n  HOLAM_VAV: \"\u014D\",\n  QAMATS_HE: \"\u00E5\u0304\",\n  SEGOL_HE: \"\u025B\",\n  TSERE_HE: \"\u0113\",\n  MS_SUFX: \"\u00E5\u0304yw\",\n  ALEF: \"\u02BE\",\n  BET_DAGESH: \"b\",\n  BET: \"b\u0331\",\n  GIMEL: \"g\u0304\",\n  GIMEL_DAGESH: \"g\",\n  DALET: \"d\u0331\",\n  DALET_DAGESH: \"d\",\n  HE: \"h\",\n  VAV: \"w\",\n  ZAYIN: \"z\",\n  HET: \"\u1E25\",\n  TET: \"\u1E6D\",\n  YOD: \"y\",\n  FINAL_KAF: \"k\u0331\",\n  KAF: \"k\u0331\",\n  KAF_DAGESH: \"k\",\n  LAMED: \"l\",\n  FINAL_MEM: \"m\",\n  MEM: \"m\",\n  FINAL_NUN: \"n\",\n  NUN: \"n\",\n  SAMEKH: \"s\",\n  AYIN: \"\u02BF\",\n  FINAL_PE: \"p\u0304\",\n  PE: \"p\u0304\",\n  PE_DAGESH: \"p\",\n  FINAL_TSADI: \"\u1E63\",\n  TSADI: \"\u1E63\",\n  QOF: \"q\",\n  RESH: \"r\",\n  SHIN: \"\u0161\",\n  SIN: \"\u015B\",\n  TAV: \"t\u0331\",\n  TAV_DAGESH: \"t\",\n  DIVINE_NAME: \"yhwh\",\n  ADDITIONAL_FEATURES: [\n    {\n      FEATURE: \"syllable\",\n      // if the syllable contains a qamets qatan character\n      HEBREW: /\\u{05C7}/u,\n      TRANSLITERATION: (syllable) => {\n        const next = syllable?.next?.value?.text;\n        // if the next syllable includes a hateph qamets, then replace the qamets qatan with a regular qamets\n        if (next && next.includes(\"\\u05B3\")) {\n          return syllable.text.replace(\"\\u{05C7}\", \"\\u{05B8}\");\n        }\n        return syllable.text;\n      }\n    }\n  ],\n  longVowels: true,\n  qametsQatan: true,\n  sqnmlvy: true,\n  wawShureq: true,\n  article: true,\n  allowNoNiqqud: true,\n  strict: false,\n  holemHaser: \"remove\",\n  shevaAfterMeteg: true\n};\n"],
   "mappings": ";;;;;;;;;;;;;;;;;AAEA;;;;;AAAO,MAAM,MAAc;EACzB,aAAa;EACb,aAAa;EACb,aAAa;EACb,cAAc;EACd,OAAO;EACP,OAAO;EACP,OAAO;EACP,OAAO;EACP,QAAQ;EACR,OAAO;EACP,aAAa;EACb,QAAQ;EACR,QAAQ;EACR,eAAe;EACf,OAAO;EACP,OAAO;EACP,WAAW;EACX,cAAc;EACd,eAAe;EACf,WAAW;EACX,WAAW;EACX,WAAW;EACX,QAAQ;EACR,WAAW;EACX,WAAW;EACX,UAAU;EACV,UAAU;EACV,SAAS;EACT,MAAM;EACN,YAAY;EACZ,KAAK;EACL,OAAO;EACP,cAAc;EACd,OAAO;EACP,cAAc;EACd,IAAI;EACJ,KAAK;EACL,OAAO;EACP,KAAK;EACL,KAAK;EACL,KAAK;EACL,WAAW;EACX,KAAK;EACL,YAAY;EACZ,OAAO;EACP,WAAW;EACX,KAAK;EACL,WAAW;EACX,KAAK;EACL,QAAQ;EACR,MAAM;EACN,UAAU;EACV,IAAI;EACJ,WAAW;EACX,aAAa;EACb,OAAO;EACP,KAAK;EACL,MAAM;EACN,MAAM;EACN,KAAK;EACL,KAAK;EACL,YAAY;EACZ,aAAa;EACb,qBAAqB;IACnB;MACE,SAAS;MAET,QAAQ;MACR,iBAAiB,CAAC,aAAY;AArEpC;AAsEQ,cAAM,QAAO,gDAAU,SAAV,mBAAgB,UAAhB,mBAAuB;AAEpC,YAAI,QAAQ,KAAK,SAAS,QAAQ,GAAG;AACnC,iBAAO,SAAS,KAAK,QAAQ,UAAY,QAAU;QACrD;AACA,eAAO,SAAS;MAClB;;;EAGJ,YAAY;EACZ,aAAa;EACb,SAAS;EACT,WAAW;EACX,SAAS;EACT,eAAe;EACf,QAAQ;EACR,YAAY;EACZ,iBAAiB;;",
   "names": []
 }

package/dist/cjs/schemas/tiberian.js

@@ -472,6 +472,14 @@ const tiberian = {
   allowNoNiqqud: false,
   article: false,
   holemHaser: "remove",
+  ketivQeres: [
+    {
+      input: "\u05D4\u05B4\u05D5\u05D0",
+      output: "\u05D4\u05B4\u05D9\u05D0",
+      captureTaamim: true,
+      ignoreTaamim: true
+    }
+  ],
   longVowels: false,
   qametsQatan: true,
   shevaAfterMeteg: false,