@hebcal/core 5.4.11 → 5.5.1

package/dist/index.cjs

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.4.11 */
+/*! @hebcal/core v5.5.1 */
 'use strict';
 
 /* eslint-disable @typescript-eslint/no-namespace, no-inner-declarations */
@@ -7776,6 +7776,7 @@ class Location extends GeoLocation {
      * @param dst single char 'Y' or 'N'
      */
     static getUsaTzid(state, tz, dst) {
+        tz = +tz;
         if (tz === 10 && state === 'AK') {
             return 'America/Adak';
         }
@@ -8343,6 +8344,40 @@ class Zmanim {
         }
         return new Date(sunset.getTime() + offset * 60 * 1000);
     }
+    /**
+     * Returns the Hebrew date relative to the specified location and Gregorian date,
+     * taking into consideration whether the time is before or after sunset.
+     *
+     * For example, if the given date and is `2024-09-22T10:35` (before sunset), and
+     * sunset for the specified location is **19:04**, then this function would
+     * return a Hebrew date of `19th of Elul, 5784`.
+     * If the given date is the same Gregorian day after sunset
+     * (for example `2024-09-22T20:07`), this function would return a
+     * Hebrew date of `20th of Elul, 5784`.
+     * @example
+     * const {GeoLocation, Zmanim, HDate} = require('@hebcal/core');
+     * const latitude = 48.85341;
+     * const longitude = 2.3488;
+     * const timezone = 'Europe/Paris';
+     * const gloc = new GeoLocation(null, latitude, longitude, 0, timezone);
+     * const before = Zmanim.makeSunsetAwareHDate(gloc, new Date('2024-09-22T17:38:46.123Z'), false);
+     * console.log(before.toString()); // '19 Elul 5784'
+     * const after = Zmanim.makeSunsetAwareHDate(gloc, new Date('2024-09-22T23:45:18.345Z'), false);
+     * console.log(after.toString()); // '20 Elul 5784'
+     */
+    static makeSunsetAwareHDate(gloc, date, useElevation) {
+        const zmanim = new Zmanim(gloc, date, useElevation);
+        const sunset = zmanim.sunset();
+        let hd = new HDate(date);
+        const sunsetMillis = sunset.getTime();
+        if (isNaN(sunsetMillis)) {
+            return hd;
+        }
+        if (date.getTime() >= sunsetMillis) {
+            hd = hd.next();
+        }
+        return hd;
+    }
 }
 
 const hour12cc = {
@@ -9483,11 +9518,11 @@ const Kislev = months.KISLEV;
 const Shvat = months.SHVAT;
 const Adar2 = months.ADAR_II;
 const CHAG$1 = flags.CHAG;
-const LIGHT_CANDLES$1 = flags.LIGHT_CANDLES;
+const LIGHT_CANDLES$2 = flags.LIGHT_CANDLES;
 const YOM_TOV_ENDS$1 = flags.YOM_TOV_ENDS;
 const CHUL_ONLY$1 = flags.CHUL_ONLY;
 const IL_ONLY$2 = flags.IL_ONLY;
-const LIGHT_CANDLES_TZEIS$2 = flags.LIGHT_CANDLES_TZEIS;
+const LIGHT_CANDLES_TZEIS$3 = flags.LIGHT_CANDLES_TZEIS;
 const CHANUKAH_CANDLES$2 = flags.CHANUKAH_CANDLES;
 const MAJOR_FAST$2 = flags.MAJOR_FAST;
 const MINOR_HOLIDAY$2 = flags.MINOR_HOLIDAY;
@@ -9706,7 +9741,7 @@ const staticHolidays = [
         flags: CHAG$1 | YOM_TOV_ENDS$1,
         emoji: '🍏🍯',
     },
-    { mm: Tishrei, dd: 9, desc: EREV_YOM_KIPPUR, flags: EREV$2 | LIGHT_CANDLES$1 },
+    { mm: Tishrei, dd: 9, desc: EREV_YOM_KIPPUR, flags: EREV$2 | LIGHT_CANDLES$2 },
     {
         mm: Tishrei,
         dd: 10,
@@ -9717,14 +9752,14 @@ const staticHolidays = [
         mm: Tishrei,
         dd: 14,
         desc: EREV_SUKKOT,
-        flags: CHUL_ONLY$1 | EREV$2 | LIGHT_CANDLES$1,
+        flags: CHUL_ONLY$1 | EREV$2 | LIGHT_CANDLES$2,
         emoji: emojiSukkot,
     },
     {
         mm: Tishrei,
         dd: 15,
         desc: SUKKOT_I,
-        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$2,
+        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$3,
         emoji: emojiSukkot,
     },
     {
@@ -9770,7 +9805,7 @@ const staticHolidays = [
         mm: Tishrei,
         dd: 22,
         desc: SHMINI_ATZERET,
-        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$2,
+        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$3,
     },
     {
         mm: Tishrei,
@@ -9782,7 +9817,7 @@ const staticHolidays = [
         mm: Tishrei,
         dd: 14,
         desc: EREV_SUKKOT,
-        flags: IL_ONLY$2 | EREV$2 | LIGHT_CANDLES$1,
+        flags: IL_ONLY$2 | EREV$2 | LIGHT_CANDLES$2,
         emoji: emojiSukkot,
     },
     {
@@ -9842,7 +9877,7 @@ const staticHolidays = [
         mm: Tishrei,
         dd: 21,
         desc: SUKKOT_VII_HOSHANA_RABA,
-        flags: LIGHT_CANDLES$1 | CHOL_HAMOED$1,
+        flags: LIGHT_CANDLES$2 | CHOL_HAMOED$1,
         chmDay: -1,
         emoji: emojiSukkot,
     },
@@ -9874,7 +9909,7 @@ const staticHolidays = [
         mm: Nisan,
         dd: 14,
         desc: EREV_PESACH,
-        flags: IL_ONLY$2 | EREV$2 | LIGHT_CANDLES$1,
+        flags: IL_ONLY$2 | EREV$2 | LIGHT_CANDLES$2,
         emoji: '🫓🍷',
     },
     {
@@ -9920,7 +9955,7 @@ const staticHolidays = [
         mm: Nisan,
         dd: 20,
         desc: PESACH_VI_CHM,
-        flags: IL_ONLY$2 | CHOL_HAMOED$1 | LIGHT_CANDLES$1,
+        flags: IL_ONLY$2 | CHOL_HAMOED$1 | LIGHT_CANDLES$2,
         chmDay: 5,
         emoji: emojiPesach,
     },
@@ -9936,14 +9971,14 @@ const staticHolidays = [
         mm: Nisan,
         dd: 14,
         desc: EREV_PESACH,
-        flags: CHUL_ONLY$1 | EREV$2 | LIGHT_CANDLES$1,
+        flags: CHUL_ONLY$1 | EREV$2 | LIGHT_CANDLES$2,
         emoji: '🫓🍷',
     },
     {
         mm: Nisan,
         dd: 15,
         desc: PESACH_I,
-        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$2,
+        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$3,
         emoji: '🫓🍷',
     },
     {
@@ -9981,7 +10016,7 @@ const staticHolidays = [
         mm: Nisan,
         dd: 20,
         desc: PESACH_VI_CHM,
-        flags: CHUL_ONLY$1 | CHOL_HAMOED$1 | LIGHT_CANDLES$1,
+        flags: CHUL_ONLY$1 | CHOL_HAMOED$1 | LIGHT_CANDLES$2,
         chmDay: 4,
         emoji: emojiPesach,
     },
@@ -9989,7 +10024,7 @@ const staticHolidays = [
         mm: Nisan,
         dd: 21,
         desc: PESACH_VII,
-        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$2,
+        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$3,
         emoji: emojiPesach,
     },
     {
@@ -10005,7 +10040,7 @@ const staticHolidays = [
         mm: Sivan,
         dd: 5,
         desc: EREV_SHAVUOT,
-        flags: EREV$2 | LIGHT_CANDLES$1,
+        flags: EREV$2 | LIGHT_CANDLES$2,
         emoji: '⛰️🌸',
     },
     {
@@ -10019,7 +10054,7 @@ const staticHolidays = [
         mm: Sivan,
         dd: 6,
         desc: SHAVUOT_I,
-        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$2,
+        flags: CHUL_ONLY$1 | CHAG$1 | LIGHT_CANDLES_TZEIS$3,
         emoji: '⛰️🌸',
     },
     {
@@ -10041,7 +10076,7 @@ const staticHolidays = [
         mm: Elul,
         dd: 29,
         desc: EREV_ROSH_HASHANA,
-        flags: EREV$2 | LIGHT_CANDLES$1,
+        flags: EREV$2 | LIGHT_CANDLES$2,
         emoji: '🍏🍯',
     },
 ];
@@ -10328,20 +10363,22 @@ class DailyLearning {
 }
 
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-const version = '5.4.11';
+const version = '5.5.1';
 
 /* eslint-disable max-len */
+const LIGHT_CANDLES$1 = flags.LIGHT_CANDLES;
+const LIGHT_CANDLES_TZEIS$2 = flags.LIGHT_CANDLES_TZEIS;
 /**
  * @private
  */
 function makeCandleEvent(ev, hd, options, isFriday, isSaturday) {
     let havdalahTitle = false;
     let useHavdalahOffset = isSaturday;
-    let mask = ev ? ev.getFlags() : flags.LIGHT_CANDLES;
+    let mask = ev ? ev.getFlags() : LIGHT_CANDLES$1;
     if (typeof ev !== 'undefined') {
         // if linked event && dow == FRI, use Candle lighting time & title
         if (!isFriday) {
-            if (mask & (flags.LIGHT_CANDLES_TZEIS | flags.CHANUKAH_CANDLES)) {
+            if (mask & (LIGHT_CANDLES_TZEIS$2 | flags.CHANUKAH_CANDLES)) {
                 useHavdalahOffset = true;
             }
             else if (mask & flags.YOM_TOV_ENDS) {
@@ -10352,7 +10389,7 @@ function makeCandleEvent(ev, hd, options, isFriday, isSaturday) {
     }
     else if (isSaturday) {
         havdalahTitle = true;
-        mask = flags.LIGHT_CANDLES_TZEIS;
+        mask = LIGHT_CANDLES_TZEIS$2;
     }
     // if offset is 0 or undefined, we'll use tzeit time
     const offset = useHavdalahOffset
@@ -10371,6 +10408,7 @@ function makeCandleEvent(ev, hd, options, isFriday, isSaturday) {
         return new HavdalahEvent(hd, mask, time, location, options.havdalahMins, ev, options);
     }
     else {
+        mask |= LIGHT_CANDLES$1;
         return new CandleLightingEvent(hd, mask, time, location, ev, options);
     }
 }