iamcal 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Oli<oli@olillin.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# iamcal
+
+A library for reading, modifying and writing [ICalendar](https://en.wikipedia.org/wiki/ICalendar) files.
+
+## Installation
+
+**iamcal** can be installed from the npm registry:
+
+```console
+npm install iamcal
+```
+
+## Getting started/Example
+
+This code;
+
+```typescript
+import { Calendar } from 'iamcal'
+import { dump } from 'iamcal/io'
+import { parseCalendar } from 'iamcal/parse'
+
+const calendar: Calendar = await parseCalendar(`
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:example
+BEGIN:VEVENT
+SUMMARY:🎉iamcal release party
+LOCATION:Las Vegas!!
+UID:20241209T100000Z-EF79AE@example.com
+DTSTAMP:20241209T100000Z
+DTSTART:20241211T200000Z
+DTEND:20241211T230000Z
+END:VEVENT
+END:VCALENDAR
+`)
+
+calendar.events().forEach(event => {
+    if (event.summary() === "🎉iamcal release party") {
+        event.setLocation("My house (budget cuts sorry)")
+    }
+})
+
+await dump(calendar, "./new_calendar.ics")
+```
+
+produces the file `new_calendar.ics`:
+
+```icalendar
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:example
+BEGIN:VEVENT
+SUMMARY:🎉iamcal release party
+LOCATION:My house (budget cuts sorry)
+UID:20241209T100000Z-EF79AE@example.com
+DTSTAMP:20241209T100000Z
+DTSTART:20241211T200000Z
+DTEND:20241211T230000Z
+END:VEVENT
+END:VCALENDAR
+```

package/lib/index.d.ts

@@ -0,0 +1,36 @@
+export interface Property {
+    name: string;
+    params: string[];
+    value: string;
+}
+export declare class Component {
+    name: string;
+    properties: Array<Property>;
+    components: Array<Component>;
+    constructor(name: string, properties?: Array<Property>, components?: Array<Component>);
+    serialize(): string;
+    getProperty(name: string): Property | null;
+    setProperty(name: string, value: string): void;
+    getPropertyParams(name: string): string[] | null;
+    setPropertyParams(name: string, params: string[]): void;
+}
+export declare class Calendar extends Component {
+    name: string;
+    constructor(component: Component);
+    events(): Array<CalendarEvent>;
+}
+export declare class CalendarEvent extends Component {
+    name: string;
+    constructor(component: Component);
+    summary(): string;
+    setSummary(value: string): void;
+    description(): string;
+    setDescription(value: string): void;
+    location(): string | undefined;
+    setLocation(value: string): void;
+    start(): Date;
+    setStart(value: Date): void;
+    end(): Date;
+    setEnd(value: Date): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../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"}

package/lib/index.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CalendarEvent = exports.Calendar = exports.Component = void 0;
+// Max line length as defined by RFC 5545 3.1.
+const MAX_LINE_LENGTH = 75;
+class Component {
+    constructor(name, properties, components) {
+        this.name = name;
+        if (properties) {
+            this.properties = properties;
+        }
+        else {
+            this.properties = new Array();
+        }
+        if (components) {
+            this.components = components;
+        }
+        else {
+            this.components = new Array();
+        }
+    }
+    serialize() {
+        // Create lines
+        const lines = [`BEGIN:${this.name}`];
+        for (let 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);
+            }
+            lines.push(line);
+        }
+        for (let component of this.components) {
+            lines.push(component.serialize());
+        }
+        lines.push(`END:${this.name}`);
+        // Join lines
+        const serialized = lines.join('\n');
+        return serialized;
+    }
+    getProperty(name) {
+        for (const property of this.properties) {
+            if (property.name === name) {
+                return property;
+            }
+        }
+        return null;
+    }
+    setProperty(name, value) {
+        for (const property of this.properties) {
+            if (property.name === name) {
+                property.value = value;
+                return;
+            }
+        }
+        this.properties.push({
+            name: name,
+            params: [],
+            value: value,
+        });
+    }
+    getPropertyParams(name) {
+        for (const property of this.properties) {
+            if (property.name === name) {
+                return property.params;
+            }
+        }
+        return null;
+    }
+    setPropertyParams(name, params) {
+        for (const property of this.properties) {
+            if (property.name === name) {
+                property.params = params;
+            }
+        }
+    }
+}
+exports.Component = Component;
+class Calendar extends Component {
+    constructor(component) {
+        super(component.name, component.properties, component.components);
+        this.name = 'VCALENDAR';
+    }
+    events() {
+        const events = new Array();
+        for (let component of this.components) {
+            if (component.name === 'VEVENT') {
+                events.push(new CalendarEvent(component));
+            }
+        }
+        return events;
+    }
+}
+exports.Calendar = Calendar;
+class CalendarEvent extends Component {
+    constructor(component) {
+        super(component.name, component.properties, component.components);
+        this.name = 'VEVENT';
+    }
+    summary() {
+        return this.getProperty('SUMMARY').value;
+    }
+    setSummary(value) {
+        this.setProperty("SUMMARY", value);
+    }
+    description() {
+        return this.getProperty('DESCRIPTION').value;
+    }
+    setDescription(value) {
+        this.setProperty("DESCRIPTION", value);
+    }
+    location() {
+        var _a;
+        return (_a = this.getProperty('LOCATION')) === null || _a === void 0 ? void 0 : _a.value;
+    }
+    setLocation(value) {
+        this.setProperty("LOCATION", value);
+    }
+    start() {
+        return new Date(this.getProperty('DTSTART').value);
+    }
+    setStart(value) {
+        this.setProperty("DTSTART", value.toISOString());
+    }
+    end() {
+        return new Date(this.getProperty('DTEND').value);
+    }
+    setEnd(value) {
+        this.setProperty("DTEND", value.toISOString());
+    }
+}
+exports.CalendarEvent = CalendarEvent;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAMA,8CAA8C;AAC9C,MAAM,eAAe,GAAG,EAAE,CAAA;AAE1B,MAAa,SAAS;IAKlB,YAAY,IAAY,EAAE,UAA4B,EAAE,UAA6B;QACjF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAChC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,EAAE,CAAA;QACjC,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAChC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,EAAE,CAAA;QACjC,CAAC;IACL,CAAC;IAED,SAAS;QACL,eAAe;QACf,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAEpC,KAAK,IAAI,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACnC,IAAI,IAAI,GACJ,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE;gBACrB,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1C,GAAG;gBACH,QAAQ,CAAC,OAAO,CAAC,CAAA;YAErB,aAAa;YACb,OAAO,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;gBACnC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAA;gBAC9C,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAA;YAChD,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpB,CAAC;QAED,KAAK,IAAI,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,CAAA;QACrC,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAE9B,aAAa;QACb,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnC,OAAO,UAAU,CAAA;IACrB,CAAC;IAED,WAAW,CAAC,IAAY;QACpB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBACzB,OAAO,QAAQ,CAAA;YACnB,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAA;IACf,CAAC;IAED,WAAW,CAAC,IAAY,EAAE,KAAa;QACnC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBACzB,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAA;gBACtB,OAAM;YACV,CAAC;QACL,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACjB,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,KAAK;SACf,CAAC,CAAA;IACN,CAAC;IAED,iBAAiB,CAAC,IAAY;QAC1B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBACzB,OAAO,QAAQ,CAAC,MAAM,CAAA;YAC1B,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAA;IACf,CAAC;IAED,iBAAiB,CAAC,IAAY,EAAE,MAAgB;QAC5C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBACzB,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAA;YAC5B,CAAC;QACL,CAAC;IACL,CAAC;CACJ;AAzFD,8BAyFC;AAED,MAAa,QAAS,SAAQ,SAAS;IAGnC,YAAY,SAAoB;QAC5B,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,CAAA;QAHrE,SAAI,GAAG,WAAW,CAAA;IAIlB,CAAC;IAED,MAAM;QACF,MAAM,MAAM,GAAG,IAAI,KAAK,EAAiB,CAAA;QAEzC,KAAK,IAAI,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpC,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC,CAAA;YAC7C,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAA;IACjB,CAAC;CACJ;AAlBD,4BAkBC;AAED,MAAa,aAAc,SAAQ,SAAS;IAGxC,YAAY,SAAoB;QAC5B,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,CAAA;QAHrE,SAAI,GAAG,QAAQ,CAAA;IAIf,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAE,CAAC,KAAK,CAAA;IAC7C,CAAC;IAED,UAAU,CAAC,KAAa;QACpB,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;IACtC,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,CAAE,CAAC,KAAK,CAAA;IACjD,CAAC;IAED,cAAc,CAAC,KAAa;QACxB,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;IAC1C,CAAC;IAED,QAAQ;;QACJ,OAAO,MAAA,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,0CAAE,KAAK,CAAA;IAC9C,CAAC;IAED,WAAW,CAAC,KAAa;QACrB,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;IACvC,CAAC;IAED,KAAK;QACD,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAE,CAAC,KAAK,CAAC,CAAA;IACvD,CAAC;IAED,QAAQ,CAAC,KAAW;QAChB,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;IACpD,CAAC;IAED,GAAG;QACC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAE,CAAC,KAAK,CAAC,CAAA;IACrD,CAAC;IAED,MAAM,CAAC,KAAW;QACd,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;IAClD,CAAC;CACJ;AA9CD,sCA8CC"}

