@hebcal/leyning 8.2.9 → 9.0.0

package/dist/module.d.ts

@@ -1,325 +0,0 @@
-import { Event, HDate, HolidayEvent } from '@hebcal/core';
-import { WriteStream } from 'node:fs';
-
-/**
- * Represents an aliyah
- */
-type Aliyah = {
-    /** Book (e.g. "Numbers") */
-    k: string;
-    /** beginning verse (e.g. "28:9") */
-    b: string;
-    /** ending verse (e.g. "28:15") */
-    e: string;
-    /** number of verses */
-    v?: number;
-    /** parsha number (1=Bereshit, 54=Vezot HaBracha) */
-    p?: number;
-    reason?: string;
-};
-type StringMap = {
-    [key: string]: string;
-};
-type AliyotMap = {
-    [key: string]: Aliyah;
-};
-/** Name of the parsha hashavua or holiday */
-type LeyningNames = {
-    /** English */
-    en: string;
-    /** Hebrew (with nikud) */
-    he: string;
-};
-/**
- * Parsha metadata (underlying JSON object)
- */
-type ParshaMeta = {
-    /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
-    num: number | number[];
-    /** parsha name in Hebrew with niqud */
-    hebrew: string;
-    /** 1 for Genesis, 2 for Exodus, 5 for Deuteronomy */
-    book: number;
-    /** Haftarah object(s) */
-    haft: Aliyah | Aliyah[];
-    /** Haftarah object(s) for Sephardim */
-    seph?: Aliyah | Aliyah[];
-    /** Map of Shabbat aliyot `1` through `7` plus `M` for maftir */
-    fullkriyah: {
-        [key: string]: string[];
-    };
-    /**
-     * Map of weekday Torah Readings
-     *  aliyot `1` through `3` for Monday and Thursday
-     */
-    weekday?: {
-        [key: string]: string[];
-    };
-    combined?: boolean;
-    p1?: string;
-    p2?: string;
-    num1?: number;
-    num2?: number;
-};
-type SpecialReading = {
-    /** Map of aliyot `1` through `7` plus `M` for maftir */
-    aliyot: AliyotMap;
-    /**
-     * Explanations for special readings,
-     *  keyed by aliyah number, `M` for maftir or `haftara` for Haftarah
-     */
-    reason: StringMap;
-    /** Haftarah object(s) */
-    haft?: Aliyah | Aliyah[];
-    /** Haftarah object(s) for Sephardim */
-    seph?: Aliyah | Aliyah[];
-};
-/**
- * Leyning base - weekday, parsha hashavua or holiday
- */
-type LeyningBase = {
-    /** Name of the parsha hashavua or holiday */
-    name: LeyningNames;
-    /** Such as `Genesis 1:1 - 6:8` */
-    summary: string;
-    summaryParts?: Aliyah[];
-    note?: string;
-};
-/**
- * Parashat haShavua - weekday or Shabbat
- */
-type LeyningParshaHaShavua = LeyningBase & {
-    /** An array of either 1 (regular) or 2 (doubled parsha). `undefined` for holiday readings */
-    parsha?: string[];
-    /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
-    parshaNum?: number | number[];
-};
-/**
- * Parashat haShavua - weekday
- */
-type LeyningWeekday = LeyningParshaHaShavua & {
-    /** Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday */
-    weekday?: AliyotMap;
-};
-type HaftarahProps = {
-    /** Haftarah object */
-    haft: Aliyah | Aliyah[];
-    /** Haftarah, such as `Isaiah 42:5 – 43:11` */
-    haftara: string;
-    /** Number of verses in the Haftarah */
-    haftaraNumV?: number;
-};
-/**
- * Shabbat and holiday leyning always has full kriyah and haftarah
- */
-type LeyningShabbatHoliday = LeyningBase & HaftarahProps & {
-    /** Map of aliyot `1` through `7` plus `M` for maftir */
-    fullkriyah: AliyotMap;
-    /** Haftarah object for Sephardim */
-    seph?: Aliyah | Aliyah[];
-    /** Haftarah for Sephardim, such as `Isaiah 42:5 - 42:21` */
-    sephardic?: string;
-    /** Number of verses in the Haftarah for Sephardim */
-    sephardicNumV?: number;
-    /** Explanations for special readings, keyed by aliyah number, `M` for maftir or `haftara` for Haftarah */
-    reason?: StringMap;
-    /** Song of Songs is read on the sabbath of Passover week, the Book of Ruth on Shavuot, Lamentations on Tisha be-Av, Ecclesiastes on the sabbath of the week of Sukkoth, and the Book of Esther on Purim */
-    megillah?: AliyotMap;
-    /** Triennial alternate Haftara */
-    triHaftara?: string;
-    /** Triennial alternate Haftara number of verses */
-    triHaftaraNumV?: number;
-};
-type Leyning = LeyningBase & LeyningParshaHaShavua & LeyningShabbatHoliday & LeyningWeekday;
-
-/**
- * Names of the books of the Torah. BOOK[1] === 'Genesis'
- * @readonly
- */
-declare const BOOK: readonly ["", "Genesis", "Exodus", "Leviticus", "Numbers", "Deuteronomy"];
-/**
- * The number of verses in each book of the Tanakh.
- * @readonly
- */
-declare const NUM_VERSES: NumVerses;
-type NumVerses = {
-    readonly [book: string]: readonly number[];
-};
-/**
- * Formats parsha as a string
- * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- */
-declare function parshaToString(parsha: string | string[]): string;
-/**
- * Calculates the number of verses in an aliyah or haftara based on
- * the `b` (begin verse), `e` (end verse) and `k` (book).
- * Modifies `aliyah` by setting the `v` field.
- */
-declare function calculateNumVerses(aliyah: Aliyah): number;
-/**
- * Formats an aliyah object like "Numbers 28:9-28:15"
- */
-declare function formatAliyahWithBook(a: Aliyah): string;
-/**
- * Formats an aliyah object like "Numbers 28:9-15"
- */
-declare function formatAliyahShort(aliyah: Aliyah, showBook: boolean): string;
-
-/**
- * Summarizes an `AliyotMap` by collapsing all adjacent aliyot.
- * Finds any non-overlapping parts (e.g. special 7th aliyah or maftir)
- */
-declare function makeLeyningParts(aliyot: AliyotMap): Aliyah[];
-/**
- * Returns a string representation of the leyning parts.
- * Separate verse ranges read from the same book are separated
- * by commas, e.g. `Isaiah 6:1-7:6, 9:5-6`.
- * Verse ranges from different books are separated by semicolons,
- * e.g. `Genesis 21:1-34; Numbers 29:1-6`.
- */
-declare function makeSummaryFromParts(parts: Aliyah | Aliyah[]): string;
-/**
- * Makes a summary of the leyning, like "Genesis 6:9-11:32"
- */
-declare function makeLeyningSummary(aliyot: AliyotMap): string;
-
-type JsonFestivalAliyah = {
-    k: number | string;
-    b: string;
-    e: string;
-    v?: number;
-    p?: number;
-};
-type JsonFestivalAliyotMap = {
-    [key: string]: JsonFestivalAliyah;
-};
-type JsonFestivalLeyning = {
-    haft?: JsonFestivalAliyah | JsonFestivalAliyah[];
-    seph?: JsonFestivalAliyah | JsonFestivalAliyah[];
-    fullkriyah?: JsonFestivalAliyotMap;
-    megillah?: string;
-    alias?: boolean;
-    key?: string;
-    note?: string;
-    il?: boolean;
-};
-
-/**
- * Is there a special festival Torah Reading for `holiday`?
- */
-declare function hasFestival(holiday: string): boolean;
-/**
- * Returns the raw metadata for festival reading for `holiday`
- */
-declare function lookupFestival(holiday: string): JsonFestivalLeyning | undefined;
-
-/**
- * Based on the event date, type and title, finds the relevant leyning key
- * @param ev event
- * @param [il] true if Israel holiday scheme
- * @returns key to look up in holiday-reading.json
- */
-declare function getLeyningKeyForEvent(ev: Event, il?: boolean): string | undefined;
-
-/**
- * Determines if the regular parashat haShavua coincides with an event that requires
- * a special maftir or Haftara (for example Shabbat HaGadol, Shabbat Chanukah, Rosh
- * Chodesh or Machar Chodesh, etc.).
- *
- * This function does not modify `aliyot`. Instead, it returns a deep copy
- * with `aliyot['M']` replaced and sets `reason.M`
- * (and in some cases the 6th and 7th aliyah, setting `reason['7']`).
- *
- * If a special Haftarah applies, the result will have a `haft` property
- * pointing to Haftarah object and sets `reason.haftara`.
- */
-declare function specialReadings2(parsha: string[], hd: HDate, il: boolean, aliyot: AliyotMap): SpecialReading;
-
-/**
- * Looks up leyning for a given holiday key. Key should be an
- * (untranslated) string used in holiday-readings.json. Returns some
- * of full kriyah aliyot, special Maftir, special Haftarah
- * @param key name from `holiday-readings.json` to find
- */
-declare function getLeyningForHolidayKey(key?: string, cholHaMoedDay?: number, il?: boolean): Leyning | undefined;
-/**
- * Looks up leyning for a given holiday. Returns some
- * of full kriyah aliyot, special Maftir, special Haftarah
- * @param ev the Hebcal event associated with this leyning
- * @param [il] true if Israel holiday scheme
- * @returns map of aliyot
- */
-declare function getLeyningForHoliday(ev: Event, il?: boolean): Leyning | undefined;
-
-/**
- * Transliterated English and Hebrew names of this parsha
- * @param parsha untranslated name like ['Pinchas'] or ['Matot','Masei']
- */
-declare function makeLeyningNames(parsha: string[]): LeyningNames;
-/**
- * Looks up Monday/Thursday aliyot for a regular parsha
- * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- */
-declare function getWeekdayReading(parsha: string | string[]): AliyotMap;
-/**
- * Looks up regular leyning for a weekly parsha with no special readings
- * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- */
-declare function getLeyningForParsha(parsha: string | string[]): Leyning;
-/**
- * Looks up leyning for a regular Shabbat parsha, including any special
- * maftir or Haftara.
- * @param ev the Hebcal event associated with this leyning
- * @param [il] in Israel
- * @returns map of aliyot
- */
-declare function getLeyningForParshaHaShavua(ev: Event, il?: boolean): Leyning;
-/**
- * Returns the parsha metadata
- * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- */
-declare function lookupParsha(parsha: string | string[]): ParshaMeta;
-
-/**
- * Looks up leyning for a regular Shabbat, Monday/Thursday weekday or holiday.
- *
- * If `hdate` coincides with a holiday that has Torah reading, returns the
- * reading for that day (see {@link getLeyningForHoliday})
- *
- * Otherwise, if `hdate` is a Saturday, returns {@link getLeyningForParshaHaShavua}
- *
- * Otherwise, if `hdate` is a Monday or Thursday, returns {@link Leyning} for the
- * Parashat haShavua, containing only the `weekday` aliyot (no `fullkriyah`).
- *
- * Otherwise, returns `undefined`.
- *
- * @param {HDate} hdate Hebrew Date
- * @param {boolean} il in Israel
- * @param {boolean} [wantarray] to return an array of 0 or more readings
- */
-declare function getLeyningOnDate(hdate: HDate, il: boolean, wantarray?: false): Leyning | LeyningWeekday | undefined;
-declare function getLeyningOnDate(hdate: HDate, il: boolean, wantarray: true): (Leyning | LeyningWeekday)[];
-
-interface StringToBoolMap {
-    [key: string]: boolean;
-}
-declare function getParshaDates(events: Event[]): StringToBoolMap;
-declare function writeFullKriyahCsv(stream: WriteStream, hyear: number, il: boolean): void;
-declare function writeHolidayMincha(stream: WriteStream, ev: HolidayEvent, il: boolean): void;
-/**
- * Formats reading for CSV
- */
-declare function writeCsvLines(stream: WriteStream, ev: Event, reading: Leyning, il: boolean, isParsha: boolean): void;
-
-/**
- * Makes a deep copy of the src object using JSON stringify and parse
- */
-declare function clone(src: any): any;
-type Haftarah = Aliyah | Aliyah[] | JsonFestivalAliyah | JsonFestivalAliyah[];
-declare function cloneHaftara(haft: Haftarah): Aliyah | Aliyah[];
-/**
- * Returns the total number of verses in an array of Aliyah (or haftarah) objects
- */
-declare function sumVerses(aliyot: Haftarah): number;
-
-export { type Aliyah, type AliyotMap, BOOK, type Haftarah, type HaftarahProps, type Leyning, type LeyningBase, type LeyningNames, type LeyningParshaHaShavua, type LeyningShabbatHoliday, type LeyningWeekday, NUM_VERSES, type NumVerses, type ParshaMeta, type SpecialReading, type StringMap, type StringToBoolMap, calculateNumVerses, clone, cloneHaftara, formatAliyahShort, formatAliyahWithBook, getLeyningForHoliday, getLeyningForHolidayKey, getLeyningForParsha, getLeyningForParshaHaShavua, getLeyningKeyForEvent, getLeyningOnDate, getParshaDates, getWeekdayReading, hasFestival, lookupFestival, lookupParsha, makeLeyningNames, makeLeyningParts, makeLeyningSummary, makeSummaryFromParts, parshaToString, specialReadings2, sumVerses, writeCsvLines, writeFullKriyahCsv, writeHolidayMincha };

package/dist/numverses.json.d.ts

@@ -1,36 +0,0 @@
-declare const _default: {
-    Genesis: number[];
-    Exodus: number[];
-    Leviticus: number[];
-    Numbers: number[];
-    Deuteronomy: number[];
-    Joshua: number[];
-    Judges: number[];
-    Ruth: number[];
-    "I Samuel": number[];
-    "II Samuel": number[];
-    "I Kings": number[];
-    "II Kings": number[];
-    Isaiah: number[];
-    Jeremiah: number[];
-    Lamentations: number[];
-    Baruch: number[];
-    Esther: number[];
-    Ecclesiastes: number[];
-    "Song of Songs": number[];
-    Ezekiel: number[];
-    Daniel: number[];
-    Hosea: number[];
-    Joel: number[];
-    Amos: number[];
-    Obadiah: number[];
-    Jonah: number[];
-    Micah: number[];
-    Nachum: number[];
-    Habakkuk: number[];
-    Zephaniah: number[];
-    Haggai: number[];
-    Zechariah: number[];
-    Malachi: number[];
-};
-export default _default;