iamcal 1.0.2 → 1.1.0

package/README.md

@@ -10,9 +10,11 @@ A library for reading, modifying and writing [ICalendar](https://en.wikipedia.or
 npm install iamcal
 ```
 
-## Getting started/Example
+## Getting started
 
-This code;
+### Parsing and editing a calendar
+
+This code:
 
 ```typescript
 import { Calendar } from 'iamcal'
@@ -58,4 +60,6 @@ DTSTART:20241211T200000Z
 DTEND:20241211T230000Z
 END:VEVENT
 END:VCALENDAR
-```
+```
+
+### Creating a new calendar

package/lib/index.d.ts

@@ -1,36 +1,150 @@
-export interface Property {
-    name: string;
-    params: string[];
-    value: string;
-}
+import { Property } from './types';
 export declare class Component {
     name: string;
-    properties: Array<Property>;
-    components: Array<Component>;
-    constructor(name: string, properties?: Array<Property>, components?: Array<Component>);
+    properties: Property[];
+    components: Component[];
+    constructor(name: string, properties?: Property[], components?: Component[]);
     serialize(): string;
     getProperty(name: string): Property | null;
-    setProperty(name: string, value: string): void;
+    setProperty(name: string, value: string): this;
+    removePropertiesWithName(name: string): this | undefined;
     getPropertyParams(name: string): string[] | null;
-    setPropertyParams(name: string, params: string[]): void;
+    setPropertyParams(name: string, params: string[]): this;
+    addComponent(component: Component): 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;
+    getComponents(name: string): Component[];
 }
+/**
+ * Represents a VCALENDAR component, the root component of an iCalendar file.
+ */
 export declare class Calendar extends Component {
     name: string;
+    /**
+     * @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);
+    events(): CalendarEvent[];
+    removeEvent(event: CalendarEvent): boolean;
+    removeEvent(uid: string): boolean;
+    prodId(): string;
+    setProdId(value: string): this;
+    version(): string;
+    setVersion(value: string): this;
+    calScale(): string | undefined;
+    setCalScale(value: string): this;
+    removeCalScale(): void;
+    method(): string | undefined;
+    setMethod(value: string): void;
+    removeMethod(): void;
+    calendarName(): string | undefined;
+    setCalendarName(value: string): void;
+    removeCalendarName(): void;
+    calendarDescription(): string | undefined;
+    setCalendarDescription(value: string): this;
+    removeCalendarDescription(): void;
+}
+/**
+ * Represents a VTIMEZONE component, containing time zone definitions.
+ */
+export declare class TimeZone extends Component {
+    constructor(id: string);
     constructor(component: Component);
-    events(): Array<CalendarEvent>;
+    id(): string;
+    setId(value: string): this;
+    lastMod(): Date | undefined;
+    setLastMod(value: Date): this;
+    removeLastMod(): void;
+    url(): string | undefined;
+    setUrl(value: string): this;
+    removeUrl(): void;
+    /** Get all time offsets. */
+    offsets(): TimeZoneOffset[];
+    /** Get standard/winter time offsets. */
+    standardOffsets(): TimeZoneOffset[];
+    /** Get daylight savings time offsets. */
+    daylightOffsets(): TimeZoneOffset[];
+}
+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. */
+declare 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);
+    start(): Date;
+    setStart(value: Date, fullDay?: boolean): this;
+    offsetFrom(): Offset;
+    setOffsetFrom(value: Offset): this;
+    offsetTo(): Offset;
+    setOffsetTo(value: Offset): this;
+    comment(): string | undefined;
+    setComment(value: string): this;
+    removeComment(): void;
+    timeZoneName(): string | undefined;
+    setTimeZoneName(value: string): this;
+    removeTimeZoneName(): void;
 }
 export declare class CalendarEvent extends Component {
     name: string;
+    constructor(uid: string, dtstamp: Date);
     constructor(component: Component);
+    stamp(): Date;
+    setStamp(value: Date, fullDay?: boolean): this;
+    uid(): string;
+    setUid(value: string): this;
     summary(): string;
-    setSummary(value: string): void;
+    setSummary(value: string): this;
+    removeSummary(): void;
     description(): string;
-    setDescription(value: string): void;
+    setDescription(value: string): this;
+    removeDescription(): void;
     location(): string | undefined;
-    setLocation(value: string): void;
+    setLocation(value: string): this;
+    removeLocation(): void;
+    /**
+     * Get the start of the event.
+     * If set as a full day the time will be at the start of the day.
+     */
     start(): Date;
-    setStart(value: Date): void;
+    setStart(value: Date, fullDay?: boolean): this;
+    removeStart(): void;
+    /**
+     * Get the end of the event.
+     * If set as a full day the time will be at the end of the day.
+     */
     end(): Date;
-    setEnd(value: Date): void;
+    setEnd(value: Date, fullDay?: boolean): this;
+    removeEnd(): void;
+    created(): Date | undefined;
+    setCreated(value: Date): this;
+    removeCreated(): void;
+    geo(): [number, number] | undefined;
+    setGeo(latitude: number, longitude: number): this;
+    removeGeo(): void;
 }
