hebrew-transliteration 2.3.1 → 2.5.0

package/README.md

@@ -254,8 +254,9 @@ There are other orthographic features:
 
 - `MS_SUFX` — HEBREW LETTER QAMATS (U+05B8) and YOD (U+05D9) and VAV (U+05D5) יו◌ָ
 - `DIVINE_NAME` — the full form of the divine name - יהוה
+- `DIVINE_NAME_ELOHIM` — optionally, the form of the divine name pointed as ʾelōhîm (e.g. יֱהֹוִה)
 - `SYLLABLE_SEPARATOR` — a syllable separator, usually an empty string
-- `DAGESH_CHAZAQ` — if true, repeats the consonant with the _dagesh_
+- `DAGESH_CHAZAQ` — if true, repeats the consonant with the _dagesh_, or can take a string
 
 ```javascript
 heb.transliterate("שַׁבָּת", { DAGESH_CHAZAQ: true });
@@ -264,6 +265,9 @@ heb.transliterate("שַׁבָּת", { DAGESH_CHAZAQ: true });
 heb.transliterate("שַׁבָּת", { DAGESH_CHAZAQ: false });
 // šabāt
 
+heb.transliterate("שַׁבָּת", { DAGESH_CHAZAQ: "\u0301" });
+// šab́āt
+
 heb.transliterate("הָאָֽרֶץ", { SYLLABLE_SEPARATOR: "-" });
 // hā-ʾā-reṣ
 ```
