hebrew-transliteration 2.1.2 → 2.2.1

package/dist/index.d.ts

@@ -1,659 +1,6 @@
-declare module 'hebrew-transliteration/hebCharsTrans' {
-  import { Schema } from "hebrew-transliteration/schema";
-  interface map {
-      [k: string]: keyof Schema;
-  }
-  export const transliterateMap: map;
-  export {};
-
-}
-declare module 'hebrew-transliteration/index' {
-  import { Text } from "havarotjs";
-  import { transliterate } from "hebrew-transliteration/transliterate";
-  import { sequence } from "hebrew-transliteration/sequence";
-  import { remove } from "hebrew-transliteration/remove";
-  import { Schema } from "hebrew-transliteration/schema";
-  export { remove, Schema, sequence, Text, transliterate };
-
-}
-declare module 'hebrew-transliteration/mapChars' {
-  import { Schema } from "hebrew-transliteration/schema";
-  /**
-   * maps single Hebrew characters to transliteration characters according to the schema
-   *
-   * @param text - a single character
-   * @param schema - a {@link Schema} for transliterating the text
-   * @returns transliteration of single characters according to the schema
-   *
-   */
-  export const mapChars: (text: string, schema: Schema) => string;
-
-}
-declare module 'hebrew-transliteration/remove' {
-  /**
-   * 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;
-  }
-  /**
-   * removes taamim and optionally removes certain niqqudim
-   *
-   * @param text - a string of Hebrew characters
-   * @param RemoveOptions - {@link RemoveOptions}
-   * @returns Hebrew characters with taamim and niqqud optionally removed
-   *
-   * @example Default
-   *
-   * ```ts
-   * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔");
-   * // "שָׂרַי אִשְׁתְּךָ";
-   * ```
-   *
-   * @example Remove vowels
-   *
-   * ```ts
-   * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true });
-   * // "שׂרי אשׁתך";
-   * ```
-   *
-   * @example Remove all
-   *
-   * ```ts
-   * heb.remove("שָׂרַ֣י אִשְׁתְּךָ֔", { removeVowels: true, removeShinDot: true, removeSinDot: true });
-   * // "שרי אשתך";
-   * ```
-   */
-  export const remove: (text: string, { removeVowels, removeShinDot, removeSinDot }?: RemoveOptions) => string;
-  export {};
-
-}
-declare module 'hebrew-transliteration/rules' {
-  import { Syllable } from "havarotjs/dist/syllable";
-  import { Word } from "havarotjs/dist/word";
-  import { Schema } from "hebrew-transliteration/schema";
-  export const sylRules: (syl: Syllable, schema: Schema) => string;
-  export const wordRules: (word: Word, schema: Schema) => string | Word;
-
-}
-declare module 'hebrew-transliteration/schema' {
-  import { SylOpts } from "havarotjs/dist/text";
-  /**
-   * class for defining a schema for transliteration
-   */
-  export class Schema implements SylOpts {
-      /**
-       * HEBREW POINT SHEVA (U+05B0) ְ◌
-       * @example
-       * 'ǝ'
-       */
-      VOCAL_SHEVA: string;
-      /**
-       * HEBREW POINT HATAF SEGOL (U+05B1) ֱ◌
-       * @example
-       * 'ĕ'
-       */
-      HATAF_SEGOL: string;
-      /**
-       * HEBREW POINT HATAF PATAH (U+05B2) ֲ◌
-       * @example
-       * 'ă'
-       */
-      HATAF_PATAH: string;
-      /**
-       * HEBREW POINT HATAF QAMATS (U+05B3) ֳ◌
-       * @example
-       * 'ŏ'
-       */
-      HATAF_QAMATS: string;
-      /**
-       * HEBREW POINT HIRIQ (U+05B4) ִ◌
-       * @example
-       * 'i'
-       */
-      HIRIQ: string;
-      /**
-       * HEBREW POINT TSERE (U+05B5) ֵ◌
-       * @example
-       * 'ē'
-       */
-      TSERE: string;
-      /**
-       * HEBREW POINT SEGOL (U+05B6) ֶ◌
-       * @example
-       * 'e'
-       */
-      SEGOL: string;
-      /**
-       * HEBREW POINT PATAH (U+05B7) ַ◌
-       * @example
-       * 'a'
-       */
-      PATAH: string;
-      /**
-       * HEBREW POINT QAMATS (U+05B8) ָ◌
-       * @example
-       * 'ā'
-       */
-      QAMATS: string;
-      /**
-       * HEBREW POINT HOLAM (U+05B9) ֹ◌
-       * @example
-       * 'ō'
-       */
-      HOLAM: string;
-      /**
-       * HEBREW POINT QUBUTS (U+05BB) ֻ◌
-       * @example
-       * 'u'
-       */
-      QUBUTS: string;
-      /**
-       * HEBREW POINT DAGESH OR MAPIQ (U+05BC) ּ◌
-       * @description typically, this will be a blank string
-       * @example
-       * ''
-       */
-      DAGESH: string;
-      /**
-       * HEBREW POINT DAGESH OR MAPIQ (U+05BC) ּ◌
-       * @description if true, repeats the consonant with the dagesh
-       * @example
-       * ```js
-       * transliterate('שַׁבָּת', { DAGESH_CHAZAQ: true });
-       * // 'shabbat'
-       * ```
-       */
-      DAGESH_CHAZAQ: boolean;
-      /**
-       * HEBREW PUNCTUATION MAQAF (U+05BE) ־◌
-       * @example
-       * '-'
-       */
-      MAQAF: string;
-      /**
-       * HEBREW PUNCTUATION PASEQ (U+05C0) ׀ ◌
-       * @description if a blank string, two spaces will occur between words
-       * @example
-       * '|' or ''
-       * @example
-       * ```js
-       * transliterate('כְּשֶׁ֣בֶת ׀ הַמֶּ֣לֶךְ', { PASEQ: '' });
-       * // 'kǝšebet  hammelek'
-       * ```
-       */
-      PASEQ: string;
-      /**
-       * HEBREW PUNCTUATION SOF PASUQ (U+05C3) ׃◌
-       * @example
-       * '' or '.'
-       */
-      SOF_PASUQ: string;
-      /**
-       * HEBREW POINT QAMATS QATAN (U+05C7) ׇ◌
-       * @example
-       * 'o'
-       */
-      QAMATS_QATAN: string;
-      /**
-       * HEBREW POINT PATAH (U+05B7) ◌ַ
-       * @example
-       * 'a'
-       */
-      FURTIVE_PATAH: string;
-      /**
-       * HEBREW POINT HIRIQ (U+05B4) and YOD (U+05D9) י◌ִ
-       * @example
-       * 'î'
-       */
-      HIRIQ_YOD: string;
-      /**
-       * HEBREW POINT TSERE (U+05B5) and YOD (U+05D9) י◌ֵ
-       * @example
-       * 'ê'
-       */
-      TSERE_YOD: string;
-      /**
-       * HEBREW POINT SEGOL (U+05B6) and YOD (U+05D9) י◌ֶ
-       * @example
-       * 'ê'
-       */
-      SEGOL_YOD: string;
-      /**
-       * HEBREW LETTER VAV (U+05D5) and DAGESH (U+05BC) וּ
-       * @example
-       * 'û'
-       */
-      SHUREQ: string;
-      /**
-       * HEBREW LETTER HOLAM (U+05B9) and VAV (U+05D5) ֹו◌
-       * @example
-       * 'ô'
-       */
-      HOLAM_VAV: string;
-      /**
-       * HEBREW POINT QAMATS (U+05B8) and HE (U+05D4) ה◌ָ
-       * @example
-       * 'â'
-       */
-      QAMATS_HE: string;
-      /**
-       * HEBREW POINT SEGOL (U+05B6) and HE (U+05D4) ה◌ֶ
-       * @example
-       * 'ê'
-       */
-      SEGOL_HE: string;
-      /**
-       * HEBREW POINT TSERE (U+05B5) and HE (U+05D4) ה◌ֵ
-       * @example
-       * 'ê'
-       */
-      TSERE_HE: string;
-      /**
-       * HEBREW LETTER QAMATS (U+05B8) and YOD (U+05D9) and VAV (U+05D5) יו◌ָ
-       * @example
-       * 'āyw'
-       */
-      MS_SUFX: string;
-      /**
-       * HEBREW LETTER ALEF (U+05D0) א
-       * @example
-       * 'ʾ'
-       */
-      ALEF: string;
-      /**
-       * HEBREW LETTER BET (U+05D1) ב
-       * @example
-       * 'b' or 'v'
-       */
-      BET: string;
-      /**
-       * HEBREW LETTER BET (U+05D1) and DAGESH (U+05BC) ּב
-       * @description
-       * the letter bet with a dagesh kal
-       * @description
-       * use when need to distinguish between spirantized forms
-       * @example
-       * 'b'
-       */
-      BET_DAGESH?: string;
-      /**
-       * HEBREW LETTER GIMEL (U+05D2) ג
-       * @example
-       * 'g'
-       */
-      GIMEL: string;
-      /**
-       * HEBREW LETTER GIMEL (U+05D2) and DAGESH (U+05BC) גּ
-       * @description
-       * the letter gimel with a dagesh kal
-       * @description
-       * use when need to distinguish between spirantized forms
-       * @example
-       * 'g'
-       */
-      GIMEL_DAGESH?: string;
-      /**
-       * HEBREW LETTER DALET (U+05D3) ד
-       * @example
-       * 'd'
-       */
-      DALET: string;
-      /**
-       * HEBREW LETTER DALET (U+05D3) and DAGESH (U+05BC) דּ
-       * @description
-       * the letter dalet with a dagesh kal
-       * @description
-       * use when need to distinguish between spirantized forms
-       * @example
-       * 'd'
-       */
-      DALET_DAGESH?: string;
-      /**
-       * HEBREW LETTER HE (U+05D4) ה
-       * @example
-       * 'h'
-       */
-      HE: string;
-      /**
-       * HEBREW LETTER VAV (U+05D5) ו
-       * @example
-       * 'w'
-       */
-      VAV: string;
-      /**
-       * HEBREW LETTER ZAYIN (U+05D6) ז
-       * @example
-       * 'z'
-       */
-      ZAYIN: string;
-      /**
-       * HEBREW LETTER HET (U+05D7) ח
-       * @example
-       * 'ḥ'
-       */
-      HET: string;
-      /**
-       * HEBREW LETTER TET (U+05D8) ט
-       * @example
-       * 'ṭ'
-       */
-      TET: string;
-      /**
-       * HEBREW LETTER YOD (U+05D9) י
-       * @example
-       * 'y'
-       */
-      YOD: string;
-      /**
-       * HEBREW LETTER FINAL KAF (U+05DA) ך
-       * @example
-       * 'k' or 'kh'
-       */
-      FINAL_KAF: string;
-      /**
-       * HEBREW LETTER KAF (U+05DB) כ
-       * @example
-       * 'k' or 'kh'
-       */
-      KAF: string;
-      /**
-       * HEBREW LETTER KAF (U+05DB) and DAGESH (U+05BC) כּ
-       * @description
-       * the letter kaf with a dagesh kal
-       * @description
-       * use when need to distinguish between spirantized forms
-       * @example
-       * 'k'
-       */
-      KAF_DAGESH?: string;
-      /**
-       * HEBREW LETTER LAMED (U+05DC) ל
-       * @example
-       * 'l'
-       */
-      LAMED: string;
-      /**
-       * HEBREW LETTER FINAL MEM (U+05DD) ם
-       * @example
-       * 'm'
-       */
-      FINAL_MEM: string;
-      /**
-       * HEBREW LETTER MEM (U+05DE) מ
-       * @example
-       * 'm'
-       */
-      MEM: string;
-      /**
-       * HEBREW LETTER FINAL NUN (U+05DF) ן
-       * @example
-       * 'n'
-       */
-      FINAL_NUN: string;
-      /**
-       * HEBREW LETTER NUN (U+05E0) נ
-       * @example
-       * 'n'
-       */
-      NUN: string;
-      /**
-       * HEBREW LETTER SAMEKH (U+05E1) ס
-       * @example
-       * 's'
-       */
-      SAMEKH: string;
-      /**
-       * HEBREW LETTER AYIN (U+05E2) ע
-       * @example
-       * 'ʿ'
-       */
-      AYIN: string;
-      /**
-       * HEBREW LETTER FINAL PE (U+05E3) ף
-       * @example
-       * 'p' or 'f'
-       */
-      FINAL_PE: string;
-      /**
-       * HEBREW LETTER PE (U+05E4) פ
-       * @example
-       * 'p' or 'f'
-       */
-      PE: string;
-      /**
-       * HEBREW LETTER  PE (U+05E4) and DAGESH (U+05BC) פּ
-       * @description
-       * the letter pe with a dagesh kal
-       * @description
-       * use when need to distinguish between spirantized forms
-       * @example
-       * 'p'
-       */
-      PE_DAGESH?: string;
-      /**
-       * HEBREW LETTER FINAL TSADI (U+05E5) ץ
-       * @example
-       * 'ṣ'
-       */
-      FINAL_TSADI: string;
-      /**
-       * HEBREW LETTER TSADI (U+05E6) צ
-       * @example
-       * 'ṣ'
-       */
-      TSADI: string;
-      /**
-       * HEBREW LETTER QOF (U+05E7) ק
-       * @example
-       * 'q'
-       */
-      QOF: string;
-      /**
-       * HEBREW LETTER RESH (U+05E8) ר
-       * @example
-       * 'r'
-       */
-      RESH: string;
-      /**
-       * HEBREW LETTER SHIN (U+05E9) and SHIN DOT (U+05C1) שׁ
-       * @example
-       * 'š'
-       */
-      SHIN: string;
-      /**
-       * HEBREW LETTER SHIN (U+05E9) and SIN DOT (U+05C2) שׁ
-       * @example
-       * 'ś'
-       */
-      SIN: string;
-      /**
-       * HEBREW LETTER TAV (U+05EA) ת
-       * @example
-       * 't' or 'th'
-       */
-      TAV: string;
-      /**
-       * HEBREW LETTER TAV (U+05EA) and DAGESH (U+05BC) תּ
-       * @description
-       * the letter tav with a dagesh kal
-       * @description
-       * use when need to distinguish between spirantized forms
-       * @example
-       * 't'
-       */
-      TAV_DAGESH?: string;
-      /**
-       * define additional sequences of characters
-       *
-       * ⚠️ there may be unpredictable results
-       *
-       * @example
-       * [{
-       *   FEATURE: 'cluster',
-       *   HEBREW: 'זּ',
-       *   TRANSLITERATION: 'tz'
-       * }]
-       */
-      ADDITIONAL_FEATURES?: {
-          /**
-           * additional orthographic feature
-           *
-           * - `"cluster"` is any combination of a single character and optionally a _dagesh_ and vowel.
-           * - `"syllable"` is any combination of a multiple characters and a single vowel and optionally a _dagesh_
-           * - `"word"` covers everything else
-           */
-          FEATURE: "word" | "syllable" | "cluster";
-          /** use consonants and vowels; do not use taamim */
-          HEBREW: string;
-          TRANSLITERATION: string;
-      }[];
-      /**
-       * the full form of the divine name - יהוה
-       * @example
-       * 'yhwh'
-       */
-      DIVINE_NAME: string;
-      /**
-       * a syllable separator, usually an empty string
-       *  @example
-       * '' or '-'
-       * @example
-       * ```js
-       * transliterate('הָאָֽרֶץ', { SYLLABLE_SEPARATOR: '-' });
-       * // 'hā-ʾā-reṣ'
-       * ```
-       */
-      SYLLABLE_SEPARATOR?: string;
-      /**
-       * a mark for indentifying the stressed syllable
-       *
-       * @description
-       * taamim are needed in the Hebrew text to correctly identify stress
-       *  @example
-       * 'ˈ' or '\u0341'
-       * @example
-       * ```js
-       * transliterate('מֶ֣לֶךְ', { STRESS_MARKER: { location: 'after-vowel', mark: '\u0301' } });
-       * // 'mélek'
-       * ```
-       */
-      STRESS_MARKER?: {
-          location: "before-syllable" | "after-syllable" | "before-vowel" | "after-vowel";
-          mark: string;
-      };
-      longVowels: SylOpts["longVowels"];
-      qametsQatan: SylOpts["qametsQatan"];
-      sqnmlvy: SylOpts["sqnmlvy"];
-      wawShureq: SylOpts["wawShureq"];
-      article: SylOpts["article"];
-      allowNoNiqqud: SylOpts["allowNoNiqqud"];
-      constructor(schema: Schema);
-  }
-  export class SBL extends Schema {
-      constructor(schema: Partial<Schema>);
-  }
-
-}
-declare module 'hebrew-transliteration/sequence' {
-  export const vowels: RegExp;
-  /**
-   * sequences Hebrew charactes according to the [SBL Hebrew Font Manual](https://www.sbl-site.org/Fonts/SBLHebrewUserManual1.5x.pdf)
-   *
-   * @param text - a string of Hebrew character
-   * @param qametsQatan - option to convert regular qamets characters to qamets qatan
-   * @returns a sequenced string of text
-   * @remarks
-   * seqeuncing follows the pattern of: consonant - dagesh - vowel - ta'am as defined in the {@link https://www.sbl-site.org/Fonts/SBLHebrewUserManual1.5x.pdf | SBL Hebrew Font Manual}
-   *
-   * @example
-   *
-   * ```ts
-   * heb.sequence("\u{5D1}\u{5B0}\u{5BC}\u{5E8}\u{5B5}\u{5D0}\u{5E9}\u{5B4}\u{5C1}\u{596}\u{5D9}\u{5EA}");
-   *              "\u{5D1}\u{5BC}\u{5B0}\u{5E8}\u{5B5}\u{5D0}\u{5E9}\u{5C1}\u{5B4}\u{596}\u{5D9}\u{5EA}";
-   * ```
-   */
-  export const sequence: (text: string, qametsQatan?: boolean) => string;
-
-}
-declare module 'hebrew-transliteration/transliterate' {
-  import { Schema } from "hebrew-transliteration/schema";
-  import { Text } from "havarotjs";
-  /**
-   * transliterates Hebrew text
-   *
-   * @param text - a string or {@link https://charlesloder.github.io/havarot/classes/text.Text.html | Text} of Hebrew characters
-   * @param schema - a {@link Schema} for transliterating the text
-   * @returns a transliterated text
-   *
-   * @example Default
-   * ```ts
-   * import { transliterate } from "hebrew-transliteration";
-   *
-   * transliterate("אֱלֹהִים");
-   * // "ʾĕlōhîm";
-   * ```
-   *
-   * ---
-   *
-   * @remarks
-   *
-   * If no {@link Schema} is passed, then the package defaults to SBL's academic style
-   *
-   * You can pass in a partial schema that will modify SBL's academic style:
-   *
-   * ```ts
-   * transliterate("שָׁלוֹם", { SHIN: "sh" })
-   * // shālôm
-   * ```
-   *
-   * ---
-   *
-   * If you need a fully custom schema, it is best to use the {@link Schema} constructor:
-   *
-   * ```ts
-   * import { transliterate, Schema } from "hebrew-transliteration";
-   *
-   * const schema = new Schema({ ALEF: "'", BET: "B", ... QAMETS: "A", ... }) // truncated for brevity
-   *
-   * transliterate("אָ֣ב", schema)
-   * // 'AB
-   * ```
-   *
-   */
-  export const transliterate: (text: string | Text, schema?: Partial<Schema> | Schema) => string;
-
-}
-declare module 'hebrew-transliteration' {
-  import main = require('hebrew-transliteration/index');
-  export = main;
-}
+import { Text } from "havarotjs";
+import { transliterate } from "./transliterate";
+import { sequence } from "./sequence";
+import { remove } from "./remove";
+import { Schema } from "./schema";
+export { remove, Schema, sequence, Text, transliterate };