@hebcal/core 5.4.10 → 5.5.0

package/dist/index.cjs

@@ -1,4 +1,4 @@
-/*! @hebcal/core v5.4.10 */
+/*! @hebcal/core v5.5.0 */
 'use strict';
 
 /* eslint-disable @typescript-eslint/no-namespace, no-inner-declarations */
@@ -145,15 +145,15 @@ exports.greg.isLeapYear = isGregLeapYear;
  */
 const NISAN$4 = 1;
 const IYYAR$1 = 2;
-// const SIVAN = 3;
+const SIVAN$1 = 3;
 const TAMUZ$1 = 4;
-// const AV = 5;
+const AV$1 = 5;
 const ELUL$1 = 6;
 const TISHREI$3 = 7;
 const CHESHVAN$1 = 8;
 const KISLEV$2 = 9;
 const TEVET$2 = 10;
-// const SHVAT = 11;
+const SHVAT$1 = 11;
 const ADAR_I$2 = 12;
 const ADAR_II$2 = 13;
 /**
@@ -163,31 +163,31 @@ const ADAR_II$2 = 13;
  */
 const months = {
     /** Nissan / ניסן */
-    NISAN: 1,
+    NISAN: NISAN$4,
     /** Iyyar / אייר */
-    IYYAR: 2,
+    IYYAR: IYYAR$1,
     /** Sivan / סיון */
-    SIVAN: 3,
+    SIVAN: SIVAN$1,
     /** Tamuz (sometimes Tammuz) / תמוז */
-    TAMUZ: 4,
+    TAMUZ: TAMUZ$1,
     /** Av / אב */
-    AV: 5,
+    AV: AV$1,
     /** Elul / אלול */
-    ELUL: 6,
+    ELUL: ELUL$1,
     /** Tishrei / תִּשְׁרֵי */
-    TISHREI: 7,
+    TISHREI: TISHREI$3,
     /** Cheshvan / חשון */
-    CHESHVAN: 8,
+    CHESHVAN: CHESHVAN$1,
     /** Kislev / כסלו */
-    KISLEV: 9,
+    KISLEV: KISLEV$2,
     /** Tevet / טבת */
-    TEVET: 10,
+    TEVET: TEVET$2,
     /** Sh'vat / שבט */
-    SHVAT: 11,
+    SHVAT: SHVAT$1,
     /** Adar or Adar Rishon / אדר */
-    ADAR_I: 12,
+    ADAR_I: ADAR_I$2,
     /** Adar Sheini (only on leap years) / אדר ב׳ */
-    ADAR_II: 13,
+    ADAR_II: ADAR_II$2,
 };
 const monthNames0 = [
     '',
@@ -447,73 +447,73 @@ function monthFromName(monthName) {
             if (c[1] === 'o') {
                 break; /* this catches "november" */
             }
-            return months.NISAN;
+            return NISAN$4;
         case 'i':
-            return months.IYYAR;
+            return IYYAR$1;
         case 'e':
-            return months.ELUL;
+            return ELUL$1;
         case 'c':
         case 'ח':
-            return months.CHESHVAN;
+            return CHESHVAN$1;
         case 'k':
         case 'כ':
-            return months.KISLEV;
+            return KISLEV$2;
         case 's':
             switch (c[1]) {
                 case 'i':
-                    return months.SIVAN;
+                    return SIVAN$1;
                 case 'h':
-                    return months.SHVAT;
+                    return SHVAT$1;
             }
             break;
         case 't':
             switch (c[1]) {
                 case 'a':
-                    return months.TAMUZ;
+                    return TAMUZ$1;
                 case 'i':
-                    return months.TISHREI;
+                    return TISHREI$3;
                 case 'e':
-                    return months.TEVET;
+                    return TEVET$2;
             }
             break;
         case 'a':
             switch (c[1]) {
                 case 'v':
-                    return months.AV;
+                    return AV$1;
                 case 'd':
                     if (/(1|[^i]i|a|א)$/i.test(monthName)) {
-                        return months.ADAR_I;
+                        return ADAR_I$2;
                     }
-                    return months.ADAR_II; // else assume sheini
+                    return ADAR_II$2; // else assume sheini
             }
             break;
         case 'ס':
-            return months.SIVAN;
+            return SIVAN$1;
         case 'ט':
-            return months.TEVET;
+            return TEVET$2;
         case 'ש':
-            return months.SHVAT;
+            return SHVAT$1;
         case 'א':
             switch (c[1]) {
                 case 'ב':
-                    return months.AV;
+                    return AV$1;
                 case 'ד':
                     if (/(1|[^i]i|a|א)$/i.test(monthName)) {
-                        return months.ADAR_I;
+                        return ADAR_I$2;
                     }
-                    return months.ADAR_II; // else assume sheini
+                    return ADAR_II$2; // else assume sheini
                 case 'י':
-                    return months.IYYAR;
+                    return IYYAR$1;
                 case 'ל':
-                    return months.ELUL;
+                    return ELUL$1;
             }
             break;
         case 'ת':
             switch (c[1]) {
                 case 'מ':
-                    return months.TAMUZ;
+                    return TAMUZ$1;
                 case 'ש':
-                    return months.TISHREI;
+                    return TISHREI$3;
             }
             break;
     }
@@ -545,15 +545,13 @@ function toSimpleHebrewDate(obj) {
     if (isSimpleHebrewDate$1(obj)) {
         return obj;
     }
-    else if (typeof obj === 'number') {
-        return abs2hebrew(obj);
-    }
     else if (isDate(obj)) {
         const abs = greg2abs(obj);
         return abs2hebrew(abs);
     }
     else {
-        throw new TypeError(`Argument not a Date: ${obj}`);
+        // typeof obj === 'number'
+        return abs2hebrew(obj);
     }
 }
 function getYahrzeitHD(hyear, date) {
@@ -700,8 +698,8 @@ function num2digits(num) {
 function gematriya(num) {
     const num0 = num;
     const num1 = parseInt(num0, 10);
-    if (!num1) {
-        throw new TypeError(`invalid parameter to gematriya ${num}`);
+    if (!num1 || num1 < 0) {
+        throw new TypeError(`invalid gematriya number: ${num}`);
     }
     let str = '';
     const thousands = Math.floor(num1 / 1000);
@@ -1006,6 +1004,38 @@ function molad(year, month) {
     };
 }
 
+/**
+ * Formats a number with leading zeros so the resulting string is 4 digits long.
+ * Similar to `string.padStart(4, '0')` but will also format
+ * negative numbers similar to how the JavaScript date formats
+ * negative year numbers (e.g. `-37` is formatted as `-000037`).
+ */
+function pad4(num) {
+    if (num < 0) {
+        return '-00' + pad4(-num);
+    }
+    else if (num < 10) {
+        return '000' + num;
+    }
+    else if (num < 100) {
+        return '00' + num;
+    }
+    else if (num < 1000) {
+        return '0' + num;
+    }
+    return String(num);
+}
+/**
+ * Formats a number with leading zeros so the resulting string is 2 digits long.
+ * Similar to `string.padStart(2, '0')`.
+ */
+function pad2(num) {
+    if (num >= 0 && num < 10) {
+        return '0' + num;
+    }
+    return String(num);
+}
+
 const _formatters = new Map();
 /**
  * @private
@@ -1055,37 +1085,6 @@ function getTimezoneOffset(tzid, date) {
     const diffMs = new Date(utcStr).getTime() - new Date(localStr).getTime();
     return Math.ceil(diffMs / 1000 / 60);
 }
-/**
- * Formats a number with leading zeros so the resulting string is 4 digits long.
- * Similar to `string.padStart(4, '0')` but will also format
- * negative numbers similar to how the JavaScript date formats
- * negative year numbers (e.g. `-37` is formatted as `-000037`).
- */
-function pad4(number) {
-    if (number < 0) {
-        return '-00' + pad4(-number);
-    }
-    else if (number < 10) {
-        return '000' + number;
-    }
-    else if (number < 100) {
-        return '00' + number;
-    }
-    else if (number < 1000) {
-        return '0' + number;
-    }
-    return String(number);
-}
-/**
- * Formats a number with leading zeros so the resulting string is 2 digits long.
- * Similar to `string.padStart(2, '0')`.
- */
-function pad2(number) {
-    if (number < 10) {
-        return '0' + number;
-    }
-    return String(number);
-}
 /**
  * Returns YYYY-MM-DD in the local timezone
  */
@@ -1117,6 +1116,28 @@ const locales = new Map();
 let activeLocale;
 /** @private */
 let activeName;
+/** @private */
+function getEnOrdinal(n) {
+    const s = ['th', 'st', 'nd', 'rd'];
+    const v = n % 100;
+    return n + (s[(v - 20) % 10] || s[v] || s[0]);
+}
+/** @private */
+function checkLocale(locale) {
+    if (typeof locale !== 'string') {
+        throw new TypeError(`Invalid locale name: ${locale}`);
+    }
+    return locale.toLowerCase();
+}
+/** @private */
+function getExistingLocale(locale) {
+    const locale1 = checkLocale(locale);
+    const loc = locales.get(locale1);
+    if (!loc) {
+        throw new RangeError(`Locale '${locale}' not found`);
+    }
+    return loc;
+}
 /**
  * A locale in Hebcal is used for translations/transliterations of
  * holidays. `@hebcal/hdate` supports four locales by default
@@ -1159,14 +1180,12 @@ class Locale {
      * @param data parsed data from a `.po` file.
      */
     static addLocale(locale, data) {
-        if (typeof locale !== 'string') {
-            throw new TypeError(`Invalid locale name: ${locale}`);
-        }
+        locale = checkLocale(locale);
         if (typeof data.contexts !== 'object' ||
             typeof data.contexts[''] !== 'object') {
             throw new TypeError(`Locale '${locale}' invalid compact format`);
         }
-        locales.set(locale.toLowerCase(), data.contexts['']);
+        locales.set(locale, data.contexts['']);
     }
     /**
      * Adds a translation to `locale`, replacing any previous translation.
@@ -1175,15 +1194,9 @@ class Locale {
      * @param translation Translation text
      */
     static addTranslation(locale, id, translation) {
-        if (typeof locale !== 'string') {
-            throw new TypeError(`Invalid locale name: ${locale}`);
-        }
-        const loc = locales.get(locale.toLowerCase());
-        if (!loc) {
-            throw new TypeError(`Unknown locale: ${locale}`);
-        }
+        const loc = getExistingLocale(locale);
         if (typeof id !== 'string' || id.length === 0) {
-            throw new TypeError(`Invalid id: ${id}`);
+            throw new TypeError(`Invalid id string: ${id}`);
         }
         const isArray = Array.isArray(translation);
         if (isArray) {
@@ -1193,7 +1206,7 @@ class Locale {
             }
         }
         else if (typeof translation !== 'string') {
-            throw new TypeError(`Invalid translation: ${translation}`);
+            throw new TypeError(`Invalid translation string: ${translation}`);
         }
         loc[id] = isArray ? translation : [translation];
     }
@@ -1203,13 +1216,7 @@ class Locale {
      * @param data parsed data from a `.po` file.
      */
     static addTranslations(locale, data) {
-        if (typeof locale !== 'string') {
-            throw new TypeError(`Invalid locale name: ${locale}`);
-        }
-        const loc = locales.get(locale.toLowerCase());
-        if (!loc) {
-            throw new TypeError(`Unknown locale: ${locale}`);
-        }
+        const loc = getExistingLocale(locale);
         if (typeof data.contexts !== 'object' ||
             typeof data.contexts[''] !== 'object') {
             throw new TypeError(`Locale '${locale}' invalid compact format`);
@@ -1224,11 +1231,8 @@ class Locale {
      * @param locale Locale name (i.e: `'he'`, `'fr'`)
      */
     static useLocale(locale) {
-        const locale0 = locale.toLowerCase();
-        const obj = locales.get(locale0);
-        if (!obj) {
-            throw new RangeError(`Locale '${locale}' not found`);
-        }
+        const locale0 = checkLocale(locale);
+        const obj = getExistingLocale(locale0);
         activeName = alias[locale0] || locale0;
         activeLocale = obj;
         return activeLocale;
@@ -1254,31 +1258,24 @@ class Locale {
         const locale1 = locale === null || locale === void 0 ? void 0 : locale.toLowerCase();
         const locale0 = locale1 || activeName;
         if (!locale0) {
-            return this.getEnOrdinal(n);
+            return getEnOrdinal(n);
         }
         switch (locale0) {
             case 'en':
             case 's':
             case 'a':
-            case 'ashkenazi':
-            case 'ashkenazi_litvish':
-            case 'ashkenazi_poylish':
-            case 'ashkenazi_standard':
-                return this.getEnOrdinal(n);
+                return getEnOrdinal(n);
             case 'es':
                 return n + 'º';
             case 'h':
             case 'he':
             case 'he-x-nonikud':
                 return String(n);
-            default:
-                return n + '.';
         }
-    }
-    static getEnOrdinal(n) {
-        const s = ['th', 'st', 'nd', 'rd'];
-        const v = n % 100;
-        return n + (s[(v - 20) % 10] || s[v] || s[0]);
+        if (locale0.startsWith('ashkenazi')) {
+            return getEnOrdinal(n);
+        }
+        return n + '.';
     }
     /**
      * Removes nekudot from Hebrew string
@@ -1468,7 +1465,7 @@ class HDate {
      * @returns an integer 1-13
      * @example
      * const hd = new HDate(new Date(2008, 10, 13)); // 15 Cheshvan 5769
-     * hd.getMonth(); // 2
+     * hd.getTishreiMonth(); // 2
      */
     getTishreiMonth() {
         const nummonths = monthsInYear(this.getFullYear());
@@ -1708,7 +1705,8 @@ class HDate {
         else if (units === UNITS_YEAR) {
             return new HDate(this.getDate(), this.getMonth(), this.getFullYear() + amount);
         }
-        else if (units === UNITS_MONTH) {
+        else {
+            // units === UNITS_MONTH
             let hd = new HDate(this);
             const sign = amount > 0 ? 1 : -1;
             amount = Math.abs(amount);
@@ -1717,9 +1715,6 @@ class HDate {
             }
             return hd;
         }
-        else {
-            throw new TypeError(`Invalid units '${units}'`);
-        }
     }
     /**
      * Returns a cloned `HDate` object with a specified amount of time subracted
@@ -1760,9 +1755,6 @@ class HDate {
      * @param other Hebrew date to compare
      */
     deltaDays(other) {
-        if (!HDate.isHDate(other)) {
-            throw new TypeError(`Bad argument: ${other}`);
-        }
         return this.abs() - other.abs();
     }
     /**
@@ -1774,10 +1766,7 @@ class HDate {
      * hd1.isSameDate(hd2); // true
      */
     isSameDate(other) {
-        if (HDate.isHDate(other)) {
-            return (this.yy === other.yy && this.mm === other.mm && this.dd === other.dd);
-        }
-        return false;
+        return this.yy === other.yy && this.mm === other.mm && this.dd === other.dd;
     }
     /**
      * Returns a string representation of this Hebrew date using English transliterations
@@ -7787,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';
         }
@@ -8354,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 = {
@@ -10339,7 +10363,7 @@ class DailyLearning {
 }
 
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-const version = '5.4.10';
+const version = '5.5.0';
 
 /* eslint-disable max-len */
 /**