feat(ics): adds setMeta method

Adds setMeta() method to provide functionality to modify base iCalendar meta properties.
jshor · Jan 16, 2021 · 2810148 · 2810148
1 parent 7647f96
commit 2810148
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 5 deletions.
diff --git a/docs/docs/icalendar.md b/docs/docs/icalendar.md
@@ -111,12 +111,26 @@ DTSTAMP:20200916
 PRODID:datebook.dev
 ```
 
+## `setMeta(key: string, value: string)` <Badge text="6.0.0" vertical="middle" />
+
+Sets iCalendar meta properties, such as `UID`, `DTSTAMP`, etc. Returns the `ICalendar` instance.
+
+* **`key: string`** - iCalendar meta property key.
+* **`value: string`** - Value of the meta property.
+
+### Example
+
+```ts
+calendar
+  .setMeta('UID', 'e9de89b0a5e9ad6efd5e5ab543ec617c')
+  .render()
+```
 
 ## `addProperty(key: string, value: ICSPropertyValue)` <Badge text="6.0.0" vertical="middle" />
 
-Adds any additional desired iCalendar property having the given key-value pair to the instance. Returns the `ICalendar` instance.
+Adds any additional desired iCalendar event property having the given key-value pair to the instance. Returns the `ICalendar` instance.
 
-* **`key: string`** - iCalendar property name.
+* **`key: string`** - iCalendar event property name.
 * **`value: Record<string, any> | string | number`** - A key-value subset of properties, or a valid value.
 
 

diff --git a/src/ICalendar.ts b/src/ICalendar.ts
@@ -19,6 +19,9 @@ export default class ICalendar extends CalendarBase {
   /** List of VEVENT property-value entries */
   private properties: string[] = []
 
+  /** Key-value pair of basic calendar properties. */
+  private meta: Record<string, string> = {}
+
   constructor (opts: CalendarOptions) {
     super(opts)
     this.setInitialParams()
@@ -28,6 +31,11 @@ export default class ICalendar extends CalendarBase {
    * Sets the basic properties for the calendar instance.
    */
   protected setInitialParams = (): void => {
+    this
+      .setMeta('UID', ics.getUid())
+      .setMeta('DTSTAMP', time.getTimeCreated())
+      .setMeta('PRODID', ics.getProdId())
+
     this
       .addProperty('CLASS', 'PUBLIC')
       .addProperty('DESCRIPTION', ics.formatText(this.description))
@@ -97,6 +105,19 @@ export default class ICalendar extends CalendarBase {
     return features.join('')
   }
 
+  /**
+   * Sets iCalendar meta properties, such as UID, DTSTAMP, etc.
+   *
+   * @param {string} key
+   * @param {string} value
+   * @returns {ICalendar}
+   */
+  public setMeta = (key: string, value: string): this => {
+    this.meta[key] = value
+
+    return this
+  }
+
   /**
    * Adds the given event to the same `.ics` file instance.
    *
@@ -189,14 +210,18 @@ export default class ICalendar extends CalendarBase {
         'END:VEVENT'
       ], [])
 
+    const meta: string[] = Object
+      .keys(this.meta)
+      .map((key: string) => {
+        return `${key}:${this.meta[key]}`
+      })
+
     return [
       'BEGIN:VCALENDAR',
       'VERSION:2.0',
       ...vEvents,
       'END:VCALENDAR',
-      `UID:${ics.getUid()}`,
-      `DTSTAMP:${time.getTimeCreated()}`,
-      `PRODID:${ics.getProdId()}`
+      ...meta
     ].join('\n')
   }
 }