fix(ics): fixes all-day timestamps #157 (#158)

Updates DTSTART and DTEND params in iCalendar such that the dates are formatted as dates with times omitted for all-day events. This works around the issue of timestamps interpreted differently in some calendar apps.
jshor · Aug 28, 2021 · 25b8b7b · 25b8b7b
1 parent 4dd9273
commit 25b8b7b
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 10 deletions.
diff --git a/src/ICalendar.ts b/src/ICalendar.ts
@@ -35,16 +35,24 @@ export default class ICalendar extends CalendarBase {
       .setMeta('UID', ics.getUid())
       .setMeta('DTSTAMP', time.getTimeCreated())
       .setMeta('PRODID', ics.getProdId())
-
-    this
       .addProperty('CLASS', 'PUBLIC')
       .addProperty('DESCRIPTION', ics.formatText(this.description))
-      .addProperty('DTSTART', time.formatDate(this.start, FORMAT.FULL))
-      .addProperty('DTEND', time.formatDate(this.end, FORMAT.FULL))
       .addProperty('LOCATION', ics.formatText(this.location))
       .addProperty('SUMMARY', ics.formatText(this.title))
       .addProperty('TRANSP', 'TRANSPARENT')
 
+    if (this.isAllDay) {
+      // for all-day events, omit the time and just place dates
+      this
+        .addProperty('DTSTART;VALUE=DATE', time.formatDateNoUtc(this.start, FORMAT.DATE))
+        .addProperty('DTEND;VALUE=DATE', time.formatDateNoUtc(time.incrementDate(this.start, 1), FORMAT.DATE))
+    } else {
+      // otherwise, set the full start and end dates
+      this
+        .addProperty('DTSTART', time.formatDate(this.start, FORMAT.FULL))
+        .addProperty('DTEND', time.formatDate(this.end, FORMAT.FULL))
+    }
+
     if (this.recurrence) {
       this.addProperty('RRULE', ics.getRrule(this.recurrence))
     }

diff --git a/src/__tests__/ICalendar.spec.ts b/src/__tests__/ICalendar.spec.ts
@@ -24,6 +24,20 @@ describe('ICalendar', () => {
     expect(result).toBeInstanceOf(CalendarBase)
   })
 
+  it('should render just the date for an all-day event', () => {
+    const obj = new ICalendar({
+      title: 'Fun Party',
+      description: 'BYOB',
+      location: 'New York',
+      start: new Date('2019-07-04T19:00:00.000')
+    })
+
+    expect(obj.render()).toContain([
+      `DTSTART;VALUE=DATE:${time.formatDateNoUtc(baseOpts.start, FORMAT.DATE)}`,
+      `DTEND;VALUE=DATE:${time.formatDateNoUtc(time.incrementDate(baseOpts.start, 1), FORMAT.DATE)}`
+    ].join('\n'))
+  })
+
   describe('addAlarm()', () => {
     let obj: ICalendar
 
@@ -242,11 +256,11 @@ describe('ICalendar', () => {
         'BEGIN:VEVENT',
         'CLASS:PUBLIC',
         `DESCRIPTION:${baseOpts.description}`,
-        `DTSTART:${time.formatDate(baseOpts.start, FORMAT.FULL)}`,
-        `DTEND:${time.formatDate(baseOpts.end, FORMAT.FULL)}`,
         `LOCATION:${baseOpts.location}`,
         `SUMMARY:${baseOpts.title}`,
         'TRANSP:TRANSPARENT',
+        `DTSTART:${time.formatDate(baseOpts.start, FORMAT.FULL)}`,
+        `DTEND:${time.formatDate(baseOpts.end, FORMAT.FULL)}`,
         'END:VEVENT',
         'END:VCALENDAR',
         `UID:${mockUuid}`,
@@ -281,22 +295,22 @@ describe('ICalendar', () => {
         'BEGIN:VEVENT',
         'CLASS:PUBLIC',
         `DESCRIPTION:${secondEventOpts.description}`,
-        `DTSTART:${time.formatDate(secondEventOpts.start, FORMAT.FULL)}`,
-        `DTEND:${time.formatDate(baseOpts.end, FORMAT.FULL)}`,
         `LOCATION:${secondEventOpts.location}`,
         `SUMMARY:${secondEventOpts.title}`,
         'TRANSP:TRANSPARENT',
+        `DTSTART:${time.formatDate(secondEventOpts.start, FORMAT.FULL)}`,
+        `DTEND:${time.formatDate(baseOpts.end, FORMAT.FULL)}`,
         'END:VEVENT',
 
         // base event
         'BEGIN:VEVENT',
         'CLASS:PUBLIC',
         `DESCRIPTION:${baseOpts.description}`,
-        `DTSTART:${time.formatDate(baseOpts.start, FORMAT.FULL)}`,
-        `DTEND:${time.formatDate(baseOpts.end, FORMAT.FULL)}`,
         `LOCATION:${baseOpts.location}`,
         `SUMMARY:${baseOpts.title}`,
         'TRANSP:TRANSPARENT',
+        `DTSTART:${time.formatDate(baseOpts.start, FORMAT.FULL)}`,
+        `DTEND:${time.formatDate(baseOpts.end, FORMAT.FULL)}`,
         'END:VEVENT',
 
         'END:VCALENDAR',