@hebcal/leyning 9.0.2 → 9.0.4

package/dist/festival.d.ts

@@ -1,9 +0,0 @@
-import { JsonFestivalLeyning } from './internalTypes';
-/**
- * Is there a special festival Torah Reading for `holiday`?
- */
-export declare function hasFestival(holiday: string): boolean;
-/**
- * Returns the raw metadata for festival reading for `holiday`
- */
-export declare function lookupFestival(holiday: string): JsonFestivalLeyning | undefined;

package/dist/getLeyningForHoliday.d.ts

@@ -1,17 +0,0 @@
-import { Event } from '@hebcal/core/dist/esm/event';
-import { Leyning } from './types';
-/**
- * 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
- */
-export 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
- */
-export declare function getLeyningForHoliday(ev: Event, il?: boolean): Leyning | undefined;

package/dist/getLeyningKeyForEvent.d.ts

@@ -1,9 +0,0 @@
-import { Event } from '@hebcal/core/dist/esm/event';
-export declare const HOLIDAY_IGNORE_MASK: number;
-/**
- * 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
- */
-export declare function getLeyningKeyForEvent(ev: Event, il?: boolean): string | undefined;

package/dist/getLeyningOnDate.d.ts

@@ -1,21 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Leyning, LeyningWeekday } from './types';
-/**
- * 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
- */
-export declare function getLeyningOnDate(hdate: HDate, il: boolean, wantarray?: false): Leyning | LeyningWeekday | undefined;
-export declare function getLeyningOnDate(hdate: HDate, il: boolean, wantarray: true): (Leyning | LeyningWeekday)[];

package/dist/he.po.d.ts

@@ -1,61 +0,0 @@
-declare const _default: {
-    headers: {
-        "plural-forms": string;
-    };
-    contexts: {
-        "": {
-            "Shabbat Machar Chodesh": string[];
-            "Shabbat Rosh Chodesh": string[];
-            "Pesach I (on Shabbat)": string[];
-            "Pesach Chol ha-Moed Day 1": string[];
-            "Pesach Chol ha-Moed Day 2": string[];
-            "Pesach Chol ha-Moed Day 2 on Sunday": string[];
-            "Pesach Chol ha-Moed Day 3": string[];
-            "Pesach Chol ha-Moed Day 3 on Monday": string[];
-            "Pesach Chol ha-Moed Day 4": string[];
-            "Pesach Chol ha-Moed Day 5": string[];
-            "Pesach Shabbat Chol ha-Moed": string[];
-            "Pesach VII (on Shabbat)": string[];
-            "Pesach VIII (on Shabbat)": string[];
-            "Shavuot II (on Shabbat)": string[];
-            "Rosh Hashana I (on Shabbat)": string[];
-            "Yom Kippur (on Shabbat)": string[];
-            "Yom Kippur (Mincha, Traditional)": string[];
-            "Yom Kippur (Mincha, Alternate)": string[];
-            "Sukkot I (on Shabbat)": string[];
-            "Sukkot Chol ha-Moed Day 1": string[];
-            "Sukkot Chol ha-Moed Day 2": string[];
-            "Sukkot Chol ha-Moed Day 3": string[];
-            "Sukkot Chol ha-Moed Day 4": string[];
-            "Sukkot Chol ha-Moed Day 5": string[];
-            "Sukkot Shabbat Chol ha-Moed": string[];
-            "Sukkot Final Day (Hoshana Raba)": string[];
-            "Shmini Atzeret (on Shabbat)": string[];
-            "Chanukah Day 1": string[];
-            "Chanukah Day 2": string[];
-            "Chanukah Day 3": string[];
-            "Chanukah Day 4": string[];
-            "Chanukah Day 5": string[];
-            "Chanukah Day 6": string[];
-            "Chanukah Day 7": string[];
-            "Chanukah Day 7 (on Rosh Chodesh)": string[];
-            "Chanukah Day 8": string[];
-            "Chanukah Day 1 (on Shabbat)": string[];
-            "Chanukah Day 2 (on Shabbat)": string[];
-            "Chanukah Day 3 (on Shabbat)": string[];
-            "Chanukah Day 4 (on Shabbat)": string[];
-            "Chanukah Day 5 (on Shabbat)": string[];
-            "Chanukah Day 7 (on Shabbat)": string[];
-            "Chanukah Day 8 (on Shabbat)": string[];
-            "Shabbat Rosh Chodesh Chanukah": string[];
-            "Yom Kippur (Mincha)": string[];
-            "Tish'a B'Av (Mincha)": string[];
-            "Asara B'Tevet (Mincha)": string[];
-            "Ta'anit Bechorot (Mincha)": string[];
-            "Ta'anit Esther (Mincha)": string[];
-            "Tzom Gedaliah (Mincha)": string[];
-            "Tzom Tammuz (Mincha)": string[];
-        };
-    };
-};
-export default _default;

