hebrew-transliteration 2.2.3 → 2.3.0

package/README.md

@@ -45,7 +45,7 @@ It exports 3 [functions](#functions):
 
 And it exports 2 [classes](#classes):
 
-1. [`Text`](#text) — the [`Text`](https://charlesloder.github.io/havarot/classes/text.Text.html) class from the `havarotjs` package
+1. [`Text`](#text) — the [`Text`](https://charlesloder.github.io/havarotjs/classes/text.Text.html) class from the `havarotjs` package
 2. [`Schema`](#schema) — a schema for transliterating Hebrew
 
 ### Functions
@@ -56,7 +56,7 @@ Takes a `string` or [`Text`](#text), and optionally a [`Schema`](#schema) or `Pa
 
 ```javascript
 heb.transliterate("אֱלֹהִים");
-// "ʾĕlōhîm";
+// ʾĕlōhîm
 ```
 
 If no [`Schema`](#schema) is passed, then the package defaults to SBL's academic style.
@@ -78,13 +78,6 @@ heb.transliterate("בְּבֵית", brillAcademic)
 ```
 **Note**: schemas are not endorsed by publishers.
 
-The available schemas are:
-
-- brillAcademic
-- brillSimple
-- sblAcademicSpirantization
-- sblSimple
-
 If you need a fully customized transliteration, it is best to use the [`Schema`](#schema) constructor:
 
 ```javascript
@@ -104,17 +97,32 @@ heb.transliterate("אָ֣ב", schema)
 
 #### `remove()`
 
-Takes `string` and options. The default only removes taamim (i.e., accent or cantillation) marks.
+Takes `string` and `RemoveOptions`.
+
+The default removes accents (i.e. characters called HEBREW ACCENT) and metheg and rafe.
 
 ```javascript
 heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔");
-// "שָׂרַי אִשְׁתְּךָ";
+// שָׂרַי אִשְׁתְּךָ;
+```
 
-heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true });
-// "שׂרי אשׁתך";
+The `RemoveOptions` can be customized.
 
-heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true, removeShinDot: true, removeSinDot: true });
-// "שרי אשתך";
+```javascript
+heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { SHIN_DOT: true, SIN_DOT: true });
+// שָרַ֣י אִשְתְּךָ֔
+```
+
+**Note:** unlike a `Schema` where a `Partial<Schema>` extends the default, `RemoveOptions` does not accept a `Partial<RemoveOptions>`.
+
+All properties for `RemoveOptions` can be found in the [source](src/remove.ts).
+
+There are some preset options availables as well.
+
+```javascript
+const opts = require("hebrew-transliteration/removeOptions");
+heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", opts.all);
+// שרי אשתך, וימצאו
 ```
 
 ---
@@ -132,7 +140,7 @@ heb.sequence("\u{5D1}\u{5B0}\u{5BC}\u{5E8}\u{5B5}\u{5D0}\u{5E9}\u{5B4}\u{5C1}\u{
 
 #### Text
 
-The [`Text`](https://charlesloder.github.io/havarot/classes/text.Text.html) class from the [`havarotjs`](https://www.npmjs.com/package/havarotjs) package.
+The [`Text`](https://charlesloder.github.io/havarotjs/classes/text.Text.html) class from the [`havarotjs`](https://www.npmjs.com/package/havarotjs) package.
 
 This class is used by [`transliterate()`](#transliterate) internally to syllabify Hebrew text, but it is exposed as well.
 
@@ -158,18 +166,13 @@ The `Schema` can be divided into a few categories.
 
 ##### 1) Syllabification
 
-The options used for syllabifying Hebrew text can be found [here](https://charlesloder.github.io/havarot/interfaces/text.SylOpts.html)
+The options used for syllabifying Hebrew text can be found [here](https://charlesloder.github.io/havarotjs/interfaces/text.SylOpts.html)
 
 ###### Differences between `Text` and `Schema`
 
-There are 5 options for syllabification that are the [same as the ones used by the `Text`](https://charlesloder.github.io/havarot/interfaces/text.SylOpts.html) class. The only `Text` syllabification option that `Schema` does not use is `schema` (yes, that's confusing):
-
-```javascript
-const text = new heb.Text("חׇכְמָ֣ה", { schema: "traditional" }); // this is okay
-const schema = new heb.Schema({ schema: "traditional" }); // this does nothing
-```
+There are 5 options for syllabification that are the [same as the ones used by the `Text`](https://charlesloder.github.io/havarotjs/interfaces/text.SylOpts.html) class.
 
-Read more about the syllabification options for the [`Text`](https://charlesloder.github.io/havarot/interfaces/text.SylOpts.html) and a [higher level overview](https://charlesloder.github.io/havarot/pages/Linguistic/syllabification.html)
+Read more about the syllabification options for the [`Text`](https://charlesloder.github.io/havarotjs/interfaces/text.SylOpts.html) and a [higher level overview](https://charlesloder.github.io/havarotjs/pages/Linguistic/syllabification.html)
 
 ###### Precedence of `Text` over `Schema`
 
@@ -327,7 +330,7 @@ heb.transliterate("בֵּ֣ית", {
 
 ## Live
 
-Use it live at [charlesLoder.github.io/hebrewTransliteration](https://charlesloder.github.io/hebrewTransliteration/index.html)
+Use it live at [https://hebrewtransliteration.app](https://hebrewtransliteration.app)
 
 ## Contributing
 

package/dist/remove.d.ts

@@ -1,65 +1,286 @@
-/**
- * Options for the `remove()` function
- */
 interface RemoveOptions {
     /**
-     * an option to remove vowels
-     *
-     * @example
-     * ```ts
-     * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true });
-     * // "שׂרי אשׁתך";
-     * ```
-     */
-    removeVowels?: boolean;
-    /**
-     * an option to remove the shin dot (U+05C1)
-     *
-     * @example
-     * ```ts
-     * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true, removeShinDot: true, removeSinDot: true });
-     * // "שרי אשתך";
-     * ```
-     */
-    removeShinDot?: boolean;
-    /**
-     * an option to remove the sin dot (U+05C2)
-     *
-     * @example
-     * ```ts
-     * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true, removeShinDot: true, removeSinDot: true });
-     * // "שרי אשתך";
-     * ```
-     */
-    removeSinDot?: boolean;
+     * ◌֑
+     */
+    ETNAHTA?: boolean;
+    /**
+     * ◌֒
+     */
+    SEGOLTA?: boolean;
+    /**
+     * ◌֓
+     */
+    SHALSHELET?: boolean;
+    /**
+     * ◌֔
+     */
+    ZAQEF_QATAN?: boolean;
+    /**
+     * ◌֕
+     */
+    ZAQEF_GADOL?: boolean;
+    /**
+     * ◌֖
+     */
+    TIPEHA?: boolean;
+    /**
+     * ◌֗
+     */
+    REVIA?: boolean;
+    /**
+     * ◌֘
+     */
+    ZARQA?: boolean;
+    /**
+     * ◌֙
+     */
+    PASHTA?: boolean;
+    /**
+     * ◌֚
+     */
+    YETIV?: boolean;
+    /**
+     * ◌֛
+     */
+    TEVIR?: boolean;
+    /**
+     * ◌֜
+     */
+    GERESH?: boolean;
+    /**
+     * ◌֝
+     */
+    GERESH_MUQDAM?: boolean;
+    /**
+     * ◌֞
+     */
+    GERSHAYIM?: boolean;
+    /**
+     * ◌֟
+     */
+    QARNEY_PARA?: boolean;
+    /**
+     * ◌֠
+     */
+    TELISHA_GEDOLA?: boolean;
+    /**
+     * ◌֡
+     */
+    PAZER?: boolean;
+    /**
+     * ◌֢
+     */
+    ATNAH_HAFUKH?: boolean;
+    /**
+     * ◌֣
+     */
+    MUNAH?: boolean;
+    /**
+     * ◌֤
+     */
+    MAHAPAKH?: boolean;
+    /**
+     * ◌֥
+     */
+    MERKHA?: boolean;
+    /**
+     * ◌֦
+     */
+    MERKHA_KEFULA?: boolean;
+    /**
+     * ◌֧
+     */
+    DARGA?: boolean;
+    /**
+     * ◌֨
+     */
+    QADMA?: boolean;
+    /**
+     * ◌֩
+     */
+    TELISHA_QETANA?: boolean;
+    /**
+     * ◌֪
+     */
+    YERAH_BEN_YOMO?: boolean;
+    /**
+     * ◌֫
+     */
+    OLE?: boolean;
+    /**
+     * ◌֬
+     */
+    ILUY?: boolean;
+    /**
+     * ◌֭
+     */
+    DEHI?: boolean;
+    /**
+     * ◌֮
+     */
+    ZINOR?: boolean;
+    /**
+     * ◌ְ
+     */
+    SHEVA?: boolean;
+    /**
+     * ◌ֱ
+     */
+    HATAF_SEGOL?: boolean;
+    /**
+     * ◌ֲ
+     */
+    HATAF_PATAH?: boolean;
+    /**
+     * ◌ֳ
+     */
+    HATAF_QAMATS?: boolean;
+    /**
+     * ◌ִ
+     */
+    HIRIQ?: boolean;
+    /**
+     * ◌ֵ
+     */
+    TSERE?: boolean;
+    /**
+     * ◌ֶ
+     */
+    SEGOL?: boolean;
+    /**
+     * ◌ַ
+     */
+    PATAH?: boolean;
+    /**
+     * ◌ָ
+     */
+    QAMATS?: boolean;
+    /**
+     * ◌ֹ
+     */
+    HOLAM?: boolean;
+    /**
+     * ◌ֻ
+     */
+    QUBUTS?: boolean;
+    /**
+     * ◌ּ
+     */
+    DAGESH?: boolean;
+    /**
+     * ◌ֽ
+     */
+    METEG?: boolean;
+    /**
+     * ◌ֿ
+     */
+    RAFE?: boolean;
+    /**
+     * ◌ׁ
+     */
+    SHIN_DOT?: boolean;
+    /**
+     * ◌ׂ
+     */
+    SIN_DOT?: boolean;
+    /**
+     * ◌ׇ
+     */
+    QAMATS_QATAN?: boolean;
+    /**
+     * ־◌
+     */
+    MAQAF?: boolean;
+    /**
+     * ׀ ◌
+     */
+    PASEQ?: boolean;
+    /**
+     * ׃◌
+     */
+    SOF_PASUQ?: boolean;
+    /**
+     * ׆
+     */
+    NUN_HAFUKHA?: boolean;
+    /**
+     * ׳
+     */
+    PUNC_GERESH?: boolean;
+    /**
+     * ״
+     */
+    PUNC_GERSHAYIM?: boolean;
+    /**
+     * ◌֯
+     */
+    MASORA_CIRCLE?: boolean;
+    /**
+     * ◌ׄ
+     */
+    UPPER_DOT?: boolean;
+    /**
+     * ◌ׅ
+     */
+    LOWER_DOT?: boolean;
 }
 /**
- * removes taamim and optionally removes certain niqqudim
+ * removes all chars called HEBREW ACCENT (U+0591-05AF)
+ */
+export declare const accents: RemoveOptions;
+/**
+ * removes all chars called HEBREW POINT (U+05B0-05BD, U+05BF, U+05C1-05C2 and U+05C7)
+ */
+export declare const points: RemoveOptions;
+/**
+ * removes chars called HEBREW POINT (U+05B0-05BC and U+05C7) except for:
+ * - SHIN_DOT
+ * - SIN_DOT
+ * - METEG
+ * - RAFE
+ */
+export declare const vowels: RemoveOptions;
+/**
+ * removes all chars called HEBREW PUNCTUATION (U+05BE, U+05C0, U+05C3, and U+05C6)
+ */
+export declare const punctuation: RemoveOptions;
+/**
+ * removes all chars called HEBREW MARK (U+05AF, U+05C4, and U+05C5)
+ */
+export declare const marks: RemoveOptions;
+export declare const all: RemoveOptions;
+/**
+ * removes niqqud from Hebrew text
  *
  * @param text - a string of Hebrew characters
- * @param RemoveOptions - {@link RemoveOptions}
- * @returns Hebrew characters with taamim and niqqud optionally removed
+ * @param options
+ * @returns Hebrew characters with accents and niqqud optionally removed
  *
  * @example Default
  *
  * ```ts
- * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔");
- * // "שָׂרַי אִשְׁתְּךָ";
+ * // by default removes all accents and metheg and rafe
+ * remove("שָׂרַ֣י אִשְׁתְּךָ֔, וַֽיִּמְצְא֗וּ");
+ * // שָׂרַי אִשְׁתְּךָ, וַיִּמְצְאוּ
  * ```
  *
- * @example Remove vowels
+ * @example Remove accents and vowels, but not shin/sin dots
  *
  * ```ts
- * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true });
- * // "שׂרי אשׁתך";
+ * import { accents, vowelsl } from "hebrew-transliteration/removeOptions";
+ *
+ * remove("שָׂרַ֣י אִשְׁתְּךָ֔, וַֽיִּמְצְא֗וּ", { ...accents, ...vowels, METEG: true });
+ * // שׂרי אשׁתך, וימצאו
  * ```
  *
  * @example Remove all
  *
  * ```ts
- * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true, removeShinDot: true, removeSinDot: true });
- * // "שרי אשתך";
+ * import { all } from "hebrew-transliteration/removeOptions";
+ *
+ * remove("שָׂרַ֣י אִשְׁתְּךָ֔, וַֽיִּמְצְא֗וּ", all);
+ * // שרי אשתך, וימצאו
  * ```
  */
-export declare const remove: (text: string, { removeVowels, removeShinDot, removeSinDot }?: RemoveOptions) => string;
+export declare const remove: (text: string, options?: RemoveOptions) => string;
 export {};

package/dist/remove.js

@@ -1,45 +1,213 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.remove = void 0;
+exports.remove = exports.all = exports.marks = exports.punctuation = exports.vowels = exports.points = exports.accents = void 0;
 const sequence_1 = require("./sequence");
-const cantillation = /[\u{0591}-\u{05AF}\u{05BF}\u{05C0}\u{05C3}-\u{05C6}\u{05F3}\u{05F4}]/gu;
-const vowels = /[\u{05B0}-\u{05BD}\u{05BF}\u{05C7}]/gu;
-const shinDot = /\u{05C1}/gu;
-const sinDot = /\u{05C2}/gu;
-const removeItem = (text, item) => text.replace(item, "");
+const removeMap = {
+    // accents //
+    ETNAHTA: "\u{0591}",
+    SEGOLTA: "\u{0592}",
+    SHALSHELET: "\u{0593}",
+    ZAQEF_QATAN: "\u{0594}",
+    ZAQEF_GADOL: "\u{0595}",
+    TIPEHA: "\u{0596}",
+    REVIA: "\u{0597}",
+    ZARQA: "\u{0598}",
+    PASHTA: "\u{0599}",
+    YETIV: "\u{059A}",
+    TEVIR: "\u{059B}",
+    GERESH: "\u{059C}",
+    GERESH_MUQDAM: "\u{059D}",
+    GERSHAYIM: "\u{059E}",
+    QARNEY_PARA: "\u{059F}",
+    TELISHA_GEDOLA: "\u{05A0}",
+    PAZER: "\u{05A1}",
+    ATNAH_HAFUKH: "\u{05A2}",
+    MUNAH: "\u{05A3}",
+    MAHAPAKH: "\u{05A4}",
+    MERKHA: "\u{05A5}",
+    MERKHA_KEFULA: "\u{05A6}",
+    DARGA: "\u{05A7}",
+    QADMA: "\u{05A8}",
+    TELISHA_QETANA: "\u{05A9}",
+    YERAH_BEN_YOMO: "\u{05AA}",
+    OLE: "\u{05AB}",
+    ILUY: "\u{05AC}",
+    DEHI: "\u{05AD}",
+    ZINOR: "\u{05AE}",
+    // points //
+    SHEVA: "\u{05B0}",
+    HATAF_SEGOL: "\u{05B1}",
+    HATAF_PATAH: "\u{05B2}",
+    HATAF_QAMATS: "\u{05B3}",
+    HIRIQ: "\u{05B4}",
+    TSERE: "\u{05B5}",
+    SEGOL: "\u{05B6}",
+    PATAH: "\u{05B7}",
+    QAMATS: "\u{05B8}",
+    HOLAM: "\u{05B9}",
+    // below is not needed because sequnce() does not output this
+    // HOLAM_HASER_FOR_VAV: "\u{05BA}", // HEBREW POINT HOLAM HASER FOR VAV
+    QUBUTS: "\u{05BB}",
+    DAGESH: "\u{05BC}",
+    METEG: "\u{05BD}",
+    RAFE: "\u{05BF}",
+    SHIN_DOT: "\u{05C1}",
+    SIN_DOT: "\u{05C2}",
+    QAMATS_QATAN: "\u{05C7}",
+    MAQAF: "\u{05BE}",
+    PASEQ: "\u{05C0}",
+    SOF_PASUQ: "\u{05C3}",
+    NUN_HAFUKHA: "\u{05C6}",
+    // the punctuation geresh/gereshayim is different then the accent ones
+    PUNC_GERESH: "\u{05F3}",
+    PUNC_GERSHAYIM: "\u{05F4}",
+    MASORA_CIRCLE: "\u{05AF}",
+    UPPER_DOT: "\u{05C4}",
+    LOWER_DOT: "\u{05C5}" // U+LOWER DOT HEBREW MARK 05C5];
+};
+/**
+ * removes all chars called HEBREW ACCENT (U+0591-05AF)
+ */
+exports.accents = {
+    ETNAHTA: true,
+    SEGOLTA: true,
+    SHALSHELET: true,
+    ZAQEF_QATAN: true,
+    ZAQEF_GADOL: true,
+    TIPEHA: true,
+    REVIA: true,
+    ZARQA: true,
+    PASHTA: true,
+    YETIV: true,
+    TEVIR: true,
+    GERESH: true,
+    GERESH_MUQDAM: true,
+    GERSHAYIM: true,
+    QARNEY_PARA: true,
+    TELISHA_GEDOLA: true,
+    PAZER: true,
+    ATNAH_HAFUKH: true,
+    MUNAH: true,
+    MAHAPAKH: true,
+    MERKHA: true,
+    MERKHA_KEFULA: true,
+    DARGA: true,
+    QADMA: true,
+    TELISHA_QETANA: true,
+    YERAH_BEN_YOMO: true,
+    OLE: true,
+    ILUY: true,
+    DEHI: true,
+    ZINOR: true
+};
+/**
+ * removes all chars called HEBREW POINT (U+05B0-05BD, U+05BF, U+05C1-05C2 and U+05C7)
+ */
+exports.points = {
+    SHEVA: true,
+    HATAF_SEGOL: true,
+    HATAF_PATAH: true,
+    HATAF_QAMATS: true,
+    HIRIQ: true,
+    TSERE: true,
+    SEGOL: true,
+    PATAH: true,
+    QAMATS: true,
+    HOLAM: true,
+    QUBUTS: true,
+    DAGESH: true,
+    SHIN_DOT: true,
+    SIN_DOT: true,
+    METEG: true,
+    RAFE: true,
+    QAMATS_QATAN: true
+};
+/**
+ * removes chars called HEBREW POINT (U+05B0-05BC and U+05C7) except for:
+ * - SHIN_DOT
+ * - SIN_DOT
+ * - METEG
+ * - RAFE
+ */
+exports.vowels = {
+    SHEVA: true,
+    HATAF_SEGOL: true,
+    HATAF_PATAH: true,
+    HATAF_QAMATS: true,
+    HIRIQ: true,
+    TSERE: true,
+    SEGOL: true,
+    PATAH: true,
+    QAMATS: true,
+    HOLAM: true,
+    QUBUTS: true,
+    DAGESH: true,
+    QAMATS_QATAN: true
+};
 /**
- * removes taamim and optionally removes certain niqqudim
+ * removes all chars called HEBREW PUNCTUATION (U+05BE, U+05C0, U+05C3, and U+05C6)
+ */
+exports.punctuation = {
+    MAQAF: true,
+    PASEQ: true,
+    SOF_PASUQ: true,
+    NUN_HAFUKHA: true,
+    PUNC_GERESH: true,
+    PUNC_GERSHAYIM: true
+};
+/**
+ * removes all chars called HEBREW MARK (U+05AF, U+05C4, and U+05C5)
+ */
+exports.marks = {
+    MASORA_CIRCLE: true,
+    UPPER_DOT: true,
+    LOWER_DOT: true
+};
+exports.all = Object.assign(Object.assign(Object.assign(Object.assign({}, exports.accents), exports.points), exports.punctuation), exports.marks);
+/**
+ * removes niqqud from Hebrew text
  *
  * @param text - a string of Hebrew characters
- * @param RemoveOptions - {@link RemoveOptions}
- * @returns Hebrew characters with taamim and niqqud optionally removed
+ * @param options
+ * @returns Hebrew characters with accents and niqqud optionally removed
  *
  * @example Default
  *
  * ```ts
- * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔");
- * // "שָׂרַי אִשְׁתְּךָ";
+ * // by default removes all accents and metheg and rafe
+ * remove("שָׂרַ֣י אִשְׁתְּךָ֔, וַֽיִּמְצְא֗וּ");
+ * // שָׂרַי אִשְׁתְּךָ, וַיִּמְצְאוּ
  * ```
  *
- * @example Remove vowels
+ * @example Remove accents and vowels, but not shin/sin dots
  *
  * ```ts
- * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true });
- * // "שׂרי אשׁתך";
+ * import { accents, vowelsl } from "hebrew-transliteration/removeOptions";
+ *
+ * remove("שָׂרַ֣י אִשְׁתְּךָ֔, וַֽיִּמְצְא֗וּ", { ...accents, ...vowels, METEG: true });
+ * // שׂרי אשׁתך, וימצאו
  * ```
  *
  * @example Remove all
  *
  * ```ts
- * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true, removeShinDot: true, removeSinDot: true });
- * // "שרי אשתך";
+ * import { all } from "hebrew-transliteration/removeOptions";
+ *
+ * remove("שָׂרַ֣י אִשְׁתְּךָ֔, וַֽיִּמְצְא֗וּ", all);
+ * // שרי אשתך, וימצאו
  * ```
  */
-const remove = (text, { removeVowels = false, removeShinDot = false, removeSinDot = false } = {}) => {
+const remove = (text, options = Object.assign(Object.assign({}, exports.accents), { METEG: true, RAFE: true })) => {
+    /** all the keys of options that are to be removed */
+    const keys = Object.keys(options).filter((k) => (k in options ? options[k] : false));
     const sequenced = (0, sequence_1.sequence)(text);
-    const remCantillation = removeItem(sequenced, cantillation);
-    const remVowels = removeVowels ? removeItem(remCantillation, vowels) : remCantillation;
-    const remShin = removeShinDot ? removeItem(remVowels, shinDot) : remVowels;
-    return removeSinDot ? removeItem(remShin, sinDot) : remShin;
+    return keys.reduce((a, c) => {
+        var _a;
+        const key = (_a = removeMap[c]) !== null && _a !== void 0 ? _a : null;
+        if (key) {
+            return a.replace(new RegExp(key, "gu"), "");
+        }
+        return a;
+    }, sequenced);
 };
 exports.remove = remove;

package/dist/schema.d.ts

@@ -425,7 +425,12 @@ export declare class Schema implements SylOpts {
          * - `"word"` covers everything else
          */
         FEATURE: "word" | "syllable" | "cluster";
-        /** use consonants and vowels; do not use taamim */
+        /**
+         * The Hebrew text — use consonants and vowels; do not use taamim
+         *
+         * The text is parsed as a Regex so special characters like `?` and `|` can be used
+         *
+         */
         HEBREW: string;
         TRANSLITERATION: string;
     }[];
@@ -469,6 +474,7 @@ export declare class Schema implements SylOpts {
     wawShureq: SylOpts["wawShureq"];
     article: SylOpts["article"];
     allowNoNiqqud: SylOpts["allowNoNiqqud"];
+    strict: SylOpts["strict"];
     constructor(schema: Schema);
 }
 export declare class SBL extends Schema {

package/dist/schema.js

@@ -75,14 +75,15 @@ class Schema {
             (this.qametsQatan = schema.qametsQatan),
             (this.sqnmlvy = schema.sqnmlvy),
             (this.wawShureq = schema.wawShureq),
-            (this.article = schema.article);
-        this.allowNoNiqqud = schema.allowNoNiqqud;
+            (this.article = schema.article),
+            (this.allowNoNiqqud = schema.allowNoNiqqud),
+            (this.strict = schema.strict);
     }
 }
 exports.Schema = Schema;
 class SBL extends Schema {
     constructor(schema) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, _25, _26, _27, _28, _29, _30, _31, _32, _33, _34, _35, _36, _37, _38, _39, _40, _41, _42, _43, _44, _45, _46;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, _25, _26, _27, _28, _29, _30, _31, _32, _33, _34, _35, _36, _37, _38, _39, _40, _41, _42, _43, _44, _45, _46, _47;
         super({
             VOCAL_SHEVA: (_a = schema.VOCAL_SHEVA) !== null && _a !== void 0 ? _a : "ǝ",
             HATAF_SEGOL: (_b = schema.HATAF_SEGOL) !== null && _b !== void 0 ? _b : "ĕ",
@@ -154,7 +155,8 @@ class SBL extends Schema {
             sqnmlvy: (_43 = schema.sqnmlvy) !== null && _43 !== void 0 ? _43 : true,
             wawShureq: (_44 = schema.wawShureq) !== null && _44 !== void 0 ? _44 : true,
             article: (_45 = schema.article) !== null && _45 !== void 0 ? _45 : true,
-            allowNoNiqqud: (_46 = schema.allowNoNiqqud) !== null && _46 !== void 0 ? _46 : true
+            allowNoNiqqud: (_46 = schema.allowNoNiqqud) !== null && _46 !== void 0 ? _46 : true,
+            strict: (_47 = schema.strict) !== null && _47 !== void 0 ? _47 : false
         });
     }
 }

package/dist/schemas/brillAcademic.js

@@ -70,5 +70,6 @@ exports.brillAcademic = {
     sqnmlvy: true,
     wawShureq: true,
     article: true,
-    allowNoNiqqud: true
+    allowNoNiqqud: true,
+    strict: false
 };

package/dist/schemas/brillSimple.js

@@ -69,5 +69,6 @@ exports.brillSimple = {
     sqnmlvy: true,
     wawShureq: true,
     article: true,
-    allowNoNiqqud: true
+    allowNoNiqqud: true,
+    strict: false
 };

package/dist/schemas/index.d.ts

@@ -2,4 +2,5 @@ import { brillAcademic } from "./brillAcademic";
 import { brillSimple } from "./brillSimple";
 import { sblAcademicSpirantization } from "./sblAcademicSpirantization";
 import { sblSimple } from "./sblSimple";
-export { brillAcademic, brillSimple, sblAcademicSpirantization, sblSimple };
+import { michiganClaremont } from "./michiganClaremont";
+export { brillAcademic, brillSimple, sblAcademicSpirantization, sblSimple, michiganClaremont };

package/dist/schemas/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sblSimple = exports.sblAcademicSpirantization = exports.brillSimple = exports.brillAcademic = void 0;
+exports.michiganClaremont = exports.sblSimple = exports.sblAcademicSpirantization = exports.brillSimple = exports.brillAcademic = void 0;
 const brillAcademic_1 = require("./brillAcademic");
 Object.defineProperty(exports, "brillAcademic", { enumerable: true, get: function () { return brillAcademic_1.brillAcademic; } });
 const brillSimple_1 = require("./brillSimple");
@@ -9,3 +9,5 @@ const sblAcademicSpirantization_1 = require("./sblAcademicSpirantization");
 Object.defineProperty(exports, "sblAcademicSpirantization", { enumerable: true, get: function () { return sblAcademicSpirantization_1.sblAcademicSpirantization; } });
 const sblSimple_1 = require("./sblSimple");
 Object.defineProperty(exports, "sblSimple", { enumerable: true, get: function () { return sblSimple_1.sblSimple; } });
+const michiganClaremont_1 = require("./michiganClaremont");
+Object.defineProperty(exports, "michiganClaremont", { enumerable: true, get: function () { return michiganClaremont_1.michiganClaremont; } });

package/dist/schemas/michiganClaremont.js

@@ -63,5 +63,6 @@ exports.michiganClaremont = {
     sqnmlvy: false,
     wawShureq: true,
     article: false,
-    allowNoNiqqud: true
+    allowNoNiqqud: true,
+    strict: false
 };

package/dist/schemas/romaniote.d.ts

@@ -0,0 +1,2 @@
+import { Schema } from "../schema";
+export declare const romaniote: Schema;

package/dist/schemas/romaniote.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.romaniote = void 0;
+exports.romaniote = {
+    ALEF: "",
+    BET: "β",
+    BET_DAGESH: "μπ",
+    GIMEL: "γ",
+    GIMEL_DAGESH: "γκ",
+    DALET: "δ",
+    DALET_DAGESH: "ντ",
+    HE: "",
+    VAV: "β",
+    ZAYIN: "ζ",
+    HET: "χ",
+    TET: "τ",
+    YOD: "γι",
+    KAF: "χ",
+    KAF_DAGESH: "κ",
+    FINAL_KAF: "χ",
+    LAMED: "λ",
+    MEM: "μ",
+    FINAL_MEM: "μ",
+    NUN: "ν",
+    FINAL_NUN: "ν",
+    SAMEKH: "σ",
+    AYIN: "",
+    PE: "φ",
+    PE_DAGESH: "π",
+    FINAL_PE: "φ",
+    TSADI: "τσ",
+    FINAL_TSADI: "τς",
+    QOF: "κ",
+    RESH: "ρ",
+    SIN: "σ",
+    SHIN: "σσ",
+    TAV: "θ",
+    TAV_DAGESH: "τ",
+    DAGESH: "",
+    DAGESH_CHAZAQ: false,
+    VOCAL_SHEVA: "ε",
+    PATAH: "α",
+    HATAF_PATAH: "α",
+    QAMATS: "α",
+    HATAF_QAMATS: "ο",
+    SEGOL: "ε",
+    HATAF_SEGOL: "ε",
+    TSERE: "ε",
+    HIRIQ: "ι",
+    HOLAM: "ω",
+    QUBUTS: "ου",
+    QAMATS_HE: "α",
+    SEGOL_HE: "ε",
+    TSERE_HE: "ε",
+    SEGOL_YOD: "ε",
+    HIRIQ_YOD: "η",
+    TSERE_YOD: "ε",
+    FURTIVE_PATAH: "a",
+    QAMATS_QATAN: "ο",
+    HOLAM_VAV: "ω",
+    SHUREQ: "ου",
+    MS_SUFX: "άβ",
+    PASEQ: "",
+    SOF_PASUQ: "",
+    MAQAF: "-",
+    DIVINE_NAME: "Αδωνάη",
+    ADDITIONAL_FEATURES: [
+        {
+            FEATURE: "cluster",
+            HEBREW: "זּ",
+            TRANSLITERATION: "τζ"
+        },
+        {
+            FEATURE: "syllable",
+            HEBREW: "ִים",
+            TRANSLITERATION: "είμ"
+        },
+        // https://github.com/microsoft/TypeScript/issues/36444
+        // can I define a final tsere-yod where syllable.isFinal
+        // https://stackoverflow.com/questions/56949513/typescript-type-of-a-property-dependent-on-another-property-within-the-same-obj
+        {
+            FEATURE: "syllable",
+            HEBREW: "\u{05B5}\u{05D9}$",
+            TRANSLITERATION: "αί"
+        },
+        {
+            FEATURE: "syllable",
+            HEBREW: "\u{05B5}\u{05D9}[\u{05BE}|-]?$",
+            TRANSLITERATION: "αί-"
+        },
+        {
+            FEATURE: "cluster",
+            HEBREW: "\u{5E9}\u{5C1}$",
+            TRANSLITERATION: "σς"
+        },
+        {
+            FEATURE: "cluster",
+            HEBREW: "\u{5E9}\u{5C1}$",
+            TRANSLITERATION: "σς"
+        }
+    ],
+    longVowels: true,
+    sqnmlvy: true,
+    qametsQatan: true,
+    wawShureq: true,
+    article: true,
+    allowNoNiqqud: true,
+    strict: false
+};

package/dist/schemas/sblAcademicSpirantization.js

@@ -69,5 +69,6 @@ exports.sblAcademicSpirantization = {
     sqnmlvy: true,
     wawShureq: true,
     article: true,
-    allowNoNiqqud: true
+    allowNoNiqqud: true,
+    strict: false
 };

package/dist/schemas/sblSimple.js

@@ -61,10 +61,23 @@ exports.sblSimple = {
     SOF_PASUQ: "",
     MAQAF: "-",
     DIVINE_NAME: "yhwh",
+    ADDITIONAL_FEATURES: [
+        {
+            FEATURE: "cluster",
+            HEBREW: "\u{05E9}\u{05C1}\u{05BC}",
+            TRANSLITERATION: "sh"
+        },
+        {
+            FEATURE: "cluster",
+            HEBREW: "\u{05E6}\u{05BC}",
+            TRANSLITERATION: "ts"
+        }
+    ],
     longVowels: true,
     sqnmlvy: true,
     qametsQatan: true,
     wawShureq: true,
     article: true,
-    allowNoNiqqud: true
+    allowNoNiqqud: true,
+    strict: false
 };

package/dist/transliterate.js

@@ -25,6 +25,8 @@ const getSylOpts = (schema) => {
         options.article = schema.article;
     if ("allowNoNiqqud" in schema)
         options.allowNoNiqqud = schema.allowNoNiqqud;
+    if ("strict" in schema)
+        options.strict = schema.strict;
     return options;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hebrew-transliteration",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "a package for transliterating Hebrew",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,12 +15,20 @@
       "types": "./dist/schemas/index.d.ts",
       "require": "./dist/schemas/index.js",
       "import": "./dist/schemas/index.js"
+    },
+    "./removeOptions": {
+      "types": "./dist/remove.d.ts",
+      "require": "./dist/remove.js",
+      "import": "./dist/remove.js"
     }
   },
   "typesVersions": {
     "*": {
       "schemas": [
         "./dist/schemas/index.d.ts"
+      ],
+      "removeOptions": [
+        "./dist/remove.d.ts"
       ]
     }
   },
@@ -56,22 +64,22 @@
   "author": "Charles Loder",
   "license": "MIT",
   "devDependencies": {
-    "@types/jest": "^29.2.0",
-    "@typescript-eslint/eslint-plugin": "^5.41.0",
-    "esbuild": "^0.15.12",
-    "eslint": "^8.26.0",
+    "@types/jest": "^29.2.2",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
+    "esbuild": "^0.15.13",
+    "eslint": "^8.27.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^27.1.3",
-    "eslint-plugin-jsdoc": "^39.3.25",
+    "eslint-plugin-jest": "^27.1.4",
+    "eslint-plugin-jsdoc": "^39.6.2",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "jest": "^29.2.2",
-    "npm-check-updates": "^16.3.15",
+    "jest": "^29.3.1",
+    "npm-check-updates": "^16.3.18",
     "npm-dts": "^1.3.12",
     "prettier": "^2.7.1",
     "ts-jest": "^29.0.3",
     "typescript": "^4.8.4"
   },
   "dependencies": {
-    "havarotjs": "^0.10.1"
+    "havarotjs": "^0.11.2"
   }
 }