fix(ics): corrects multi-event order #194, metadata #201

This corrects the order of events added using addEvent() such that the
sequence is respected. This also addresses metadata issues for DTSTAMP,
PRODID and UID.

src/ICalendar.ts

@@ -34,7 +34,6 @@ export default class ICalendar extends CalendarBase {
     this
       .setMeta('UID', ics.getUid())
       .setMeta('DTSTAMP', time.getTimeCreated())
-      .setMeta('PRODID', ics.getProdId())
       .addProperty('CLASS', 'PUBLIC')
       .addProperty('DESCRIPTION', ics.formatText(this.description))
       .addProperty('LOCATION', ics.formatText(this.location))
@@ -113,6 +112,19 @@ export default class ICalendar extends CalendarBase {
     return features.join('')
   }
 
+  /**
+   * Returns the iCalendar meta properties, formatted as VEVENT entry lines.
+   *
+   * @returns {string[]}
+   */
+  public getMeta = (): string[] => {
+    return Object
+      .keys(this.meta)
+      .map((key: string) => {
+        return `${key}:${this.meta[key]}`
+      })
+  }
+
   /**
    * Sets iCalendar meta properties, such as UID, DTSTAMP, etc.
    *
@@ -208,28 +220,25 @@ export default class ICalendar extends CalendarBase {
    * @returns {string}
    */
   public render = (): string => {
-    const vEvents: string[] = this
-      .additionalEvents
-      .concat(this)
-      .reduce((properties: string[], calendar: ICalendar) => [
-        ...properties,
-        'BEGIN:VEVENT',
-        ...calendar.properties,
-        'END:VEVENT'
-      ], [])
-
-    const meta: string[] = Object
-      .keys(this.meta)
-      .map((key: string) => {
-        return `${key}:${this.meta[key]}`
-      })
+    const events = [
+      this,
+      ...this.additionalEvents
+    ]
+
+    const vEvents = events.reduce((properties: string[], calendar: ICalendar) => [
+      ...properties,
+      'BEGIN:VEVENT',
+      ...calendar.properties,
+      ...calendar.getMeta(),
+      'END:VEVENT'
+    ], [])
 
     return [
       'BEGIN:VCALENDAR',
       'VERSION:2.0',
       ...vEvents,
-      'END:VCALENDAR',
-      ...meta
+      `PRODID:${ics.getProdId()}`,
+      'END:VCALENDAR'
     ].join('\n')
   }
 }

src/__tests__/ICalendar.spec.ts

@@ -38,6 +38,33 @@ describe('ICalendar', () => {
     ].join('\n'))
   })
 
+  describe('addEvent()', () => {
+    const renderIcs = (i: number) => new ICalendar({
+      title: `Event ${i}`,
+      location: 'online',
+      description: 'Example description',
+      start: new Date('2021-09-01T17:00:00'),
+      end: new Date('2021-09-01T19:00:00')
+    })
+
+    it('should render with two additional events in the correct order', () => {
+      const ics = renderIcs(1)
+
+      ics.addEvent(renderIcs(2))
+      ics.addEvent(renderIcs(3))
+
+      const titles = ics
+        .render()
+        .match(/SUMMARY:Event [0-9]/ig)
+
+      expect(titles).toEqual([
+        'SUMMARY:Event 1',
+        'SUMMARY:Event 2',
+        'SUMMARY:Event 3'
+      ])
+    })
+  })
+
   describe('addAlarm()', () => {
     let obj: ICalendar
 
@@ -261,11 +288,11 @@ describe('ICalendar', () => {
         'TRANSP:TRANSPARENT',
         `DTSTART:${time.formatDate(baseOpts.start, FORMAT.FULL)}`,
         `DTEND:${time.formatDate(baseOpts.end, FORMAT.FULL)}`,
-        'END:VEVENT',
-        'END:VCALENDAR',
         `UID:${mockUuid}`,
         `DTSTAMP:${time.getTimeCreated()}`,
-        'PRODID:foobar'
+        'END:VEVENT',
+        'PRODID:foobar',
+        'END:VCALENDAR'
       ].join('\n')
 
       expect(rendered).toBe(expected)
@@ -291,17 +318,6 @@ describe('ICalendar', () => {
         'BEGIN:VCALENDAR',
         'VERSION:2.0',
 
-        // second event
-        'BEGIN:VEVENT',
-        'CLASS:PUBLIC',
-        `DESCRIPTION:${secondEventOpts.description}`,
-        `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',
@@ -311,12 +327,25 @@ describe('ICalendar', () => {
         'TRANSP:TRANSPARENT',
         `DTSTART:${time.formatDate(baseOpts.start, FORMAT.FULL)}`,
         `DTEND:${time.formatDate(baseOpts.end, FORMAT.FULL)}`,
+        `UID:${mockUuid}`,
+        `DTSTAMP:${time.getTimeCreated()}`,
         'END:VEVENT',
 
-        'END:VCALENDAR',
+        // second event
+        'BEGIN:VEVENT',
+        'CLASS:PUBLIC',
+        `DESCRIPTION:${secondEventOpts.description}`,
+        `LOCATION:${secondEventOpts.location}`,
+        `SUMMARY:${secondEventOpts.title}`,
+        'TRANSP:TRANSPARENT',
+        `DTSTART:${time.formatDate(secondEventOpts.start, FORMAT.FULL)}`,
+        `DTEND:${time.formatDate(baseOpts.end, FORMAT.FULL)}`,
         `UID:${mockUuid}`,
         `DTSTAMP:${time.getTimeCreated()}`,
-        'PRODID:foobar'
+        'END:VEVENT',
+
+        'PRODID:foobar',
+        'END:VCALENDAR'
       ].join('\n')
 
       expect(rendered).toBe(expected)

src/utils/__tests__/time.spec.ts

@@ -12,7 +12,7 @@ describe('time utils', () => {
     })
 
     it('should get the current time in date time format', () => {
-      expect(time.getTimeCreated()).toBe(time.formatDate(new Date(), FORMAT.DATE))
+      expect(time.getTimeCreated()).toBe(time.formatDate(new Date(), FORMAT.FULL))
     })
   })
 

src/utils/time.ts

@@ -123,7 +123,7 @@ const formatDateNoUtc = (d: Date = new Date(), format: string): string => {
  * @returns {string}
  */
 const getTimeCreated = (): string => {
-  return formatDate(new Date(), FORMAT.DATE)
+  return formatDate(new Date(), FORMAT.FULL)
 }
 
 /**