package/lib/io.d.ts

@@ -0,0 +1,16 @@
+import fs from 'fs';
+import { Calendar } from '.';
+/**
+ * Read a calendar from a .ical file
+ * @param path Path to the file to read
+ * @throws DeserializationError Component must be of valid format
+ * @throws TypeError Component must be a `VCALENDAR`
+ */
+export declare function load(path: fs.PathLike): Promise<Calendar>;
+/**
+ * Write a calendar to a .ical file
+ * @param calendar The calendar
+ * @param path Path to the file to write
+ */
+export declare function dump(calendar: Calendar, path: string): void;
+//# sourceMappingURL=io.d.ts.map

package/lib/io.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"io.d.ts","sourceRoot":"","sources":["../io.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AAEnB,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;AAG5B;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAW/D;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,QAEpD"}

package/lib/io.js

@@ -0,0 +1,46 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.load = load;
+exports.dump = dump;
+const fs_1 = __importDefault(require("fs"));
+const readline_1 = __importDefault(require("readline"));
+const _1 = require(".");
+const parse_1 = require("./parse");
+/**
+ * Read a calendar from a .ical file
+ * @param path Path to the file to read
+ * @throws DeserializationError Component must be of valid format
+ * @throws TypeError Component must be a `VCALENDAR`
+ */
+function load(path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const stream = fs_1.default.createReadStream(path);
+        const lines = readline_1.default.createInterface({ input: stream, crlfDelay: Infinity });
+        const component = yield (0, parse_1.deserialize)(lines);
+        if (component.name != 'VCALENDAR') {
+            throw TypeError('Component is not a calendar');
+        }
+        return new _1.Calendar(component);
+    });
+}
+/**
+ * Write a calendar to a .ical file
+ * @param calendar The calendar
+ * @param path Path to the file to write
+ */
+function dump(calendar, path) {
+    fs_1.default.writeFileSync(path, calendar.serialize());
+}
+//# sourceMappingURL=io.js.map