package/dist/index.d.ts

@@ -1,11 +0,0 @@
-export * from './types';
-export * from './locale';
-export * from './common';
-export * from './summary';
-export * from './festival';
-export { getLeyningKeyForEvent } from './getLeyningKeyForEvent';
-export * from './specialReadings';
-export * from './getLeyningForHoliday';
-export * from './leyning';
-export { getLeyningOnDate } from './getLeyningOnDate';
-export * from './clone';

package/dist/internalTypes.d.ts

@@ -1,20 +0,0 @@
-export type JsonFestivalAliyah = {
-    k: number | string;
-    b: string;
-    e: string;
-    v?: number;
-    p?: number;
-};
-export type JsonFestivalAliyotMap = {
-    [key: string]: JsonFestivalAliyah;
-};
-export type JsonFestivalLeyning = {
-    haft?: JsonFestivalAliyah | JsonFestivalAliyah[];
-    seph?: JsonFestivalAliyah | JsonFestivalAliyah[];
-    fullkriyah?: JsonFestivalAliyotMap;
-    megillah?: string;
-    alias?: boolean;
-    key?: string;
-    note?: string;
-    il?: boolean;
-};

package/dist/leyning.d.ts

@@ -1,30 +0,0 @@
-import { Event } from '@hebcal/core/dist/esm/event';
-import { AliyotMap, Leyning, LeyningNames, ParshaMeta } from './types';
-/**
- * Transliterated English and Hebrew names of this parsha
- * @param parsha untranslated name like ['Pinchas'] or ['Matot','Masei']
- */
-export 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']
- */
-export 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']
- */
-export 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
- */
-export declare function getLeyningForParshaHaShavua(ev: Event, il?: boolean): Leyning;
-/**
- * Returns the parsha metadata
- * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
- */
-export declare function lookupParsha(parsha: string | string[]): ParshaMeta;

package/dist/locale.d.ts

@@ -1,2 +0,0 @@
-import { Locale } from '@hebcal/core/dist/esm/locale';
-export { Locale };

package/dist/specialReadings.d.ts

@@ -1,15 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { AliyotMap, SpecialReading } from './types';
-/**
- * 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`.
- */
-export declare function specialReadings2(parsha: string[], hd: HDate, il: boolean, aliyot: AliyotMap): SpecialReading;

package/dist/summary.d.ts

@@ -1,18 +0,0 @@
-import { Aliyah, AliyotMap } from './types';
-/**
- * Summarizes an `AliyotMap` by collapsing all adjacent aliyot.
- * Finds any non-overlapping parts (e.g. special 7th aliyah or maftir)
- */
-export 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`.
- */
-export declare function makeSummaryFromParts(parts: Aliyah | Aliyah[]): string;
-/**
- * Makes a summary of the leyning, like "Genesis 6:9-11:32"
- */
-export declare function makeLeyningSummary(aliyot: AliyotMap): string;

package/dist/types.d.ts

@@ -1,130 +0,0 @@
-/**
- * Represents an aliyah
- */
-export 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;
-};
-export type StringMap = {
-    [key: string]: string;
-};
-export type AliyotMap = {
-    [key: string]: Aliyah;
-};
-/** Name of the parsha hashavua or holiday */
-export type LeyningNames = {
-    /** English */
-    en: string;
-    /** Hebrew (with nikud) */
-    he: string;
-};
-/**
- * Parsha metadata (underlying JSON object)
- */
-export 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;
-};
-export 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
- */
-export 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
- */
-export 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
- */
-export type LeyningWeekday = LeyningParshaHaShavua & {
-    /** Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday */
-    weekday?: AliyotMap;
-};
-export 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
- */
-export 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;
-};
-export type Leyning = LeyningBase & LeyningParshaHaShavua & LeyningShabbatHoliday & LeyningWeekday;