iamcal 2.1.2 → 3.0.0

package/src/component.ts

@@ -1,14 +1,15 @@
 import { CalendarDateOrTime } from './date'
+import { Property } from './property/Property'
+import type { AllowedPropertyName, KnownPropertyName } from './property/names'
 import {
-    AllowedPropertyName,
-    KnownPropertyName,
     MissingPropertyError,
-    Property,
     PropertyValidationError,
     validateProperty,
-} from './property'
+} from './property/validate'
 
-/** Represents an error which occurs while validating a calendar component. */
+/**
+ * Represents an error which occurs while validating a calendar component.
+ */
 export class ComponentValidationError extends Error {
     constructor(message: string) {
         super(message)
@@ -16,9 +17,16 @@ export class ComponentValidationError extends Error {
     }
 }
 
-// Max line length as defined by RFC 5545 3.1.
-const MAX_LINE_LENGTH = 75
-
+/**
+ * Represents an error which occurs when trying to perform an operation which
+ * would break the state of a calendar component.
+ */
+export class IllegalOperationError extends Error {
+    constructor(message: string) {
+        super(message)
+        this.name = 'IllegalOperationError'
+    }
+}
 export class Component {
     name: string
     properties: Property[]
@@ -31,7 +39,10 @@ export class Component {
     ) {
         this.name = name
         if (properties) {
-            this.properties = properties
+            this.properties = []
+            properties.forEach(property => {
+                this.addProperty(property)
+            })
         } else {
             this.properties = []
         }
@@ -47,17 +58,7 @@ export class Component {
         const lines = [`BEGIN:${this.name}`]
 
         for (const property of this.properties) {
-            let line =
-                property['name'] + //
-                property.params.map(p => ';' + p).join('') +
-                ':' +
-                property['value']
-
-            // Wrap lines
-            while (line.length > MAX_LINE_LENGTH) {
-                lines.push(line.substring(0, MAX_LINE_LENGTH))
-                line = ' ' + line.substring(MAX_LINE_LENGTH)
-            }
+            const line = property.serialize()
             lines.push(line)
         }
 
@@ -84,29 +85,52 @@ export class Component {
 
     setProperty(name: string, value: string | CalendarDateOrTime): this {
         for (const property of this.properties) {
-            if (property.name === name) {
-                if (typeof value === 'string') {
-                    property.value = value
-                } else {
-                    const prop = value.toProperty(name)
-                    property.params = prop.params
-                    property.value = prop.value
-                }
+            if (property.name !== name) continue
+
+            if (typeof value === 'string') {
+                property.value = value
                 return this
             }
+
+            const dateProperty = Property.fromDate(name, value)
+
+            // Update value type
+            if (dateProperty.getValueType() === 'DATE')
+                property.setValueType('DATE')
+            else property.removeValueType()
+
+            // Update value
+            property.value = dateProperty.value
+
+            return this
         }
+        // Property is new
         this.properties.push(
             typeof value === 'string'
-                ? {
-                      name: name,
-                      params: [],
-                      value: value,
-                  }
-                : value.toProperty(name)
+                ? new Property(name, value)
+                : Property.fromDate(name, value)
         )
         return this
     }
 
+    /**
+     * Add a property to this component.
+     * @param property The property to add.
+     * @returns This component for chaining.
+     * @throws {IllegalOperationError} If the property cannot be added to this component.
+     */
+    addProperty(property: Property): this {
+        // TODO: Validate if property can be added to this component.
+        this.properties.push(property)
+        return this
+    }
+
+    /**
+     * Check whether this component has a certain property.
+     * @param name The property name to check.
+     * @param value An optional value to check against the property. If this is specified the property value must equal this value.
+     * @returns Whether the property is present and matches the value if given.
+     */
     hasProperty(name: string, value?: string): boolean {
         for (const property of this.properties) {
             if (
@@ -126,24 +150,6 @@ export class Component {
         this.properties.splice(index, 1)
     }
 
-    getPropertyParams(name: string): string[] | null {
-        for (const property of this.properties) {
-            if (property.name === name) {
-                return property.params
-            }
-        }
-        return null
-    }
-
-    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

package/src/components/Calendar.ts

@@ -1,4 +1,4 @@
-import { KnownPropertyName } from '../property'
+import { KnownPropertyName } from '../property/names'
 import { Component, ComponentValidationError } from '../component'
 import { CalendarEvent } from './CalendarEvent'
 
@@ -27,13 +27,13 @@ export class Calendar extends Component {
      * @param component A VCALENDAR component.
      */
     constructor(component: Component)
-    constructor(a?: string | Component, b?: string) {
+    constructor(a: string | Component, b?: string) {
         let component: Component
         if (a instanceof Component) {
-            component = a as Component
+            component = a
             Calendar.prototype.validate.call(component)
         } else {
-            const prodid = a as string
+            const prodid = a
             const version = (b as string) ?? '2.0'
             component = new Component('VCALENDAR')
             component.setProperty('PRODID', prodid)
@@ -61,10 +61,9 @@ export class Calendar extends Component {
     removeEvent(uid: string): boolean
     removeEvent(a: CalendarEvent | string): boolean {
         if (a instanceof CalendarEvent) {
-            const event = a as CalendarEvent
-            return this.removeComponent(event)
+            return this.removeComponent(a)
         } else {
-            const uid = a as string
+            const uid = a
             for (const event of this.getEvents()) {
                 if (event.getUid() !== uid) continue
                 return this.removeComponent(event)
@@ -136,27 +135,4 @@ export class Calendar extends Component {
     removeCalendarDescription() {
         this.removePropertiesWithName('X-WR-CALDESC')
     }
-
-    /* eslint-disable */
-
-    /** @deprecated use {@link getEvents} instead */
-    events = this.getEvents
-    /** @deprecated use {@link getProductId} instead */
-    prodId = this.getProductId
-    /** @deprecated use {@link setProductId} instead */
-    setProdId = this.setProductId
-    /** @deprecated use {@link getVersion} instead */
-    version = this.getVersion
-    /** @deprecated use {@link getCalendarScale} instead */
-    calScale = this.getCalendarScale
-    /** @deprecated use {@link setCalendarScale} instead */
-    setCalScale = this.setCalendarScale
-    /** @deprecated use {@link removeCalendarScale} instead */
-    removeCalScale = this.removeCalendarScale
-    /** @deprecated use {@link getMethod} instead */
-    method = this.getMethod
-    /** @deprecated use {@link getCalendarName} instead */
-    calendarName = this.getCalendarName
-    /** @deprecated use {@link getCalendarDescription} instead */
-    calendarDescription = this.getCalendarDescription
 }

package/src/components/CalendarEvent.ts

@@ -1,12 +1,13 @@
-import { KnownPropertyName, PropertyValidationError } from '../property'
-import { ComponentValidationError, Component } from '../component'
+import { Component, ComponentValidationError } from '../component'
 import {
+    CalendarDateOrTime,
     CalendarDateTime,
     convertDate,
-    CalendarDateOrTime,
     parseDateProperty,
     toDateTimeString,
 } from '../date'
+import { KnownPropertyName } from '../property/names'
+import { PropertyValidationError } from '../property/validate'
 
 /**
  * Represents a VEVENT component, representing an event in a calendar.
@@ -27,10 +28,10 @@ export class CalendarEvent extends Component {
     ) {
         let component: Component
         if (a instanceof Component) {
-            component = a as Component
+            component = a
             CalendarEvent.prototype.validate.call(component)
         } else {
-            const uid = a as string
+            const uid = a
             const dtstamp = convertDate(b!, false)
             const dtstart = convertDate(c!)
             component = new Component('VEVENT')
@@ -42,7 +43,7 @@ export class CalendarEvent extends Component {
     }
 
     serialize(): string {
-        if (!this.getEnd() && !this.duration()) {
+        if (!this.getEnd() && !this.getDuration()) {
             throw new Error(
                 'Failed to serialize calendar event, end or duration must be set'
             )
@@ -240,31 +241,4 @@ export class CalendarEvent extends Component {
     removeGeographicLocation() {
         this.removePropertiesWithName('GEO')
     }
-
-    /* eslint-disable */
-
-    /** @deprecated use {@link getStamp} instead */
-    stamp = this.getStamp
-    /** @deprecated use {@link getUid} instead */
-    uid = this.getUid
-    /** @deprecated use {@link getSummary} instead */
-    summary = this.getSummary
-    /** @deprecated use {@link getDescription} instead */
-    description = this.getDescription
-    /** @deprecated use {@link getLocation} instead */
-    location = this.getLocation
-    /** @deprecated use {@link getStart} instead */
-    start = this.getStart
-    /** @deprecated use {@link getEnd} instead */
-    end = this.getEnd
-    /** @deprecated use {@link getDuration} instead */
-    duration = this.getDuration
-    /** @deprecated use {@link getCreated} instead */
-    created = this.getCreated
-    /** @deprecated use {@link getGeographicPosition} instead */
-    geo = this.getGeographicPosition
-    /** @deprecated use {@link setGeographicPosition} instead */
-    setGeo = this.setGeographicPosition
-    /** @deprecated use {@link removeGeographicLocation} instead */
-    removeGeo = this.removeGeographicLocation
 }

package/src/components/TimeZone.ts

@@ -1,6 +1,6 @@
 import { Component, ComponentValidationError } from '../component'
 import { CalendarDateOrTime, parseDateProperty } from '../date'
-import { KnownPropertyName } from '../property'
+import { KnownPropertyName } from '../property/names'
 import { TimeZoneOffset } from './TimeZoneOffset'
 
 /**
@@ -14,10 +14,10 @@ export class TimeZone extends Component {
     constructor(a: string | Component) {
         let component: Component
         if (a instanceof Component) {
-            component = a as Component
+            component = a
             TimeZone.prototype.validate.call(component)
         } else {
-            const tzid = a as string
+            const tzid = a
             component = new Component('VTIMEZONE')
             component.setProperty('TZID', tzid)
         }
@@ -101,52 +101,4 @@ export class TimeZone extends Component {
             c => new TimeZoneOffset(c)
         )
     }
-
-    /* eslint-disable */
-
-    /**
-     * @deprecated Use {@link getId} instead.
-     */
-    id = this.getId
-
-    /**
-     * @deprecated Use {@link getLastModified} instead.
-     */
-    lastMod = this.getLastModified
-
-    /**
-     * @deprecated Use {@link setLastModified} instead.
-     */
-    setLastMod = this.setLastModified
-
-    /**
-     * @deprecated Use {@link removeLastModified} instead.
-     */
-    removeLastMod = this.removeLastModified
-
-    /**
-     * @deprecated Use {@link getUrl} instead.
-     */
-    url = this.getUrl
-
-    /**
-     * Get all time offsets.
-     * @returns An array of time zone offsets defined in this time zone.
-     * @deprecated Use {@link getOffsets} instead.
-     */
-    offsets = this.getOffsets
-
-    /**
-     * Get standard/winter time offsets.
-     * @returns An array of time zone offsets defined in this time zone that are of type STANDARD.
-     * @deprecated Use {@link getStandardOffsets} instead.
-     */
-    standardOffsets = this.getStandardOffsets
-
-    /**
-     * Get daylight savings time offsets.
-     * @returns An array of time zone offsets defined in this time zone that are of type DAYLIGHT.
-     * @deprecated Use {@link getDaylightOffsets} instead.
-     */
-    daylightOffsets = this.getDaylightOffsets
 }

package/src/components/TimeZoneOffset.ts

@@ -1,6 +1,6 @@
 import { Component, ComponentValidationError } from '../component'
 import { CalendarDateOrTime, convertDate, parseDateProperty } from '../date'
-import { AllowedPropertyName } from '../property'
+import { AllowedPropertyName } from '../property/names'
 
 export const knownOffsetTypes = ['DAYLIGHT', 'STANDARD']
 export type OffsetType = (typeof knownOffsetTypes)[number]
@@ -32,13 +32,13 @@ export class TimeZoneOffset extends Component {
     ) {
         let component: Component
         if (a instanceof Component) {
-            component = a as Component
+            component = a
             TimeZoneOffset.prototype.validate.call(component)
         } else {
-            const name = a as OffsetType
+            const name: OffsetType = a
             const start = convertDate(b!)
-            const offsetFrom = c as Offset
-            const offsetTo = d as Offset
+            const offsetFrom = c!
+            const offsetTo = d!
             component = new Component(name)
             component.setProperty('DTSTART', start)
             component.setProperty('TZOFFSETFROM', offsetFrom)
@@ -149,39 +149,4 @@ export class TimeZoneOffset extends Component {
     removeTimeZoneName() {
         this.removePropertiesWithName('TZNAME')
     }
-
-    /* eslint-disable */
-
-    /**
-     * Get the date or time when this time zone offset starts.
-     * @returns The start date or time of this time zone offset.
-     * @deprecated Use {@link getStart} instead.
-     */
-    start = this.getStart
-
-    /**
-     * Get the offset which is offset from during this time zone offset.
-     * @returns The offset in a format such as "+0100" or "-0230".
-     * @deprecated Use {@link getOffsetFrom} instead.
-     */
-    offsetFrom = this.getOffsetFrom
-
-    /**
-     * Get the offset which is offset to during this time zone offset.
-     * @returns The offset in a format such as "+0100" or "-0230".
-     * @deprecated Use {@link getOffsetTo} instead.
-     */
-    offsetTo = this.getOffsetTo
-
-    /**
-     * @deprecated Use {@link getComment} instead.
-     */
-    comment = this.getComment
-
-    /**
-     * Get the name of this time zone offset.
-     * @returns The time zone offset name if it exists.
-     * @deprecated Use {@link getTimeZoneName} instead.
-     */
-    timeZoneName = this.getTimeZoneName
 }

package/src/date.ts

@@ -1,5 +1,5 @@
 import * as patterns from './patterns'
-import { getPropertyValueType, type Property } from './property'
+import { Property } from './property/Property'
 
 export const ONE_SECOND_MS = 1000
 export const ONE_MINUTE_MS = 60 * ONE_SECOND_MS
@@ -7,12 +7,6 @@ export const ONE_HOUR_MS = 60 * ONE_MINUTE_MS
 export const ONE_DAY_MS = 24 * ONE_HOUR_MS
 
 export interface CalendarDateOrTime {
-    /**
-     * Create a property from this date.
-     * @param name The name of the property.
-     */
-    toProperty(name: string): Property
-
     /**
      * Get the string value of this date.
      * @returns An iCalendar date or date-time string.
@@ -62,14 +56,6 @@ export class CalendarDate implements CalendarDateOrTime {
         this.date.setHours(0, 0, 0, 0)
     }
 
-    toProperty(name: string): Property {
-        return {
-            name,
-            params: ['VALUE=DATE'],
-            value: this.getValue(),
-        }
-    }
-
     getValue(): string {
         return toDateString(this.date)
     }
@@ -106,14 +92,6 @@ export class CalendarDateTime implements CalendarDateOrTime {
         }
     }
 
-    toProperty(name: string): Property {
-        return {
-            name,
-            params: [],
-            value: this.getValue(),
-        }
-    }
-
     getValue(): string {
         return toDateTimeString(this.date)
     }
@@ -208,24 +186,30 @@ export function padSeconds(seconds: number): string {
 /**
  * Parse a date property into a {@link CalendarDateOrTime}.
  * @param dateProperty The property to parse.
- * @param defaultType The default value type to be used if the property does not have an explicit value type.
  * @returns The parsed date as a {@link CalendarDateOrTime}.
  * @throws If the value is invalid for the value type.
  * @throws If the value type is not `DATE-TIME` or `DATE`.
  */
-export function parseDateProperty(
-    dateProperty: Property,
-    defaultType: 'DATE-TIME' | 'DATE' = 'DATE-TIME'
-): CalendarDateOrTime {
+export function parseDateProperty(dateProperty: Property): CalendarDateOrTime {
     const value = dateProperty.value
-    const valueType = getPropertyValueType(dateProperty, defaultType)
+    const valueType = dateProperty.getValueType()
 
     if (valueType === 'DATE-TIME') {
         return new CalendarDateTime(value)
     } else if (valueType === 'DATE') {
         return new CalendarDate(value)
     } else {
-        throw new Error(`Illegal value type for date '${valueType}'`)
+        const explicitValueType = dateProperty.hasValueType()
+        if (explicitValueType)
+            throw new Error(`Illegal value type for date '${valueType}'`)
+        else {
+            // Infer type based on shape
+            try {
+                return new CalendarDateTime(value)
+            } catch {
+                return new CalendarDate(value)
+            }
+        }
     }
 }