@@ -291,26 +295,74 @@ heb.transliterate("הַזֹּאת", {
 - In the Romaniote reading tradition, however, the `ZAYIN` is usually transliterated with `'z'` (really `'ζ'`),
 - but a `ZAYIN` followed by a _dagesh_ is transliterated as `'tz'` (really `'τζ'`)
 
-Each additional feature consists of 3 parts:
+Each additional feature consists of 4 properties:
 
 1. `FEATURE` — has three options:
   - `"cluster"` — a `cluster` is any combination of a single character and optionally a *dagesh* and vowel.
   - `"syllable"` — a `syllable` is any combination of a multiple characters and a single vowel and optionally a *dagesh*
   - `"word"` — covers everything else
 2. `HEBREW` — the Hebrew text to be transliterated
-3. `TRANSLITERATION` — the text used to transliterate the Hebrew text
+3. `TRANSLITERATION` — the text used to transliterate the Hebrew text, or a callback function
+4. `PASS_THROUGH` — if `true` passes the characters of the result of the `TRANSLITERATION` callback to the be mapped to the schema. If `TRANSLITERATION` is a string, this does nothing. Default `true`.
+
+**Using a callback**
+
+A callback can be used `TRANSLITERATION` instead of just a string.
+
+```js
+const heb = require("hebrew-transliteration");
+const rules = require("hebrew-transliteration/dist/rules");
+
+// use a callback to transliterate a vocal sheva with the same character as the next syllable
+heb.transliterate("בְּרֵאשִׁ֖ית וַיַּבְדֵּל", {
+  ADDITIONAL_FEATURES: [
+    {
+      // matches any sheva in a syllable that is NOT preceded by a vowel character
+      HEBREW: "(?<![\u{05B1}-\u{05BB}\u{05C7}].*)\u{05B0}",
+      FEATURE: "syllable",
+      TRANSLITERATION: function (syllable, _hebrew, schema) {
+        const next = syllable.next;
+        // ensure type safety
+        const nextVowel = next.vowelName === "SHEVA" ? "VOCAL_SHEVA" : next.vowelName;
+
+        if (next && nextVowel) {
+          const vowel = schema[nextVowel] || "";
+          return syllable.text.replace(new RegExp("\u{05B0}", "u"), vowel);
+        }
+
+        return syllable.text;
+      }
+    }
+  ]
+});
+
+// bērēʾšît wayyabdēl
+```
+
 
-:warning: this is an experimental property; results may not always meet expectations
+:warning: this is an experimental `ADDTIONAL_FEATURES`; results may not always meet expectations.
 
 ###### Stress Marker
 
-The `STRESS_MARKER` property is an optional mark to indicate stress in transliteration.
+The `STRESS_MARKER` property is an optional property to indicate stress in transliteration.
 
+It's properties are:
+- location
+- mark
+- exclude (optional)
+
+**Example**
 ```javascript
 heb.transliterate("מֶ֣לֶךְ", { STRESS_MARKER: { location: "after-vowel", mark: "\u0301" } });
 // mélek
 ```
 
+_mark_
+
+The string used to mark stress (e.g. [a combining acute accent (U+0301)](https://www.compart.com/en/unicode/U+0301) )
+
+_location_
+
 The `location` has four options:
 
 - `"before-syllable"`
@@ -328,6 +380,52 @@ heb.transliterate("בֵּ֣ית", {
 // beít
 ```
 
+_exclude_
+
+An optional property determining whether to exclude the mark on certain syllables.
+
+It has three options
+- `undefined`/`"never"`
+- `"single"`
+- `"final"`
+
+Examples:
+
+```js
+// undefined and "never" are the same
+heb.transliterate("בֹּ֖קֶר י֥וֹם אֶחָֽד׃ ", {
+  STRESS_MARKER: {
+    location: "after-vowel",
+    mark: "\u0301",
+  }
+});
+
+// bṓqer yốm ʾeḥā́d
+
+// exclude only single syllable words
+heb.transliterate("בֹּ֖קֶר י֥וֹם אֶחָֽד׃ ", {
+  STRESS_MARKER: {
+    location: "after-vowel",
+    mark: "\u0301",
+    exclude: "single"
+  }
+});
+
+// bṓqer yôm ʾeḥā́d
+
+// exclude when accent is on the final syllable
+// implicitly excludes single syllable words
+heb.transliterate("בֹּ֖קֶר י֥וֹם אֶחָֽד׃ ", {
+  STRESS_MARKER: {
+    location: "after-vowel",
+    mark: "\u0301",
+    exclude: "single"
+  }
+});
+
+// bṓqer yôm ʾeḥād
+```
+
 ## Live
 
 Use it live at [https://hebrewtransliteration.app](https://hebrewtransliteration.app)

package/dist/hebCharsTrans.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hebCharsTrans.d.ts","sourceRoot":"","sources":["../src/hebCharsTrans.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,UAAU,GAAG;IACX,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,MAAM,CAAC;CAC3B;AAED,eAAO,MAAM,gBAAgB,EAAE,GAoD9B,CAAC"}

package/dist/hebCharsTrans.js

@@ -54,3 +54,4 @@ exports.transliterateMap = {
     // ױ: "", // HEBREW LIGATURE YIDDISH VAV YOD (U+05F1)
     // ײ: "" // HEBREW LIGATURE YIDDISH DOUBLE YOD (U+05F2)
 };
+//# sourceMappingURL=hebCharsTrans.js.map

package/dist/hebCharsTrans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hebCharsTrans.js","sourceRoot":"","sources":["../src/hebCharsTrans.ts"],"names":[],"mappings":";;;AAMa,QAAA,gBAAgB,GAAQ;IACnC,WAAW;IACX,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE,cAAc;IAC1B,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,QAAQ;IACpB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,QAAQ;IACpB,UAAU,EAAE,QAAQ;IACpB,kDAAkD;IAClD,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,WAAW;IACvB,UAAU,EAAE,cAAc;IAC1B,eAAe;IACf,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,WAAW;IACd,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,WAAW;IACd,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,WAAW;IACd,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,QAAQ;IACX,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,UAAU;IACb,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,aAAa;IAChB,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,KAAK,CAAC,6BAA6B;IACtC,kDAAkD;IAClD,wDAAwD;IACxD,qDAAqD;IACrD,uDAAuD;CACxD,CAAC"}

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC"}

package/dist/index.js

@@ -11,3 +11,4 @@ const remove_1 = require("./remove");
 Object.defineProperty(exports, "remove", { enumerable: true, get: function () { return remove_1.remove; } });
 const schema_1 = require("./schema");
 Object.defineProperty(exports, "Schema", { enumerable: true, get: function () { return schema_1.Schema; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAME,qFAN1B,gBAAI,OAM0B;AALvC,mDAAgD;AAKP,8FALhC,6BAAa,OAKgC;AAJtD,yCAAsC;AAIb,yFAJhB,mBAAQ,OAIgB;AAHjC,qCAAkC;AAGzB,uFAHA,eAAM,OAGA;AAFf,qCAAkC;AAEjB,uFAFR,eAAM,OAEQ"}

package/dist/mapChars.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapChars.d.ts","sourceRoot":"","sources":["../src/mapChars.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,SAAU,MAAM,UAAU,MAAM,WAC+B,CAAC"}

package/dist/mapChars.js

@@ -12,3 +12,4 @@ const hebCharsTrans_1 = require("./hebCharsTrans");
  */
 const mapChars = (text, schema) => [...text].map((char) => (char in hebCharsTrans_1.transliterateMap ? schema[hebCharsTrans_1.transliterateMap[char]] : char)).join("");
 exports.mapChars = mapChars;
+//# sourceMappingURL=mapChars.js.map

package/dist/mapChars.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapChars.js","sourceRoot":"","sources":["../src/mapChars.ts"],"names":[],"mappings":";;;AAAA,mDAA0D;AAG1D;;;;;;;GAOG;AACI,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE,CACvD,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,gCAAG,CAAC,CAAC,CAAC,MAAM,CAAC,gCAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AADxE,QAAA,QAAQ,YACgE"}

package/dist/remove.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove.d.ts","sourceRoot":"","sources":["../src/remove.ts"],"names":[],"mappings":"AAEA,UAAU,aAAa;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAsED;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,aA+BrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,aAkBpB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,EAAE,aAcpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,aAOzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE,aAInB,CAAC;AAEF,eAAO,MAAM,GAAG,EAAE,aAKjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,MAAM,SAAU,MAAM,YAAW,aAAa,KAA6C,MAWvG,CAAC"}

package/dist/remove.js

@@ -211,3 +211,4 @@ const remove = (text, options = Object.assign(Object.assign({}, exports.accents)
     }, sequenced);
 };
 exports.remove = remove;
+//# sourceMappingURL=remove.js.map

package/dist/remove.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove.js","sourceRoot":"","sources":["../src/remove.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AA6OtC,MAAM,SAAS,GAAQ;IACrB,aAAa;IACb,OAAO,EAAE,UAAU;IACnB,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,UAAU;IACtB,WAAW,EAAE,UAAU;IACvB,WAAW,EAAE,UAAU;IACvB,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,aAAa,EAAE,UAAU;IACzB,SAAS,EAAE,UAAU;IACrB,WAAW,EAAE,UAAU;IACvB,cAAc,EAAE,UAAU;IAC1B,KAAK,EAAE,UAAU;IACjB,YAAY,EAAE,UAAU;IACxB,KAAK,EAAE,UAAU;IACjB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,UAAU;IAClB,aAAa,EAAE,UAAU;IACzB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,UAAU;IACjB,cAAc,EAAE,UAAU;IAC1B,cAAc,EAAE,UAAU;IAC1B,GAAG,EAAE,UAAU;IACf,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,UAAU;IAChB,KAAK,EAAE,UAAU;IACjB,YAAY;IACZ,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,UAAU;IACvB,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,UAAU;IACxB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE,UAAU;IACjB,6DAA6D;IAC7D,uEAAuE;IACvE,MAAM,EAAE,UAAU;IAClB,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE,UAAU;IACjB,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,UAAU;IACnB,YAAY,EAAE,UAAU;IACxB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,UAAU;IACjB,SAAS,EAAE,UAAU;IACrB,WAAW,EAAE,UAAU;IACvB,sEAAsE;IACtE,WAAW,EAAE,UAAU;IACvB,cAAc,EAAE,UAAU;IAC1B,aAAa,EAAE,UAAU;IACzB,SAAS,EAAE,UAAU;IACrB,SAAS,EAAE,UAAU,CAAC,iCAAiC;CACxD,CAAC;AAEF;;GAEG;AACU,QAAA,OAAO,GAAkB;IACpC,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,UAAU,EAAE,IAAI;IAChB,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,aAAa,EAAE,IAAI;IACnB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;IACpB,KAAK,EAAE,IAAI;IACX,YAAY,EAAE,IAAI;IAClB,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,IAAI;IACZ,aAAa,EAAE,IAAI;IACnB,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,cAAc,EAAE,IAAI;IACpB,cAAc,EAAE,IAAI;IACpB,GAAG,EAAE,IAAI;IACT,IAAI,EAAE,IAAI;IACV,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;CACZ,CAAC;AAEF;;GAEG;AACU,QAAA,MAAM,GAAkB;IACnC,KAAK,EAAE,IAAI;IACX,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,YAAY,EAAE,IAAI;CACnB,CAAC;AAEF;;;;;;GAMG;AACU,QAAA,MAAM,GAAkB;IACnC,KAAK,EAAE,IAAI;IACX,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,YAAY,EAAE,IAAI;CACnB,CAAC;AAEF;;GAEG;AACU,QAAA,WAAW,GAAkB;IACxC,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;CACrB,CAAC;AAEF;;GAEG;AACU,QAAA,KAAK,GAAkB;IAClC,aAAa,EAAE,IAAI;IACnB,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,IAAI;CAChB,CAAC;AAEW,QAAA,GAAG,+DACX,eAAO,GACP,cAAM,GACN,mBAAW,GACX,aAAK,EACR;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACI,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,0CAA8B,eAAO,KAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAE,EAAU,EAAE;IAC/G,qDAAqD;IACrD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAc,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAClG,MAAM,SAAS,GAAG,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC;IACjC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;;QAC1B,MAAM,GAAG,GAAG,MAAA,SAAS,CAAC,CAAc,CAAC,mCAAI,IAAI,CAAC;QAC9C,IAAI,GAAG,EAAE;YACP,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;SAC7C;QACD,OAAO,CAAC,CAAC;IACX,CAAC,EAAE,SAAS,CAAC,CAAC;AAChB,CAAC,CAAC;AAXW,QAAA,MAAM,UAWjB"}

package/dist/rules.d.ts

@@ -1,5 +1,23 @@
 import { Syllable } from "havarotjs/syllable";
 import { Word } from "havarotjs/word";
 import { Schema } from "./schema";
+/**
+ * replaces part of a string and transliterates the remaining characters according to the schema
+ *
+ * @example
+ * ```ts
+ * // replaces בָ as VA, but only when matching the regex sequence
+ * const betAndQamats = /\u{05D1}\u{05B8}/u
+ * replaceAndTransliterate("דָּבָר", betAndQamats, "VA", schema);
+ * // dāVAr
+ * ```
+ *
+ * @param input the text to be transliterated
+ * @param regex the regex used as the search value
+ * @param replaceValue the string to replace the regex
+ * @param schema the Schema
+ * @returns
+ */
+export declare const replaceAndTransliterate: (input: string, regex: RegExp, replaceValue: string, schema: Schema) => string;
 export declare const sylRules: (syl: Syllable, schema: Schema) => string;
 export declare const wordRules: (word: Word, schema: Schema) => string | Word;

package/dist/rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../src/rules.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AA6MlC,eAAO,MAAM,QAAQ,QAAS,QAAQ,UAAU,MAAM,KAAG,MAqCxD,CAAC;AAeF,eAAO,MAAM,SAAS,SAAU,IAAI,UAAU,MAAM,KAAG,MAAM,GAAG,IAgB/D,CAAC"}