@hebcal/rest-api 5.1.4 → 5.2.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
-/*! @hebcal/rest-api v5.1.4 */
-import { parshiot, HDate, flags, HebrewCalendar, Zmanim, Locale as Locale$1, gematriya } from '@hebcal/core';
+/*! @hebcal/rest-api v5.2.0 */
+import { parshiot, HDate, flags, HebrewCalendar, version, Zmanim, Locale as Locale$1, gematriya } from '@hebcal/core';
 import { getLeyningForParshaHaShavua, getLeyningForHoliday, formatAliyahWithBook } from '@hebcal/leyning';
 import { getTriennialForParshaHaShavua } from '@hebcal/triennial';
 
@@ -706,7 +706,8 @@ var holidayDescription0 = {
  * makeAnchor('Rosh Chodesh Adar II') // 'rosh-chodesh-adar-ii'
  */
 function makeAnchor(s) {
-    return s.toLowerCase()
+    return s
+        .toLowerCase()
         .replace(/'/g, '')
         .replace(/[^\w]/g, '-')
         .replace(/-+/g, '-')
@@ -732,7 +733,7 @@ const doubled = new Set();
 for (const name of doubledParshiyot) {
     const anchor = makeAnchor(name);
     doubled.add(anchor);
-    const [p1, p2] = anchor.split('-');
+    const [p1] = anchor.split('-');
     const id = parsha2id.get(p1);
     parsha2id.set(anchor, id);
 }
@@ -775,14 +776,25 @@ function shortenSedrotUrl(u) {
     }
 }
 
-const LOC_FIELDS = ['elevation', 'admin1', 'asciiname', 'geo', 'zip', 'state', 'stateName', 'geonameid'];
+const LOC_FIELDS = [
+    'elevation',
+    'admin1',
+    'asciiname',
+    'geo',
+    'zip',
+    'state',
+    'stateName',
+    'geonameid',
+];
 const holidayDescription = holidayDescription0;
 const countryNames = countryNames0;
 /**
  * Converts a @hebcal/core `Location` to a plain JS object.
  */
 function locationToPlainObj(location) {
-    if (typeof location === 'object' && location !== null && typeof location.getLatitude === 'function') {
+    if (typeof location === 'object' &&
+        location !== null &&
+        typeof location.getLatitude === 'function') {
         const cc = location.getCountryCode();
         const o = {
             title: location.getName(),
@@ -816,7 +828,8 @@ function getDownloadFilename(options) {
             fileName += '_' + options.month;
         }
     }
-    else if (typeof options.start === 'object' && typeof options.end === 'object') {
+    else if (typeof options.start === 'object' &&
+        typeof options.end === 'object') {
         const start = new HDate(options.start);
         const end = new HDate(options.end);
         const y1 = start.greg().getFullYear();
@@ -857,7 +870,9 @@ function getEventCategories(ev) {
  * Renders the event title in default locale, but strips off time
  */
 function renderTitleWithoutTime(ev) {
-    return typeof ev.eventTime === 'undefined' ? ev.render() : ev.renderBrief();
+    return typeof ev.eventTime === 'undefined'
+        ? ev.render()
+        : ev.renderBrief();
 }
 function shortLocationName(options) {
     const loc = options.location;
@@ -890,19 +905,20 @@ function getCalendarTitle(events, options) {
     else {
         title += ' Diaspora';
     }
-    if (options.subscribe == '1') {
+    const sub = options.subscribe;
+    if (sub === '1' || sub === 1 || sub === true) {
         return title;
     }
-    if (options.year && (options.isHebrewYear || events.length == 0)) {
+    if (options.year && (options.isHebrewYear || events.length === 0)) {
         title += ' ' + options.year;
     }
     else if (events.length) {
         const start = events[0].getDate().greg();
         const end = events[events.length - 1].getDate().greg();
-        if (start.getFullYear() != end.getFullYear()) {
+        if (start.getFullYear() !== end.getFullYear()) {
             title += ' ' + start.getFullYear() + '-' + end.getFullYear();
         }
-        else if (start.getMonth() == end.getMonth()) {
+        else if (start.getMonth() === end.getMonth()) {
             const monthFormat = new Intl.DateTimeFormat('en-US', { month: 'long' });
             const startMonth = monthFormat.format(start);
             title += ' ' + startMonth + ' ' + start.getFullYear();
@@ -917,34 +933,42 @@ function getCalendarTitle(events, options) {
  * Returns an English language description of the holiday
  */
 function getHolidayDescription(ev, firstSentence = false) {
-    const str0 = ev.getFlags() & flags.SHABBAT_MEVARCHIM ?
-        holidayDescription['Shabbat Mevarchim Chodesh'] :
-        holidayDescription[ev.getDesc()] || holidayDescription[ev.basename()] || '';
+    const str0 = ev.getFlags() & flags.SHABBAT_MEVARCHIM
+        ? holidayDescription['Shabbat Mevarchim Chodesh']
+        : holidayDescription[ev.getDesc()] ||
+            holidayDescription[ev.basename()] ||
+            '';
     const str = str0.normalize();
     if (firstSentence && str) {
         const dot = str.indexOf('.');
-        if (dot != -1) {
+        if (dot !== -1) {
             return str.substring(0, dot);
         }
     }
     return str;
 }
-const HOLIDAY_IGNORE_MASK = flags.DAF_YOMI | flags.OMER_COUNT |
-    flags.SHABBAT_MEVARCHIM | flags.MOLAD | flags.USER_EVENT |
-    flags.NACH_YOMI | flags.DAILY_LEARNING |
-    flags.HEBREW_DATE | flags.YERUSHALMI_YOMI;
+const HOLIDAY_IGNORE_MASK = flags.DAF_YOMI |
+    flags.OMER_COUNT |
+    flags.SHABBAT_MEVARCHIM |
+    flags.MOLAD |
+    flags.USER_EVENT |
+    flags.NACH_YOMI |
+    flags.DAILY_LEARNING |
+    flags.HEBREW_DATE |
+    flags.YERUSHALMI_YOMI;
 /**
  * Makes mulit-line text that summarizes Torah & Haftarah
  */
 function makeTorahMemoText(ev, il) {
     var _a;
     const mask = ev.getFlags();
-    if ((mask & HOLIDAY_IGNORE_MASK) || (typeof ev.eventTime !== 'undefined')) {
+    if (mask & HOLIDAY_IGNORE_MASK ||
+        typeof ev.eventTime !== 'undefined') {
         return '';
     }
-    const reading = (mask & flags.PARSHA_HASHAVUA) ?
-        getLeyningForParshaHaShavua(ev, il) :
-        getLeyningForHoliday(ev, il);
+    const reading = mask & flags.PARSHA_HASHAVUA
+        ? getLeyningForParshaHaShavua(ev, il)
+        : getLeyningForHoliday(ev, il);
     let memo = '';
     if (reading && (reading.summary || reading.haftara)) {
         if (reading.summary) {
@@ -1004,10 +1028,12 @@ function appendIsraelAndTracking(url, il, utmSource, utmMedium, utmCampaign) {
             else if (isSedrot) {
                 shortenSedrotUrl(u);
             }
-            else { // isOmer
+            else {
+                // isOmer
                 u.pathname = '/o/' + path.substring(6);
             }
-            if (!utmCampaign || !(utmCampaign.startsWith('ical-') || utmCampaign.startsWith('pdf-'))) {
+            if (!utmCampaign ||
+                !(utmCampaign.startsWith('ical-') || utmCampaign.startsWith('pdf-'))) {
                 if (utmSource) {
                     u.searchParams.set('us', utmSource);
                 }
@@ -1040,12 +1066,14 @@ function shouldRenderBrief(ev) {
     const mask = ev.getFlags();
     if (mask & flags.HEBREW_DATE) {
         const hd = ev.getDate();
-        return (hd.getDate() === 1) ? false : true;
+        return hd.getDate() === 1 ? false : true;
     }
-    else if (mask & (flags.DAILY_LEARNING | flags.DAF_YOMI | flags.YERUSHALMI_YOMI)) {
+    else if (mask &
+        (flags.DAILY_LEARNING | flags.DAF_YOMI | flags.YERUSHALMI_YOMI)) {
         return true;
     }
-    else if (mask & flags.MINOR_FAST && ev.getDesc().substring(0, 16) === 'Yom Kippur Katan') {
+    else if (mask & flags.MINOR_FAST &&
+        ev.getDesc().substring(0, 16) === 'Yom Kippur Katan') {
         return true;
     }
     else if (mask & flags.SHABBAT_MEVARCHIM) {
@@ -1081,15 +1109,20 @@ function eventToCsv(ev, options) {
     const mday = d.getDate();
     const mon = d.getMonth() + 1;
     const year = String(d.getFullYear()).padStart(4, '0');
-    const date = options.euro ? `"${mday}/${mon}/${year}"` : `"${mon}/${mday}/${year}"`;
+    const date = options.euro
+        ? `"${mday}/${mon}/${year}"`
+        : `"${mon}/${mday}/${year}"`;
     let startTime = '';
     let endTime = '';
     let endDate = '';
     let allDay = '"true"';
-    const timed = Boolean(ev.eventTime);
-    let subj = shouldRenderBrief(ev) ? ev.renderBrief(options.locale) : ev.render(options.locale);
+    const timedEv = ev;
+    const timed = Boolean(timedEv.eventTime);
+    let subj = shouldRenderBrief(ev)
+        ? ev.renderBrief(options.locale)
+        : ev.render(options.locale);
     if (timed) {
-        const timeStr = HebrewCalendar.reformatTimeStr(ev.eventTimeStr, ' PM', options);
+        const timeStr = HebrewCalendar.reformatTimeStr(timedEv.eventTimeStr, ' PM', options);
         endTime = startTime = `"${timeStr}"`;
         endDate = date;
         allDay = '"false"';
@@ -1108,7 +1141,7 @@ function eventToCsv(ev, options) {
             loc = category;
         }
     }
-    subj = subj.replace(/,/g, '').replace(/"/g, '\'\'');
+    subj = subj.replace(/,/g, '').replace(/"/g, "''");
     if (options.appendHebrewToSubject) {
         const hebrew = ev.renderBrief('he');
         if (hebrew) {
@@ -1116,15 +1149,19 @@ function eventToCsv(ev, options) {
         }
     }
     let memo0 = ev.memo || getHolidayDescription(ev, true);
-    if (!memo0 && typeof ev.linkedEvent !== 'undefined') {
-        memo0 = ev.linkedEvent.render(options.locale);
-    }
-    const memo = memo0.replace(/,/g, ';').replace(/"/g, '\'\'').replace(/\n/g, ' / ');
-    const showTimeAs = (timed || (mask & flags.CHAG)) ? 4 : 3;
+    if (!memo0 && typeof timedEv.linkedEvent !== 'undefined') {
+        memo0 = timedEv.linkedEvent.render(options.locale);
+    }
+    const memo = memo0
+        .replace(/,/g, ';')
+        .replace(/"/g, "''")
+        .replace(/\n/g, ' / ');
+    const showTimeAs = timed || mask & flags.CHAG ? 4 : 3;
     return `"${subj}",${date},${startTime},${endDate},${endTime},${allDay},"${memo}","${showTimeAs}","${loc}"`;
 }
 function eventsToCsv(events, options) {
-    return [csvHeader].concat(events.map((ev) => eventToCsv(ev, options))).join('\r\n') + '\r\n';
+    return ([csvHeader].concat(events.map(ev => eventToCsv(ev, options))).join('\r\n') +
+        '\r\n');
 }
 
 function eventIsoDate(ev) {
@@ -1137,6 +1174,7 @@ function eventsToClassicApi(events, options, leyning = true) {
     const result = {
         title: getCalendarTitle(events, options),
         date: new Date().toISOString(),
+        version,
     };
     result.location = locationToPlainObj(options.location);
     if (events.length) {
@@ -1145,28 +1183,31 @@ function eventsToClassicApi(events, options, leyning = true) {
             end: eventIsoDate(events[events.length - 1]),
         };
     }
-    result.items = events.map((ev) => eventToClassicApiObject(ev, options, leyning));
+    result.items = events.map(ev => eventToClassicApiObject(ev, options, leyning));
     return result;
 }
 /**
  * Converts a Hebcal event to a classic Hebcal.com JSON API object
  */
 function eventToClassicApiObject(ev, options, leyning = true) {
-    const eventTime = ev.eventTime;
+    const timedEv = ev;
+    const eventTime = timedEv.eventTime;
     const timed = Boolean(eventTime);
     const hd = ev.getDate();
     const dt = hd.greg();
     const tzid = typeof options.location === 'object' ? options.location.getTzid() : 'UTC';
-    const date = timed ?
-        Zmanim.formatISOWithTimeZone(tzid, eventTime) :
-        isoDateString(dt);
+    const date = timed
+        ? Zmanim.formatISOWithTimeZone(tzid, eventTime)
+        : isoDateString(dt);
     const categories = getEventCategories(ev);
     const mask = ev.getFlags();
-    let title = shouldRenderBrief(ev) ? ev.renderBrief(options.locale) : ev.render(options.locale);
+    let title = shouldRenderBrief(ev)
+        ? ev.renderBrief(options.locale)
+        : ev.render(options.locale);
     const desc = ev.getDesc();
     const candles = desc === 'Havdalah' || desc === 'Candle lighting';
     if (candles) {
-        const time = HebrewCalendar.reformatTimeStr(ev.eventTimeStr, 'pm', options);
+        const time = HebrewCalendar.reformatTimeStr(timedEv.eventTimeStr, 'pm', options);
         title += ': ' + time;
     }
     const result = {
@@ -1180,10 +1221,10 @@ function eventToClassicApiObject(ev, options, leyning = true) {
     if (categories.length > 1) {
         result.subcat = categories[1];
     }
-    if (categories[0] === 'holiday' && (mask & flags.CHAG)) {
+    if (categories[0] === 'holiday' && mask & flags.CHAG) {
         result.yomtov = true;
     }
-    if (title != desc) {
+    if (title !== desc) {
         result.title_orig = desc;
     }
     const hebrew = ev.renderBrief('he');
@@ -1193,10 +1234,10 @@ function eventToClassicApiObject(ev, options, leyning = true) {
     if (!candles) {
         if (leyning) {
             const il = options.il;
-            const isParsha = (mask === flags.PARSHA_HASHAVUA);
-            const reading = isParsha ?
-                getLeyningForParshaHaShavua(ev, il) :
-                getLeyningForHoliday(ev, il);
+            const isParsha = mask === flags.PARSHA_HASHAVUA;
+            const reading = isParsha
+                ? getLeyningForParshaHaShavua(ev, il)
+                : getLeyningForHoliday(ev, il);
             if (reading) {
                 result.leyning = formatLeyningResult(reading);
                 const hyear = hd.getFullYear();
@@ -1244,7 +1285,7 @@ function eventToClassicApiObject(ev, options, leyning = true) {
         };
         delete result.hebrew;
     }
-    if ((options.heDateParts && !timed) || (mask & flags.HEBREW_DATE)) {
+    if ((options.heDateParts && !timed) || mask & flags.HEBREW_DATE) {
         const yy = hd.getFullYear();
         const mm = hd.getMonthName();
         const dd = hd.getDate();
@@ -1258,8 +1299,8 @@ function eventToClassicApiObject(ev, options, leyning = true) {
     if (typeof memo === 'string' && memo.length !== 0) {
         result.memo = memo.normalize();
     }
-    else if (typeof ev.linkedEvent !== 'undefined') {
-        result.memo = ev.linkedEvent.render(options.locale);
+    else if (typeof timedEv.linkedEvent !== 'undefined') {
+        result.memo = timedEv.linkedEvent.render(options.locale);
     }
     if (options.includeEvent) {
         result.ev = ev;
@@ -1269,7 +1310,7 @@ function eventToClassicApiObject(ev, options, leyning = true) {
 function formatAliyot(result, aliyot) {
     for (const [num, aliyah] of Object.entries(aliyot)) {
         if (typeof aliyah !== 'undefined') {
-            const k = num == 'M' ? 'maftir' : num;
+            const k = num === 'M' ? 'maftir' : num;
             result[k] = formatAliyahWithBook(aliyah);
         }
     }
@@ -1278,7 +1319,7 @@ function formatAliyot(result, aliyot) {
 function formatReasons(result, reason) {
     for (const num of ['7', '8', 'M']) {
         if (reason[num]) {
-            const k = num == 'M' ? 'maftir' : num;
+            const k = num === 'M' ? 'maftir' : num;
             result[k] += ' | ' + reason[num];
         }
     }
@@ -1331,12 +1372,12 @@ function getLinkAndGuid(ev, il, tzid, mainUrl, utmSource, utmMedium) {
     return [link, guid];
 }
 const localeToLg = {
-    's': 'en',
-    'a': 'en',
+    s: 'en',
+    a: 'en',
     'he-x-NoNikud': 'he',
-    'h': 'he',
-    'ah': 'en',
-    'sh': 'en',
+    h: 'he',
+    ah: 'en',
+    sh: 'en',
 };
 function eventsToRss2(events, options) {
     options.dayFormat = new Intl.DateTimeFormat('en-US', {
@@ -1349,9 +1390,9 @@ function eventsToRss2(events, options) {
     if (!options.mainUrl || !options.selfUrl) {
         throw new TypeError('mainUrl cannot be empty or blank');
     }
-    const buildDate = options.buildDate = options.buildDate || new Date();
+    const buildDate = (options.buildDate = options.buildDate || new Date());
     const thisYear = buildDate.getFullYear();
-    const lastBuildDate = options.lastBuildDate = buildDate.toUTCString();
+    const lastBuildDate = (options.lastBuildDate = buildDate.toUTCString());
     const title = options.title || getCalendarTitle(events, options);
     const description = options.description || title;
     const utmSource = options.utmSource || 'shabbat1c';
@@ -1406,7 +1447,7 @@ function eventToRssItem2(ev, options) {
     let memo;
     if (candles) {
         const colon = subj.indexOf(': ');
-        if (colon != -1) {
+        if (colon !== -1) {
             const options = { location, il, locale: Locale$1.getLocaleName() };
             const time = HebrewCalendar.reformatTimeStr(ev.eventTimeStr, 'pm', options);
             subj = subj.substring(0, colon) + ': ' + time;
@@ -1416,11 +1457,11 @@ function eventToRssItem2(ev, options) {
         memo = makeMemo(ev, il);
     }
     const dayFormat = options.dayFormat;
-    const description0 = memo || dayFormat.format(evDate);
-    const description = description0.indexOf('<') === -1 ? description0 : `<![CDATA[${description0}]]>`;
-    const geoTags = (cat0 == 'candles') ?
-        `<geo:lat>${location.getLatitude()}</geo:lat>\n<geo:long>${location.getLongitude()}</geo:long>\n` :
-        '';
+    const tmp = memo || dayFormat.format(evDate);
+    const description = tmp.indexOf('<') === -1 ? tmp : `<![CDATA[${tmp}]]>`;
+    const geoTags = cat0 === 'candles'
+        ? `<geo:lat>${location.getLatitude()}</geo:lat>\n<geo:long>${location.getLongitude()}</geo:long>\n`
+        : '';
     return `<item>
 <title>${subj}</title>
 <link>${link}</link>
@@ -1438,15 +1479,16 @@ ${geoTags}</item>
 function eventToFullCalendar(ev, tzid, il) {
     const classes = getEventCategories(ev);
     const mask = ev.getFlags();
-    if (classes[0] == 'holiday' && mask & flags.CHAG) {
+    if (classes[0] === 'holiday' && mask & flags.CHAG) {
         classes.push('yomtov');
     }
-    const eventTime = ev.eventTime;
+    const timedEv = ev;
+    const eventTime = timedEv.eventTime;
     const timed = Boolean(eventTime);
     const title = shouldRenderBrief(ev) ? ev.renderBrief() : ev.render();
-    const start = timed ?
-        Zmanim.formatISOWithTimeZone(tzid, eventTime) :
-        isoDateString(ev.getDate().greg());
+    const start = timed
+        ? Zmanim.formatISOWithTimeZone(tzid, eventTime)
+        : isoDateString(ev.getDate().greg());
     const result = {
         title,
         start,
@@ -1468,8 +1510,8 @@ function eventToFullCalendar(ev, tzid, il) {
         if (memo) {
             result.description = memo;
         }
-        else if (typeof ev.linkedEvent !== 'undefined') {
-            result.description = ev.linkedEvent.render();
+        else if (typeof timedEv.linkedEvent !== 'undefined') {
+            result.description = timedEv.linkedEvent.render();
         }
     }
     return result;

package/dist/module.d.ts

@@ -10,7 +10,7 @@ type RestApiEventOptions = {
     utmCampaign?: string;
     appendHebrewToSubject?: boolean;
     yahrzeit?: boolean;
-    subscribe?: string | boolean;
+    subscribe?: string | number | boolean;
     heDateParts?: boolean;
     includeEvent?: boolean;
     euro?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "5.1.4",
+  "version": "5.2.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -30,7 +30,8 @@
   },
   "dependencies": {
     "@hebcal/core": "^5.5.2",
-    "@hebcal/leyning": "^8.2.6",
+    "@hebcal/hdate": "^0.11.5",
+    "@hebcal/leyning": "^8.2.7",
     "@hebcal/triennial": "^5.1.3"
   },
   "scripts": {
@@ -40,25 +41,29 @@
     "prepublish": "npm run build",
     "pretest": "npm run build",
     "docs": "typedoc",
+    "lint": "gts lint",
+    "coverage": "jest --coverage",
+    "clean": "gts clean",
+    "fix": "gts fix",
     "test": "jest"
   },
   "license": "BSD-2-Clause",
   "devDependencies": {
-    "@babel/preset-env": "^7.25.7",
+    "@babel/preset-env": "^7.25.8",
     "@babel/preset-typescript": "^7.25.7",
     "@hebcal/learning": "^5.1.1",
-    "@rollup/plugin-commonjs": "^28.0.0",
+    "@rollup/plugin-commonjs": "^28.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.3.0",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.1.0",
+    "@rollup/plugin-typescript": "^12.1.1",
     "@types/jest": "^29.5.13",
     "gts": "^5.3.1",
     "jest": "^29.7.0",
     "rollup": "^4.24.0",
     "rollup-plugin-dts": "^6.1.1",
     "ts-jest": "^29.2.5",
-    "typedoc": "^0.26.8",
-    "typescript": "^5.6.2"
+    "typedoc": "^0.26.10",
+    "typescript": "^5.6.3"
   }
 }