@hebcal/icalendar 4.21.0 → 5.0.0

package/dist/index.js

@@ -1,4 +1,4 @@
-/*! @hebcal/icalendar v4.21.0 */
+/*! @hebcal/icalendar v5.0.0 */
 'use strict';
 
 var core = require('@hebcal/core');
@@ -6,7 +6,7 @@ var murmurhash3 = require('murmurhash3');
 var restApi = require('@hebcal/rest-api');
 var fs = require('fs');
 
-const version="4.21.0";
+const version="5.0.0";
 
 const VTIMEZONE = {};
 const CATEGORY = {
@@ -43,7 +43,7 @@ function addOptional(arr, key, val) {
 /**
  * @private
  * @param {string} url
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string}
  */
 function appendTrackingToUrl(url, options) {
@@ -65,7 +65,7 @@ class IcalEvent {
   /**
    * Builds an IcalEvent object from a Hebcal Event
    * @param {Event} ev
-   * @param {HebrewCalendar.Options} options
+   * @param {CalOptions} options
    */
   constructor(ev, options = {}) {
     this.ev = ev;
@@ -90,9 +90,8 @@ class IcalEvent {
       this.locationName = core.Locale.gettext('Nach Yomi');
     } else if (mask & core.flags.MISHNA_YOMI) {
       this.locationName = core.Locale.gettext('Mishna Yomi');
-    } else if (timed && options.location && options.location.name) {
-      const comma = options.location.name.indexOf(',');
-      this.locationName = comma == -1 ? options.location.name : options.location.name.substring(0, comma);
+    } else if (timed && options.location) {
+      this.locationName = options.location.getShortName();
     }
     const date = IcalEvent.formatYYYYMMDD(ev.getDate().greg());
     this.startDate = date;
@@ -105,8 +104,8 @@ class IcalEvent {
       minute = +minute;
       this.startDate += 'T' + restApi.pad2(hour) + restApi.pad2(minute) + '00';
       this.endDate = this.startDate;
-      if (options.location && options.location.tzid) {
-        this.dtargs = `;TZID=${options.location.tzid}`;
+      if (options.location?.getTzid()) {
+        this.dtargs = `;TZID=${options.location.getTzid()}`;
       }
     } else {
       this.endDate = IcalEvent.formatYYYYMMDD(ev.getDate().next().greg());
@@ -174,10 +173,11 @@ class IcalEvent {
     const digest = murmurhash3.murmur32HexSync(this.ev.getDesc());
     let uid = `hebcal-${this.startDate}-${digest}`;
     if (this.timed && options.location) {
-      if (options.location.geoid) {
-        uid += `-${options.location.geoid}`;
-      } else if (options.location.name) {
-        uid += '-' + restApi.makeAnchor(options.location.name);
+      const loc = options.location;
+      if (loc.getGeoId()) {
+        uid += `-${loc.getGeoId()}`;
+      } else if (loc.getName()) {
+        uid += '-' + restApi.makeAnchor(loc.getName());
       }
     }
     return uid;
@@ -209,7 +209,7 @@ class IcalEvent {
     addOptional(arr, 'DESCRIPTION', memo);
     addOptional(arr, 'LOCATION', this.locationName);
     if (this.timed && options.location) {
-      arr.push('GEO:' + options.location.latitude + ';' + options.location.longitude);
+      arr.push('GEO:' + options.location.getLatitude() + ';' + options.location.getLongitude());
     }
     const trigger = this.getAlarm();
     if (trigger) {
@@ -317,7 +317,7 @@ class IcalEvent {
 /**
  * Transforms a single Event into a VEVENT string
  * @param {Event} ev
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string} multi-line result, delimited by \r\n
  */
 function eventToIcal(ev, options) {
@@ -354,17 +354,17 @@ function makeTorahMemo(ev, il) {
 /**
  * @private
  * @param {Event} e
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string}
  */
 function createMemo(e, options) {
-  const desc = e.getDesc();
-  const candles = desc === 'Havdalah' || desc === 'Candle lighting';
-  if (typeof e.memo === 'string' && e.memo.length && e.memo.indexOf('\n') !== -1) {
-    e.memo = e.memo.replace(/\n/g, '\\n');
+  let memo = e.memo;
+  if (typeof memo === 'string' && memo.length && memo.indexOf('\n') !== -1) {
+    memo = memo.replace(/\n/g, '\\n');
   }
-  if (candles) {
-    return e.memo || '';
+  const desc = e.getDesc();
+  if (desc === 'Havdalah' || desc === 'Candle lighting') {
+    return memo || '';
   }
   const mask = e.getFlags();
   if (mask & core.flags.OMER_COUNT) {
@@ -373,30 +373,32 @@ function createMemo(e, options) {
   }
   const url = appendTrackingToUrl(e.url(), options);
   const torahMemo = makeTorahMemo(e, options.il);
-  if (mask & core.flags.PARSHA_HASHAVUA) {
-    return torahMemo + '\\n\\n' + url;
-  } else {
-    let memo = e.memo || restApi.getHolidayDescription(e);
-    if (!memo && typeof e.linkedEvent !== 'undefined') {
+  if (!memo) {
+    if (typeof e.linkedEvent !== 'undefined') {
       memo = e.linkedEvent.render(options.locale);
+    } else {
+      memo = restApi.getHolidayDescription(e);
     }
-    if (torahMemo) {
-      memo += '\\n\\n' + torahMemo;
+  }
+  if (torahMemo) {
+    if (memo.length) {
+      memo += '\\n\\n';
     }
-    if (url) {
-      if (memo.length) {
-        memo += '\\n\\n';
-      }
-      memo += url;
+    memo += torahMemo;
+  }
+  if (url) {
+    if (memo.length) {
+      memo += '\\n\\n';
     }
-    return memo;
+    memo += url;
   }
+  return memo;
 }
 
 /**
  * Generates an RFC 2445 iCalendar string from an array of events
  * @param {Event[]} events
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {Promise<string>}
  */
 async function eventsToIcalendar(events, options) {
@@ -414,7 +416,7 @@ async function eventsToIcalendar(events, options) {
 /**
  * Generates an RFC 2445 iCalendar string from an array of IcalEvents
  * @param {IcalEvent[]} icals
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {Promise<string>}
  */
 async function icalEventsToString(icals, options) {
@@ -444,8 +446,8 @@ async function icalEventsToString(icals, options) {
     stream.push(`X-APPLE-CALENDAR-COLOR:${opts.calendarColor}\r\n`);
   }
   const location = opts.location;
-  if (location && location.tzid) {
-    const tzid = location.tzid;
+  const tzid = location?.getTzid();
+  if (tzid) {
     stream.push(`X-WR-TIMEZONE;VALUE=TEXT:${tzid}\r\n`);
     if (VTIMEZONE[tzid]) {
       stream.push(VTIMEZONE[tzid]);

package/dist/index.mjs

@@ -1,10 +1,10 @@
-/*! @hebcal/icalendar v4.21.0 */
+/*! @hebcal/icalendar v5.0.0 */
 import { flags, Locale, greg } from '@hebcal/core';
 import { murmur32HexSync } from 'murmurhash3';
 import { shouldRenderBrief, pad2, getEventCategories, makeAnchor, pad4, getHolidayDescription, getCalendarTitle, appendIsraelAndTracking, makeTorahMemoText } from '@hebcal/rest-api';
 import { promises } from 'fs';
 
-const version="4.21.0";
+const version="5.0.0";
 
 const VTIMEZONE = {};
 const CATEGORY = {
@@ -41,7 +41,7 @@ function addOptional(arr, key, val) {
 /**
  * @private
  * @param {string} url
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string}
  */
 function appendTrackingToUrl(url, options) {
@@ -63,7 +63,7 @@ class IcalEvent {
   /**
    * Builds an IcalEvent object from a Hebcal Event
    * @param {Event} ev
-   * @param {HebrewCalendar.Options} options
+   * @param {CalOptions} options
    */
   constructor(ev, options = {}) {
     this.ev = ev;
@@ -88,9 +88,8 @@ class IcalEvent {
       this.locationName = Locale.gettext('Nach Yomi');
     } else if (mask & flags.MISHNA_YOMI) {
       this.locationName = Locale.gettext('Mishna Yomi');
-    } else if (timed && options.location && options.location.name) {
-      const comma = options.location.name.indexOf(',');
-      this.locationName = comma == -1 ? options.location.name : options.location.name.substring(0, comma);
+    } else if (timed && options.location) {
+      this.locationName = options.location.getShortName();
     }
     const date = IcalEvent.formatYYYYMMDD(ev.getDate().greg());
     this.startDate = date;
@@ -103,8 +102,8 @@ class IcalEvent {
       minute = +minute;
       this.startDate += 'T' + pad2(hour) + pad2(minute) + '00';
       this.endDate = this.startDate;
-      if (options.location && options.location.tzid) {
-        this.dtargs = `;TZID=${options.location.tzid}`;
+      if (options.location?.getTzid()) {
+        this.dtargs = `;TZID=${options.location.getTzid()}`;
       }
     } else {
       this.endDate = IcalEvent.formatYYYYMMDD(ev.getDate().next().greg());
@@ -172,10 +171,11 @@ class IcalEvent {
     const digest = murmur32HexSync(this.ev.getDesc());
     let uid = `hebcal-${this.startDate}-${digest}`;
     if (this.timed && options.location) {
-      if (options.location.geoid) {
-        uid += `-${options.location.geoid}`;
-      } else if (options.location.name) {
-        uid += '-' + makeAnchor(options.location.name);
+      const loc = options.location;
+      if (loc.getGeoId()) {
+        uid += `-${loc.getGeoId()}`;
+      } else if (loc.getName()) {
+        uid += '-' + makeAnchor(loc.getName());
       }
     }
     return uid;
@@ -207,7 +207,7 @@ class IcalEvent {
     addOptional(arr, 'DESCRIPTION', memo);
     addOptional(arr, 'LOCATION', this.locationName);
     if (this.timed && options.location) {
-      arr.push('GEO:' + options.location.latitude + ';' + options.location.longitude);
+      arr.push('GEO:' + options.location.getLatitude() + ';' + options.location.getLongitude());
     }
     const trigger = this.getAlarm();
     if (trigger) {
@@ -315,7 +315,7 @@ class IcalEvent {
 /**
  * Transforms a single Event into a VEVENT string
  * @param {Event} ev
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string} multi-line result, delimited by \r\n
  */
 function eventToIcal(ev, options) {
@@ -352,17 +352,17 @@ function makeTorahMemo(ev, il) {
 /**
  * @private
  * @param {Event} e
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string}
  */
 function createMemo(e, options) {
-  const desc = e.getDesc();
-  const candles = desc === 'Havdalah' || desc === 'Candle lighting';
-  if (typeof e.memo === 'string' && e.memo.length && e.memo.indexOf('\n') !== -1) {
-    e.memo = e.memo.replace(/\n/g, '\\n');
+  let memo = e.memo;
+  if (typeof memo === 'string' && memo.length && memo.indexOf('\n') !== -1) {
+    memo = memo.replace(/\n/g, '\\n');
   }
-  if (candles) {
-    return e.memo || '';
+  const desc = e.getDesc();
+  if (desc === 'Havdalah' || desc === 'Candle lighting') {
+    return memo || '';
   }
   const mask = e.getFlags();
   if (mask & flags.OMER_COUNT) {
@@ -371,30 +371,32 @@ function createMemo(e, options) {
   }
   const url = appendTrackingToUrl(e.url(), options);
   const torahMemo = makeTorahMemo(e, options.il);
-  if (mask & flags.PARSHA_HASHAVUA) {
-    return torahMemo + '\\n\\n' + url;
-  } else {
-    let memo = e.memo || getHolidayDescription(e);
-    if (!memo && typeof e.linkedEvent !== 'undefined') {
+  if (!memo) {
+    if (typeof e.linkedEvent !== 'undefined') {
       memo = e.linkedEvent.render(options.locale);
+    } else {
+      memo = getHolidayDescription(e);
     }
-    if (torahMemo) {
-      memo += '\\n\\n' + torahMemo;
+  }
+  if (torahMemo) {
+    if (memo.length) {
+      memo += '\\n\\n';
     }
-    if (url) {
-      if (memo.length) {
-        memo += '\\n\\n';
-      }
-      memo += url;
+    memo += torahMemo;
+  }
+  if (url) {
+    if (memo.length) {
+      memo += '\\n\\n';
     }
-    return memo;
+    memo += url;
   }
+  return memo;
 }
 
 /**
  * Generates an RFC 2445 iCalendar string from an array of events
  * @param {Event[]} events
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {Promise<string>}
  */
 async function eventsToIcalendar(events, options) {
@@ -412,7 +414,7 @@ async function eventsToIcalendar(events, options) {
 /**
  * Generates an RFC 2445 iCalendar string from an array of IcalEvents
  * @param {IcalEvent[]} icals
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {Promise<string>}
  */
 async function icalEventsToString(icals, options) {
@@ -442,8 +444,8 @@ async function icalEventsToString(icals, options) {
     stream.push(`X-APPLE-CALENDAR-COLOR:${opts.calendarColor}\r\n`);
   }
   const location = opts.location;
-  if (location && location.tzid) {
-    const tzid = location.tzid;
+  const tzid = location?.getTzid();
+  if (tzid) {
     stream.push(`X-WR-TIMEZONE;VALUE=TEXT:${tzid}\r\n`);
     if (VTIMEZONE[tzid]) {
       stream.push(VTIMEZONE[tzid]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/icalendar",
-  "version": "4.21.0",
+  "version": "5.0.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "ical",
@@ -11,10 +11,6 @@
   "description": "Jewish holidays and Hebrew calendar as iCalendar RFC 2445",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
-  "exports": {
-    "import": "./dist/index.mjs",
-    "require": "./dist/index.js"
-  },
   "typings": "icalendar.d.ts",
   "files": [
     "dist",
@@ -28,8 +24,8 @@
     "url": "https://github.com/hebcal/hebcal-icalendar/issues"
   },
   "dependencies": {
-    "@hebcal/core": "^4.1.1",
-    "@hebcal/rest-api": "^4.5.1",
+    "@hebcal/core": "^5.0.0-rc2",
+    "@hebcal/rest-api": "^5.0.0",
     "murmurhash3": "^0.5.0"
   },
   "scripts": {
@@ -46,18 +42,18 @@
     ]
   },
   "devDependencies": {
-    "@babel/core": "^7.22.5",
-    "@babel/preset-env": "^7.22.5",
-    "@babel/register": "^7.22.5",
-    "@hebcal/learning": "^1.4.0",
-    "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-commonjs": "^25.0.2",
-    "@rollup/plugin-json": "^6.0.0",
+    "@babel/core": "^7.23.3",
+    "@babel/preset-env": "^7.23.3",
+    "@babel/register": "^7.22.15",
+    "@hebcal/learning": "^5.0.0",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-json": "^6.0.1",
     "ava": "^5.3.1",
-    "eslint": "^8.44.0",
+    "eslint": "^8.54.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
-    "rollup": "^3.26.0"
+    "rollup": "^4.5.1"
   }
 }