@hebcal/rest-api 3.10.1 → 3.13.0

package/dist/index.mjs

@@ -1,4 +1,4 @@
-/*! @hebcal/rest-api v3.10.1 */
+/*! @hebcal/rest-api v3.13.0 */
 import { flags, Zmanim, HebrewCalendar, Locale } from '@hebcal/core';
 import * as leyn from '@hebcal/leyning';
 
@@ -156,6 +156,9 @@ function getEventCategories(ev) {
 
     case flags.MINOR_HOLIDAY:
       return ['holiday', 'minor'];
+
+    case flags.MISHNA_YOMI:
+      return ['mishnayomi'];
     // fall through to string-based category
   }
 
@@ -318,16 +321,60 @@ function makeTorahMemoText(ev, il) {
  */
 
 function appendIsraelAndTracking(url, il, utmSource, utmMedium, utmCampaign) {
-  if (url.substring(0, 22) !== 'https://www.hebcal.com') {
-    utmSource = 'hebcal.com';
-  } else if (il && url.indexOf('?') === -1) {
-    url += '?i=on';
+  const u = new URL(url);
+  const isHebcal = u.host === 'www.hebcal.com';
+
+  if (isHebcal) {
+    if (il) {
+      u.searchParams.set('i', 'on');
+    }
+
+    const path = u.pathname;
+    const isHolidays = path.startsWith('/holidays/');
+    const isSedrot = path.startsWith('/sedrot/');
+
+    if (isHolidays || isSedrot) {
+      u.host = 'hebcal.com';
+
+      if (isHolidays) {
+        u.pathname = '/h/' + path.substring(10);
+      } else {
+        u.pathname = '/s/' + path.substring(8);
+      }
+
+      if (!utmCampaign || !(utmCampaign.startsWith('ical-') || utmCampaign.startsWith('pdf-'))) {
+        if (utmSource) {
+          u.searchParams.set('us', utmSource);
+        }
+
+        if (utmMedium) {
+          u.searchParams.set('um', utmMedium);
+        }
+      }
+
+      if (utmCampaign) {
+        u.searchParams.set('uc', utmCampaign);
+      }
+
+      return u.toString();
+    }
+  }
+
+  utmSource = isHebcal ? utmSource : 'hebcal.com';
+
+  if (utmSource) {
+    u.searchParams.set('utm_source', utmSource);
   }
 
-  const sep = url.indexOf('?') === -1 ? '?' : '&';
-  const utm = `utm_source=${utmSource}&utm_medium=${utmMedium}`;
-  const campaign = utmCampaign ? `&utm_campaign=${utmCampaign}` : '';
-  return url + sep + utm + campaign;
+  if (utmMedium) {
+    u.searchParams.set('utm_medium', utmMedium);
+  }
+
+  if (utmCampaign) {
+    u.searchParams.set('utm_campaign', utmCampaign);
+  }
+
+  return u.toString();
 }
 /**
  * @private
@@ -467,7 +514,7 @@ function eventsToClassicApi(events, options, leyning = true) {
       cc: location.getCountryCode(),
       country: countryNames[location.getCountryCode()]
     };
-    ['admin1', 'asciiname', 'geo', 'zip', 'state', 'geonameid'].forEach(k => {
+    ['admin1', 'asciiname', 'geo', 'zip', 'state', 'stateName', 'geonameid'].forEach(k => {
       if (location[k]) {
         result.location[k] = location[k];
       }
@@ -634,10 +681,12 @@ function formatLeyningResult(reading) {
  * @param {boolean} il
  * @param {string} tzid
  * @param {string} mainUrl
+ * @param {string} utmSource
+ * @param {string} utmMedium
  * @return {string[]}
  */
 
-function getLinkAndGuid(ev, il, tzid, mainUrl) {
+function getLinkAndGuid(ev, il, tzid, mainUrl, utmSource, utmMedium) {
   let link;
   let guid;
   const dt = ev.eventTime || ev.getDate().greg();
@@ -649,11 +698,11 @@ function getLinkAndGuid(ev, il, tzid, mainUrl) {
   const url0 = ev.url();
 
   if (url0) {
-    link = appendIsraelAndTracking(url0, il, 'shabbat1c', 'rss').replace(/&/g, '&');
+    link = appendIsraelAndTracking(url0, il, utmSource, utmMedium).replace(/&/g, '&');
     guid = `${url0}#${anchor}`;
   } else {
     const url1 = `${mainUrl}&dt=${dtStr}`;
-    const url = appendIsraelAndTracking(url1, il, 'shabbat1c', 'rss').replace(/&/g, '&');
+    const url = appendIsraelAndTracking(url1, il, utmSource, utmMedium).replace(/&/g, '&');
     guid = url1.replace(/&/g, '&') + `#${anchor}`;
     link = `${url}#${anchor}`;
   }
@@ -701,7 +750,7 @@ const localeToLg = {
  */
 
 function eventsToRss2(events, options) {
-  const dayFormat = new Intl.DateTimeFormat('en-US', {
+  options.dayFormat = new Intl.DateTimeFormat('en-US', {
     weekday: 'long',
     day: '2-digit',
     month: 'long',
@@ -709,13 +758,14 @@ function eventsToRss2(events, options) {
   });
   const location = options.location;
   const mainUrl = options.mainUrl;
-  const evPubDate = options.evPubDate;
-  const buildDate = options.buildDate || new Date();
+  const buildDate = options.buildDate = options.buildDate || new Date();
   const thisYear = buildDate.getFullYear();
-  const lastBuildDate = buildDate.toUTCString();
+  const lastBuildDate = options.lastBuildDate = buildDate.toUTCString();
   const title = options.title || getCalendarTitle(events, options);
   const description = options.description || title;
-  const mainUrlEsc = appendIsraelAndTracking(mainUrl, location && location.getIsrael(), options.utmSource, options.utmMedium, options.utmCampaign).replace(/&/g, '&');
+  const utmSource = options.utmSource || 'shabbat1c';
+  const utmMedium = options.utmMedium || 'rss';
+  const mainUrlEsc = appendIsraelAndTracking(mainUrl, location && location.getIsrael(), utmSource, utmMedium, options.utmCampaign).replace(/&/g, '&');
   const selfUrlEsc = options.selfUrl.replace(/&/g, '&');
   const lang = options.lang || localeToLg[options.locale] || options.locale || 'en-US';
   let str = `<?xml version="1.0" encoding="UTF-8"?>
@@ -730,7 +780,7 @@ function eventsToRss2(events, options) {
 <lastBuildDate>${lastBuildDate}</lastBuildDate>
 `;
   events.forEach(ev => {
-    str += eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl);
+    str += eventToRssItem2(ev, options);
   });
   str += '</channel>\n</rss>\n';
   return str;
@@ -757,6 +807,16 @@ function getPubDate(ev, evPubDate, evDate, lastBuildDate) {
 
   return lastBuildDate;
 }
+/**
+ * @param {Event} ev
+ * @param {HebrewCalendar.Options} options
+ * @return {string}
+ */
+
+
+function eventToRssItem2(ev, options) {
+  return eventToRssItem(ev, options.evPubDate, options.lastBuildDate, options.dayFormat, options.location, options.mainUrl, options);
+}
 /**
  * @param {Event} ev
  * @param {boolean} evPubDate
@@ -764,17 +824,19 @@ function getPubDate(ev, evPubDate, evDate, lastBuildDate) {
  * @param {Intl.DateTimeFormat} dayFormat
  * @param {Location} location
  * @param {string} mainUrl
+ * @param {HebrewCalendar.Options} [options]
  * @return {string}
  */
 
-
-function eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl) {
+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 il = location ? location.getIsrael() : false;
   const tzid = location ? location.getTzid() : 'UTC';
-  const linkGuid = getLinkAndGuid(ev, il, tzid, mainUrl);
+  const utmSource = options && options.utmSource || 'shabbat1c';
+  const utmMedium = options && options.utmMedium || 'rss';
+  const linkGuid = getLinkAndGuid(ev, il, tzid, mainUrl, utmSource, utmMedium);
   const link = linkGuid[0];
   const guid = linkGuid[1];
   const categories = getEventCategories(ev);
@@ -865,4 +927,4 @@ function eventToFullCalendar(ev, tzid, il) {
   return result;
 }
 
-export { appendIsraelAndTracking, countryNames, eventToClassicApiObject, eventToCsv, eventToFullCalendar, eventToRssItem, eventsToClassicApi, eventsToCsv, eventsToRss, eventsToRss2, getCalendarTitle, getDownloadFilename, getEventCategories, getHolidayDescription, holidayDescription, makeAnchor, makeTorahMemoText, pad2, pad4, renderTitleWithoutTime, shouldRenderBrief, timeZoneOffsetStr, toISOString, toISOStringWithTimezone };
+export { appendIsraelAndTracking, countryNames, eventToClassicApiObject, eventToCsv, eventToFullCalendar, eventToRssItem, eventToRssItem2, eventsToClassicApi, eventsToCsv, eventsToRss, eventsToRss2, getCalendarTitle, getDownloadFilename, getEventCategories, getHolidayDescription, holidayDescription, makeAnchor, makeTorahMemoText, pad2, pad4, renderTitleWithoutTime, shouldRenderBrief, timeZoneOffsetStr, toISOString, toISOStringWithTimezone };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "3.10.1",
+  "version": "3.13.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -21,7 +21,7 @@
     "url": "https://github.com/hebcal/hebcal-rest-api/issues"
   },
   "dependencies": {
-    "@hebcal/core": "^3.30.0",
+    "@hebcal/core": "^3.33.3",
     "@hebcal/leyning": "^4.12.1"
   },
   "scripts": {
@@ -39,32 +39,24 @@
     "require": [
       "@babel/register"
     ],
-    "babel": {
-      "testOptions": {
-        "presets": [
-          "@babel/env"
-        ]
-      }
-    },
     "inherit": true,
     "verbose": true
   },
   "devDependencies": {
-    "@ava/babel": "^2.0.0",
-    "@babel/core": "^7.16.5",
-    "@babel/preset-env": "^7.16.5",
-    "@babel/register": "^7.16.5",
-    "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^21.0.1",
+    "@babel/core": "^7.17.5",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/register": "^7.17.0",
+    "@rollup/plugin-babel": "^5.3.1",
+    "@rollup/plugin-commonjs": "^21.0.2",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.1.1",
-    "ava": "^3.15.0",
-    "core-js": "^3.19.3",
-    "eslint": "^8.4.1",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "ava": "^4.1.0",
+    "core-js": "^3.21.1",
+    "eslint": "^8.10.0",
     "eslint-config-google": "^0.14.0",
-    "jsdoc": "^3.6.7",
-    "jsdoc-to-markdown": "^7.1.0",
-    "rollup": "^2.61.1",
+    "jsdoc": "^3.6.10",
+    "jsdoc-to-markdown": "^7.1.1",
+    "rollup": "^2.70.0",
     "rollup-plugin-terser": "^7.0.2"
   }
 }

package/rest-api.d.ts

@@ -40,7 +40,8 @@ declare module '@hebcal/rest-api' {
    */
   export function eventsToRss(events: Event[], location: Location, mainUrl: string, selfUrl: string, lang?: string, evPubDate?: boolean): string;
   export function eventsToRss2(events: Event[], options: HebrewCalendar.Options): string;
-  export function eventToRssItem(ev: Event, evPubDate: boolean, lastBuildDate: string, dayFormat: Intl.DateTimeFormat, location: Location, baseUrl: string): string;
+  export function eventToRssItem(ev: Event, evPubDate: boolean, lastBuildDate: string, dayFormat: Intl.DateTimeFormat, location: Location, baseUrl: string, options?: HebrewCalendar.Options): string;
+  export function eventToRssItem2(ev: Event, options: HebrewCalendar.Options): string;
   export function getDownloadFilename(options: HebrewCalendar.Options): string;
   export function pad2(number: number): string;
   export function pad4(number: number): string;