@hebcal/core 5.0.5 → 5.0.7

package/dist/index.cjs

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.0.5 */
+/*! @hebcal/core v5.0.7 */
 'use strict';
 
 /** @private */
@@ -3706,27 +3706,68 @@ class Zmanim {
     return this.getShaahZmanisBasedZman(4);
   }
   /**
-   * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham
+   * Returns an array with alot (Date) and ms in hour (number)
+   * @private
+   * @return {any[]}
+   */
+  getTemporalHour72() {
+    const alot72 = this.sunriseOffset(-72, false, true);
+    const tzeit72 = this.sunsetOffset(72, false, true);
+    const temporalHour = (tzeit72 - alot72) / 12;
+    return [alot72, temporalHour];
+  }
+  /**
+   * Returns an array with alot (Date) and ms in hour (number)
+   * @private
+   * @return {any[]}
+   */
+  getTemporalHour16Point1() {
+    const alot16one = this.alotHaShachar();
+    const tzeit16one = this.tzeit(16.1);
+    const temporalHour = (tzeit16one - alot16one) / 12;
+    return [alot16one, temporalHour];
+  }
+  /**
+   * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
+   * Based on the opinion of the MGA that the day is calculated from
+   * dawn being fixed 72 minutes before sea-level sunrise, and nightfall is fixed
+   * 72 minutes after sea-level sunset.
    * @return {Date}
    */
   sofZmanShmaMGA() {
     // Magen Avraham
-    const alot72 = this.sunriseOffset(-72, false, true);
-    const tzeit72 = this.sunsetOffset(72, false, true);
-    const temporalHour = (tzeit72 - alot72) / 12; // ms in hour
+    const [alot72, temporalHour] = this.getTemporalHour72();
     return new Date(alot72.getTime() + 3 * temporalHour);
   }
+  /**
+   * Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham.
+   * Based on the opinion of the MGA that the day is calculated from
+   * dawn to nightfall with both being 16.1° below the horizon.
+   * @return {Date}
+   */
+  sofZmanShmaMGA16Point1() {
+    const [alot, temporalHour] = this.getTemporalHour16Point1();
+    return new Date(alot.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, false, true);
-    const tzeit72 = this.sunsetOffset(72, false, true);
-    const temporalHour = (tzeit72 - alot72) / 12; // ms in hour
+    const [alot72, temporalHour] = this.getTemporalHour72();
     return new Date(alot72.getTime() + 4 * temporalHour);
   }
+  /**
+   * Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham.
+   * Based on the opinion of the MGA that the day is calculated from
+   * dawn to nightfall with both being 16.1° below the horizon.
+   * @return {Date}
+   */
+  sofZmanTfillaMGA16Point1() {
+    const [alot, temporalHour] = this.getTemporalHour16Point1();
+    return new Date(alot.getTime() + 4 * temporalHour);
+  }
   /**
    * Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours
    * @return {Date}
@@ -3879,6 +3920,54 @@ class Zmanim {
   }
 }
 
+const hour12cc = {
+  US: 1,
+  CA: 1,
+  BR: 1,
+  AU: 1,
+  NZ: 1,
+  DO: 1,
+  PR: 1,
+  GR: 1,
+  IN: 1,
+  KR: 1,
+  NP: 1,
+  ZA: 1
+};
+
+/**
+ * @private
+ * @param {string} timeStr - original time like "20:30"
+ * @param {string} suffix - "p" or "pm" or " P.M.". Add leading space if you want it
+ * @param {CalOptions} options
+ * @return {string}
+ */
+function reformatTimeStr(timeStr, suffix, options) {
+  var _options$location;
+  if (typeof timeStr !== 'string') throw new TypeError(`Bad timeStr: ${timeStr}`);
+  const cc = (options === null || options === void 0 || (_options$location = options.location) === null || _options$location === void 0 ? void 0 : _options$location.cc) || (options !== null && options !== void 0 && options.il ? 'IL' : 'US');
+  const hour12 = options === null || options === void 0 ? void 0 : options.hour12;
+  if (typeof hour12 !== 'undefined' && !hour12) {
+    return timeStr;
+  }
+  if (!hour12 && typeof hour12cc[cc] === 'undefined') {
+    return timeStr;
+  }
+  const hm = timeStr.split(':');
+  let hour = parseInt(hm[0], 10);
+  if (hour < 12 && suffix) {
+    suffix = suffix.replace('p', 'a').replace('P', 'A');
+    if (hour === 0) {
+      hour = 12;
+    }
+  } else if (hour > 12) {
+    hour = hour % 12;
+  } else if (hour === 0) {
+    hour = '00';
+  }
+  return `${hour}:${hm[1]}${suffix}`;
+}
+
 /* eslint-disable max-len */
 const FRI$3 = 5;
 const SAT$3 = 6;
