iamcal 1.0.2 → 1.1.0

package/src/index.ts

@@ -1,18 +1,15 @@
-export interface Property {
-    name: string
-    params: string[]
-    value: string
-}
+import { parseDate, toDateString, toDateTimeString } from './parse'
+import { Property } from './types'
 
 // Max line length as defined by RFC 5545 3.1.
 const MAX_LINE_LENGTH = 75
 
 export class Component {
     name: string
-    properties: Array<Property>
-    components: Array<Component>
+    properties: Property[]
+    components: Component[]
 
-    constructor(name: string, properties?: Array<Property>, components?: Array<Component>) {
+    constructor(name: string, properties?: Property[], components?: Component[]) {
         this.name = name
         if (properties) {
             this.properties = properties
@@ -40,7 +37,7 @@ export class Component {
             // Wrap lines
             while (line.length > MAX_LINE_LENGTH) {
                 lines.push(line.substring(0, MAX_LINE_LENGTH))
-                line = " " + line.substring(MAX_LINE_LENGTH)
+                line = ' ' + line.substring(MAX_LINE_LENGTH)
             }
             lines.push(line)
         }
@@ -66,11 +63,11 @@ export class Component {
         return null
     }
 
-    setProperty(name: string, value: string) {
+    setProperty(name: string, value: string): this {
         for (const property of this.properties) {
             if (property.name === name) {
                 property.value = value
-                return
+                return this
             }
         }
         this.properties.push({
@@ -78,6 +75,14 @@ export class Component {
             params: [],
             value: value,
         })
+        return this
+    }
+
+    removePropertiesWithName(name: string) {
+        const index = this.properties.findIndex(p => p.name === name)
+        if (index === -1) return this
+        // Remove property at index
+        this.properties.splice(index, 1)
     }
 
     getPropertyParams(name: string): string[] | null {
@@ -89,79 +94,486 @@ export class Component {
         return null
     }
 
-    setPropertyParams(name: string, params: string[]) {
+    setPropertyParams(name: string, params: string[]): this {
         for (const property of this.properties) {
             if (property.name === name) {
                 property.params = params
             }
         }
+        return this
+    }
+
+    addComponent(component: Component): this {
+        this.components.push(component)
+        return this
+    }
+
+    /**
+     * Remove a component from this component
+     * @returns `true` if the component was removed. `false` if the component was not present
+     */
+    removeComponent(component: Component): boolean {
+        const index = this.components.indexOf(component)
+        if (index === -1) return false
+
+        // Remove element at index from list
+        this.components.splice(index, 1)
+
+        return true
+    }
+
+    getComponents(name: string): Component[] {
+        const components: Component[] = []
+
+        for (let component of this.components) {
+            if (component.name === name) {
+                components.push(component)
+            }
+        }
+
+        return components
     }
 }
 
+/**
+ * Represents a VCALENDAR component, the root component of an iCalendar file.
+ */
 export class Calendar extends Component {
     name = 'VCALENDAR'
 
-    constructor(component: Component) {
+    /**
+     * @param prodid A unique identifier of the program creating the calendar.
+     *
+     * Example: `-//Google Inc//Google Calendar 70.9054//EN`
+     */
+    constructor(prodid: string)
+    /**
+     * @param prodid A unique identifier of the program creating the calendar.
+     *
+     * Example: `-//Google Inc//Google Calendar 70.9054//EN`
+     * @param version The version of the iCalendar specification that this calendar uses.
+     */
+    constructor(prodid: string, version: string)
+    /**
+     * @param component A VCALENDAR component.
+     */
+    constructor(component: Component)
+    constructor(a?: string | Component, b?: string) {
+        var component: Component
+        if (a instanceof Component) {
+            component = a as Component
+        } else {
+            const prodid = a as string
+            const version = (b as string) ?? '2.0'
+            component = new Component('VCALENDAR')
+            component.setProperty('PRODID', prodid)
+            component.setProperty('VERSION', version)
+        }
         super(component.name, component.properties, component.components)
     }
 
-    events(): Array<CalendarEvent> {
-        const events = new Array<CalendarEvent>()
+    events(): CalendarEvent[] {
+        return this.getComponents('VEVENT').map(c => new CalendarEvent(c))
+    }
 
-        for (let component of this.components) {
-            if (component.name === 'VEVENT') {
-                events.push(new CalendarEvent(component))
+    removeEvent(event: CalendarEvent): boolean
+    removeEvent(uid: string): boolean
+    removeEvent(a: CalendarEvent | string): boolean {
+        if (a instanceof CalendarEvent) {
+            const event = a as CalendarEvent
+            return this.removeComponent(event)
+        } else {
+            const uid = a as string
+            for (const event of this.events()) {
+                if (event.uid() !== uid) continue
+                return this.removeComponent(event)
             }
         }
+        return false
+    }
+
+    prodId(): string {
+        return this.getProperty('PRODID')!.value
+    }
+
+    setProdId(value: string): this {
+        return this.setProperty('PRODID', value)
+    }
+
+    version(): string {
+        return this.getProperty('VERSION')!.value
+    }
+
+    setVersion(value: string): this {
+        return this.setProperty('VERSION', value)
+    }
+
+    calScale(): string | undefined {
+        return this.getProperty('CALSCALE')?.value
+    }
+
+    setCalScale(value: string): this {
+        return this.setProperty('CALSCALE', value)
+    }
 
-        return events
+    removeCalScale() {
+        this.removePropertiesWithName('CALSCALE')
+    }
+
+    method(): string | undefined {
+        return this.getProperty('METHOD')?.value
+    }
+
+    setMethod(value: string) {
+        this.setProperty('METHOD', value)
+    }
+
+    removeMethod() {
+        this.removePropertiesWithName('METHOD')
+    }
+
+    calendarName(): string | undefined {
+        return this.getProperty('X-WR-CALNAME')?.value
+    }
+
+    setCalendarName(value: string) {
+        this.setProperty('X-WR-CALNAME', value)
+    }
+
+    removeCalendarName() {
+        this.removePropertiesWithName('X-WR-CALNAME')
+    }
+
+    calendarDescription(): string | undefined {
+        return this.getProperty('X-WR-CALDESC')?.value
+    }
+
+    setCalendarDescription(value: string): this {
+        return this.setProperty('X-WR-CALDESC', value)
+    }
+
+    removeCalendarDescription() {
+        this.removePropertiesWithName('X-WR-CALDESC')
+    }
+}
+
+/**
+ * Represents a VTIMEZONE component, containing time zone definitions.
+ */
+export class TimeZone extends Component {
+    constructor(id: string)
+    constructor(component: Component)
+    constructor(a: string | Component) {
+        var component: Component
+        if (a instanceof Component) {
+            component = a as Component
+        } else {
+            const tzid = a as string
+            component = new Component('VTIMEZONE')
+            component.setProperty('TZID', tzid)
+        }
+        super(component.name, component.properties, component.components)
+    }
+
+    id(): string {
+        return this.getProperty('TZID')!.value
+    }
+
+    setId(value: string): this {
+        return this.setProperty('TZID', value)
+    }
+
+    lastMod(): Date | undefined {
+        const text = this.getProperty('LAST-MOD')
+        if (!text) return
+        return parseDate(text)
+    }
+
+    setLastMod(value: Date): this {
+        return this.setProperty('LAST-MOD', value.toISOString())
+    }
+
+    removeLastMod() {
+        this.removePropertiesWithName('LAST-MOD')
+    }
+
+    url(): string | undefined {
+        return this.getProperty('TZURL')?.value
+    }
+
+    setUrl(value: string): this {
+        return this.setProperty('TZURL', value)
+    }
+
+    removeUrl() {
+        this.removePropertiesWithName('TZURL')
+    }
+
+    /** Get all time offsets. */
+    offsets(): TimeZoneOffset[] {
+        const offsets: TimeZoneOffset[] = []
+        this.components.forEach(component => {
+            if (component.name === 'STANDARD' || component.name === 'DAYLIGHT') {
+                offsets.push(new TimeZoneOffset(component))
+            }
+        })
+        return offsets
+    }
+
+    /** Get standard/winter time offsets. */
+    standardOffsets(): TimeZoneOffset[] {
+        return this.getComponents('STANDARD').map(c => new TimeZoneOffset(c))
+    }
+
+    /** Get daylight savings time offsets. */
+    daylightOffsets(): TimeZoneOffset[] {
+        return this.getComponents('DAYLIGHT').map(c => new TimeZoneOffset(c))
+    }
+}
+
+export type OffsetType = 'DAYLIGHT' | 'STANDARD'
+type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
+export type Offset = `${'-' | '+'}${Digit}${Digit}${Digit}${Digit}`
+/** Represents a STANDARD or DAYLIGHT component, defining a time zone offset. */
+class TimeZoneOffset extends Component {
+    /**
+     *
+     * @param type If this is a STANDARD or DAYLIGHT component.
+     * @param start From when this offset is active.
+     * @param offsetFrom The offset that is in use prior to this time zone observance.
+     * @param offsetTo The offset that is in use during this time zone observance.
+     */
+    constructor(type: OffsetType, start: Date, offsetFrom: Offset, offsetTo: Offset)
+    constructor(component: Component)
+    constructor(a: OffsetType | Component, b?: Date, c?: Offset, d?: Offset) {
+        var component: Component
+        if (a instanceof Component) {
+            component = a as Component
+        } else {
+            const name = a as OffsetType
+            const start = b as Date
+            const offsetFrom = c as Offset
+            const offsetTo = d as Offset
+            component = new Component(name)
+            component.setProperty('DTSTART', toDateTimeString(start))
+            component.setProperty('TZOFFSETFROM', offsetFrom)
+            component.setProperty('TZOFFSETTO', offsetTo)
+        }
+        super(component.name, component.properties, component.components)
+    }
+
+    start(): Date {
+        return parseDate(this.getProperty('DTSTART')!)
+    }
+
+    setStart(value: Date, fullDay: boolean = false): this {
+        if (fullDay) {
+            this.setProperty('DTSTART', toDateString(value))
+            this.setPropertyParams('DTSTART', ['VALUE=DATE'])
+        } else {
+            this.setProperty('DTSTART', toDateTimeString(value))
+        }
+        return this
+    }
+
+    offsetFrom(): Offset {
+        return this.getProperty('TZOFFSETFROM')!.value as Offset
+    }
+
+    setOffsetFrom(value: Offset): this {
+        return this.setProperty('TZOFFSETFROM', value)
+    }
+
+    offsetTo(): Offset {
+        return this.getProperty('TZOFFSETTO')!.value as Offset
+    }
+
+    setOffsetTo(value: Offset): this {
+        return this.setProperty('TZOFFSETTO', value)
+    }
+
+    comment(): string | undefined {
+        return this.getProperty('COMMENT')?.value
+    }
+
+    setComment(value: string): this {
+        return this.setProperty('COMMENT', value)
+    }
+
+    removeComment() {
+        this.removePropertiesWithName('COMMENT')
+    }
+
+    timeZoneName(): string | undefined {
+        return this.getProperty('TZNAME')?.value
+    }
+
+    setTimeZoneName(value: string): this {
+        return this.setProperty('TZNAME', value)
+    }
+
+    removeTimeZoneName() {
+        this.removePropertiesWithName('TZNAME')
     }
 }
 
 export class CalendarEvent extends Component {
     name = 'VEVENT'
 
-    constructor(component: Component) {
+    constructor(uid: string, dtstamp: Date)
+    constructor(component: Component)
+    constructor(a: string | Component, b?: Date) {
+        var component: Component
+        if (b) {
+            const uid = a as string
+            const dtstamp = b as Date
+            component = new Component('VEVENT')
+            component.setProperty('UID', uid)
+            component.setProperty('DTSTAMP', toDateTimeString(dtstamp))
+        } else {
+            component = a as Component
+        }
         super(component.name, component.properties, component.components)
     }
 
+    stamp(): Date {
+        return parseDate(this.getProperty('DTSTAMP')!)
+    }
+
+    setStamp(value: Date, fullDay: boolean = false): this {
+        if (fullDay) {
+            this.setProperty('DTSTAMP', toDateString(value))
+            this.setPropertyParams('DTSTAMP', ['VALUE=DATE'])
+        } else {
+            this.setProperty('DTSTAMP', toDateTimeString(value))
+        }
+        return this
+    }
+
+    uid(): string {
+        return this.getProperty('UID')!.value
+    }
+
+    setUid(value: string): this {
+        return this.setProperty('UID', value)
+    }
+
     summary(): string {
         return this.getProperty('SUMMARY')!.value
     }
 
-    setSummary(value: string) {
-        this.setProperty("SUMMARY", value)
+    setSummary(value: string): this {
+        return this.setProperty('SUMMARY', value)
+    }
+
+    removeSummary() {
+        this.removePropertiesWithName('SUMMARY')
     }
 
     description(): string {
         return this.getProperty('DESCRIPTION')!.value
     }
 
-    setDescription(value: string) {
-        this.setProperty("DESCRIPTION", value)
+    setDescription(value: string): this {
+        return this.setProperty('DESCRIPTION', value)
+    }
+
+    removeDescription() {
+        this.removePropertiesWithName('DESCRIPTION')
     }
 
     location(): string | undefined {
         return this.getProperty('LOCATION')?.value
     }
 
-    setLocation(value: string) {
-        this.setProperty("LOCATION", value)
+    setLocation(value: string): this {
+        return this.setProperty('LOCATION', value)
+    }
+
+    removeLocation() {
+        this.removePropertiesWithName('LOCATION')
     }
 
+    /**
+     * Get the start of the event.
+     * If set as a full day the time will be at the start of the day.
+     */
     start(): Date {
-        return new Date(this.getProperty('DTSTART')!.value)
+        return parseDate(this.getProperty('DTSTART')!)
+    }
+
+    setStart(value: Date, fullDay: boolean = false): this {
+        if (fullDay) {
+            this.setProperty('DTSTART', toDateString(value))
+            this.setPropertyParams('DTSTART', ['VALUE=DATE'])
+        } else {
+            this.setProperty('DTSTART', toDateTimeString(value))
+        }
+        return this
     }
 
-    setStart(value: Date) {
-        this.setProperty("DTSTART", value.toISOString())
+    removeStart() {
+        this.removePropertiesWithName('DTSTART')
     }
 
+    /**
+     * Get the end of the event.
+     * If set as a full day the time will be at the end of the day.
+     */
     end(): Date {
-        return new Date(this.getProperty('DTEND')!.value)
+        const endDate = parseDate(this.getProperty('DTEND')!)
+        if (this.getPropertyParams('DTEND')?.includes('VALUE=DATE')) {
+            const ONE_DAY = 24 * 60 * 60 * 1000
+            const endTime = new Date(endDate.getTime() + ONE_DAY)
+            return endTime
+        } else {
+            return endDate
+        }
+    }
+
+    setEnd(value: Date, fullDay: boolean = false): this {
+        if (fullDay) {
+            this.setProperty('DTEND', toDateString(value))
+            this.setPropertyParams('DTEND', ['VALUE=DATE'])
+        } else {
+            this.setProperty('DTEND', toDateTimeString(value))
+        }
+        return this
+    }
+
+    removeEnd() {
+        this.removePropertiesWithName('DTEND')
+    }
+
+    created(): Date | undefined {
+        const property = this.getProperty('CREATED')
+        if (!property) return
+        return parseDate(property)
     }
-    
-    setEnd(value: Date) {
-        this.setProperty("DTEND", value.toISOString())
+
+    setCreated(value: Date): this {
+        return this.setProperty('CREATED', toDateTimeString(value))
+    }
+
+    removeCreated() {
+        this.removePropertiesWithName('CREATED')
+    }
+
+    geo(): [number, number] | undefined {
+        const text = this.getProperty('GEO')?.value
+        if (!text) return
+        const pattern = /^[+-]?\d+(\.\d+)?,[+-]?\d+(\.\d+)?$/
+        if (!pattern.test(text)) throw new Error(`Failed to parse GEO property: ${text}`)
+        const [longitude, latitude] = text.split(',')
+        return [parseFloat(longitude), parseFloat(latitude)]
+    }
+
+    setGeo(latitude: number, longitude: number): this {
+        const text = `${latitude},${longitude}`
+        return this
+    }
+
+    removeGeo() {
+        this.removePropertiesWithName('GEO')
     }
 }

package/src/parse.ts

@@ -1,6 +1,7 @@
 import readline from 'readline'
 import { Readable } from 'stream'
 import { Calendar, CalendarEvent, Component } from '.'
+import { Property } from './types'
 
 export class DeserializationError extends Error {
     name = 'DeserializationError'
@@ -162,4 +163,27 @@ export async function parseEvent(text: string): Promise<CalendarEvent> {
     if (component.name !== "VEVENT")
         throw new DeserializationError("Not an event")
     return new CalendarEvent(component)
+}
+
+export function parseDate(dateProperty: Property): Date {
+    const value = dateProperty.value.trim()
+    if (dateProperty.params.includes('VALUE=DATE')) {
+        // Parse date only
+        return new Date(`${value.substring(0, 4)}-${value.substring(4, 6)}-${value.substring(6, 8)}`)
+    } else {
+        // Parse date and time
+        return new Date(`${value.substring(0, 4)}-${value.substring(4, 6)}-${value.substring(6, 8)} ${value.substring(9, 11)}:${value.substring(11, 13)}:${value.substring(13, 15)}`)
+    }
+}
+
+export function toTimeString(date: Date): string {
+    return `${date.getHours().toString().padStart(2, '0')}${date.getMinutes().toString().padStart(2, '0')}${date.getSeconds().toString().padStart(2, '0')}`
+}
+
+export function toDateString(date: Date): string {
+    return `${date.getFullYear().toString().padStart(4, '0')}${date.getMonth().toString().padStart(2, '0')}${date.getDate().toString().padStart(2, '0')}`
+}
+
+export function toDateTimeString(date: Date): string {
+    return `${toDateString(date)}T${toTimeString(date)}`
 }

package/src/types.ts

@@ -0,0 +1,5 @@
+export interface Property {
+    name: string
+    params: string[]
+    value: string
+}