@hebcal/rest-api 3.19.5 → 4.2.0

package/dist/index.mjs

@@ -1,6 +1,7 @@
-/*! @hebcal/rest-api v3.19.5 */
-import { flags, HDate, Zmanim, HebrewCalendar, Locale, gematriya } from '@hebcal/core';
-import * as leyn from '@hebcal/leyning';
+/*! @hebcal/rest-api v4.2.0 */
+import { flags, HDate, HebrewCalendar, Zmanim, Locale, gematriya } from '@hebcal/core';
+import { getLeyningForParshaHaShavua, getLeyningForHoliday, formatAliyahWithBook } from '@hebcal/leyning';
+import { getTriennialForParshaHaShavua } from '@hebcal/triennial';
 
 const Chanukah="Hanukkah, the Jewish festival of rededication. Also known as the Festival of Lights";const Pesach="Passover, the Feast of Unleavened Bread. Also called Chag HaMatzot (the Festival of Matzah), it commemorates the Exodus and freedom of the Israelites from ancient Egypt";const Purim="Celebration of Jewish deliverance as told by Megilat Esther. It commemorates a time when the Jewish people living in Persia were saved from extermination";const Shavuot="Festival of Weeks. Commemorates the giving of the Torah at Mount Sinai";const Sigd="Ethiopian Jewish holiday occurring 50 days after Yom Kippur";const Sukkot="Feast of Booths";var holidayDescription = {"Asara B'Tevet":"Fast commemorating the siege of Jerusalem",Chanukah:Chanukah,"Days of the Omer":"7 weeks from the second night of Pesach to the day before Shavuot","Lag BaOmer":"33rd day of counting the Omer","Leil Selichot":"Prayers for forgiveness in preparation for the High Holidays","Pesach Sheni":"Second Passover, one month after Passover",Pesach:Pesach,"Purim Katan":"Minor Purim celebration during Adar I on leap years",Purim:Purim,"Rosh Chodesh Nisan":"Start of month of Nisan on the Hebrew calendar. נִיסָן (transliterated Nisan or Nissan) is the 1st month of the Hebrew year, has 30 days, and corresponds to March or April on the Gregorian calendar. רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Iyyar":"Start of month of Iyyar on the Hebrew calendar. אִיָיר (transliterated Iyyar or Iyar) is the 2nd month of the Hebrew year, has 29 days, and corresponds to April or May on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Sivan":"Start of month of Sivan on the Hebrew calendar. Sivan (סִיוָן) is the 3rd month of the Hebrew year, has 30 days, and corresponds to May or June on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Tamuz":"Start of month of Tamuz on the Hebrew calendar. תַּמּוּז (transliterated Tamuz or Tammuz) is the 4th month of the Hebrew year, has 29 days, and corresponds to June or July on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Av":"Start of month of Av on the Hebrew calendar. Av (אָב) is the 5th month of the Hebrew year, has 30 days, and corresponds to July or August on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Elul":"Start of month of Elul on the Hebrew calendar. Elul (אֱלוּל) is the 6th month of the Hebrew year, has 29 days, and corresponds to August or September on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Cheshvan":"Start of month of Cheshvan on the Hebrew calendar. חֶשְׁוָן (transliterated Cheshvan or Heshvan) is the 8th month of the Hebrew year, has 29 or 30 days, and corresponds to October or November on the Gregorian calendar. רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Kislev":"Start of month of Kislev on the Hebrew calendar. Kislev (כִּסְלֵו) is the 9th month of the Hebrew year, has 30 or 29 days, and corresponds to November or December on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Tevet":"Start of month of Tevet on the Hebrew calendar. Tevet (טֵבֵת) is the 10th month of the Hebrew year, has 29 days, and corresponds to December or January on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Sh'vat":"Start of month of Sh'vat on the Hebrew calendar. שְׁבָט (transliterated Sh'vat or Shevat) is the 11th month of the Hebrew year, has 30 days, and corresponds to January or February on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Adar":"Start of month of Adar on the Hebrew calendar. Adar (אַדָר) is the 12th month of the Hebrew year, has 29 days, and corresponds to February or March on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Adar I":"Start of month of Adar I (on leap years) on the Hebrew calendar. Adar I (אַדָר א׳) is the 12th month of the Hebrew year, occurs only on leap years, has 30 days, and corresponds to February or March on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Chodesh Adar II":"Start of month of Adar II (on leap years) on the Hebrew calendar. Adar II (אַדָר ב׳), sometimes \"Adar Bet\" or \"Adar Sheni\", is the 13th month of the Hebrew year, has 29 days, occurs only on leap years, and corresponds to February or March on the Gregorian calendar.  רֹאשׁ חוֹדֶשׁ, transliterated Rosh Chodesh or Rosh Hodesh, is a minor holiday that occurs at the beginning of every month in the Hebrew calendar. It is marked by the birth of a new moon","Rosh Hashana":"The Jewish New Year. Also spelled Rosh Hashanah","Rosh Hashana LaBehemot":"New Year for Tithing Animals","Shabbat Chazon":"Shabbat before Tish'a B'Av (Shabbat of Prophecy/Shabbat of Vision)","Shabbat HaChodesh":"Shabbat before Rosh Chodesh Nissan","Shabbat HaGadol":"Shabbat before Pesach","Shabbat Machar Chodesh":"When Shabbat falls the day before Rosh Chodesh","Shabbat Nachamu":"Shabbat after Tish'a B'Av (Shabbat of Consolation). The first of seven Shabbatot leading up to Rosh Hashanah. Named after the Haftarah (from Isaiah 40) which begins with the verse נַחֲמוּ נַחֲמוּ, עַמִּי (\"Comfort, oh comfort my people\")","Shabbat Parah":"Shabbat of the Red Heifer","Shabbat Rosh Chodesh":"When Shabbat falls on Rosh Chodesh","Shabbat Shekalim":"Shabbat before Rosh Chodesh Adar","Shabbat Shirah":"Shabbat of Song","Shabbat Shuva":"Shabbat that falls between Rosh Hashanah and Yom Kippur (Shabbat of Returning)","Shabbat Zachor":"Shabbat before Purim",Shavuot:Shavuot,"Shmini Atzeret":"Eighth Day of Assembly","Shushan Purim":"Purim celebrated in Jerusalem and walled cities",Sigd:Sigd,"Simchat Torah":"Day of Celebrating the Torah",Sukkot:Sukkot,"Ta'anit Bechorot":"Fast of the First Born","Ta'anit Esther":"Fast of Esther","Tish'a B'Av":"The Ninth of Av. Fast commemorating the destruction of the two Temples","Tu B'Av":"Minor Jewish holiday of love. Observed on the 15th day of the Hebrew month of Av","Tu BiShvat":"New Year for Trees","Tzom Gedaliah":"Fast of the Seventh Month. Commemorates the assassination of the Jewish governor of Judah","Tzom Tammuz":"Fast commemorating breaching of the walls of Jerusalem before the destruction of the Second Temple","Yom HaAliyah":"Recognizes Aliyah, immigration to the Jewish State of Israel","Yom HaAliyah School Observance":"Aliyah Day observed in Israeli schools","Yom HaAtzma'ut":"Israeli Independence Day. Commemorates the declaration of independence of Israel in 1948. Although Yom HaAtzma'ut is normally observed on the 5th of Iyyar, it may be moved earlier or postponed if observance of the holiday (or Yom HaZikaron, which always precedes it) would conflict with Shabbat","Yom HaShoah":"Holocaust Memorial Day","Yom HaZikaron":"Israeli Memorial Day. Remembers those who died in the War of Independence and other wars in Israel. The full name of the holiday is Yom HaZikaron LeHalalei Ma'arakhot Yisrael ul'Nifge'ei Pe'ulot HaEivah (Hebrew: יוֹם הזִּכָּרוֹן לְחַלְלֵי מַעֲרָכוֹת יִשְׂרָאֵל וּלְנִפְגְעֵי פְּעֻלּוֹת הָאֵיבָה), Memorial Day for the Fallen Soldiers of the Wars of Israel and Victims of Actions of Terrorism. Although Yom Hazikaron is normally observed on the 4th of Iyyar, it may be moved earlier or postponed if observance of the holiday (or Yom HaAtzma'ut, which always follows it) would conflict with Shabbat","Yom Kippur":"Day of Atonement","Yom Kippur Katan":"Minor day of atonement occurring monthly on the day preceeding each Rosh Chodesh","Yom Yerushalayim":"Jerusalem Day. Commemorates the re-unification of Jerusalem in 1967"};
 