package/lib/io.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"io.js","sourceRoot":"","sources":["../io.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAWA,oBAWC;AAOD,oBAEC;AA/BD,4CAAmB;AACnB,wDAA+B;AAC/B,wBAA4B;AAC5B,mCAAqC;AAErC;;;;;GAKG;AACH,SAAsB,IAAI,CAAC,IAAiB;;QACxC,MAAM,MAAM,GAAG,YAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACxC,MAAM,KAAK,GAAG,kBAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAA;QAE9E,MAAM,SAAS,GAAG,MAAM,IAAA,mBAAW,EAAC,KAAK,CAAC,CAAA;QAE1C,IAAI,SAAS,CAAC,IAAI,IAAI,WAAW,EAAE,CAAC;YAChC,MAAM,SAAS,CAAC,6BAA6B,CAAC,CAAA;QAClD,CAAC;QAED,OAAO,IAAI,WAAQ,CAAC,SAAS,CAAC,CAAA;IAClC,CAAC;CAAA;AAED;;;;GAIG;AACH,SAAgB,IAAI,CAAC,QAAkB,EAAE,IAAY;IACjD,YAAE,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAA;AAChD,CAAC"}

package/lib/parse.d.ts

@@ -0,0 +1,28 @@
+import readline from 'readline';
+import { Calendar, CalendarEvent, Component } from '.';
+export declare class DeserializationError extends Error {
+    name: string;
+}
+/**
+ * Deserialize a calendar component
+ * @param lines the serialized component as a readline interface
+ */
+export declare function deserialize(lines: readline.Interface): Promise<Component>;
+/**
+ * Deserialize a calendar component
+ * @param text the serialized component
+ */
+export declare function deserializeString(text: string): Promise<Component>;
+/**
+ * Parse a calendar in ICalendar format
+ * @param text the serialized calendar
+ * @returns the parsed calendar
+ */
+export declare function parseCalendar(text: string): Promise<Calendar>;
+/**
+ * Parse an event in ICalendar format
+ * @param text the serialized event
+ * @returns the parsed event
+ */
+export declare function parseEvent(text: string): Promise<CalendarEvent>;
+//# sourceMappingURL=parse.d.ts.map

