@hebcal/core 6.6.0 → 6.7.0

package/dist/src/event.js

@@ -1,295 +0,0 @@
-import { HDate, Locale } from '@hebcal/hdate';
-import './locale'; // Adds Hebrew and Ashkenazic translations
-/**
- * Holiday flags for Event. These flags are typically
- * combined using bitwise arithmetic to form a mask.
- * @readonly
- * @enum {number}
- */
-export const flags = {
-    /** Chag, yontiff, yom tov */
-    CHAG: 0x000001,
-    /** Light candles 18 minutes before sundown */
-    LIGHT_CANDLES: 0x000002,
-    /** End of holiday (end of Yom Tov)  */
-    YOM_TOV_ENDS: 0x000004,
-    /** Observed only in the Diaspora (chutz l'aretz)  */
-    CHUL_ONLY: 0x000008,
-    /** Observed only in Israel */
-    IL_ONLY: 0x000010,
-    /** Light candles in the evening at Tzeit time (3 small stars) */
-    LIGHT_CANDLES_TZEIS: 0x000020,
-    /** Candle-lighting for Chanukah */
-    CHANUKAH_CANDLES: 0x000040,
-    /** Rosh Chodesh, beginning of a new Hebrew month */
-    ROSH_CHODESH: 0x000080,
-    /** Minor fasts like Tzom Tammuz, Ta'anit Esther, ... */
-    MINOR_FAST: 0x000100,
-    /** Shabbat Shekalim, Zachor, ... */
-    SPECIAL_SHABBAT: 0x000200,
-    /** Weekly sedrot on Saturdays */
-    PARSHA_HASHAVUA: 0x000400,
-    /** Daily page of Talmud (Bavli) */
-    DAF_YOMI: 0x000800,
-    /** Days of the Omer */
-    OMER_COUNT: 0x001000,
-    /** Yom HaShoah, Yom HaAtzma'ut, ... */
-    MODERN_HOLIDAY: 0x002000,
-    /** Yom Kippur and Tish'a B'Av */
-    MAJOR_FAST: 0x004000,
-    /** On the Saturday before Rosh Chodesh */
-    SHABBAT_MEVARCHIM: 0x008000,
-    /** Molad */
-    MOLAD: 0x010000,
-    /** Yahrzeit or Hebrew Anniversary */
-    USER_EVENT: 0x020000,
-    /** Daily Hebrew date ("11th of Sivan, 5780") */
-    HEBREW_DATE: 0x040000,
-    /** A holiday that's not major, modern, rosh chodesh, or a fast day */
-    MINOR_HOLIDAY: 0x080000,
-    /** Evening before a major or minor holiday */
-    EREV: 0x100000,
-    /** Chol haMoed, intermediate days of Pesach or Sukkot */
-    CHOL_HAMOED: 0x200000,
-    /** Mishna Yomi */
-    MISHNA_YOMI: 0x400000,
-    /** Yom Kippur Katan, minor day of atonement on the day preceeding each Rosh Chodesh */
-    YOM_KIPPUR_KATAN: 0x800000,
-    /** Daily page of Jerusalem Talmud (Yerushalmi) */
-    YERUSHALMI_YOMI: 0x1000000,
-    /** Nach Yomi */
-    NACH_YOMI: 0x2000000,
-    /** Daily Learning */
-    DAILY_LEARNING: 0x4000000,
-    /** Yizkor */
-    YIZKOR: 0x8000000,
-    /** BeHaB fast days on Monday, Thursday and Monday after Pesach and Sukkot */
-    BEHAB: 0x10000000,
-};
-const flagToCategory = [
-    [flags.MAJOR_FAST, 'holiday', 'major', 'fast'],
-    [flags.CHANUKAH_CANDLES, 'holiday', 'minor'],
-    [flags.HEBREW_DATE, 'hebdate'],
-    [flags.MINOR_FAST, 'holiday', 'fast'],
-    [flags.MINOR_HOLIDAY, 'holiday', 'minor'],
-    [flags.MODERN_HOLIDAY, 'holiday', 'modern'],
-    [flags.MOLAD, 'molad'],
-    [flags.OMER_COUNT, 'omer'],
-    [flags.PARSHA_HASHAVUA, 'parashat'], // backwards-compat
-    [flags.ROSH_CHODESH, 'roshchodesh'],
-    [flags.SHABBAT_MEVARCHIM, 'mevarchim'],
-    [flags.SPECIAL_SHABBAT, 'holiday', 'shabbat'],
-    [flags.USER_EVENT, 'user'],
-    [flags.YIZKOR, 'yizkor'],
-];
-/**
- * Represents an Event with a title, date, and flags.
- *
- * Events are used to represent holidays, candle-lighting times,
- * Torah readings, Omer days, Hebrew dates, and more. Most concrete event
- * types are subclasses (e.g. {@link HolidayEvent}, {@link TimedEvent},
- * {@link ParshaEvent}, {@link OmerEvent}) and are produced by
- * {@link HebrewCalendar.calendar}.
- *
- * To get the title of the event in a language other than English with
- * Sephardic transliterations, use the {@link Event.render} method.
- *
- * @example
- * import {Event, HDate, flags} from '@hebcal/core';
- * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);
- * ev.getDate().toString(); // '6 Sivan 5749'
- * ev.getDesc();             // 'Shavuot'
- * ev.render('he');          // 'שָׁבוּעוֹת'
- */
-export class Event {
-    /** Hebrew date of this event */
-    date;
-    /**
-     * Untranslated title of this event. Note that these description
-     * strings are always in English and will remain stable across releases.
-     * To get the title of the event in another language, use the
-     * `render()` method.
-     */
-    desc;
-    /** Bitmask of optional event flags. See {@link flags} */
-    mask;
-    /** Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒 */
-    emoji;
-    /** Optional longer description or memo text */
-    memo;
-    /** Alarms are used by iCalendar feeds */
-    alarm;
-    /**
-     * Constructs Event
-     * @param date Hebrew date event occurs
-     * @param desc Description (not translated)
-     * @param [mask=0] optional bitmask of holiday flags (see {@link flags})
-     * @param [attrs={}] optional additional attributes (e.g. `eventTimeStr`, `cholHaMoedDay`)
-     */
-    constructor(date, desc, mask = 0, attrs) {
-        if (!HDate.isHDate(date)) {
-            throw new TypeError(`Invalid Event date: ${date}`);
-        }
-        else if (typeof desc !== 'string') {
-            throw new TypeError(`Invalid Event description: ${desc}`);
-        }
-        this.date = date;
-        this.desc = desc;
-        this.mask = +mask;
-        if (typeof attrs === 'object' && attrs !== null) {
-            Object.assign(this, attrs);
-        }
-    }
-    /**
-     * Hebrew date of this event
-     */
-    getDate() {
-        return this.date;
-    }
-    /**
-     * Gregorian date of this event
-     */
-    greg() {
-        return this.date.greg();
-    }
-    /**
-     * Untranslated title of this event. Note that these description
-     * strings are always in English and will remain stable across releases.
-     * To get the title of the event in another language, use the
-     * `render()` method.
-     */
-    getDesc() {
-        return this.desc;
-    }
-    /**
-     * Bitmask of optional event flags. See {@link flags}
-     */
-    getFlags() {
-        return this.mask;
-    }
-    /**
-     * Returns (translated) description of this event
-     * @example
-     * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);
-     * ev.render('en'); // 'Shavuot'
-     * ev.render('he'); // 'שָׁבוּעוֹת'
-     * ev.render('ashkenazi'); // 'Shavuos'
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale) {
-        return Locale.gettext(this.desc, locale);
-    }
-    /**
-     * Returns a brief (translated) description of this event.
-     *
-     * For most events this is the same as {@link render}. Some subclasses
-     * (e.g. {@link CandleLightingEvent}, {@link HavdalahEvent},
-     * {@link OmerEvent}) produce shorter text without an attached time or
-     * extra qualifier — useful for compact UI display.
-     * @example
-     * import {CandleLightingEvent} from '@hebcal/core';
-     * // For a regular Event, renderBrief() == render():
-     * const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);
-     * ev.renderBrief('en'); // 'Shavuot'
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale) {
-        return this.render(locale);
-    }
-    /**
-     * Returns the event's emoji character (e.g. `🕯️`, `🕎`, `🇮🇱`, `🍏🍯`),
-     * or `null` if no emoji is associated with this event.
-     * Subclasses override this to provide holiday-specific emoji.
-     */
-    getEmoji() {
-        return this.emoji || null;
-    }
-    /**
-     * Returns a simplified (untranslated) description for this event, suitable
-     * for grouping related events under a single name.
-     *
-     * For example, {@link HolidayEvent} strips qualifiers so that
-     * `"Erev Pesach"` → `"Pesach"` and `"Sukkot III (CH''M)"` → `"Sukkot"`.
-     * For many events the basename and the event description are identical.
-     * @example
-     * import {HolidayEvent, HDate, months, flags} from '@hebcal/core';
-     * const ev = new HolidayEvent(
-     *   new HDate(14, months.NISAN, 5784), 'Erev Pesach', flags.EREV);
-     * ev.getDesc();    // 'Erev Pesach'
-     * ev.basename();   // 'Pesach'
-     */
-    basename() {
-        return this.getDesc();
-    }
-    /**
-     * Returns a URL to hebcal.com or sefaria.org for more detail on the event,
-     * or `undefined` for events with no detail page.
-     *
-     * Subclasses such as {@link HolidayEvent}, {@link ChanukahEvent},
-     * {@link AsaraBTevetEvent}, {@link ParshaEvent}, and {@link OmerEvent}
-     * override this with their own URL patterns.
-     */
-    url() {
-        return undefined;
-    }
-    /**
-     * Is this event observed in Israel?
-     * @example
-     * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
-     * ev1.observedInIsrael(); // false
-     * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
-     * ev2.observedInIsrael(); // true
-     */
-    observedInIsrael() {
-        return !(this.mask & flags.CHUL_ONLY);
-    }
-    /**
-     * Is this event observed in the Diaspora?
-     * @example
-     * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
-     * ev1.observedInDiaspora(); // true
-     * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
-     * ev2.observedInDiaspora(); // true
-     */
-    observedInDiaspora() {
-        return !(this.mask & flags.IL_ONLY);
-    }
-    /**
-     * Is this event observed in Israel/Diaspora?
-     * @example
-     * const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
-     * ev1.observedIn(false); // true
-     * ev1.observedIn(true); // false
-     * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
-     * ev2.observedIn(false); // true
-     * ev2.observedIn(true); // true
-     * @param il
-     */
-    observedIn(il) {
-        return il ? this.observedInIsrael() : this.observedInDiaspora();
-    }
-    /**
-     * Returns an array of category strings classifying this event, derived
-     * from its {@link flags} bitmask. The first element is the broad category
-     * (e.g. `'holiday'`, `'roshchodesh'`, `'parashat'`, `'omer'`), followed
-     * by zero or more refinements (e.g. `'major'`, `'minor'`, `'fast'`).
-     *
-     * Returns `['unknown']` if no flag maps to a known category.
-     * @example
-     * import {Event, HDate, flags} from '@hebcal/core';
-     * new Event(new HDate(10, 'Tishrei', 5784), 'Yom Kippur', flags.MAJOR_FAST)
-     *   .getCategories(); // ['holiday', 'major', 'fast']
-     * new Event(new HDate(1, 'Shvat', 5784), 'Rosh Chodesh Sh\'vat', flags.ROSH_CHODESH)
-     *   .getCategories(); // ['roshchodesh']
-     */
-    getCategories() {
-        const mask = this.getFlags();
-        for (const attrs of flagToCategory) {
-            const attr0 = attrs[0];
-            if (mask & attr0) {
-                return attrs.slice(1);
-            }
-        }
-        return ['unknown'];
-    }
-}

