@hebcal/rest-api 3.19.3 → 4.0.0

package/README.md

@@ -44,15 +44,9 @@ Converts to lowercase and replaces non-word characters with hyphen ('-')
 <dd></dd>
 <dt><a href="#pad4">pad4(number)</a> ⇒ <code>string</code></dt>
 <dd></dd>
-<dt><del><a href="#timeZoneOffsetStr">timeZoneOffsetStr(tzid, date)</a> ⇒ <code>string</code></del></dt>
-<dd><p>Get offset string (like &quot;+05:00&quot; or &quot;-08:00&quot;) from tzid (like &quot;Europe/Moscow&quot;)</p>
-</dd>
 <dt><a href="#toISOString">toISOString(d)</a> ⇒ <code>string</code></dt>
 <dd><p>Returns just the date portion as YYYY-MM-DD</p>
 </dd>
-<dt><del><a href="#toISOStringWithTimezone">toISOStringWithTimezone(date, timeStr, tzid)</a> ⇒ <code>string</code></del></dt>
-<dd><p>Returns a string like &quot;2018-09-01T12:30:00-05:00&quot;</p>
-</dd>
 <dt><a href="#getEventCategories">getEventCategories(ev)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
 <dd><p>Returns a category and subcategory name</p>
 </dd>
@@ -86,14 +80,10 @@ Converts to lowercase and replaces non-word characters with hyphen (&#39;-&#39;)
 <dd></dd>
 <dt><a href="#formatLeyningResult">formatLeyningResult(reading)</a> ⇒ <code>Object</code></dt>
 <dd></dd>
-<dt><a href="#eventsToRss">eventsToRss(events, location, mainUrl, selfUrl, [lang], [evPubDate])</a> ⇒ <code>string</code></dt>
-<dd></dd>
 <dt><a href="#eventsToRss2">eventsToRss2(events, options)</a> ⇒ <code>string</code></dt>
 <dd></dd>
 <dt><a href="#eventToRssItem2">eventToRssItem2(ev, options)</a> ⇒ <code>string</code></dt>
 <dd></dd>
-<dt><a href="#eventToRssItem">eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl, [options])</a> ⇒ <code>string</code></dt>
-<dd></dd>
 <dt><a href="#eventToFullCalendar">eventToFullCalendar(ev, tzid, il)</a> ⇒ <code>Object</code></dt>
 <dd><p>Converts a Hebcal event to a FullCalendar.io object</p>
 </dd>
@@ -151,20 +141,6 @@ makeAnchor('Rosh Chodesh Adar II') // 'rosh-chodesh-adar-ii'
 | --- | --- |
 | number | <code>number</code> | 
 
-<a name="timeZoneOffsetStr"></a>
-
-## ~~timeZoneOffsetStr(tzid, date) ⇒ <code>string</code>~~
-***Deprecated***
-
-Get offset string (like "+05:00" or "-08:00") from tzid (like "Europe/Moscow")
-
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| tzid | <code>string</code> | 
-| date | <code>Date</code> | 
-
 <a name="toISOString"></a>
 
 ## toISOString(d) ⇒ <code>string</code>
@@ -176,21 +152,6 @@ Returns just the date portion as YYYY-MM-DD
 | --- | --- |
 | d | <code>Date</code> | 
 
-<a name="toISOStringWithTimezone"></a>
-
-## ~~toISOStringWithTimezone(date, timeStr, tzid) ⇒ <code>string</code>~~
-***Deprecated***
-
-Returns a string like "2018-09-01T12:30:00-05:00"
-
-**Kind**: global function  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| date | <code>Date</code> |  |
-| timeStr | <code>string</code> | must be formatted with only hours and minutes, like "17:12" |
-| tzid | <code>string</code> | like "America/New_York" |
-
 <a name="getEventCategories"></a>
 
 ## getEventCategories(ev) ⇒ <code>Array.&lt;string&gt;</code>
@@ -329,21 +290,7 @@ Converts a Hebcal event to a classic Hebcal.com JSON API object
 
 | Param | Type |
 | --- | --- |
-| reading | <code>leyn.Leyning</code> | 
-
-<a name="eventsToRss"></a>
-
-## eventsToRss(events, location, mainUrl, selfUrl, [lang], [evPubDate]) ⇒ <code>string</code>
-**Kind**: global function  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| events | <code>Array.&lt;Event&gt;</code> |  |  |
-| location | <code>Location</code> |  |  |
-| mainUrl | <code>string</code> |  |  |
-| selfUrl | <code>string</code> |  |  |
-| [lang] | <code>string</code> | <code>&quot;en-US&quot;</code> | language such as 'he' (default 'en-US') |
-| [evPubDate] | <code>boolean</code> | <code>true</code> | if true, use event time as pubDate (false uses lastBuildDate) |
+| reading | <code>Leyning</code> | 
 
 <a name="eventsToRss2"></a>
 