package/lib/parse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../parse.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAA;AAE/B,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,CAAA;AAEtD,qBAAa,oBAAqB,SAAQ,KAAK;IAC3C,IAAI,SAAyB;CAChC;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAsH/E;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAIxE;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAKnE;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAKrE"}

package/lib/parse.js

@@ -0,0 +1,208 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeserializationError = void 0;
+exports.deserialize = deserialize;
+exports.deserializeString = deserializeString;
+exports.parseCalendar = parseCalendar;
+exports.parseEvent = parseEvent;
+const readline_1 = __importDefault(require("readline"));
+const stream_1 = require("stream");
+const _1 = require(".");
+class DeserializationError extends Error {
+    constructor() {
+        super(...arguments);
+        this.name = 'DeserializationError';
+    }
+}
+exports.DeserializationError = DeserializationError;
+/**
+ * Deserialize a calendar component
+ * @param lines the serialized component as a readline interface
+ */
+function deserialize(lines) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, lines_1, lines_1_1;
+        var _b, e_1, _c, _d;
+        const component = new _1.Component('');
+        let done = false;
+        // We use a stack to keep track of nested components
+        const stack = new Array();
+        const subcomponentLines = new Array();
+        function processLine(line) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (line.trim() === '')
+                    return;
+                if (done) {
+                    throw new DeserializationError('Trailing data after component end');
+                }
+                if (line.startsWith('BEGIN:')) {
+                    // Begin component
+                    const name = line.slice(line.indexOf(':') + 1);
+                    stack.push(name);
+                    if (stack.length == 1) {
+                        component.name = name;
+                    }
+                    else {
+                        subcomponentLines.push(line);
+                    }
+                }
+                else if (line.startsWith('END:')) {
+                    // End component
+                    if (stack.length == 0) {
+                        throw new DeserializationError('Component end before begin');
+                    }
+                    const stackName = stack.pop();
+                    const name = line.slice(line.indexOf(':') + 1);
+                    if (stackName !== name) {
+                        throw new DeserializationError('Malformed subcomponent');
+                    }
+                    // Check the length of the stack after being popped
+                    if (stack.length == 1) {
+                        subcomponentLines.push(line);
+                        const subcomponent = yield deserializeString(subcomponentLines.join('\r\n'));
+                        subcomponentLines.length = 0;
+                        component.components.push(subcomponent);
+                    }
+                    else if (stack.length > 1) {
+                        subcomponentLines.push(line);
+                    }
+                    else if (stack.length == 0) {
+                        done = true;
+                    }
+                }
+                else {
+                    if (stack.length == 0)
+                        throw new DeserializationError('Property outside of components');
+                    if (stack.length > 1) {
+                        // Line of subcomponent
+                        subcomponentLines.push(line);
+                    }
+                    else {
+                        // Property
+                        const colon = line.indexOf(':');
+                        if (colon === -1) {
+                            throw new DeserializationError(`Invalid content line: ${line}`);
+                        }
+                        const name = line.slice(0, colon);
+                        const value = line.slice(colon + 1);
+                        const params = name.split(';');
+                        const property = {
+                            name: params[0],
+                            params: params.slice(1),
+                            value: value,
+                        };
+                        component.properties.push(property);
+                    }
+                }
+            });
+        }
+        /*
+        The following code unfolds lines and passes them to be processed above.
+    
+        According to RFC 5545 content lines may be split using a line "folding"
+        technique. That is, a long line can be split between any two characters by
+        inserting a newline immediately followed by a white-space character.
+    
+        For example, the line:
+    
+        DESCRIPTION:This is a long description that exists on a long line.
+    
+        Can be represented as:
+    
+        DESCRIPTION:This is a lo
+            ng description
+            that exists on a long line.
+        */
+        let unfoldedLine = '';
+        try {
+            for (_a = true, lines_1 = __asyncValues(lines); lines_1_1 = yield lines_1.next(), _b = lines_1_1.done, !_b; _a = true) {
+                _d = lines_1_1.value;
+                _a = false;
+                const line = _d;
+                if (line.startsWith(' ') || line.startsWith('\t')) {
+                    // Unfold continuation line (remove leading whitespace and append)
+                    unfoldedLine += line.replace(/[\r\n]/, '').slice(1);
+                }
+                else {
+                    if (unfoldedLine) {
+                        // Process the previous unfolded line
+                        yield processLine(unfoldedLine);
+                    }
+                    // Start a new unfolded line
+                    unfoldedLine = line;
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_a && !_b && (_c = lines_1.return)) yield _c.call(lines_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        // Process the last unfolded line
+        yield processLine(unfoldedLine);
+        // Check that component has been closed
+        if (!done) {
+            throw new DeserializationError('No component end');
+        }
+        return component;
+    });
+}
+/**
+ * Deserialize a calendar component
+ * @param text the serialized component
+ */
+function deserializeString(text) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const stream = stream_1.Readable.from(text);
+        const lines = readline_1.default.createInterface({ input: stream, crlfDelay: Infinity });
+        return deserialize(lines);
+    });
+}
+/**
+ * Parse a calendar in ICalendar format
+ * @param text the serialized calendar
+ * @returns the parsed calendar
+ */
+function parseCalendar(text) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const component = yield deserializeString(text);
+        if (component.name !== "VCALENDAR")
+            throw new DeserializationError("Not a calendar");
+        return new _1.Calendar(component);
+    });
+}
+/**
+ * Parse an event in ICalendar format
+ * @param text the serialized event
+ * @returns the parsed event
+ */
+function parseEvent(text) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const component = yield deserializeString(text);
+        if (component.name !== "VEVENT")
+            throw new DeserializationError("Not an event");
+        return new _1.CalendarEvent(component);
+    });
+}
+//# sourceMappingURL=parse.js.map

