@hebcal/core 3.33.7 → 3.34.0

package/dist/index.js

@@ -1,4 +1,4 @@
-/*! @hebcal/core v3.33.7 */
+/*! @hebcal/core v3.34.0 */
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -2042,18 +2042,12 @@ class HebrewDateEvent extends Event {
 
 }
 
-var sun = {};
-
-Object.defineProperty(sun, "__esModule", {
-  value: true
-});
-var Sun_1 = sun.Sun = void 0;
-
 class Sun {
   constructor(date, latitude, longitude) {
     this.date = date;
     this.latitude = latitude;
     this.longitude = longitude;
+
     this.julianDate = getJD(date);
   }
 
@@ -2064,11 +2058,8 @@ class Sun {
   timeAtAngle(angle, rising) {
     return calcSunriseSet(rising, angle, this.julianDate, this.date, this.latitude, this.longitude);
   }
-
 }
 
-Sun_1 = sun.Sun = Sun;
-
 function formatDate(date, minutes) {
   const seconds = (minutes - Math.floor(minutes)) * 60;
   return new Date(Date.UTC(date.getFullYear(), date.getMonth(), date.getDate(), 0, minutes, seconds));
@@ -2080,24 +2071,21 @@ function calcTimeJulianCent(jd) {
 }
 
 function radToDeg(angleRad) {
-  return 180.0 * angleRad / Math.PI;
+  return (180.0 * angleRad / Math.PI);
 }
 
 function degToRad(angleDeg) {
-  return Math.PI * angleDeg / 180.0;
+  return (Math.PI * angleDeg / 180.0);
 }
 
 function calcGeomMeanLongSun(t) {
-  let L0 = 280.46646 + t * (36000.76983 + t * 0.0003032);
-
+  let L0 = 280.46646 + t * (36000.76983 + t * (0.0003032));
   while (L0 > 360.0) {
     L0 -= 360.0;
   }
-
   while (L0 < 0.0) {
     L0 += 360.0;
   }
-
   return L0; // in degrees
 }
 
@@ -2136,8 +2124,8 @@ function calcSunApparentLong(t) {
 }
 
 function calcMeanObliquityOfEcliptic(t) {
-  const seconds = 21.448 - t * (46.8150 + t * (0.00059 - t * 0.001813));
-  const e0 = 23.0 + (26.0 + seconds / 60.0) / 60.0;
+  const seconds = 21.448 - t * (46.8150 + t * (0.00059 - t * (0.001813)));
+  const e0 = 23.0 + (26.0 + (seconds / 60.0)) / 60.0;
   return e0; // in degrees
 }
 
@@ -2151,6 +2139,7 @@ function calcObliquityCorrection(t) {
 function calcSunDeclination(t) {
   const e = calcObliquityCorrection(t);
   const lambda = calcSunApparentLong(t);
+
   const sint = Math.sin(degToRad(e)) * Math.sin(degToRad(lambda));
   const theta = radToDeg(Math.asin(sint));
   return theta; // in degrees
@@ -2161,13 +2150,16 @@ function calcEquationOfTime(t) {
   const l0 = calcGeomMeanLongSun(t);
   const e = calcEccentricityEarthOrbit(t);
   const m = calcGeomMeanAnomalySun(t);
+
   let y = Math.tan(degToRad(epsilon) / 2.0);
   y *= y;
+
   const sin2l0 = Math.sin(2.0 * degToRad(l0));
   const sinm = Math.sin(degToRad(m));
   const cos2l0 = Math.cos(2.0 * degToRad(l0));
   const sin4l0 = Math.sin(4.0 * degToRad(l0));
   const sin2m = Math.sin(2.0 * degToRad(m));
+
   const Etime = y * sin2l0 - 2.0 * e * sinm + 4.0 * e * y * sinm * cos2l0 - 0.5 * y * y * sin4l0 - 1.25 * e * e * sin2m;
   return radToDeg(Etime) * 4.0; // in minutes of time
 }
@@ -2175,7 +2167,7 @@ function calcEquationOfTime(t) {
 function calcHourAngle(angle, lat, solarDec) {
   const latRad = degToRad(lat);
   const sdRad = degToRad(solarDec);
-  const HAarg = Math.cos(degToRad(90 + angle)) / (Math.cos(latRad) * Math.cos(sdRad)) - Math.tan(latRad) * Math.tan(sdRad);
+  const HAarg = (Math.cos(degToRad(90 + angle)) / (Math.cos(latRad) * Math.cos(sdRad)) - Math.tan(latRad) * Math.tan(sdRad));
   const HA = Math.acos(HAarg);
   return HA; // in radians (for sunset, use -HA)
 }
@@ -2183,24 +2175,19 @@ function calcHourAngle(angle, lat, solarDec) {
 function isNumber(inputVal) {
   let oneDecimal = false;
   const inputStr = `${inputVal}`;
-
   for (let i = 0; i < inputStr.length; i++) {
     const oneChar = inputStr.charAt(i);
-
     if (i === 0 && (oneChar === '-' || oneChar === '+')) {
       continue;
     }
-
     if (oneChar === '.' && !oneDecimal) {
       oneDecimal = true;
       continue;
     }
-
     if (oneChar < '0' || oneChar > '9') {
       return false;
     }
   }
-
   return true;
 }
 
@@ -2208,7 +2195,6 @@ function getJD(date) {
   let year = date.getFullYear();
   let month = date.getMonth() + 1;
   const day = date.getDate();
-
   if (month < 3) {
     year--;
     month += 12;
@@ -2223,46 +2209,130 @@ function getJD(date) {
 function calcSolNoon(jd, longitude, date) {
   const tnoon = calcTimeJulianCent(jd - longitude / 360.0);
   let eqTime = calcEquationOfTime(tnoon);
-  const solNoonOffset = 720.0 - longitude * 4 - eqTime; // in minutes
-
+  const solNoonOffset = 720.0 - (longitude * 4) - eqTime; // in minutes
   const newt = calcTimeJulianCent(jd + solNoonOffset / 1440.0);
   eqTime = calcEquationOfTime(newt);
-  let solNoonLocal = 720 - longitude * 4 - eqTime; // in minutes
-
+  let solNoonLocal = 720 - (longitude * 4) - eqTime; // in minutes
   while (solNoonLocal < 0.0) {
     solNoonLocal += 1440.0;
   }
-
   while (solNoonLocal >= 1440.0) {
     solNoonLocal -= 1440.0;
   }
-
-  return formatDate(date, solNoonLocal); // return timeString(solNoonLocal, 3);
+  return formatDate(date, solNoonLocal);
+  // return timeString(solNoonLocal, 3);
 }
 
 function calcSunriseSetUTC(rise, angle, JD, latitude, longitude) {
   const t = calcTimeJulianCent(JD);
   const eqTime = calcEquationOfTime(t);
   const solarDec = calcSunDeclination(t);
-  let hourAngle = calcHourAngle(angle, latitude, solarDec); //alert("HA = " + radToDeg(hourAngle));
-
+  let hourAngle = calcHourAngle(angle, latitude, solarDec);
+  //alert("HA = " + radToDeg(hourAngle));
   if (!rise) hourAngle = -hourAngle;
   const delta = longitude + radToDeg(hourAngle);
-  const timeUTC = 720 - 4.0 * delta - eqTime; // in minutes
-
+  const timeUTC = 720 - (4.0 * delta) - eqTime; // in minutes
   return timeUTC;
 }
 
-function calcSunriseSet(rise, angle, JD, date, latitude, longitude) // rise = 1 for sunrise, 0 for sunset
-{
-  const timeUTC = calcSunriseSetUTC(rise, angle, JD, latitude, longitude);
-  const newTimeUTC = calcSunriseSetUTC(rise, angle, JD + timeUTC / 1440.0, latitude, longitude);
+function calcSunriseSet(rise, angle, JD, date, latitude, longitude)
+  // rise = 1 for sunrise, 0 for sunset
+  {
+    const timeUTC = calcSunriseSetUTC(rise, angle, JD, latitude, longitude);
+    const newTimeUTC = calcSunriseSetUTC(rise, angle, JD + timeUTC / 1440.0, latitude, longitude);
+    if (isNumber(newTimeUTC)) {
 
-  if (isNumber(newTimeUTC)) {
-    return formatDate(date, newTimeUTC);
-  } else {
-    // no sunrise/set found
-    return new Date(NaN);
+      return formatDate(date, newTimeUTC);
+
+    } else { // no sunrise/set found
+      return new Date(NaN);
+    }
+  }
+
+const degreesBelowHorizon = {
+  sunrise: 0.833,
+  sunriseEnd: 0.3,
+  twilight: 6,
+  nauticalTwilight: 12,
+  night: 18,
+  goldenHour: -6
+};
+
+class SolarCalc {
+  constructor(date, latitude, longitude) {
+    this.date = date;
+    this.lat = latitude;
+    this.longitude = longitude;
+
+    this.sun = new Sun(date, latitude, longitude);
+  }
+
+  get solarNoon() {
+    return this.sun.solarNoon;
+  }
+
+  get sunrise() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.sunrise, true);
+  }
+
+  get sunset() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.sunrise);
+  }
+
+  get sunriseEnd() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.sunriseEnd, true);
+  }
+
+  get sunsetStart() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.sunriseEnd, false);
+  }
+
+  get civilDawn() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.twilight, true);
+  }
+
+  get dawn() {
+    return this.civilDawn;
+  }
+
+  get civilDusk() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.twilight, false);
+  }
+
+  get dusk() {
+    return this.civilDusk;
+  }
+
+  get nauticalDawn() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.nauticalTwilight, true);
+  }
+
+  get nauticalDusk() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.nauticalTwilight, false);
+  }
+
+  get nightStart() {
+    return this.astronomicalDusk;
+  }
+
+  get astronomicalDusk() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.night, false);
+  }
+
+  get astronomicalDawn() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.night, true);
+  }
+
+  get nightEnd() {
+    return this.astronomicalDawn;
+  }
+
+  get goldenHourStart() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.goldenHour, false);
+  }
+
+  get goldenHourEnd() {
+    return this.sun.timeAtAngle(degreesBelowHorizon.goldenHour, true);
   }
 }
 
