@hebcal/core 6.14.3 → 6.14.5

package/dist/bundle.js

@@ -1,9 +1,9 @@
-/*! @hebcal/core v6.14.3, distributed under GPLv2 or later https://www.gnu.org/licenses/gpl-2.0.txt */
+/*! @hebcal/core v6.14.5, distributed under GPLv2 or later https://www.gnu.org/licenses/gpl-2.0.txt */
 var hebcal = (function (exports) {
 'use strict';
 
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-const version = '6.14.3';
+const version = '6.14.5';
 
 /*! @hebcal/hdate v0.23.1, distributed under GPLv2 or later https://www.gnu.org/licenses/gpl-2.0.txt */
 /**
@@ -11465,9 +11465,13 @@ class HolidayEvent extends Event {
     /**
      * Returns a `https://www.hebcal.com/holidays/...` URL for more detail on
      * this holiday. Israel-only holidays get an `?i=on` query parameter.
-     * Returns `undefined` for years outside `[100, 2999]`.
+     * Returns `undefined` for years outside `[100, 2999]` and for
+     * Ta'anit BeHaB, which has no holiday page.
      */
     url() {
+        if (this.hasFlag('BEHAB')) {
+            return undefined;
+        }
         const year = this.greg().getFullYear();
         if (year < 100 || year > 2999) {
             return undefined;
@@ -12442,6 +12446,131 @@ function getSedra(hyear, il) {
     return sedra;
 }
 
+const { HAVDALAH, CANDLE_LIGHTING } = holidayDesc;
+/**
+ * Base class for events that have an associated wall-clock time and
+ * geographic location — for example, candle lighting, havdalah, and
+ * fast begin/end times.
+ *
+ * Stores both a `Date` (`eventTime`) and pre-formatted 24-hour
+ * (`eventTimeStr`) and locale-aware (`fmtTime`) strings. May reference a
+ * "linked" event such as the holiday whose candle-lighting time this
+ * represents.
+ */
+class TimedEvent extends Event {
+    /**
+     * Normally created by {@link calendar} rather than directly.
+     * @param date Hebrew date the event occurs
+     * @param desc Description (not translated)
+     * @param mask optional holiday flags
+     * @param eventTime the exact moment of the event
+     * @param location geographic location used to format the time
+     * @param linkedEvent optional event this time is associated with
+     * @param options optional; `locale` and `hour12` affect {@link fmtTime}
+     */
+    constructor(date, desc, mask, eventTime, location, linkedEvent, options) {
+        super(date, desc, mask);
+        this.eventTime = Zmanim.roundTime(eventTime);
+        this.location = location;
+        const timeFormat = location.getTimeFormatter();
+        this.eventTimeStr = Zmanim.formatTime(this.eventTime, timeFormat);
+        const opts = { ...options, location };
+        this.fmtTime = reformatTimeStr(this.eventTimeStr, 'pm', opts);
+        if (linkedEvent !== undefined) {
+            this.linkedEvent = linkedEvent;
+        }
+    }
+    /**
+     * @param [locale] Optional locale name (defaults to empty locale)
+     */
+    render(locale) {
+        return `${Locale.gettext(this.getDesc(), locale)}: ${this.fmtTime}`;
+    }
+    /**
+     * Returns translation of "Candle lighting" without the time.
+     * @param [locale] Optional locale name (defaults to empty locale)
+     */
+    renderBrief(locale) {
+        return Locale.gettext(this.getDesc(), locale);
+    }
+    getCategories() {
+        const desc = this.getDesc();
+        switch (desc) {
+            // LIGHT_CANDLES or LIGHT_CANDLES_TZEIS
+            case CANDLE_LIGHTING:
+                return ['candles'];
+            // YOM_TOV_ENDS
+            case HAVDALAH:
+                return ['havdalah'];
+            // flags.MINOR_FAST or flags.MAJOR_FAST
+            case holidayDesc.FAST_BEGINS:
+            case holidayDesc.FAST_ENDS:
+                return ['zmanim', 'fast'];
+            case holidayDesc.SOF_ZMAN_ACHILAT_CHAMETZ:
+                return ['zmanim', 'achilasChametz'];
+            case holidayDesc.BIUR_CHAMETZ:
+                return ['zmanim', 'biurChametz'];
+        }
+        /* NOTREACHED */
+        return ['unknown'];
+    }
+}
+/**
+ * Candle-lighting event for the eve of Shabbat or a Yom Tov.
+ *
+ * Generated by {@link calendar} when `options.candlelighting`
+ * is `true` and `options.location` is provided. By default candle lighting
+ * occurs 18 minutes before sundown in the Diaspora and 20 minutes before
+ * sundown in Israel (40 minutes in Jerusalem; 30 minutes in Haifa and
+ * Zikhron Ya'akov), configurable via `options.candleLightingMins`.
+ */
+class CandleLightingEvent extends TimedEvent {
+    constructor(date, mask, eventTime, location, linkedEvent, options) {
+        super(date, CANDLE_LIGHTING, mask, eventTime, location, linkedEvent, options);
+    }
+    getEmoji() {
+        return '🕯️';
+    }
+}
+/**
+ * Havdalah event marking the end of Shabbat or a Yom Tov.
+ *
+ * Generated by {@link calendar} when `options.candlelighting`
+ * is `true` and `options.location` is provided. By default Havdalah is
+ * calculated by *tzeit hakochavim* (8.5° solar depression); pass
+ * `options.havdalahMins` to use a fixed minute offset instead, or
+ * `options.havdalahDeg` to use a different degree.
+ */
+class HavdalahEvent extends TimedEvent {
+    constructor(date, mask, eventTime, location, havdalahMins, linkedEvent, options) {
+        super(date, HAVDALAH, mask, eventTime, location, linkedEvent, options);
+        if (havdalahMins) {
+            this.havdalahMins = havdalahMins;
+        }
+    }
+    /**
+     * @param [locale] Optional locale name (defaults to empty locale)
+     */
+    render(locale) {
+        return `${this.renderBrief(locale)}: ${this.fmtTime}`;
+    }
+    /**
+     * Returns translation of "Havdalah" without the time.
+     * @param [locale] Optional locale name (defaults to empty locale)
+     */
+    renderBrief(locale) {
+        let str = Locale.gettext(this.getDesc(), locale);
+        if (this.havdalahMins) {
+            const min = Locale.gettext('min', locale);
+            str += ` (${this.havdalahMins} ${min})`;
+        }
+        return str;
+    }
+    getEmoji() {
+        return '✨';
+    }
+}
+
 const ykk = 'Yom Kippur Katan';
 /** YKK is minor day of atonement on the day preceeding each Rosh Chodesh */
 class YomKippurKatanEvent extends HolidayEvent {
@@ -12524,7 +12653,7 @@ function getHolidaysOnDate(date, il) {
     }
     return events.filter(ev => ev.observedIn(il));
 }
-const { CHAG, LIGHT_CANDLES_TZEIS: LIGHT_CANDLES_TZEIS$2, CHANUKAH_CANDLES: CHANUKAH_CANDLES$1, BEHAB: BEHAB$1, MINOR_FAST: MINOR_FAST$1, SPECIAL_SHABBAT: SPECIAL_SHABBAT$1, MAJOR_FAST: MAJOR_FAST$1, MINOR_HOLIDAY: MINOR_HOLIDAY$1, EREV: EREV$1, SHABBAT_MEVARCHIM: SHABBAT_MEVARCHIM$1, } = flags;
+const { CHAG, LIGHT_CANDLES_TZEIS: LIGHT_CANDLES_TZEIS$2, CHANUKAH_CANDLES: CHANUKAH_CANDLES$1, BEHAB: BEHAB$1, MINOR_FAST: MINOR_FAST$1, SPECIAL_SHABBAT: SPECIAL_SHABBAT$1, MAJOR_FAST: MAJOR_FAST$1, MINOR_HOLIDAY: MINOR_HOLIDAY$1, EREV: EREV$1, } = flags;
 const SUN = 0;
 const TUE = 2;
 const THU = 4;
@@ -12545,36 +12674,74 @@ function addToMap(map, ...events) {
     }
 }
 /** @internal */
-const TIME_OF_DAY_MORNING = 0;
+const TIME_OF_DAY_DAWN = 0;
+/** @internal */
+const TIME_OF_DAY_MORNING = 1;
 /** @internal */
-const TIME_OF_DAY_MEVARCHIM = 1;
+const TIME_OF_DAY_MEVARCHIM = 2;
 /** @internal */
-const TIME_OF_DAY_DAY = 2;
+const TIME_OF_DAY_DAY = 3;
 /** @internal */
-const TIME_OF_DAY_EVENING = 3;
+const TIME_OF_DAY_MIDDAY = 4;
+/** @internal */
+const TIME_OF_DAY_LEARNING = 5;
+/** @internal */
+const TIME_OF_DAY_EVENING = 6;
+/** @internal */
+const TIME_OF_DAY_NIGHT = 7;
 /**
  * Approximate time of day of an event, used to order events on the same date.
- * - Morning: special Shabbatot (tied to the Torah or Haftarah reading), minor
- *   fasts (which begin at dawn) and Birkat Hachamah (recited at sunrise)
- * - Shabbat Mevarchim, announced in synagogue after the Torah reading
- * - Day: everything else
+ * Events of equal rank keep the order in which they were created, and timed
+ * events of equal rank are ordered by their time.
+ * - Dawn: Fast begins for a minor fast, and a Latest Kiddush Levana before
+ *   noon (which is never later than _alot hashachar_)
+ * - Morning: the parsha, special Shabbatot (tied to the Torah or Haftarah
+ *   reading), minor fasts (which begin at dawn) and Birkat Hachamah
+ *   (recited at sunrise)
+ * - Molad and Shabbat Mevarchim, announced in synagogue after the Torah
+ *   reading
+ * - Day: everything else, including Yizkor and the Omer count
+ * - Midday: the deadlines for eating and burning chametz
+ * - Daily learning
  * - Evening: Erev holidays, Chanukah candle-lighting and Leil Selichot
+ * - Night: other timed events such as candle-lighting, Havdalah,
+ *   Fast ends, and a Latest Kiddush Levana after noon
  * @internal
  */
 function timeOfDay(ev) {
-    const mask = ev.getFlags();
+    if (ev instanceof TimedEvent) {
+        return timedEventTimeOfDay(ev);
+    }
     const desc = ev.getDesc();
-    if (mask & (EREV$1 | CHANUKAH_CANDLES$1) || desc === holidayDesc.LEIL_SELICHOT) {
+    if (ev.hasAnyFlag('EREV', 'CHANUKAH_CANDLES') || desc === holidayDesc.LEIL_SELICHOT) {
         return TIME_OF_DAY_EVENING;
     }
-    if (mask & (SPECIAL_SHABBAT$1 | MINOR_FAST$1) || desc === holidayDesc.BIRKAT_HACHAMAH) {
+    if (ev.hasAnyFlag('PARSHA_HASHAVUA', 'SPECIAL_SHABBAT', 'MINOR_FAST') ||
+        desc === holidayDesc.BIRKAT_HACHAMAH) {
         return TIME_OF_DAY_MORNING;
     }
-    if (mask & SHABBAT_MEVARCHIM$1) {
+    if (ev.hasAnyFlag('SHABBAT_MEVARCHIM', 'MOLAD')) {
         return TIME_OF_DAY_MEVARCHIM;
     }
+    if (ev.hasAnyFlag('DAILY_LEARNING', 'DAF_YOMI', 'MISHNA_YOMI', 'NACH_YOMI', 'YERUSHALMI_YOMI')) {
+        return TIME_OF_DAY_LEARNING;
+    }
     return TIME_OF_DAY_DAY;
 }
+function timedEventTimeOfDay(ev) {
+    const desc = ev.getDesc();
+    if (desc === holidayDesc.SOF_ZMAN_ACHILAT_CHAMETZ || desc === holidayDesc.BIUR_CHAMETZ) {
+        return TIME_OF_DAY_MIDDAY;
+    }
+    // A minor fast begins at dawn, but Tish'a B'Av at sunset the day before.
+    // Latest Kiddush Levana is either before dawn or after nightfall.
+    if (desc === holidayDesc.FAST_BEGINS || ev.hasFlag('KIDDUSH_LEVANA')) {
+        // `eventTimeStr` is 24-hour local time; some engines format midnight as 24:00
+        const hour = Number.parseInt(ev.eventTimeStr, 10) % 24;
+        return hour < 12 ? TIME_OF_DAY_DAWN : TIME_OF_DAY_NIGHT;
+    }
+    return TIME_OF_DAY_NIGHT;
+}
 function addStaticHolidays(map, year) {
     for (const h of staticHolidays) {
         const hd = new HDate(h.dd, h.mm, year);
@@ -12950,131 +13117,6 @@ function isFastDay(date, il) {
     return events.some(ev => ev.hasAnyFlag('MAJOR_FAST', 'MINOR_FAST') && !ev.hasFlag('EREV'));
 }
 
-const { HAVDALAH, CANDLE_LIGHTING } = holidayDesc;
-/**
- * Base class for events that have an associated wall-clock time and
- * geographic location — for example, candle lighting, havdalah, and
- * fast begin/end times.
- *
- * Stores both a `Date` (`eventTime`) and pre-formatted 24-hour
- * (`eventTimeStr`) and locale-aware (`fmtTime`) strings. May reference a
- * "linked" event such as the holiday whose candle-lighting time this
- * represents.
- */
-class TimedEvent extends Event {
-    /**
-     * Normally created by {@link calendar} rather than directly.
-     * @param date Hebrew date the event occurs
-     * @param desc Description (not translated)
-     * @param mask optional holiday flags
-     * @param eventTime the exact moment of the event
-     * @param location geographic location used to format the time
-     * @param linkedEvent optional event this time is associated with
-     * @param options optional; `locale` and `hour12` affect {@link fmtTime}
-     */
-    constructor(date, desc, mask, eventTime, location, linkedEvent, options) {
-        super(date, desc, mask);
-        this.eventTime = Zmanim.roundTime(eventTime);
-        this.location = location;
-        const timeFormat = location.getTimeFormatter();
-        this.eventTimeStr = Zmanim.formatTime(this.eventTime, timeFormat);
-        const opts = { ...options, location };
-        this.fmtTime = reformatTimeStr(this.eventTimeStr, 'pm', opts);
-        if (linkedEvent !== undefined) {
-            this.linkedEvent = linkedEvent;
-        }
-    }
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale) {
-        return `${Locale.gettext(this.getDesc(), locale)}: ${this.fmtTime}`;
-    }
-    /**
-     * Returns translation of "Candle lighting" without the time.
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale) {
-        return Locale.gettext(this.getDesc(), locale);
-    }
-    getCategories() {
-        const desc = this.getDesc();
-        switch (desc) {
-            // LIGHT_CANDLES or LIGHT_CANDLES_TZEIS
-            case CANDLE_LIGHTING:
-                return ['candles'];
-            // YOM_TOV_ENDS
-            case HAVDALAH:
-                return ['havdalah'];
-            // flags.MINOR_FAST or flags.MAJOR_FAST
-            case holidayDesc.FAST_BEGINS:
-            case holidayDesc.FAST_ENDS:
-                return ['zmanim', 'fast'];
-            case holidayDesc.SOF_ZMAN_ACHILAT_CHAMETZ:
-                return ['zmanim', 'achilasChametz'];
-            case holidayDesc.BIUR_CHAMETZ:
-                return ['zmanim', 'biurChametz'];
-        }
-        /* NOTREACHED */
-        return ['unknown'];
-    }
-}
-/**
- * Candle-lighting event for the eve of Shabbat or a Yom Tov.
- *
- * Generated by {@link calendar} when `options.candlelighting`
- * is `true` and `options.location` is provided. By default candle lighting
- * occurs 18 minutes before sundown in the Diaspora and 20 minutes before
- * sundown in Israel (40 minutes in Jerusalem; 30 minutes in Haifa and
- * Zikhron Ya'akov), configurable via `options.candleLightingMins`.
- */
-class CandleLightingEvent extends TimedEvent {
-    constructor(date, mask, eventTime, location, linkedEvent, options) {
-        super(date, CANDLE_LIGHTING, mask, eventTime, location, linkedEvent, options);
-    }
-    getEmoji() {
-        return '🕯️';
-    }
-}
-/**
- * Havdalah event marking the end of Shabbat or a Yom Tov.
- *
- * Generated by {@link calendar} when `options.candlelighting`
- * is `true` and `options.location` is provided. By default Havdalah is
- * calculated by *tzeit hakochavim* (8.5° solar depression); pass
- * `options.havdalahMins` to use a fixed minute offset instead, or
- * `options.havdalahDeg` to use a different degree.
- */
-class HavdalahEvent extends TimedEvent {
-    constructor(date, mask, eventTime, location, havdalahMins, linkedEvent, options) {
-        super(date, HAVDALAH, mask, eventTime, location, linkedEvent, options);
-        if (havdalahMins) {
-            this.havdalahMins = havdalahMins;
-        }
-    }
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale) {
-        return `${this.renderBrief(locale)}: ${this.fmtTime}`;
-    }
-    /**
-     * Returns translation of "Havdalah" without the time.
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale) {
-        let str = Locale.gettext(this.getDesc(), locale);
-        if (this.havdalahMins) {
-            const min = Locale.gettext('min', locale);
-            str += ` (${this.havdalahMins} ${min})`;
-        }
-        return str;
-    }
-    getEmoji() {
-        return '✨';
-    }
-}
-
 const { LIGHT_CANDLES: LIGHT_CANDLES$1, LIGHT_CANDLES_TZEIS: LIGHT_CANDLES_TZEIS$1 } = flags;
 const { FAST_BEGINS, FAST_ENDS } = holidayDesc;
 /** @internal */
@@ -14511,6 +14553,16 @@ class MevarchimChodeshEvent extends Event {
  * * `options.addHebrewDates` - print the Hebrew date for the entire date range
  * * `options.addHebrewDatesForEvents` - print the Hebrew date for dates with some events
  *
+ * Events are returned in date order. Events on the same date are ordered by
+ * approximate time of day: timed events before dawn (Fast begins, an early
+ * Latest Kiddush Levana), then the parsha, special Shabbatot and minor fasts,
+ * then the Molad and Shabbat Mevarchim, then other holidays, Yizkor and the
+ * Omer, then the chametz deadlines on Erev Pesach, then daily learning, then
+ * evening holidays (Erev holidays, Chanukah), and finally the remaining timed
+ * events (candle-lighting, Havdalah, Fast ends) in order of time. When
+ * `options.addHebrewDates` or `options.addHebrewDatesForEvents` adds a Hebrew
+ * date event, it comes first.
+ *
  * Lastly, translation and transliteration of event titles is controlled by
  * `options.locale` and the {@link Locale} API.
  * `@hebcal/core` supports three locales by default:
@@ -14601,26 +14653,18 @@ function calendar(options = {}) {
         let candlesEv;
         const holidays0 = holidaysYear.get(hd.toString()) || [];
         const holidays = holidays0.filter(ev => ev.observedIn(il));
-        // On Shabbat, events tied to the morning Torah reading and announcements
-        // in synagogue come first: the parsha, special Shabbatot such as
-        // Shabbat Shekalim, then the Molad and Shabbat Mevarchim
         if (options.sedrot && isSaturday) {
             const parsha0 = sedra.lookup(abs);
             if (!parsha0.chag) {
                 evts.push(new ParshaEvent(parsha0));
             }
         }
-        let mevarchim = isSaturday && (options.molad || options.shabbatMevarchim)
-            ? makeMoladAndMevarchimChodesh(hd, options)
-            : [];
+        if (isSaturday && (options.molad || options.shabbatMevarchim)) {
+            evts.push(...makeMoladAndMevarchimChodesh(hd, options));
+        }
         for (const ev of holidays) {
-            if (mevarchim.length && timeOfDay(ev) > TIME_OF_DAY_MEVARCHIM) {
-                evts.push(...mevarchim);
-                mevarchim = [];
-            }
             candlesEv = appendHolidayAndRelated(candlesEv, evts, ev, options, isFriday, isSaturday, hasUserMask);
         }
-        evts.push(...mevarchim);
         const mm = hd.getMonth();
         const dd = hd.getDate();
         // When Erev Pesach falls on Shabbat, burning chametz is moved to Friday.
@@ -14686,9 +14730,10 @@ function calendar(options = {}) {
                 kiddushLevanaEv = makeKiddushLevanaEvent(hyear, mm, options);
             }
             if (kiddushLevanaEv?.getDate().abs() === abs) {
-                insertTimedEvent(evts, prevEventsLength, kiddushLevanaEv);
+                evts.push(kiddushLevanaEv);
             }
         }
+        sortByTimeOfDay(evts, prevEventsLength);
         if (options.addHebrewDates ||
             (options.addHebrewDatesForEvents &&
                 prevEventsLength !== evts.length - numDailyLearning)) {
@@ -14994,22 +15039,28 @@ function setOptionsFromMask(options) {
         options.kiddushLevanaMaharil = true;
     return m;
 }
+function compareTimeOfDay(a, b) {
+    const diff = timeOfDay(a) - timeOfDay(b);
+    if (diff !== 0) {
+        return diff;
+    }
+    if (a instanceof TimedEvent && b instanceof TimedEvent) {
+        return a.eventTime.getTime() - b.eventTime.getTime();
+    }
+    return 0;
+}
 /**
- * Inserts `ev` into today's events (those at index `start` and beyond)
- * just before the first `TimedEvent` that occurs later, or appends it.
- * Unlike other timed events, Latest Kiddush Levana may fall at dawn,
- * at candle-lighting or late at night, so its position can't be fixed.
+ * Sorts today's events (those at index `start` and beyond) in place by
+ * {@link timeOfDay}. The sort is stable, so events of equal rank keep the
+ * order in which they were added, e.g. Yizkor after its holiday.
  */
-function insertTimedEvent(events, start, ev) {
-    const time = ev.eventTime.getTime();
-    for (let i = start; i < events.length; i++) {
-        const other = events[i];
-        if (other instanceof TimedEvent && other.eventTime.getTime() > time) {
-            events.splice(i, 0, ev);
-            return;
-        }
+function sortByTimeOfDay(events, start) {
+    if (events.length - start < 2) {
+        return;
     }
-    events.push(ev);
+    const today = events.splice(start);
+    today.sort(compareTimeOfDay);
+    events.push(...today);
 }
 /**
  * Appends the Event `ev` to the `events` array. Also may add related