package/dist/src/getStartAndEnd.d.ts

@@ -1,6 +0,0 @@
-import { CalOptions } from './CalOptions';
-/**
- * Parse options object to determine start & end days
- * @private
- */
-export declare function getStartAndEnd(options: CalOptions): number[];

package/dist/src/getStartAndEnd.js

@@ -1,105 +0,0 @@
-import { greg2abs, isDate, daysInGregMonth, HDate, months } from '@hebcal/hdate';
-const TISHREI = months.TISHREI;
-/**
- * Gets the R.D. days for a number, Date, or HDate
- * @private
- */
-function getAbs(d) {
-    if (typeof d === 'number')
-        return d;
-    if (isDate(d))
-        return greg2abs(d);
-    if (HDate.isHDate(d))
-        return d.abs();
-    throw new TypeError(`Invalid date type: ${d}`);
-}
-function getYear(options) {
-    if (options.year !== undefined) {
-        return Number(options.year);
-    }
-    return options.isHebrewYear
-        ? new HDate().getFullYear()
-        : new Date().getFullYear();
-}
-const MAX_NUM_YEARS = 2000;
-/**
- * Parse options object to determine start & end days
- * @private
- */
-export function getStartAndEnd(options) {
-    if ((options.start && !options.end) || (options.end && !options.start)) {
-        throw new TypeError('Both options.start and options.end are required');
-    }
-    else if (options.start && options.end) {
-        const start = getAbs(options.start), end = getAbs(options.end);
-        if (end - start > 365 * MAX_NUM_YEARS) {
-            throw new RangeError(`Date range exceeds ${MAX_NUM_YEARS} years`);
-        }
-        return [start, end];
-    }
-    const isHebrewYear = Boolean(options.isHebrewYear);
-    const theYear = getYear(options);
-    if (isNaN(theYear)) {
-        throw new RangeError(`Invalid year ${options.year}`);
-    }
-    else if (isHebrewYear && theYear < 1) {
-        throw new RangeError(`Invalid Hebrew year ${theYear}`);
-    }
-    const theMonth = getMonth(options);
-    const numYears = Number(options.numYears) || 1;
-    if (numYears > MAX_NUM_YEARS) {
-        throw new RangeError(`options.numYears exceeds ${MAX_NUM_YEARS}`);
-    }
-    if (isHebrewYear) {
-        return startEndHebrew(theMonth, theYear, numYears);
-    }
-    else {
-        return startEndGregorian(theMonth, theYear, numYears);
-    }
-}
-function getMonth(options) {
-    if (options.month) {
-        if (options.isHebrewYear) {
-            return HDate.monthNum(options.month);
-        }
-        else if (typeof options.month === 'number') {
-            return options.month;
-        }
-    }
-    return NaN;
-}
-function startEndGregorian(theMonth, theYear, numYears) {
-    const gregMonth = theMonth ? theMonth - 1 : 0;
-    const startGreg = new Date(theYear, gregMonth, 1);
-    if (theYear < 100) {
-        startGreg.setFullYear(theYear);
-    }
-    const startAbs = greg2abs(startGreg);
-    let endAbs;
-    if (theMonth) {
-        endAbs = startAbs + daysInGregMonth(theMonth, theYear) - 1;
-    }
-    else {
-        const endYear = theYear + numYears;
-        const endGreg = new Date(endYear, 0, 1);
-        if (endYear < 100) {
-            endGreg.setFullYear(endYear);
-        }
-        endAbs = greg2abs(endGreg) - 1;
-    }
-    return [startAbs, endAbs];
-}
-function startEndHebrew(theMonth, theYear, numYears) {
-    const startDate = new HDate(1, theMonth || TISHREI, theYear);
-    let startAbs = startDate.abs();
-    const endAbs = theMonth
-        ? startAbs + startDate.daysInMonth()
-        : new HDate(1, TISHREI, theYear + numYears).abs() - 1;
-    // for full Hebrew year, start on Erev Rosh Hashana which
-    // is technically in the previous Hebrew year
-    // (but conveniently lets us get candle-lighting time for Erev)
-    if (!theMonth && theYear > 1) {
-        startAbs--;
-    }
-    return [startAbs, endAbs];
-}