@@ -118,17 +119,6 @@ function pad4(number) {
 
   return '' + number;
 }
-/**
- * Get offset string (like "+05:00" or "-08:00") from tzid (like "Europe/Moscow")
- * @deprecated
- * @param {string} tzid
- * @param {Date} date
- * @return {string}
- */
-
-function timeZoneOffsetStr(tzid, date) {
-  return Zmanim.timeZoneOffset(tzid, date);
-}
 /**
  * Returns just the date portion as YYYY-MM-DD
  * @param {Date} d
@@ -138,20 +128,6 @@ function timeZoneOffsetStr(tzid, date) {
 function toISOString(d) {
   return pad4(d.getFullYear()) + '-' + pad2(d.getMonth() + 1) + '-' + pad2(d.getDate());
 }
-/**
- * Returns a string like "2018-09-01T12:30:00-05:00"
- * @deprecated
- * @param {Date} date
- * @param {string} timeStr must be formatted with only hours and minutes, like "17:12"
- * @param {string} tzid like "America/New_York"
- * @return {string}
- */
-
-function toISOStringWithTimezone(date, timeStr, tzid) {
-  const str = toISOString(date);
-  if (!timeStr) return str;
-  return str + 'T' + timeStr + ':00' + Zmanim.timeZoneOffset(tzid, date);
-}
 /**
  * Returns a category and subcategory name
  * @param {Event} ev
@@ -332,7 +308,7 @@ function makeTorahMemoText(ev, il) {
     return '';
   }
 
-  const reading = mask & flags.PARSHA_HASHAVUA ? leyn.getLeyningForParshaHaShavua(ev, il) : leyn.getLeyningForHoliday(ev, il);
+  const reading = mask & flags.PARSHA_HASHAVUA ? getLeyningForParshaHaShavua(ev, il) : getLeyningForHoliday(ev, il);
   let memo = '';
 
   if (reading && (reading.summary || reading.haftara)) {
@@ -637,17 +613,17 @@ function eventToClassicApiObject(ev, options, leyning = true) {
     if (leyning) {
       const il = options.il;
       const isParsha = mask === flags.PARSHA_HASHAVUA;
-      const reading = isParsha ? leyn.getLeyningForParshaHaShavua(ev, il) : leyn.getLeyningForHoliday(ev, il);
+      const reading = isParsha ? getLeyningForParshaHaShavua(ev, il) : getLeyningForHoliday(ev, il);
 
       if (reading) {
         result.leyning = formatLeyningResult(reading);
         const hyear = hd.getFullYear();
 
         if (isParsha && !il && hyear >= 5745) {
-          const triReading = leyn.getTriennialForParshaHaShavua(ev);
+          const triReading = getTriennialForParshaHaShavua(ev);
 
           if (triReading) {
-            result.leyning.triennial = formatAliyot({}, triReading);
+            result.leyning.triennial = formatAliyot({}, triReading.aliyot);
           }
         }
       }
@@ -714,13 +690,13 @@ function formatAliyot(result, aliyot) {
 
     if (typeof aliyah !== 'undefined') {
       const k = num == 'M' ? 'maftir' : num;
-      result[k] = leyn.formatAliyahWithBook(aliyah);
+      result[k] = formatAliyahWithBook(aliyah);
     }
   });
   return result;
 }
 /**
- * @param {leyn.Leyning} reading
+ * @param {Leyning} reading
  * @return {Object}
  */
 