+export {};
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;CAChB;AAKD,qBAAa,SAAS;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAA;IAC3B,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;gBAEhB,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAcrF,SAAS,IAAI,MAAM;IA+BnB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAS1C,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAcvC,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAShD,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE;CAOnD;AAED,qBAAa,QAAS,SAAQ,SAAS;IACnC,IAAI,SAAc;gBAEN,SAAS,EAAE,SAAS;IAIhC,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC;CAWjC;AAED,qBAAa,aAAc,SAAQ,SAAS;IACxC,IAAI,SAAW;gBAEH,SAAS,EAAE,SAAS;IAIhC,OAAO,IAAI,MAAM;IAIjB,UAAU,CAAC,KAAK,EAAE,MAAM;IAIxB,WAAW,IAAI,MAAM;IAIrB,cAAc,CAAC,KAAK,EAAE,MAAM;IAI5B,QAAQ,IAAI,MAAM,GAAG,SAAS;IAI9B,WAAW,CAAC,KAAK,EAAE,MAAM;IAIzB,KAAK,IAAI,IAAI;IAIb,QAAQ,CAAC,KAAK,EAAE,IAAI;IAIpB,GAAG,IAAI,IAAI;IAIX,MAAM,CAAC,KAAK,EAAE,IAAI;CAGrB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAKlC,qBAAa,SAAS;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,QAAQ,EAAE,CAAA;IACtB,UAAU,EAAE,SAAS,EAAE,CAAA;gBAEX,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,QAAQ,EAAE,EAAE,UAAU,CAAC,EAAE,SAAS,EAAE;IAc3E,SAAS,IAAI,MAAM;IA+BnB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAS1C,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAe9C,wBAAwB,CAAC,IAAI,EAAE,MAAM;IAOrC,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAShD,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;IASvD,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAKxC;;;OAGG;IACH,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAU9C,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE;CAW3C;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,SAAS;IACnC,IAAI,SAAc;IAElB;;;;OAIG;gBACS,MAAM,EAAE,MAAM;IAC1B;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAC3C;;OAEG;gBACS,SAAS,EAAE,SAAS;IAehC,MAAM,IAAI,aAAa,EAAE;IAIzB,WAAW,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO;IAC1C,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAejC,MAAM,IAAI,MAAM;IAIhB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI9B,OAAO,IAAI,MAAM;IAIjB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI/B,QAAQ,IAAI,MAAM,GAAG,SAAS;IAI9B,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIhC,cAAc;IAId,MAAM,IAAI,MAAM,GAAG,SAAS;IAI5B,SAAS,CAAC,KAAK,EAAE,MAAM;IAIvB,YAAY;IAIZ,YAAY,IAAI,MAAM,GAAG,SAAS;IAIlC,eAAe,CAAC,KAAK,EAAE,MAAM;IAI7B,kBAAkB;IAIlB,mBAAmB,IAAI,MAAM,GAAG,SAAS;IAIzC,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI3C,yBAAyB;CAG5B;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,SAAS;gBACvB,EAAE,EAAE,MAAM;gBACV,SAAS,EAAE,SAAS;IAahC,EAAE,IAAI,MAAM;IAIZ,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI1B,OAAO,IAAI,IAAI,GAAG,SAAS;IAM3B,UAAU,CAAC,KAAK,EAAE,IAAI,GAAG,IAAI;IAI7B,aAAa;IAIb,GAAG,IAAI,MAAM,GAAG,SAAS;IAIzB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI3B,SAAS;IAIT,4BAA4B;IAC5B,OAAO,IAAI,cAAc,EAAE;IAU3B,wCAAwC;IACxC,eAAe,IAAI,cAAc,EAAE;IAInC,yCAAyC;IACzC,eAAe,IAAI,cAAc,EAAE;CAGtC;AAED,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,UAAU,CAAA;AAChD,KAAK,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;AACtE,MAAM,MAAM,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE,CAAA;AACnE,gFAAgF;AAChF,cAAM,cAAe,SAAQ,SAAS;IAClC;;;;;;OAMG;gBACS,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;gBACnE,SAAS,EAAE,SAAS;IAkBhC,KAAK,IAAI,IAAI;IAIb,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,GAAE,OAAe,GAAG,IAAI;IAUrD,UAAU,IAAI,MAAM;IAIpB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIlC,QAAQ,IAAI,MAAM;IAIlB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIhC,OAAO,IAAI,MAAM,GAAG,SAAS;IAI7B,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI/B,aAAa;IAIb,YAAY,IAAI,MAAM,GAAG,SAAS;IAIlC,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIpC,kBAAkB;CAGrB;AAED,qBAAa,aAAc,SAAQ,SAAS;IACxC,IAAI,SAAW;gBAEH,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI;gBAC1B,SAAS,EAAE,SAAS;IAehC,KAAK,IAAI,IAAI;IAIb,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,GAAE,OAAe,GAAG,IAAI;IAUrD,GAAG,IAAI,MAAM;IAIb,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI3B,OAAO,IAAI,MAAM;IAIjB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI/B,aAAa;IAIb,WAAW,IAAI,MAAM;IAIrB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAInC,iBAAiB;IAIjB,QAAQ,IAAI,MAAM,GAAG,SAAS;IAI9B,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIhC,cAAc;IAId;;;OAGG;IACH,KAAK,IAAI,IAAI;IAIb,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,GAAE,OAAe,GAAG,IAAI;IAUrD,WAAW;IAIX;;;OAGG;IACH,GAAG,IAAI,IAAI;IAWX,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,GAAE,OAAe,GAAG,IAAI;IAUnD,SAAS;IAIT,OAAO,IAAI,IAAI,GAAG,SAAS;IAM3B,UAAU,CAAC,KAAK,EAAE,IAAI,GAAG,IAAI;IAI7B,aAAa;IAIb,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS;IASnC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjD,SAAS;CAGZ"}