jcal-zmanim 1.5.12 → 1.5.13

package/README.md

@@ -2,6 +2,35 @@
 
 A comprehensive JavaScript library for the Jewish Calendar.
 
+## Table of Contents
+
+### Getting Started
+
+- [Installation](#to-add-jcal-zmanim-to-your-project)
+- [Basic Usage](#some-basic-uses-of-jcal-zmanim)
+
+### API Reference
+
+- [The jDate Object](#the-jdate-object)
+  - [Creating a jDate](#creating-a-jdate-instance)
+  - [Properties and Functions](#jdate-instance-properties-and-functions)
+  - [Static Properties and Functions](#jdate-static-properties-and-functions)
+- [The Location Object](#the-location-object)
+  - [Finding a Location](#finding-a-location)
+  - [Properties and Functions](#location-properties-and-functions)
+  - [Creating a Location](#creating-a-new-location)
+  - [Polar Regions](#polar-regions)
+- [Zmanim](#zmanim)
+  - [Zmanim Types](#zmanim-types)
+  - [Calculate other Zmanim](#calculate-other-zmanim)
+- [The Sedra Object](#the-sedra-object)
+- [The Dafyomi Object](#the-dafyomi-object)
+- [The Molad Functions](#the-molad-functions)
+- [Daily Notifications](#daily-notifications-and-shul-notifications)
+- [The Utils Functions](#the-utils-functions)
+
+---
+
 ### To add _jcal-zmanim_ to your project
 
 > _npm install jcal-zmanim_
@@ -10,13 +39,6 @@ OR
 
 > _yarn add jcal-zmanim_
 
-### Performance
-
-As of version 1.5.8, `jcal-zmanim` includes built-in caching for complex astronomical and calendar calculations.
-
-- **Zmanim Caching:** Sunrise/Sunset calculations are cached per date/location to improve performance when rendering calendars or lists of zmanim.
-- **Calendar Caching:** Year-based calculations are cached to speed up date conversions and manipulations.
-
 ### Some basic uses of _jcal-zmanim_
 
 ##### Print out todays Jewish Date
@@ -144,19 +166,25 @@ The code above, prints out to the console:
 
 ## The jDate object
 
-A _jDate_ is a single day in the Jewish Calendar.<br>
+A **_jDate_** is a **single day in the Jewish Calendar**.<br>
 It is used as the basic date unit throughout jcal-zmanim.
 
 ```javascript
 import { jDate } from "jcal-zmanim";
 
-//The following will create a Jewish Date object for todays Date.
+//Create a jDate object for todays Date.
 const jdate = new jDate();
-
-//The following will output the above Jewish Date in the format: Thursday, the 3rd of Kislev 5784.
 console.log(jdate.toString());
+//Output: Wednesday, the 18th of Teves 5786
+
+//Create a jDate object for January 9 2035.
+const jdate2 = new jDate("January 9 2035");
+console.log(jdate2.toStringHeb());
+//Output: יום שלישי כ"ח טבת תשצ"ה
 ```
 
+It is important to note that in jcal-zmanim, the Jewish Months start at Nissan (1) and end at Adar Sheini (13) as it is in the Torah.
+
 ### Creating a jDate instance
 
 A jDate can be created in a number of ways:
@@ -164,7 +192,7 @@ A jDate can be created in a number of ways:
 #### Create a jDate using the jDate constructor
 
 - `const jdate = new jDate()` - Sets the Jewish Date for the current system date
-- `const jdate = new jDate(javascriptDateObject)` - Sets to the Jewish date on the given Gregorian date
+- `const jdate = new jDate(Date)` - Sets to the Jewish date on the given Javascript/Typescript Date object
 - `const jdate = new jDate("January 1 2045")` - Accepts any valid javascript Date string (uses JavaScript's new Date(string))
 - `const jdate = new jDate(jewishYear, jewishMonth, jewishDay)` - Months start at 1. Nissan is month 1 Adar Sheini is 13.
 - `const jdate = new jDate(jewishYear, jewishMonth)` - Same as above, with Day defaulting to 1
@@ -175,20 +203,20 @@ A jDate can be created in a number of ways:
 - `const jdate = new jDate(jewishYear, jewishMonth, jewishDay, absoluteDate)` - Most efficient constructor. Needs no calculations at all.
 - `const jdate = new jDate( { year: 5776, month: 4, day: 5, abs: 122548708 } )` - same as new jDate(jewishYear, jewishMonth, jewishDay, absoluteDate)
 
-#### Create a jDate using the static _toJDate_ function
+### Static jDate Constructors
 
-- `jDate.toJDate()` OR `jDate.now()` - To get the current Jewish Date.
+- Besides for `new jDate()`, you can also use `jDate.now()` to get the current Jewish Date.
 
 ```javascript
-//To print out the current Jewish Date in English.
-console.log(jDate.toJDate().toString());
 //A shortcut to get the current jDate.
 const currentJDate = jDate.now();
+//To print out the current Jewish Date in English.
+console.log(currentJDate.toString());
 //To print out the current Jewish Date in Hebrew:
-console.log(jDate.now().toStringHeb());
+console.log(currentJDate.toStringHeb());
 ```
 
-- `jDate.toJDate(Date)` - Sets to the Jewish date on the given Javascript Date object
+- The static function `jDate.toJDate(Date)` can also be used to convert a Javascript Date object to a jDate object.
 - `jDate.toJDate("January 1 2045")` - Accepts any valid Javascript Date string (uses string constructor of Date object)
 
 ```javascript
@@ -343,13 +371,13 @@ import { Location } from "jcal-zmanim";
 
 const myLocation = new Location(
   "Nowhere", // The location name
-  "יהופיץ", //The name in Hebrew.
+  "יהופיץ", // The name in Hebrew
   false, // This place is not in Israel
-  35.01 - // The latitude.  North is positive.
-    155.23, // The longitude. East is negative.
-  11, // The Time Zone: The number of hours offset from UTC.
+  35.01, // The latitude.  North is positive
+  155.23, // The longitude. East is negative
+  11, // The Time Zone: The number of hours offset from UTC
   1106, // The elevation in Meters. (Feet x 3.2808)
-  18 // The number of minutes before sunset candles are lit on Erev Shabbos.
+  18 // The number of minutes before sunset candles are lit on Erev Shabbos
 );
 ```
 

package/dist/README.md

@@ -2,6 +2,35 @@
 
 A comprehensive JavaScript library for the Jewish Calendar.
 
+## Table of Contents
+
+### Getting Started
+
+- [Installation](#to-add-jcal-zmanim-to-your-project)
+- [Basic Usage](#some-basic-uses-of-jcal-zmanim)
+
+### API Reference
+
+- [The jDate Object](#the-jdate-object)
+  - [Creating a jDate](#creating-a-jdate-instance)
+  - [Properties and Functions](#jdate-instance-properties-and-functions)
+  - [Static Properties and Functions](#jdate-static-properties-and-functions)
+- [The Location Object](#the-location-object)
+  - [Finding a Location](#finding-a-location)
+  - [Properties and Functions](#location-properties-and-functions)
+  - [Creating a Location](#creating-a-new-location)
+  - [Polar Regions](#polar-regions)
+- [Zmanim](#zmanim)
+  - [Zmanim Types](#zmanim-types)
+  - [Calculate other Zmanim](#calculate-other-zmanim)
+- [The Sedra Object](#the-sedra-object)
+- [The Dafyomi Object](#the-dafyomi-object)
+- [The Molad Functions](#the-molad-functions)
+- [Daily Notifications](#daily-notifications-and-shul-notifications)
+- [The Utils Functions](#the-utils-functions)
+
+---
+
 ### To add _jcal-zmanim_ to your project
 
 > _npm install jcal-zmanim_
@@ -10,13 +39,6 @@ OR
 
 > _yarn add jcal-zmanim_
 
-### Performance
-
-As of version 1.5.8, `jcal-zmanim` includes built-in caching for complex astronomical and calendar calculations.
-
-- **Zmanim Caching:** Sunrise/Sunset calculations are cached per date/location to improve performance when rendering calendars or lists of zmanim.
-- **Calendar Caching:** Year-based calculations are cached to speed up date conversions and manipulations.
-
 ### Some basic uses of _jcal-zmanim_
 
 ##### Print out todays Jewish Date
@@ -144,19 +166,25 @@ The code above, prints out to the console:
 
 ## The jDate object
 
-A _jDate_ is a single day in the Jewish Calendar.<br>
+A **_jDate_** is a **single day in the Jewish Calendar**.<br>
 It is used as the basic date unit throughout jcal-zmanim.
 
 ```javascript
 import { jDate } from "jcal-zmanim";
 
-//The following will create a Jewish Date object for todays Date.
+//Create a jDate object for todays Date.
 const jdate = new jDate();
-
-//The following will output the above Jewish Date in the format: Thursday, the 3rd of Kislev 5784.
 console.log(jdate.toString());
+//Output: Wednesday, the 18th of Teves 5786
+
+//Create a jDate object for January 9 2035.
+const jdate2 = new jDate("January 9 2035");
+console.log(jdate2.toStringHeb());
+//Output: יום שלישי כ"ח טבת תשצ"ה
 ```
 
+It is important to note that in jcal-zmanim, the Jewish Months start at Nissan (1) and end at Adar Sheini (13) as it is in the Torah.
+
 ### Creating a jDate instance
 
 A jDate can be created in a number of ways:
@@ -164,7 +192,7 @@ A jDate can be created in a number of ways:
 #### Create a jDate using the jDate constructor
 
 - `const jdate = new jDate()` - Sets the Jewish Date for the current system date
-- `const jdate = new jDate(javascriptDateObject)` - Sets to the Jewish date on the given Gregorian date
+- `const jdate = new jDate(Date)` - Sets to the Jewish date on the given Javascript/Typescript Date object
 - `const jdate = new jDate("January 1 2045")` - Accepts any valid javascript Date string (uses JavaScript's new Date(string))
 - `const jdate = new jDate(jewishYear, jewishMonth, jewishDay)` - Months start at 1. Nissan is month 1 Adar Sheini is 13.
 - `const jdate = new jDate(jewishYear, jewishMonth)` - Same as above, with Day defaulting to 1
@@ -175,20 +203,20 @@ A jDate can be created in a number of ways:
 - `const jdate = new jDate(jewishYear, jewishMonth, jewishDay, absoluteDate)` - Most efficient constructor. Needs no calculations at all.
 - `const jdate = new jDate( { year: 5776, month: 4, day: 5, abs: 122548708 } )` - same as new jDate(jewishYear, jewishMonth, jewishDay, absoluteDate)
 
-#### Create a jDate using the static _toJDate_ function
+### Static jDate Constructors
 
-- `jDate.toJDate()` OR `jDate.now()` - To get the current Jewish Date.
+- Besides for `new jDate()`, you can also use `jDate.now()` to get the current Jewish Date.
 
 ```javascript
-//To print out the current Jewish Date in English.
-console.log(jDate.toJDate().toString());
 //A shortcut to get the current jDate.
 const currentJDate = jDate.now();
+//To print out the current Jewish Date in English.
+console.log(currentJDate.toString());
 //To print out the current Jewish Date in Hebrew:
-console.log(jDate.now().toStringHeb());
+console.log(currentJDate.toStringHeb());
 ```
 
-- `jDate.toJDate(Date)` - Sets to the Jewish date on the given Javascript Date object
+- The static function `jDate.toJDate(Date)` can also be used to convert a Javascript Date object to a jDate object.
 - `jDate.toJDate("January 1 2045")` - Accepts any valid Javascript Date string (uses string constructor of Date object)
 
 ```javascript
@@ -343,13 +371,13 @@ import { Location } from "jcal-zmanim";
 
 const myLocation = new Location(
   "Nowhere", // The location name
-  "יהופיץ", //The name in Hebrew.
+  "יהופיץ", // The name in Hebrew
   false, // This place is not in Israel
-  35.01 - // The latitude.  North is positive.
-    155.23, // The longitude. East is negative.
-  11, // The Time Zone: The number of hours offset from UTC.
+  35.01, // The latitude.  North is positive
+  155.23, // The longitude. East is negative
+  11, // The Time Zone: The number of hours offset from UTC
   1106, // The elevation in Meters. (Feet x 3.2808)
-  18 // The number of minutes before sunset candles are lit on Erev Shabbos.
+  18 // The number of minutes before sunset candles are lit on Erev Shabbos
 );
 ```
 

package/dist/index.cjs

@@ -301,22 +301,13 @@ var DateUtils = /*#__PURE__*/ function() {
             value: /**
    * Add two character suffix to number. e.g. 21st, 102nd, 93rd, 500th
    */ function toSuffixed(num) {
-                var t = num.toString();
-                var suffix = "th";
-                if (t.length === 1 || t[t.length - 2] !== "1") {
-                    switch(t[t.length - 1]){
-                        case "1":
-                            suffix = "st";
-                            break;
-                        case "2":
-                            suffix = "nd";
-                            break;
-                        case "3":
-                            suffix = "rd";
-                            break;
-                    }
-                }
-                return t + suffix;
+                var suffixes = [
+                    "th",
+                    "st",
+                    "nd",
+                    "rd"
+                ];
+                return num.toString() + (suffixes[(num % 100 - 20) % 10] || suffixes[num % 10] || suffixes[0]);
             }
         },
         {
@@ -13549,7 +13540,7 @@ var _ZmanimUtils = /*#__PURE__*/ function() {
                                 }
                                 break;
                             case ZmanTypeIds.SofZmanEatingChometz:
-                                if (shaaZmanisMga && jdate.Month === 1 && jdate.Day === 14 && Utils.isTimeAfter(sunrise, Utils.timeFromDate(date))) {
+                                if (shaaZmanisMga && jdate.Month === 1 && jdate.Day === 14) {
                                     zmanTimes.push({
                                         zmanType: zmanType,
                                         time: Utils.addMinutes(sunrise, -90 + offset + shaaZmanisMga * 4)
@@ -13557,7 +13548,7 @@ var _ZmanimUtils = /*#__PURE__*/ function() {
                                 }
                                 break;
                             case ZmanTypeIds.SofZmanBurnChometz:
-                                if (shaaZmanisMga && jdate.Month === 1 && (jdate.Day === 14 || jdate.DayOfWeek === DaysOfWeek.FRIDAY && jdate.Day === 13) && Utils.isTimeAfter(sunrise, Utils.timeFromDate(date))) {
+                                if (shaaZmanisMga && jdate.Month === 1 && (jdate.Day === 14 && jdate.DayOfWeek !== DaysOfWeek.SHABBOS || jdate.DayOfWeek === DaysOfWeek.FRIDAY && jdate.Day === 13)) {
                                     zmanTimes.push({
                                         zmanType: zmanType,
                                         time: Utils.addMinutes(sunrise, -90 + offset + shaaZmanisMga * 5)
@@ -13846,9 +13837,28 @@ function getAroundTheYearNotifications() {
             if (dow !== DaysOfWeek.SHABBOS && day > 15 && day !== 21) {
                 addTefillahNote("Vesain Bracha", "\u05D5\u05EA\u05DF \u05D1\u05E8\u05DB\u05D4");
             }
+            if (!isNightTime && (dow !== DaysOfWeek.THURSDAY && day === 13 || dow === DaysOfWeek.WEDNESDAY && day === 12)) {
+                addDayNote("Bedikas Chometz Tonight", "\u05D1\u05D3\u05D9\u05E7\u05EA \u05D7\u05DE\u05E5 \u05D1\u05E2\u05E8\u05D1");
+            }
             if (isNightTime && (dow !== DaysOfWeek.FRIDAY && day === 14 || dow === DaysOfWeek.THURSDAY && day === 13)) {
                 addDayNote("Bedikas Chometz", "\u05D1\u05D3\u05D9\u05E7\u05EA \u05D7\u05DE\u05E5");
             }
+            if (day === 14) {
+                var eatingZman = ZmanimUtils.getZmanTimes([
+                    getZmanType(ZmanTypeIds.SofZmanEatingChometz)
+                ], sdate, jdate, location)[0];
+                if (eatingZman && eatingZman.time) {
+                    addDayNote("Sof Zman Eating Chometz: ".concat(Utils.getTimeString(eatingZman.time)), "סוף זמן אכילת חמץ: ".concat(Utils.getTimeString(eatingZman.time)));
+                }
+            }
+            if (day === 14 && dow !== DaysOfWeek.SHABBOS || day === 13 && dow === DaysOfWeek.FRIDAY) {
+                var burnZman = ZmanimUtils.getZmanTimes([
+                    getZmanType(ZmanTypeIds.SofZmanBurnChometz)
+                ], sdate, jdate, location)[0];
+                if (burnZman && burnZman.time) {
+                    addDayNote("Sof Zman Burn Chometz: ".concat(Utils.getTimeString(burnZman.time)), "סוף זמן ביעור חמץ: ".concat(Utils.getTimeString(burnZman.time)));
+                }
+            }
             if (isMorning && dow !== DaysOfWeek.SHABBOS && [
                 14,
                 16,
@@ -14024,8 +14034,8 @@ function getAroundTheYearNotifications() {
             break;
         case JewishMonthsNames.TAMUZ:
             if (isDaytime && (day === 17 && DaysOfWeek.SHABBOS !== 6 || day === 18 && dow === DaysOfWeek.SUNDAY)) {
+                addDayNote("Shiva Asar B`Tamuz", '\u05D9"\u05D6 \u05D1\u05EA\u05DE\u05D5\u05D6');
                 if (isDaytime) {
-                    addDayNote("Shiva Asar B`Tamuz", '\u05D9"\u05D6 \u05D1\u05EA\u05DE\u05D5\u05D6');
                     addTefillahNote("Avinu Malkeinu", "\u05D0\u05D1\u05D9\u05E0\u05D5 \u05DE\u05DC\u05DB\u05E0\u05D5");
                     addTefillahNote("Aneinu", "\u05E2\u05E0\u05E0\u05D5");
                 }
@@ -14131,8 +14141,8 @@ function getAroundTheYearNotifications() {
                     break;
                 case 3:
                     if (dow !== DaysOfWeek.SHABBOS) {
+                        addDayNote("Fast of Tzom Gedalya", "\u05E6\u05D5\u05DD \u05D2\u05D3\u05DC\u05D9\u05D4");
                         if (isDaytime) {
-                            addDayNote("Fast of Tzom Gedalya", "\u05E6\u05D5\u05DD \u05D2\u05D3\u05DC\u05D9\u05D4");
                             addTefillahNote("Aneinu", "\u05E2\u05E0\u05E0\u05D5");
                         }
                         if (isAfterChatzosHalayla || isMorning) {
@@ -14143,8 +14153,8 @@ function getAroundTheYearNotifications() {
                     break;
                 case 4:
                     if (dow === DaysOfWeek.SUNDAY) {
+                        addDayNote("Fast of Tzom Gedalya", "\u05E6\u05D5\u05DD \u05D2\u05D3\u05DC\u05D9\u05D4");
                         if (isDaytime) {
-                            addDayNote("Fast of Tzom Gedalya", "\u05E6\u05D5\u05DD \u05D2\u05D3\u05DC\u05D9\u05D4");
                             addTefillahNote("Aneinu", "\u05E2\u05E0\u05E0\u05D5");
                         }
                         if (isAfterChatzosHalayla || isMorning) {
@@ -14390,13 +14400,15 @@ function getAroundTheYearNotifications() {
                         }
                     }
                 }
-            } else if (day === 10 && isDaytime) {
+            } else if (day === 10) {
                 addDayNote("Fast of Asara B`Teves", "\u05E2\u05E9\u05E8\u05D4 \u05D1\u05D8\u05D1\u05EA");
                 if (isMorning) {
                     addTefillahNote("Selichos", "\u05E1\u05DC\u05D9\u05D7\u05D5\u05EA");
                 }
-                addTefillahNote("Avinu Malkeinu", "\u05D0\u05D1\u05D9\u05E0\u05D5 \u05DE\u05DC\u05DB\u05E0\u05D5");
-                addTefillahNote("Aneinu", "\u05E2\u05E0\u05E0\u05D5");
+                if (isDaytime) {
+                    addTefillahNote("Avinu Malkeinu", "\u05D0\u05D1\u05D9\u05E0\u05D5 \u05DE\u05DC\u05DB\u05E0\u05D5");
+                    addTefillahNote("Aneinu", "\u05E2\u05E0\u05E0\u05D5");
+                }
             }
             break;
         case JewishMonthsNames.SHVAT:
@@ -14424,12 +14436,14 @@ function getAroundTheYearNotifications() {
                 }
             } else {
                 if (isDaytime && (day === 11 && dow === DaysOfWeek.THURSDAY || day === 13 && dow !== DaysOfWeek.SHABBOS)) {
+                    addDayNote("Fast of Ta`anis Esther", "\u05EA\u05E2\u05E0\u05D9\u05EA \u05D0\u05E1\u05EA\u05E8");
                     if (isMorning) {
-                        addDayNote("Fast of Ta`anis Esther", "\u05EA\u05E2\u05E0\u05D9\u05EA \u05D0\u05E1\u05EA\u05E8");
                         addTefillahNote("Selichos", "\u05E1\u05DC\u05D9\u05D7\u05D5\u05EA");
                     }
-                    addTefillahNote("Avinu Malkeinu", "\u05D0\u05D1\u05D9\u05E0\u05D5 \u05DE\u05DC\u05DB\u05E0\u05D5");
-                    addTefillahNote("Aneinu", "\u05E2\u05E0\u05E0\u05D5");
+                    if (isDaytime) {
+                        addTefillahNote("Avinu Malkeinu", "\u05D0\u05D1\u05D9\u05E0\u05D5 \u05DE\u05DC\u05DB\u05E0\u05D5");
+                        addTefillahNote("Aneinu", "\u05E2\u05E0\u05E0\u05D5");
+                    }
                 } else {
                     var isYerushalayim = location.Name === "Jerusalem" || location.NameHebrew === "\u05D9\u05E8\u05D5\u05E9\u05DC\u05D9\u05DD";
                     if (day === 14) {