@@ -794,32 +770,7 @@ function getLinkAndGuid(ev, il, tzid, mainUrl, utmSource, utmMedium) {
 
   return [link, guid];
 }
-/**
- * @param {Event[]} events
- * @param {Location} location
- * @param {string} mainUrl
- * @param {string} selfUrl
- * @param {string} [lang] language such as 'he' (default 'en-US')
- * @param {boolean} [evPubDate] if true, use event time as pubDate (false uses lastBuildDate)
- * @return {string}
- */
-
 
-function eventsToRss(events, location, mainUrl, selfUrl, lang = 'en-US', evPubDate = true) {
-  const cityDescr = location.getName();
-  const options = {
-    location,
-    mainUrl,
-    selfUrl,
-    lang,
-    evPubDate,
-    title: Locale.gettext('Shabbat') + ` Times for ${cityDescr}`,
-    description: `Weekly Shabbat candle lighting times for ${cityDescr}`,
-    utmSource: 'shabbat1c',
-    utmMedium: 'rss'
-  };
-  return eventsToRss2(events, options);
-}
 const localeToLg = {
   's': 'en',
   'a': 'en',
@@ -900,28 +851,15 @@ function getPubDate(ev, evPubDate, evDate, lastBuildDate) {
 
 
 function eventToRssItem2(ev, options) {
-  return eventToRssItem(ev, options.evPubDate, options.lastBuildDate, options.dayFormat, options.location, options.mainUrl, options);
-}
-/**
- * @param {Event} ev
- * @param {boolean} evPubDate
- * @param {string} lastBuildDate
- * @param {Intl.DateTimeFormat} dayFormat
- * @param {Location} location
- * @param {string} mainUrl
- * @param {CalOptions} [options]
- * @return {string}
- */
-
-function eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl, options) {
   let subj = ev.render();
   const evDate = ev.getDate().greg();
-  const pubDate = getPubDate(ev, evPubDate, evDate, lastBuildDate);
+  const pubDate = getPubDate(ev, options.evPubDate, evDate, options.lastBuildDate);
+  const location = options.location;
   const il = location ? location.getIsrael() : false;
   const tzid = location ? location.getTzid() : 'UTC';
   const utmSource = options && options.utmSource || 'shabbat1c';
   const utmMedium = options && options.utmMedium || 'rss';
-  const linkGuid = getLinkAndGuid(ev, il, tzid, mainUrl, utmSource, utmMedium);
+  const linkGuid = getLinkAndGuid(ev, il, tzid, options.mainUrl, utmSource, utmMedium);
   const link = linkGuid[0];
   const guid = linkGuid[1];
   const categories = getEventCategories(ev);
@@ -946,6 +884,7 @@ function eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainU
     memo = ev.getFlags() & flags.PARSHA_HASHAVUA ? makeTorahMemoText(ev, il) : ev.memo || holidayDescription[ev.basename()];
   }
 
+  const dayFormat = options.dayFormat;
   const description = memo || dayFormat.format(evDate);
   const geoTags = cat0 == 'candles' ? `<geo:lat>${location.getLatitude()}</geo:lat>\n<geo:long>${location.getLongitude()}</geo:long>\n` : '';
   return `<item>
@@ -1012,4 +951,4 @@ function eventToFullCalendar(ev, tzid, il) {
   return result;
 }
 
-export { appendIsraelAndTracking, countryNames, eventToClassicApiObject, eventToCsv, eventToFullCalendar, eventToRssItem, eventToRssItem2, eventsToClassicApi, eventsToCsv, eventsToRss, eventsToRss2, getCalendarTitle, getDownloadFilename, getEventCategories, getHolidayDescription, holidayDescription, locationToPlainObj, makeAnchor, makeTorahMemoText, pad2, pad4, renderTitleWithoutTime, shouldRenderBrief, timeZoneOffsetStr, toISOString, toISOStringWithTimezone };
+export { appendIsraelAndTracking, countryNames, eventToClassicApiObject, eventToCsv, eventToFullCalendar, eventToRssItem2, eventsToClassicApi, eventsToCsv, eventsToRss2, getCalendarTitle, getDownloadFilename, getEventCategories, getHolidayDescription, holidayDescription, locationToPlainObj, makeAnchor, makeTorahMemoText, pad2, pad4, renderTitleWithoutTime, shouldRenderBrief, toISOString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "3.19.5",
+  "version": "4.2.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -21,8 +21,9 @@
     "url": "https://github.com/hebcal/hebcal-rest-api/issues"
   },
   "dependencies": {
-    "@hebcal/core": "^3.42.2",
-    "@hebcal/leyning": "^4.19.1"
+    "@hebcal/core": "^3.42.3",
+    "@hebcal/leyning": "^6.0.3",
+    "@hebcal/triennial": "^1.0.1"
   },
   "scripts": {
     "build": "rollup -c",
@@ -43,20 +44,20 @@
     "verbose": true
   },
   "devDependencies": {
-    "@babel/core": "^7.18.10",
+    "@babel/core": "^7.18.13",
     "@babel/preset-env": "^7.18.10",
     "@babel/register": "^7.18.9",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-commonjs": "^22.0.2",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
-    "ava": "^4.3.1",
-    "core-js": "^3.24.1",
+    "ava": "^4.3.3",
+    "core-js": "^3.25.0",
     "eslint": "^8.22.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^3.6.11",
     "jsdoc-to-markdown": "^7.1.1",
-    "rollup": "^2.78.0",
+    "rollup": "^2.78.1",
     "rollup-plugin-terser": "^7.0.2"
   }
 }

package/rest-api.d.ts

@@ -35,12 +35,11 @@ declare module '@hebcal/rest-api' {
    */
   export function shouldRenderBrief(ev: Event): boolean;
   /**
-   * @param [lang] - language such as 'he' (default 'en-US')
-   * @param [evPubDate] - if true, use event time as pubDate (false uses lastBuildDate)
+   * Extends `CalOptions` with
+   * `lang` - language such as 'he' (default 'en-US')
+   * `evPubDate` - if true, use event time as pubDate (false uses lastBuildDate)
    */
-  export function eventsToRss(events: Event[], location: Location, mainUrl: string, selfUrl: string, lang?: string, evPubDate?: boolean): string;
   export function eventsToRss2(events: Event[], options: CalOptions): string;
-  export function eventToRssItem(ev: Event, evPubDate: boolean, lastBuildDate: string, dayFormat: Intl.DateTimeFormat, location: Location, baseUrl: string, options?: CalOptions): string;
   export function eventToRssItem2(ev: Event, options: CalOptions): string;
   export function getDownloadFilename(options: CalOptions): string;
   export function pad2(number: number): string;
@@ -50,22 +49,10 @@ declare module '@hebcal/rest-api' {
    * Converts to lowercase and replaces non-word characters with hyphen ('-').
    */
   export function makeAnchor(s: string): string;
-  /**
-   * Get offset string (like "+05:00" or "-08:00") from tzid (like "Europe/Moscow")
-   * @deprecated
-   */
-  export function timeZoneOffsetStr(tzid: string, date: Date): string;
   /**
    * Returns just the date portion as YYYY-MM-DD
    */
   export function toISOString(d: Date): string;
-  /**
-   * Returns a string like "2018-09-01T12:30:00-05:00'"
-   * @deprecated
-   * @param timeStr - must be formatted with only hours and minutes, like "17:12"
-   * @param tzid - like "America/New_York"
-   */
-  export function toISOStringWithTimezone(date: Date, timeStr: string, tzid: string): string;
   /**
    * Returns a category and subcategory name
    */