@@ -3888,11 +3977,10 @@ const SAT$3 = 6;
  * @param {Event} e
  * @param {HDate} hd
  * @param {number} dow
- * @param {Location} location
  * @param {CalOptions} options
  * @return {Event}
  */
-function makeCandleEvent(e, hd, dow, location, options) {
+function makeCandleEvent(e, hd, dow, options) {
   let havdalahTitle = false;
   let useHavdalahOffset = dow === SAT$3;
   let mask = e ? e.getFlags() : flags.LIGHT_CANDLES;
@@ -3912,15 +4000,16 @@ function makeCandleEvent(e, hd, dow, location, options) {
   }
   // if offset is 0 or undefined, we'll use tzeit time
   const offset = useHavdalahOffset ? options.havdalahMins : options.candleLightingMins;
+  const location = options.location;
   const zmanim = new Zmanim(location, hd, options.useElevation);
   const time = offset ? zmanim.sunsetOffset(offset, true) : zmanim.tzeit(options.havdalahDeg);
   if (isNaN(time.getTime())) {
     return null; // no sunset
   }
   if (havdalahTitle) {
-    return new HavdalahEvent(hd, mask, time, location, options.havdalahMins, e);
+    return new HavdalahEvent(hd, mask, time, location, options.havdalahMins, e, options);
   } else {
-    return new CandleLightingEvent(hd, mask, time, location, e);
+    return new CandleLightingEvent(hd, mask, time, location, e, options);
   }
 }
 
@@ -3933,13 +4022,18 @@ class TimedEvent extends Event {
    * @param {Date} eventTime
    * @param {Location} location
    * @param {Event} linkedEvent
+   * @param {CalOptions} options
    */
-  constructor(date, desc, mask, eventTime, location, linkedEvent) {
+  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 = Object.assign({
+      location
+    }, options);
+    this.fmtTime = reformatTimeStr(this.eventTimeStr, 'pm', opts);
     if (typeof linkedEvent !== 'undefined') {
       this.linkedEvent = linkedEvent;
     }
@@ -3949,7 +4043,7 @@ class TimedEvent extends Event {
    * @return {string}
    */
   render(locale) {
-    return Locale.gettext(this.getDesc(), locale) + ': ' + this.eventTimeStr;
+    return Locale.gettext(this.getDesc(), locale) + ': ' + this.fmtTime;
   }
   /**
    * Returns translation of "Candle lighting" without the time.
@@ -3986,9 +4080,10 @@ class HavdalahEvent extends TimedEvent {
    * @param {Location} location
    * @param {number} havdalahMins
    * @param {Event} linkedEvent
+   * @param {CalOptions} options
    */
-  constructor(date, mask, eventTime, location, havdalahMins, linkedEvent) {
-    super(date, 'Havdalah', mask, eventTime, location, linkedEvent);
+  constructor(date, mask, eventTime, location, havdalahMins, linkedEvent, options) {
+    super(date, 'Havdalah', mask, eventTime, location, linkedEvent, options);
     if (havdalahMins) {
       this.havdalahMins = havdalahMins;
     }
@@ -3998,7 +4093,7 @@ class HavdalahEvent extends TimedEvent {
    * @return {string}
    */
   render(locale) {
-    return this.renderBrief(locale) + ': ' + this.eventTimeStr;
+    return this.renderBrief(locale) + ': ' + this.fmtTime;
   }
   /**
    * Returns translation of "Havdalah" without the time.
@@ -4027,9 +4122,10 @@ class CandleLightingEvent extends TimedEvent {
    * @param {Date} eventTime
    * @param {Location} location
    * @param {Event} linkedEvent
+   * @param {CalOptions} options
    */
-  constructor(date, mask, eventTime, location, linkedEvent) {
-    super(date, 'Candle lighting', mask, eventTime, location, linkedEvent);
+  constructor(date, mask, eventTime, location, linkedEvent, options) {
+    super(date, 'Candle lighting', mask, eventTime, location, linkedEvent, options);
   }
   /** @return {string} */
   getEmoji() {
@@ -4057,14 +4153,14 @@ function makeFastStartEnd(ev, options) {
   const zmanim = new Zmanim(location, dt, options.useElevation);
   if (desc === 'Erev Tish\'a B\'Av') {
     const sunset = zmanim.sunset();
-    ev.startEvent = makeTimedEvent(hd, sunset, 'Fast begins', ev, location);
+    ev.startEvent = makeTimedEvent(hd, sunset, 'Fast begins', ev, options);
   } else if (desc.startsWith('Tish\'a B\'Av')) {
-    ev.endEvent = makeTimedEvent(hd, zmanim.tzeit(fastEndDeg), 'Fast ends', ev, location);
+    ev.endEvent = makeTimedEvent(hd, zmanim.tzeit(fastEndDeg), 'Fast ends', ev, options);
   } else {
     const dawn = zmanim.alotHaShachar();
-    ev.startEvent = makeTimedEvent(hd, dawn, 'Fast begins', ev, location);
+    ev.startEvent = makeTimedEvent(hd, dawn, 'Fast begins', ev, options);
     if (dt.getDay() !== 5 && !(hd.getDate() === 14 && hd.getMonth() === months.NISAN)) {
-      ev.endEvent = makeTimedEvent(hd, zmanim.tzeit(fastEndDeg), 'Fast ends', ev, location);
+      ev.endEvent = makeTimedEvent(hd, zmanim.tzeit(fastEndDeg), 'Fast ends', ev, options);
     }
   }
   return ev;
@@ -4076,14 +4172,15 @@ function makeFastStartEnd(ev, options) {
  * @param {Date} time
  * @param {string} desc
  * @param {Event} ev
- * @param {Location} location
+ * @param {CalOptions} options
  * @return {TimedEvent}
  */
-function makeTimedEvent(hd, time, desc, ev, location) {
+function makeTimedEvent(hd, time, desc, ev, options) {
   if (isNaN(time.getTime())) {
     return null;
   }
-  return new TimedEvent(hd, desc, ev.getFlags(), time, location, ev);
+  const location = options.location;
+  return new TimedEvent(hd, desc, ev.getFlags(), time, location, ev, options);
 }
 
 /**
@@ -4099,7 +4196,7 @@ function makeWeekdayChanukahCandleLighting(ev, hd, options) {
   const zmanim = new Zmanim(location, hd.greg(), options.useElevation);
   const candleLightingTime = zmanim.dusk();
   // const candleLightingTime = zmanim.tzeit(4.6667);
-  return makeTimedEvent(hd, candleLightingTime, ev.getDesc(), ev, location);
+  return makeTimedEvent(hd, candleLightingTime, ev.getDesc(), ev, options);
 }
 
 /* eslint-disable camelcase */
@@ -4187,6 +4284,33 @@ class Molad {
   getChalakim() {
     return this.chalakim;
   }
+  /**
+   * @param {string} [locale] Optional locale name (defaults to active locale)
+   * @param {CalOptions} options
+   * @return {string}
+   */
+  render(locale, options) {
+    locale = locale || Locale.getLocaleName();
+    if (typeof locale === 'string') {
+      locale = locale.toLowerCase();
+    }
+    const isHebrewLocale = locale === 'he' || locale === 'he-x-nonikud' || locale === 'h';
+    const monthName = Locale.gettext(this.getMonthName(), locale);
+    const dayNames = isHebrewLocale ? heDayNames : shortDayNames;
+    const dow = dayNames[this.getDow()];
+    const minutes = this.getMinutes();
+    const hour = this.getHour();
+    const chalakim = this.getChalakim();
+    const moladStr = Locale.gettext('Molad', locale);
+    const minutesStr = Locale.lookupTranslation('min', locale) || 'minutes';
+    const chalakimStr = Locale.gettext('chalakim', locale);
+    if (isHebrewLocale) {
+      const ampm = hour < 5 ? night : hour < 12 ? morning : hour < 17 ? afternoon : hour < 21 ? evening : night;
+      return `${moladStr} ${monthName} יִהְיֶה בַּיּוֹם ${dow} בשָׁבוּעַ, ` + `בְּשָׁעָה ${hour} ${ampm}, ` + `ו-${minutes} ${minutesStr} ` + `ו-${chalakim} ${chalakimStr}`;
+    }
+    const fmtTime = reformatTimeStr(`${hour}:00`, 'pm', options);
+    return `${moladStr} ${monthName}: ${dow}, ${minutes} ${minutesStr} and ${chalakim} ${chalakimStr} after ${fmtTime}`;
+  }
 }
 
 /** Represents a Molad announcement on Shabbat Mevarchim */
@@ -4195,38 +4319,21 @@ class MoladEvent extends Event {
    * @param {HDate} date Hebrew date event occurs
    * @param {number} hyear molad year
    * @param {number} hmonth molad month
+   * @param {CalOptions} options
    */
-  constructor(date, hyear, hmonth) {
+  constructor(date, hyear, hmonth, options) {
     const m = new Molad(hyear, hmonth);
     const monthName = m.getMonthName();
     super(date, `Molad ${monthName} ${hyear}`, flags.MOLAD);
     this.molad = m;
+    this.options = options;
   }
   /**
    * @param {string} [locale] Optional locale name (defaults to active locale).
    * @return {string}
    */
   render(locale) {
-    const m = this.molad;
-    locale = locale || Locale.getLocaleName();
-    if (typeof locale === 'string') {
-      locale = locale.toLowerCase();
-    }
-    const isHebrewLocale = locale === 'he' || locale === 'he-x-nonikud' || locale === 'h';
-    const monthName = Locale.gettext(m.getMonthName(), locale);
-    const dayNames = isHebrewLocale ? heDayNames : shortDayNames;
-    const dow = dayNames[m.getDow()];
-    const minutes = m.getMinutes();
-    const hour = m.getHour();
-    const chalakim = m.getChalakim();
-    const moladStr = Locale.gettext('Molad', locale);
-    const minutesStr = Locale.lookupTranslation('min', locale) || 'minutes';
-    const chalakimStr = Locale.gettext('chalakim', locale);
-    if (isHebrewLocale) {
-      const ampm = hour < 5 ? night : hour < 12 ? morning : hour < 17 ? afternoon : hour < 21 ? evening : night;
-      return `${moladStr} ${monthName} יִהְיֶה בַּיּוֹם ${dow} בשָׁבוּעַ, ` + `בְּשָׁעָה ${hour} ${ampm}, ` + `ו-${minutes} ${minutesStr} ` + `ו-${chalakim} ${chalakimStr}`;
-    }
-    return `${moladStr} ${monthName}: ${dow}, ${minutes} ${minutesStr} and ${chalakim} ${chalakimStr} after ${hour}:00`;
+    return this.molad.render(locale, this.options);
   }
 }
 
@@ -5809,8 +5916,10 @@ class MevarchimChodeshEvent extends Event {
     const hyear = date.getFullYear();
     const hmonth = date.getMonth();
     const monNext = hmonth == HDate.monthsInYear(hyear) ? NISAN$1 : hmonth + 1;
-    const molad = new MoladEvent(date, hyear, monNext);
-    this.memo = molad.render('en');
+    const molad = new Molad(hyear, monNext);
+    this.memo = molad.render('en', {
+      hour12: false
+    });
   }
   /** @return {string} */
   basename() {
@@ -6164,7 +6273,7 @@ class DailyLearning {
 }
 
 // DO NOT EDIT THIS AUTO-GENERATED FILE!
-const version = '5.0.5';
+const version = '5.0.7';
 
 const NONE$1 = 0;
 const HALF = 1;
@@ -7118,20 +7227,6 @@ function getMaskFromOptions(options) {
 }
 const MASK_LIGHT_CANDLES = LIGHT_CANDLES | LIGHT_CANDLES_TZEIS | CHANUKAH_CANDLES | YOM_TOV_ENDS;
 const defaultLocation = new Location(0, 0, false, 'UTC');
-const hour12cc = {
-  US: 1,
-  CA: 1,
-  BR: 1,
-  AU: 1,
-  NZ: 1,
-  DO: 1,
-  PR: 1,
-  GR: 1,
-  IN: 1,
-  KR: 1,
-  NP: 1,
-  ZA: 1
-};
 
 /**
  * @private
@@ -7386,10 +7481,10 @@ class HebrewCalendar {
       const hmonth = hd.getMonth();
       if (options.molad && dow == SAT && hmonth != ELUL && hd.getDate() >= 23 && hd.getDate() <= 29) {
         const monNext = hmonth == HDate.monthsInYear(hyear) ? NISAN : hmonth + 1;
-        evts.push(new MoladEvent(hd, hyear, monNext));
+        evts.push(new MoladEvent(hd, hyear, monNext, options));
       }
       if (!candlesEv && options.candlelighting && (dow == FRI || dow == SAT)) {
-        candlesEv = makeCandleEvent(undefined, hd, dow, location, options);
+        candlesEv = makeCandleEvent(undefined, hd, dow, options);
         if (dow === FRI && candlesEv && sedra) {
           candlesEv.memo = sedra.getString(abs);
         }
@@ -7556,28 +7651,7 @@ class HebrewCalendar {
    * @return {string}
    */
   static reformatTimeStr(timeStr, suffix, options) {
-    var _options$location2;
-    if (typeof timeStr !== 'string') throw new TypeError(`Bad timeStr: ${timeStr}`);
-    const cc = ((_options$location2 = options.location) === null || _options$location2 === void 0 ? void 0 : _options$location2.cc) || (options.il ? 'IL' : 'US');
-    if (typeof options.hour12 !== 'undefined' && !options.hour12) {
-      return timeStr;
-    }
-    if (!options.hour12 && typeof hour12cc[cc] === 'undefined') {
-      return timeStr;
-    }
-    const hm = timeStr.split(':');
-    let hour = parseInt(hm[0], 10);
-    if (hour < 12 && suffix) {
-      suffix = suffix.replace('p', 'a').replace('P', 'A');
-      if (hour === 0) {
-        hour = 12;
-      }
-    } else if (hour > 12) {
-      hour = hour % 12;
-    } else if (hour === 0) {
-      hour = '00';
-    }
-    return `${hour}:${hm[1]}${suffix}`;
+    return reformatTimeStr(timeStr, suffix, options);
   }
 
   /** @return {string} */
@@ -7676,7 +7750,7 @@ function appendHolidayAndRelated(events, ev, options, candlesEv, dow) {
   if (eFlags & options.mask || !eFlags && !options.userMask) {
     if (options.candlelighting && eFlags & MASK_LIGHT_CANDLES) {
       const hd = ev.getDate();
-      candlesEv = makeCandleEvent(ev, hd, dow, location, options);
+      candlesEv = makeCandleEvent(ev, hd, dow, options);
       if (eFlags & CHANUKAH_CANDLES && candlesEv && !options.noHolidays) {
         const chanukahEv = dow === FRI || dow === SAT ? candlesEv : makeWeekdayChanukahCandleLighting(ev, hd, options);
         const attrs = {