@@ -2402,7 +2472,8 @@ class Zmanim {
 
     const dt = greg.isDate(date) ? date : HDate.isHDate(date) ? date.greg() : throwTypeError$2(`invalid date: ${date}`);
     this.date = dt;
-    this.sun = new Sun_1(this.date, latitude, longitude);
+    this.solarCalc = new SolarCalc(this.date, latitude, longitude);
+    this.sun = this.solarCalc.sun;
     this.latitude = latitude;
     this.longitude = longitude;
   }
@@ -2414,48 +2485,60 @@ class Zmanim {
 
   suntime() {
     return {
-      solarNoon: this.sun.solarNoon,
+      solarNoon: this.solarCalc.solarNoon,
       sunrise: this.sunrise(),
       sunset: this.sunset(),
-      sunriseEnd: this.sun.timeAtAngle(0.3, true),
-      sunsetStart: this.sun.timeAtAngle(0.3, false),
+      sunriseEnd: this.solarCalc.sunriseEnd,
+      sunsetStart: this.solarCalc.sunsetStart,
       dawn: this.dawn(),
       dusk: this.dusk(),
-      nauticalDawn: this.sun.timeAtAngle(12, true),
-      nauticalDusk: this.sun.timeAtAngle(12, false),
-      nightEnd: this.sun.timeAtAngle(18, true),
-      night: this.sun.timeAtAngle(18, false),
-      goldenHourEnd: this.sun.timeAtAngle(-6, true),
-      goldenHour: this.sun.timeAtAngle(-6, false),
+      nauticalDawn: this.solarCalc.nauticalDawn,
+      nauticalDusk: this.solarCalc.nauticalDusk,
+      nightEnd: this.solarCalc.nightEnd,
+      night: this.solarCalc.nightStart,
+      goldenHourEnd: this.solarCalc.goldenHourEnd,
+      goldenHour: this.solarCalc.goldenHourStart,
       alotHaShachar: this.alotHaShachar(),
       misheyakir: this.misheyakir(),
       misheyakirMachmir: this.misheyakirMachmir(),
       tzeit: this.tzeit()
     };
   }
-  /** @return {Date} */
+  /**
+   * Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
+   * @return {Date}
+   */
 
 
   sunrise() {
     return this.sun.timeAtAngle(0.833333, true);
   }
-  /** @return {Date} */
+  /**
+   * When the upper edge of the Sun disappears below the horizon (0.833° below horizon)
+   * @return {Date}
+   */
 
 
   sunset() {
     return this.sun.timeAtAngle(0.833333, false);
   }
-  /** @return {Date} */
+  /**
+   * Civil dawn; Sun is 6° below the horizon in the morning
+   * @return {Date}
+   */
 
 
   dawn() {
-    return this.sun.timeAtAngle(6, true);
+    return this.solarCalc.dawn;
   }
-  /** @return {Date} */
+  /**
+   * Civil dusk; Sun is 6° below the horizon in the evening
+   * @return {Date}
+   */
 
 
   dusk() {
-    return this.sun.timeAtAngle(6, false);
+    return this.solarCalc.dusk;
   }
   /** @return {number} */
 
@@ -2501,63 +2584,121 @@ class Zmanim {
   hourOffset(hours) {
     return new Date(this.sunrise().getTime() + this.hour() * hours);
   }
-  /** @return {Date} */
+  /**
+   * Midday – Chatzot; Sunrise plus 6 halachic hours
+   * @return {Date}
+   */
 
 
   chatzot() {
     return this.hourOffset(6);
   }
-  /** @return {Date} */
+  /**
+   * Midnight – Chatzot; Sunset plus 6 halachic hours
+   * @return {Date}
+   */
 
 
   chatzotNight() {
     return new Date(this.sunrise().getTime() - this.nightHour() * 6);
   }
-  /** @return {Date} */
+  /**
+   * Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning
+   * @return {Date}
+   */
 
 
   alotHaShachar() {
     return this.sun.timeAtAngle(16.1, true);
   }
-  /** @return {Date} */
+  /**
+   * Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning
+   * @return {Date}
+   */
 
 
   misheyakir() {
     return this.sun.timeAtAngle(11.5, true);
   }
-  /** @return {Date} */
+  /**
+   * Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning
+   * @return {Date}
+   */
 
 
   misheyakirMachmir() {
     return this.sun.timeAtAngle(10.2, true);
   }
-  /** @return {Date} */
+  /**
+   * Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra
+   * @return {Date}
+   */
 
 
   sofZmanShma() {
     // Gra
     return this.hourOffset(3);
   }
-  /** @return {Date} */
+  /**
+   * Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra
+   * @return {Date}
+   */
 
 
   sofZmanTfilla() {
     // Gra
     return this.hourOffset(4);
   }
-  /** @return {Date} */
+  /**
+   * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham
+   * @return {Date}
+   */
+
+
+  sofZmanShmaMGA() {
+    // Magen Avraham
+    const alot72 = this.sunriseOffset(-72);
+    const tzeit72 = this.sunsetOffset(72);
+    const temporalHour = (tzeit72 - alot72) / 12; // ms in hour
+
+    return new Date(alot72.getTime() + 3 * temporalHour);
+  }
+  /**
+   * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham
+   * @return {Date}
+   */
+
+
+  sofZmanTfillaMGA() {
+    // Magen Avraham
+    const alot72 = this.sunriseOffset(-72);
+    const tzeit72 = this.sunsetOffset(72);
+    const temporalHour = (tzeit72 - alot72) / 12; // ms in hour
+
+    return new Date(alot72.getTime() + 4 * temporalHour);
+  }
+  /**
+   * Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours
+   * @return {Date}
+   */
 
 
   minchaGedola() {
     return this.hourOffset(6.5);
   }
-  /** @return {Date} */
+  /**
+   * Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours
+   * @return {Date}
+   */
 
 
   minchaKetana() {
     return this.hourOffset(9.5);
   }
-  /** @return {Date} */
+  /**
+   * Plag haMincha; Sunrise plus 10.75 halachic hours
+   * @return {Date}
+   */
 
 
   plagHaMincha() {
@@ -2573,13 +2714,19 @@ class Zmanim {
   tzeit(angle = 8.5) {
     return this.sun.timeAtAngle(angle, false);
   }
-  /** @return {Date} */
+  /**
+   * Alias for sunrise
+   * @return {Date}
+   */
 
 
   neitzHaChama() {
     return this.sunrise();
   }
-  /** @return {Date} */
+  /**
+   * Alias for sunset
+   * @return {Date}
+   */
 
 
   shkiah() {
@@ -2660,8 +2807,30 @@ class Zmanim {
     return getPseudoISO(tzid, date).substring(0, 19) + Zmanim.timeZoneOffset(tzid, date);
   }
   /**
-   * Returns sunset + offset (either positive or negative).
-   * @param {number} offset
+   * Returns sunrise + `offset` minutes (either positive or negative).
+   * @param {number} offset minutes
+   * @return {Date}
+   */
+
+
+  sunriseOffset(offset) {
+    const sunrise = this.sunrise();
+
+    if (isNaN(sunrise.getTime())) {
+      return sunrise;
+    } // For positive offsets only, round up to next minute if needed
+
+
+    if (offset > 0 && sunrise.getSeconds() >= 30) {
+      offset++;
+    }
+
+    sunrise.setSeconds(0);
+    return new Date(sunrise.getTime() + offset * 60 * 1000);
+  }
+  /**
+   * Returns sunset + `offset` minutes (either positive or negative).
+   * @param {number} offset minutes
    * @return {Date}
    */
 
@@ -5074,7 +5243,7 @@ function getBirthdayOrAnniversary_(hyear, gdate) {
   return new HDate(day, month, hyear);
 }
 
-var version="3.33.7";
+var version="3.34.0";
 
 var headers$1={"plural-forms":"nplurals=2; plural=(n > 1);",language:"en_CA@ashkenazi"};var contexts$1={"":{Berachot:["Berachos"],Shabbat:["Shabbos"],Taanit:["Taanis"],Yevamot:["Yevamos"],Ketubot:["Kesubos"],"Baba Batra":["Baba Basra"],Makkot:["Makkos"],Shevuot:["Shevuos"],Horayot:["Horayos"],Menachot:["Menachos"],Bechorot:["Bechoros"],Keritot:["Kerisos"],Midot:["Midos"],"Achrei Mot":["Achrei Mos"],Bechukotai:["Bechukosai"],"Beha'alotcha":["Beha'aloscha"],Bereshit:["Bereshis"],Chukat:["Chukas"],"Erev Shavuot":["Erev Shavuos"],"Erev Sukkot":["Erev Sukkos"],"Ki Tavo":["Ki Savo"],"Ki Teitzei":["Ki Seitzei"],"Ki Tisa":["Ki Sisa"],Matot:["Matos"],"Purim Katan":["Purim Koton"],Tazria:["Sazria"],"Shabbat Chazon":["Shabbos Chazon"],"Shabbat HaChodesh":["Shabbos HaChodesh"],"Shabbat HaGadol":["Shabbos HaGadol"],"Shabbat Nachamu":["Shabbos Nachamu"],"Shabbat Parah":["Shabbos Parah"],"Shabbat Shekalim":["Shabbos Shekalim"],"Shabbat Shuva":["Shabbos Shuvah"],"Shabbat Zachor":["Shabbos Zachor"],Shavuot:["Shavuos"],"Shavuot I":["Shavuos I"],"Shavuot II":["Shavuos II"],Shemot:["Shemos"],"Shmini Atzeret":["Shmini Atzeres"],"Simchat Torah":["Simchas Torah"],Sukkot:["Sukkos"],"Sukkot I":["Sukkos I"],"Sukkot II":["Sukkos II"],"Sukkot II (CH''M)":["Sukkos II (CH''M)"],"Sukkot III (CH''M)":["Sukkos III (CH''M)"],"Sukkot IV (CH''M)":["Sukkos IV (CH''M)"],"Sukkot V (CH''M)":["Sukkos V (CH''M)"],"Sukkot VI (CH''M)":["Sukkos VI (CH''M)"],"Sukkot VII (Hoshana Raba)":["Sukkos VII (Hoshana Raba)"],"Ta'anit Bechorot":["Ta'anis Bechoros"],"Ta'anit Esther":["Ta'anis Esther"],Toldot:["Toldos"],Vaetchanan:["Vaeschanan"],Yitro:["Yisro"],"Vezot Haberakhah":["Vezos Haberakhah"],Parashat:["Parshas"],"Leil Selichot":["Leil Selichos"],"Shabbat Mevarchim Chodesh":["Shabbos Mevorchim Chodesh"],"Shabbat Shirah":["Shabbos Shirah"],Tevet:["Teves"],"Asara B'Tevet":["Asara B'Teves"],Berakhot:["Berakhos"],Sheviit:["Sheviis"],Terumot:["Terumos"],Maasrot:["Maasros"],Eduyot:["Eduyos"],Avot:["Avos"],Bekhorot:["Bekhoros"],Middot:["Middos"],Oholot:["Oholos"],Tahorot:["Tahoros"],Mikvaot:["Mikvaos"]}};var poAshkenazi = {headers:headers$1,contexts:contexts$1};