package/dist/src/hallel.d.ts

@@ -1,6 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-/**
- * @private
- */
-export declare function hallel_(events: Event[], hdate: HDate): number;

package/dist/src/hallel.js

@@ -1,39 +0,0 @@
-import { months } from '@hebcal/hdate';
-import { flags } from './event';
-import { holidayDesc as hdesc } from './staticHolidays';
-const NONE = 0;
-const HALF = 1;
-const WHOLE = 2;
-/**
- * @private
- */
-export function hallel_(events, hdate) {
-    const abs = hdate.abs();
-    for (const ev of events) {
-        const hd = ev.getDate();
-        if (hd.abs() !== abs) {
-            continue;
-        }
-        const desc = ev.getDesc();
-        const month = hd.getMonth();
-        const mday = hd.getDate();
-        const mask = ev.getFlags();
-        if (desc.startsWith('Chanukah') ||
-            desc.startsWith('Shavuot') ||
-            desc.startsWith('Sukkot') ||
-            (month === months.NISAN &&
-                (mday === 15 || mday === 16) &&
-                mask & flags.CHAG) || // Pesach
-            desc === hdesc.YOM_HAATZMA_UT ||
-            desc === hdesc.YOM_YERUSHALAYIM) {
-            return WHOLE;
-        }
-        if (mask & flags.ROSH_CHODESH ||
-            (desc.startsWith('Pesach') &&
-                desc !== hdesc.PESACH_I &&
-                desc !== hdesc.PESACH_II)) {
-            return HALF;
-        }
-    }
-    return NONE;
-}

