@pipobscure/ical 0.0.1 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipobscure/ical",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Full iCalendar (RFC 5545) implementation — tolerant parsing, strict generation",
   "type": "module",
   "author": "Philipp Dunkel <pip@pipobscure.com>",
@@ -17,13 +17,13 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist/",
-    "src/"
+    "dist/"
   ],
   "scripts": {
     "build": "tsc",
-    "check": "tsc --noEmit",
-    "test": "npm run build && node --experimental-strip-types --test 'test/**/*.test.ts'"
+    "typecheck": "tsc --noEmit",
+    "test": "npm run build && node --experimental-strip-types --test 'test/**/*.test.ts'",
+    "postversion": "git push --follow-tags"
   },
   "devDependencies": {
     "@types/node": "^25.3.0",

package/src/alarm.ts

@@ -1,105 +0,0 @@
-/**
- * VALARM component (RFC 5545 §3.6.6)
- *
- * ACTION is required.  TRIGGER is required.
- * Three alarm types: AUDIO, DISPLAY, EMAIL.
- */
-
-import { Component } from './component.js';
-import { Property, parseProperty } from './property.js';
-import type { ICalDuration, ICalDateTime } from './types.js';
-
-export type AlarmAction = 'AUDIO' | 'DISPLAY' | 'EMAIL' | string;
-
-export class Alarm extends Component {
-  constructor() {
-    super('VALARM');
-  }
-
-  // ── Required properties ──────────────────────────────────────────────
-
-  get action(): AlarmAction | null {
-    return this.getProperty('ACTION')?.text ?? null;
-  }
-  set action(v: AlarmAction) {
-    this.setProperty('ACTION', v);
-  }
-
-  /** TRIGGER: relative (DURATION) or absolute (DATE-TIME). */
-  get trigger(): ICalDuration | ICalDateTime | null {
-    const p = this.getProperty('TRIGGER');
-    if (!p) return null;
-    const v = p.scalar;
-    if (typeof v === 'object' && v !== null && (v.type === 'duration' || v.type === 'date-time')) {
-      return v as ICalDuration | ICalDateTime;
-    }
-    return null;
-  }
-  set trigger(v: ICalDuration | ICalDateTime) {
-    const params: Record<string, string> =
-      v.type === 'date-time' ? { VALUE: 'DATE-TIME' } : {};
-    this.setProperty('TRIGGER', v, params);
-  }
-
-  // ── Optional properties ──────────────────────────────────────────────
-
-  get description(): string | null {
-    return this.getProperty('DESCRIPTION')?.text ?? null;
-  }
-  set description(v: string) {
-    this.setProperty('DESCRIPTION', v);
-  }
-
-  get summary(): string | null {
-    return this.getProperty('SUMMARY')?.text ?? null;
-  }
-  set summary(v: string) {
-    this.setProperty('SUMMARY', v);
-  }
-
-  get repeat(): number | null {
-    return this.getProperty('REPEAT')?.number ?? null;
-  }
-  set repeat(v: number) {
-    this.setProperty('REPEAT', v);
-  }
-
-  get duration(): ICalDuration | null {
-    const v = this.getValue('DURATION');
-    return typeof v === 'object' && v !== null && v.type === 'duration'
-      ? (v as ICalDuration)
-      : null;
-  }
-  set duration(v: ICalDuration) {
-    this.setProperty('DURATION', v);
-  }
-
-  get attendees(): Property[] {
-    return this.getProperties('ATTENDEE');
-  }
-
-  addAttendee(calAddress: string, params: Record<string, string> = {}): this {
-    this.appendProperty('ATTENDEE', calAddress, params);
-    return this;
-  }
-
-  // ── Strict validation before serialization ───────────────────────────
-
-  override toString(): string {
-    if (!this.action) throw new Error('VALARM: ACTION is required');
-    if (!this.getProperty('TRIGGER')) throw new Error('VALARM: TRIGGER is required');
-    return super.toString();
-  }
-
-  // ── Factory ──────────────────────────────────────────────────────────
-
-  static fromRaw(
-    props: ReadonlyArray<{ name: string; params: Record<string, string>; value: string }>,
-  ): Alarm {
-    const alarm = new Alarm();
-    for (const { name, params, value } of props) {
-      alarm.addProperty(parseProperty(name, value, params));
-    }
-    return alarm;
-  }
-}

package/src/calendar.ts

@@ -1,153 +0,0 @@
-/**
- * VCALENDAR component (RFC 5545 §3.4, §3.6)
- *
- * Top-level container.  VERSION and PRODID are required.
- * Contains VEVENT, VTODO, VJOURNAL, VFREEBUSY, and VTIMEZONE sub-components.
- */
-
-import { Component } from './component.js';
-import { parseProperty } from './property.js';
-import { Event } from './event.js';
-import { Todo } from './todo.js';
-import { Journal } from './journal.js';
-import { FreeBusy } from './freebusy.js';
-import { Timezone } from './timezone.js';
-
-export class Calendar extends Component {
-  constructor() {
-    super('VCALENDAR');
-  }
-
-  // ── Required properties ──────────────────────────────────────────────
-
-  /** RFC 5545 requires VERSION:2.0 */
-  get version(): string | null {
-    return this.getProperty('VERSION')?.text ?? null;
-  }
-  set version(v: string) {
-    this.setProperty('VERSION', v);
-  }
-
-  /** e.g. '-//My App//My App v1.0//EN' */
-  get prodid(): string | null {
-    return this.getProperty('PRODID')?.text ?? null;
-  }
-  set prodid(v: string) {
-    this.setProperty('PRODID', v);
-  }
-
-  // ── Optional calendar properties ─────────────────────────────────────
-
-  /** Defaults to GREGORIAN when absent */
-  get calscale(): string | null {
-    return this.getProperty('CALSCALE')?.text ?? null;
-  }
-  set calscale(v: string) {
-    this.setProperty('CALSCALE', v);
-  }
-
-  /** iTIP method (REQUEST, REPLY, CANCEL, etc.) */
-  get method(): string | null {
-    return this.getProperty('METHOD')?.text ?? null;
-  }
-  set method(v: string) {
-    this.setProperty('METHOD', v);
-  }
-
-  // ── Sub-component accessors ──────────────────────────────────────────
-
-  get events(): Event[] {
-    return this.getComponents('VEVENT') as Event[];
-  }
-
-  get todos(): Todo[] {
-    return this.getComponents('VTODO') as Todo[];
-  }
-
-  get journals(): Journal[] {
-    return this.getComponents('VJOURNAL') as Journal[];
-  }
-
-  get freebusys(): FreeBusy[] {
-    return this.getComponents('VFREEBUSY') as FreeBusy[];
-  }
-
-  get timezones(): Timezone[] {
-    return this.getComponents('VTIMEZONE') as Timezone[];
-  }
-
-  // ── Fluent add methods ───────────────────────────────────────────────
-
-  addEvent(event: Event): this {
-    this.addComponent(event);
-    return this;
-  }
-
-  addTodo(todo: Todo): this {
-    this.addComponent(todo);
-    return this;
-  }
-
-  addJournal(journal: Journal): this {
-    this.addComponent(journal);
-    return this;
-  }
-
-  addFreebusy(fb: FreeBusy): this {
-    this.addComponent(fb);
-    return this;
-  }
-
-  addTimezone(tz: Timezone): this {
-    this.addComponent(tz);
-    return this;
-  }
-
-  // ── Lookup helpers ───────────────────────────────────────────────────
-
-  /** Find an event/todo/journal by UID. */
-  getByUid(uid: string): Event | Todo | Journal | undefined {
-    const all: Array<Event | Todo | Journal> = [...this.events, ...this.todos, ...this.journals];
-    return all.find((c) => c.uid === uid);
-  }
-
-  /** Look up a VTIMEZONE by TZID. */
-  getTimezone(tzid: string): Timezone | undefined {
-    return this.timezones.find((tz) => tz.tzid === tzid);
-  }
-
-  // ── Strict serialization ─────────────────────────────────────────────
-
-  override toString(): string {
-    if (!this.prodid) throw new Error('VCALENDAR: PRODID is required');
-    if (!this.version) throw new Error('VCALENDAR: VERSION is required');
-    return super.toString();
-  }
-
-  // ── Factory ──────────────────────────────────────────────────────────
-
-  static fromRaw(
-    props: ReadonlyArray<{ name: string; params: Record<string, string>; value: string }>,
-    subcomponents: Component[],
-  ): Calendar {
-    const cal = new Calendar();
-    for (const { name, params, value } of props) {
-      cal.addProperty(parseProperty(name, value, params));
-    }
-    for (const sub of subcomponents) {
-      cal.addComponent(sub);
-    }
-    return cal;
-  }
-
-  /**
-   * Create a minimal valid VCALENDAR with sensible defaults.
-   */
-  static create(prodid: string, method?: string): Calendar {
-    const cal = new Calendar();
-    cal.version = '2.0';
-    cal.prodid = prodid;
-    if (method) cal.method = method;
-    return cal;
-  }
-}

package/src/component.ts

@@ -1,193 +0,0 @@
-/**
- * Base Component class for all iCalendar components.
- *
- * Stores properties as an ordered list (preserving parse order) and also
- * indexes them by name for O(1) lookup.  Supports multiple occurrences of
- * the same property name (e.g. ATTENDEE, RDATE, EXDATE).
- *
- * Serialization is strict: outputs CRLF line endings, folds at 75 octets.
- */
-
-import { Property } from './property.js';
-import type { ICalValue } from './types.js';
-
-// ── Line folding (RFC 5545 §3.1) ─────────────────────────────────────────
-
-/** Count UTF-8 octets in a string without allocating a Buffer. */
-function octetLen(s: string): number {
-  let n = 0;
-  for (let i = 0; i < s.length; i++) {
-    const c = s.charCodeAt(i);
-    if (c < 0x80) n += 1;
-    else if (c < 0x800) n += 2;
-    else if (c < 0xd800 || c >= 0xe000) n += 3;
-    else { i++; n += 4; } // surrogate pair → U+10000..U+10FFFF
-  }
-  return n;
-}
-
-/**
- * Fold a single content-line string into RFC 5545-compliant chunks.
- * Returns the string with CRLF + SPACE inserted at 75-octet boundaries.
- */
-function foldLine(line: string): string {
-  if (octetLen(line) <= 75) return line;
-
-  const chunks: string[] = [];
-  let pos = 0;
-  let firstLine = true;
-
-  while (pos < line.length) {
-    const maxOctets = firstLine ? 75 : 74; // continuation prefix ' ' takes 1 octet
-    let end = pos;
-    let octets = 0;
-
-    while (end < line.length) {
-      const c = line.charCodeAt(end);
-      let charOctets: number;
-      if (c < 0x80) charOctets = 1;
-      else if (c < 0x800) charOctets = 2;
-      else if (c < 0xd800 || c >= 0xe000) charOctets = 3;
-      else { charOctets = 4; } // surrogate pair
-
-      if (octets + charOctets > maxOctets) break;
-      octets += charOctets;
-      end += c >= 0xd800 && c < 0xdc00 ? 2 : 1; // advance past surrogate pairs
-    }
-
-    if (end === pos) break; // safety: single char wider than budget
-
-    chunks.push((firstLine ? '' : ' ') + line.slice(pos, end));
-    pos = end;
-    firstLine = false;
-  }
-
-  return chunks.join('\r\n');
-}
-
-// ── Component ─────────────────────────────────────────────────────────────
-
-export class Component {
-  readonly type: string;
-
-  /** Ordered list of properties (preserves parse order). */
-  protected readonly _props: Property[] = [];
-  /** Index: name → Property[] */
-  private readonly _index = new Map<string, Property[]>();
-  /** Child components (e.g. VALARM inside VEVENT). */
-  readonly components: Component[] = [];
-
-  constructor(type: string) {
-    this.type = type.toUpperCase();
-  }
-
-  // ── Property access ──────────────────────────────────────────────────
-
-  /** Return the first Property with the given name, or undefined. */
-  getProperty(name: string): Property | undefined {
-    return this._index.get(name.toUpperCase())?.[0];
-  }
-
-  /** Return all Property instances with the given name. */
-  getProperties(name: string): Property[] {
-    return this._index.get(name.toUpperCase()) ?? [];
-  }
-
-  /** Return the scalar value of the first property with the given name. */
-  getValue(name: string): ICalValue | null | undefined {
-    const p = this.getProperty(name);
-    return p?.scalar;
-  }
-
-  /** Return the typed list value of the first property with the given name. */
-  getValues(name: string): ICalValue[] {
-    return this.getProperty(name)?.list ?? [];
-  }
-
-  // ── Property mutation ────────────────────────────────────────────────
-
-  /** Add a Property instance (preserving insertion order). */
-  addProperty(prop: Property): void {
-    this._props.push(prop);
-    const key = prop.name;
-    const existing = this._index.get(key);
-    if (existing) {
-      existing.push(prop);
-    } else {
-      this._index.set(key, [prop]);
-    }
-  }
-
-  /**
-   * Replace all existing properties with the given name with a single new one.
-   * If value is undefined/null the property is removed.
-   */
-  setProperty(
-    name: string,
-    value: ICalValue | readonly ICalValue[] | null | undefined,
-    params: Readonly<Record<string, string | readonly string[]>> = {},
-  ): void {
-    const key = name.toUpperCase();
-    // Remove existing
-    const startLen = this._props.length;
-    const idx = this._props.findIndex((p) => p.name === key);
-    if (idx !== -1) this._props.splice(idx, 1);
-    this._index.delete(key);
-
-    if (value === null || value === undefined) return;
-
-    const prop = new Property(key, value, params);
-    // Insert at the position where old one was (or append)
-    const insertAt = idx !== -1 && idx < this._props.length ? idx : this._props.length;
-    this._props.splice(insertAt, 0, prop);
-    this._index.set(key, [prop]);
-  }
-
-  /** Append an additional property (for multi-value properties). */
-  appendProperty(
-    name: string,
-    value: ICalValue | readonly ICalValue[],
-    params: Readonly<Record<string, string | readonly string[]>> = {},
-  ): void {
-    const prop = new Property(name.toUpperCase(), value, params);
-    this.addProperty(prop);
-  }
-
-  /** Remove all properties with the given name. */
-  removeProperty(name: string): void {
-    const key = name.toUpperCase();
-    const filtered = this._props.filter((p) => p.name !== key);
-    this._props.length = 0;
-    this._props.push(...filtered);
-    this._index.delete(key);
-  }
-
-  // ── Component children ───────────────────────────────────────────────
-
-  addComponent(comp: Component): void {
-    this.components.push(comp);
-  }
-
-  getComponents(type: string): Component[] {
-    return this.components.filter((c) => c.type === type.toUpperCase());
-  }
-
-  // ── Serialization ────────────────────────────────────────────────────
-
-  /**
-   * Serialize to an RFC 5545-compliant iCalendar string segment.
-   * Uses CRLF line endings and folds at 75 octets.
-   */
-  toString(): string {
-    const lines: string[] = [];
-    lines.push(`BEGIN:${this.type}`);
-    for (const prop of this._props) {
-      lines.push(foldLine(prop.toContentLine()));
-    }
-    for (const child of this.components) {
-      lines.push(child.toString());
-    }
-    lines.push(`END:${this.type}`);
-    return lines.join('\r\n');
-  }
-}