hebrew-transliteration 2.2.2 → 2.2.4

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
@@ -132,7 +132,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 +158,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):
+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.
 
-```javascript
-const text = new heb.Text("חׇכְמָ֣ה", { schema: "traditional" }); // this is okay
-const schema = new heb.Schema({ schema: "traditional" }); // this does nothing
-```
-
-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`
 

package/dist/rules.d.ts

@@ -1,5 +1,5 @@
-import { Syllable } from "havarotjs/dist/syllable";
-import { Word } from "havarotjs/dist/word";
+import { Syllable } from "havarotjs/syllable";
+import { Word } from "havarotjs/word";
 import { Schema } from "./schema";
 export declare const sylRules: (syl: Syllable, schema: Schema) => string;
 export declare const wordRules: (word: Word, schema: Schema) => string | Word;

package/dist/rules.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.wordRules = exports.sylRules = void 0;
-const cluster_1 = require("havarotjs/dist/cluster");
+const cluster_1 = require("havarotjs/cluster");
 const regularExpressions_1 = require("havarotjs/dist/utils/regularExpressions");
 const mapChars_1 = require("./mapChars");
 const taamim = /[\u{0590}-\u{05AF}\u{05BD}\u{05BF}]/u;

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,96 @@
+"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: true,
+    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: "o",
+    HOLAM_VAV: "o",
+    SHUREQ: "ου",
+    MS_SUFX: "άβ",
+    PASEQ: "",
+    SOF_PASUQ: "",
+    MAQAF: "-",
+    DIVINE_NAME: "Αδωνάη",
+    ADDITIONAL_FEATURES: [
+        {
+            FEATURE: "cluster",
+            HEBREW: "זּ",
+            TRANSLITERATION: "τζ"
+        },
+        {
+            FEATURE: "syllable",
+            HEBREW: "ִים",
+            TRANSLITERATION: "είμ"
+        },
+        {
+            FEATURE: "syllable",
+            HEBREW: "\u{05B5}\u{05D9}$",
+            TRANSLITERATION: "αί"
+        },
+        {
+            FEATURE: "syllable",
+            HEBREW: "\u{05B5}\u{05D9}[\u{05BE}|-]?$",
+            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

@@ -66,5 +66,6 @@ exports.sblSimple = {
     qametsQatan: true,
     wawShureq: true,
     article: true,
-    allowNoNiqqud: true
+    allowNoNiqqud: true,
+    strict: false
 };

package/dist/transliterate.js

@@ -4,7 +4,7 @@ exports.transliterate = void 0;
 const rules_1 = require("./rules");
 const schema_1 = require("./schema");
 const havarotjs_1 = require("havarotjs");
-const word_1 = require("havarotjs/dist/word");
+const word_1 = require("havarotjs/word");
 /**
  *
  * @param schema
@@ -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.2",
+  "version": "2.2.4",
   "description": "a package for transliterating Hebrew",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -56,22 +56,22 @@
   "author": "Charles Loder",
   "license": "MIT",
   "devDependencies": {
-    "@types/jest": "^29.1.1",
-    "@typescript-eslint/eslint-plugin": "^5.38.1",
-    "esbuild": "^0.15.10",
-    "eslint": "^8.24.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.0.4",
-    "eslint-plugin-jsdoc": "^39.3.6",
+    "eslint-plugin-jest": "^27.1.4",
+    "eslint-plugin-jsdoc": "^39.6.2",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "jest": "^29.1.2",
-    "npm-check-updates": "^16.3.7",
+    "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.9.2"
+    "havarotjs": "^0.11.2"
   }
 }