@@ -365,21 +312,6 @@ Converts a Hebcal event to a classic Hebcal.com JSON API object
 | ev | <code>Event</code> | 
 | options | <code>CalOptions</code> | 
 
-<a name="eventToRssItem"></a>
-
-## eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl, [options]) ⇒ <code>string</code>
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| ev | <code>Event</code> | 
-| evPubDate | <code>boolean</code> | 
-| lastBuildDate | <code>string</code> | 
-| dayFormat | <code>Intl.DateTimeFormat</code> | 
-| location | <code>Location</code> | 
-| mainUrl | <code>string</code> | 
-| [options] | <code>CalOptions</code> | 
-
 <a name="eventToFullCalendar"></a>
 
 ## eventToFullCalendar(ev, tzid, il) ⇒ <code>Object</code>

package/dist/bundle.js

@@ -1,27 +1,7 @@
-/*! @hebcal/rest-api v3.19.3 */
-var hebcal__rest_api = (function (exports, core, leyn) {
+/*! @hebcal/rest-api v4.0.0 */
+var hebcal__rest_api = (function (exports, core, leyning) {
 'use strict';
 
-function _interopNamespace(e) {
-if (e && e.__esModule) return e;
-var n = Object.create(null);
-if (e) {
-Object.keys(e).forEach(function (k) {
-if (k !== 'default') {
-var d = Object.getOwnPropertyDescriptor(e, k);
-Object.defineProperty(n, k, d.get ? d : {
-enumerable: true,
-get: function () { return e[k]; }
-});
-}
-});
-}
-n["default"] = e;
-return Object.freeze(n);
-}
-
-var leyn__namespace = /*#__PURE__*/_interopNamespace(leyn);
-
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 var check = function (it) {
@@ -4006,17 +3986,32 @@ function makeAnchor(s) {
  */
 
 function getDownloadFilename(options) {
-  let fileName = 'hebcal_' + options.year;
+  let fileName = 'hebcal';
 
-  if (options.isHebrewYear) {
-    fileName += 'h';
-  }
+  if (options.year) {
+    fileName += '_' + options.year;
+
+    if (options.isHebrewYear) {
+      fileName += 'h';
+    }
 
-  if (options.month) {
-    fileName += '_' + options.month;
+    if (options.month) {
+      fileName += '_' + options.month;
+    }
+  } else if (typeof options.start === 'object' && typeof options.end === 'object') {
+    const start = new core.HDate(options.start);
+    const end = new core.HDate(options.end);
+    const y1 = start.greg().getFullYear();
+    const y2 = end.greg().getFullYear();
+
+    if (y1 === y2) {
+      fileName += '_' + y1;
+    } else {
+      fileName += '_' + y1 + '_' + y2;
+    }
   }
 
-  if (options.location) {
+  if (typeof options.location === 'object') {
     const loc = options.location;
     const name = loc.zip || loc.asciiname || loc.getShortName();
 
@@ -4037,7 +4032,7 @@ function pad2(number) {
     return '0' + number;
   }
 
-  return String(number);
+  return '' + number;
 }
 /**
  * @param {number} number
@@ -4055,18 +4050,7 @@ function pad4(number) {
     return '0' + number;
   }
 
-  return String(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 core.Zmanim.timeZoneOffset(tzid, date);
+  return '' + number;
 }
 /**
  * Returns just the date portion as YYYY-MM-DD
@@ -4077,20 +4061,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' + core.Zmanim.timeZoneOffset(tzid, date);
-}
 /**
  * Returns a category and subcategory name
  * @param {Event} ev
@@ -4272,7 +4242,7 @@ function makeTorahMemoText(ev, il) {
     return '';
   }
 
-  const reading = mask & core.flags.PARSHA_HASHAVUA ? leyn__namespace.getLeyningForParshaHaShavua(ev, il) : leyn__namespace.getLeyningForHoliday(ev, il);
+  const reading = mask & core.flags.PARSHA_HASHAVUA ? leyning.getLeyningForParshaHaShavua(ev, il) : leyning.getLeyningForHoliday(ev, il);
   let memo = '';
 
   if (reading && (reading.summary || reading.haftara)) {
@@ -4529,7 +4499,7 @@ function eventsToClassicApi(events, options) {
  */
 
 function eventToClassicApiObject(ev, options) {
-  let leyning = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+  let leyning$1 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
   const timed = Boolean(ev.eventTime);
   const hd = ev.getDate();
   const dt = hd.greg();
@@ -4576,20 +4546,20 @@ function eventToClassicApiObject(ev, options) {
   }
 
   if (!candles) {
-    if (leyning) {
+    if (leyning$1) {
       const il = options.il;
       const isParsha = mask === core.flags.PARSHA_HASHAVUA;
-      const reading = isParsha ? leyn__namespace.getLeyningForParshaHaShavua(ev, il) : leyn__namespace.getLeyningForHoliday(ev, il);
+      const reading = isParsha ? leyning.getLeyningForParshaHaShavua(ev, il) : leyning.getLeyningForHoliday(ev, il);
 
       if (reading) {
         result.leyning = formatLeyningResult(reading);
         const hyear = hd.getFullYear();
 
-        if (isParsha && !il && hyear >= 5745 && hyear <= 5830) {
-          const triReading = leyn__namespace.getTriennialForParshaHaShavua(ev);
+        if (isParsha && !il && hyear >= 5745) {
+          const triReading = leyning.getTriennialForParshaHaShavua(ev);
 
           if (triReading) {
-            result.leyning.triennial = formatAliyot({}, triReading);
+            result.leyning.triennial = formatAliyot({}, triReading.aliyot);
           }
         }
       }
@@ -4619,6 +4589,17 @@ function eventToClassicApiObject(ev, options) {
     };
   }
 
+  if (mask & core.flags.HEBREW_DATE) {
+    const yy = hd.getFullYear();
+    const mm = hd.getMonthName();
+    const dd = hd.getDate();
+    result.heDateParts = {
+      y: core.gematriya(yy),
+      m: core.Locale.gettext(mm, 'he-x-NoNikud'),
+      d: core.gematriya(dd)
+    };
+  }
+
   const memo = ev.memo || holidayDescription[ev.basename()];
 
   if (memo) {
@@ -4645,13 +4626,13 @@ function formatAliyot(result, aliyot) {
 
     if (typeof aliyah !== 'undefined') {
       const k = num == 'M' ? 'maftir' : num;
-      result[k] = leyn__namespace.formatAliyahWithBook(aliyah);
+      result[k] = leyning.formatAliyahWithBook(aliyah);
     }
   });
   return result;
 }
 /**
- * @param {leyn.Leyning} reading
+ * @param {Leyning} reading
  * @return {Object}
  */
 
@@ -4725,34 +4706,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) {
-  let lang = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 'en-US';
-  let evPubDate = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : true;
-  const cityDescr = location.getName();
-  const options = {
-    location,
-    mainUrl,
-    selfUrl,
-    lang,
-    evPubDate,
-    title: core.Locale.gettext('Shabbat') + " Times for ".concat(cityDescr),
-    description: "Weekly Shabbat candle lighting times for ".concat(cityDescr),
-    utmSource: 'shabbat1c',
-    utmMedium: 'rss'
-  };
-  return eventsToRss2(events, options);
-}
 const localeToLg = {
   's': 'en',
   'a': 'en',
@@ -4823,28 +4777,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);
@@ -4869,6 +4810,7 @@ function eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainU
     memo = ev.getFlags() & core.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>".concat(location.getLatitude(), "</geo:lat>\n<geo:long>").concat(location.getLongitude(), "</geo:long>\n") : '';
   return "<item>\n<title>".concat(subj, "</title>\n<link>").concat(link, "</link>\n<guid isPermaLink=\"false\">").concat(guid, "</guid>\n<description>").concat(description, "</description>\n<category>").concat(cat0, "</category>\n<pubDate>").concat(pubDate, "</pubDate>\n").concat(geoTags, "</item>\n");
@@ -4932,11 +4874,9 @@ exports.countryNames = countryNames;
 exports.eventToClassicApiObject = eventToClassicApiObject;
 exports.eventToCsv = eventToCsv;
 exports.eventToFullCalendar = eventToFullCalendar;
-exports.eventToRssItem = eventToRssItem;
 exports.eventToRssItem2 = eventToRssItem2;
 exports.eventsToClassicApi = eventsToClassicApi;
 exports.eventsToCsv = eventsToCsv;
-exports.eventsToRss = eventsToRss;
 exports.eventsToRss2 = eventsToRss2;
 exports.getCalendarTitle = getCalendarTitle;
 exports.getDownloadFilename = getDownloadFilename;
@@ -4950,9 +4890,7 @@ exports.pad2 = pad2;
 exports.pad4 = pad4;
 exports.renderTitleWithoutTime = renderTitleWithoutTime;
 exports.shouldRenderBrief = shouldRenderBrief;
-exports.timeZoneOffsetStr = timeZoneOffsetStr;
 exports.toISOString = toISOString;
-exports.toISOStringWithTimezone = toISOStringWithTimezone;
 
 Object.defineProperty(exports, '__esModule', { value: true });