package/dist/src/he-x-NoNikud.po.d.ts

@@ -1,28 +0,0 @@
-declare const _default: {
-    headers: {
-        "plural-forms": string;
-        language: string;
-    };
-    contexts: {
-        "": {
-            Korach: string[];
-            Chukat: string[];
-            "Erev Yom Kippur": string[];
-            "Yom Kippur": string[];
-            "Yom Kippur Katan": string[];
-            "Pesach Shabbat Chol ha-Moed": string[];
-            "Sukkot Shabbat Chol ha-Moed": string[];
-            "Erev Sukkot": string[];
-            Sukkot: string[];
-            "Sukkot I": string[];
-            "Sukkot II": string[];
-            "Sukkot II (CH''M)": string[];
-            "Sukkot III (CH''M)": string[];
-            "Sukkot IV (CH''M)": string[];
-            "Sukkot V (CH''M)": string[];
-            "Sukkot VI (CH''M)": string[];
-            "Sukkot VII (Hoshana Raba)": string[];
-        };
-    };
-};
-export default _default;

package/dist/src/he-x-NoNikud.po.js

@@ -1 +0,0 @@
-export default { "headers": { "plural-forms": "nplurals=2; plural=(n != 1);", "language": "he-x-NoNikud" }, "contexts": { "": { "Korach": ["קורח"], "Chukat": ["חוקת"], "Erev Yom Kippur": ["ערב יום כיפור"], "Yom Kippur": ["יום כיפור"], "Yom Kippur Katan": ["יום כיפור קטן"], "Pesach Shabbat Chol ha-Moed": ["פסח שבת חול המועד"], "Sukkot Shabbat Chol ha-Moed": ["סוכות שבת חול המועד"], "Erev Sukkot": ["ערב סוכות"], "Sukkot": ["סוכות"], "Sukkot I": ["סוכות א׳"], "Sukkot II": ["סוכות ב׳"], "Sukkot II (CH''M)": ["סוכות ב׳ (חוה״מ)"], "Sukkot III (CH''M)": ["סוכות ג׳ (חוה״מ)"], "Sukkot IV (CH''M)": ["סוכות ד׳ (חוה״מ)"], "Sukkot V (CH''M)": ["סוכות ה׳ (חוה״מ)"], "Sukkot VI (CH''M)": ["סוכות ו׳ (חוה״מ)"], "Sukkot VII (Hoshana Raba)": ["סוכות ז׳ (הושענא רבה)"] } } };