package/lib/parse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.js","sourceRoot":"","sources":["../parse.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAYA,kCAsHC;AAMD,8CAIC;AAOD,sCAKC;AAOD,gCAKC;AApKD,wDAA+B;AAC/B,mCAAiC;AACjC,wBAAsD;AAEtD,MAAa,oBAAqB,SAAQ,KAAK;IAA/C;;QACI,SAAI,GAAG,sBAAsB,CAAA;IACjC,CAAC;CAAA;AAFD,oDAEC;AAED;;;GAGG;AACH,SAAsB,WAAW,CAAC,KAAyB;;;;QACvD,MAAM,SAAS,GAAG,IAAI,YAAS,CAAC,EAAE,CAAC,CAAA;QACnC,IAAI,IAAI,GAAG,KAAK,CAAA;QAEhB,oDAAoD;QACpD,MAAM,KAAK,GAAG,IAAI,KAAK,EAAU,CAAA;QAEjC,MAAM,iBAAiB,GAAG,IAAI,KAAK,EAAU,CAAA;QAE7C,SAAe,WAAW,CAAC,IAAY;;gBACnC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE;oBAAE,OAAM;gBAE9B,IAAI,IAAI,EAAE,CAAC;oBACP,MAAM,IAAI,oBAAoB,CAAC,mCAAmC,CAAC,CAAA;gBACvE,CAAC;gBAED,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC5B,kBAAkB;oBAClB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;oBAC9C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBAEhB,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;wBACpB,SAAS,CAAC,IAAI,GAAG,IAAI,CAAA;oBACzB,CAAC;yBAAM,CAAC;wBACJ,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBAChC,CAAC;gBACL,CAAC;qBAAM,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBACjC,gBAAgB;oBAChB,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;wBACpB,MAAM,IAAI,oBAAoB,CAAC,4BAA4B,CAAC,CAAA;oBAChE,CAAC;oBAED,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAE,CAAA;oBAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;oBAC9C,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;wBACrB,MAAM,IAAI,oBAAoB,CAAC,wBAAwB,CAAC,CAAA;oBAC5D,CAAC;oBAED,mDAAmD;oBACnD,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;wBACpB,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;wBAC5B,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;wBAC5E,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAA;wBAE5B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;oBAC3C,CAAC;yBAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC1B,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBAChC,CAAC;yBAAM,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;wBAC3B,IAAI,GAAG,IAAI,CAAA;oBACf,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC;wBAAE,MAAM,IAAI,oBAAoB,CAAC,gCAAgC,CAAC,CAAA;oBAEvF,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACnB,uBAAuB;wBACvB,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBAChC,CAAC;yBAAM,CAAC;wBACJ,WAAW;wBACX,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;wBAC/B,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;4BACf,MAAM,IAAI,oBAAoB,CAAC,yBAAyB,IAAI,EAAE,CAAC,CAAA;wBACnE,CAAC;wBACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;wBACjC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;wBAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;wBAC9B,MAAM,QAAQ,GAAG;4BACb,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;4BACf,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;4BACvB,KAAK,EAAE,KAAK;yBACf,CAAA;wBAED,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;oBACvC,CAAC;gBACL,CAAC;YACL,CAAC;SAAA;QAED;;;;;;;;;;;;;;;;UAgBE;QACF,IAAI,YAAY,GAAG,EAAE,CAAA;;YACrB,gBAAyB,UAAA,cAAA,KAAK,CAAA,yEAAE,CAAC;gBAAR,qBAAK;gBAAL,WAAK;gBAAnB,MAAM,IAAI,KAAA,CAAA;gBACjB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBAChD,kEAAkE;oBAClE,YAAY,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBACvD,CAAC;qBAAM,CAAC;oBACJ,IAAI,YAAY,EAAE,CAAC;wBACf,qCAAqC;wBACrC,MAAM,WAAW,CAAC,YAAY,CAAC,CAAA;oBACnC,CAAC;oBACD,4BAA4B;oBAC5B,YAAY,GAAG,IAAI,CAAA;gBACvB,CAAC;YACL,CAAC;;;;;;;;;QAED,iCAAiC;QACjC,MAAM,WAAW,CAAC,YAAY,CAAC,CAAA;QAE/B,uCAAuC;QACvC,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,oBAAoB,CAAC,kBAAkB,CAAC,CAAA;QACtD,CAAC;QAED,OAAO,SAAS,CAAA;IACpB,CAAC;CAAA;AAED;;;GAGG;AACH,SAAsB,iBAAiB,CAAC,IAAY;;QAChD,MAAM,MAAM,GAAG,iBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,kBAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAA;QAC9E,OAAO,WAAW,CAAC,KAAK,CAAC,CAAA;IAC7B,CAAC;CAAA;AAED;;;;GAIG;AACH,SAAsB,aAAa,CAAC,IAAY;;QAC5C,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC/C,IAAI,SAAS,CAAC,IAAI,KAAK,WAAW;YAC9B,MAAM,IAAI,oBAAoB,CAAC,gBAAgB,CAAC,CAAA;QACpD,OAAO,IAAI,WAAQ,CAAC,SAAS,CAAC,CAAA;IAClC,CAAC;CAAA;AAED;;;;GAIG;AACH,SAAsB,UAAU,CAAC,IAAY;;QACzC,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC/C,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ;YAC3B,MAAM,IAAI,oBAAoB,CAAC,cAAc,CAAC,CAAA;QAClD,OAAO,IAAI,gBAAa,CAAC,SAAS,CAAC,CAAA;IACvC,CAAC;CAAA"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "iamcal",
+  "version": "1.0.0",
+  "description": "Read and write ICalendar files",
+  "files": [
+    "/lib"
+  ],
+  "exports": {
+    ".": "./lib/index.js",
+    "./parse": "./lib/parse.js",
+    "./io": "./lib/io.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/olillin/iamcal.git"
+  },
+  "keywords": [
+    "ical",
+    "calendar"
+  ],
+  "author": "Oli <oli@olillin.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/olillin/iamcal/issues"
+  },
+  "homepage": "https://github.com/olillin/iamcal#readme",
+  "dependencies": {
+    "typescript": "^5.7.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.1",
+    "tsc": "^2.0.4"
+  }
+}