@craftguild/jscalendar 0.5.2 → 0.5.4

package/dist/ical.js

@@ -1,270 +0,0 @@
-import { normalizeUtcDateTime } from "./utils.js";
-const TYPE_EVENT = "Event";
-const TYPE_GROUP = "Group";
-const TYPE_TASK = "Task";
-const DEFAULT_PRODID = "-//craftguild//EN";
-/**
- * Convert JSCalendar objects into an iCalendar string.
- * @param objects JSCalendar objects to export.
- * @param options Export options.
- * @return iCalendar text.
- */
-export function toICal(objects, options = {}) {
-    const lines = [];
-    const includeX = options.includeXJSCalendar !== false;
-    lines.push("BEGIN:VCALENDAR");
-    lines.push("VERSION:2.0");
-    lines.push(`PRODID:${options.prodId ?? DEFAULT_PRODID}`);
-    const method = options.method ?? findMethod(objects);
-    if (method)
-        lines.push(`METHOD:${method.toUpperCase()}`);
-    for (const object of objects) {
-        if (object["@type"] === TYPE_GROUP) {
-            const group = object;
-            if (includeX) {
-                lines.push(`X-JSCALENDAR-GROUP:${escapeText(JSON.stringify(stripEntries(group)))}`);
-            }
-            for (const entry of group.entries) {
-                lines.push(...buildComponent(entry, includeX));
-            }
-        }
-        else {
-            lines.push(...buildComponent(object, includeX));
-        }
-    }
-    lines.push("END:VCALENDAR");
-    return foldLines(lines).join("\r\n");
-}
-/**
- * Find the first METHOD value from objects.
- * @param objects JSCalendar objects.
- * @return METHOD value or undefined.
- */
-function findMethod(objects) {
-    for (const object of objects) {
-        if (object.method)
-            return object.method;
-    }
-    return undefined;
-}
-/**
- * Build an iCalendar component from a JSCalendar object.
- * @param object JSCalendar object.
- * @param includeX Whether to include X-JSCALENDAR.
- * @return iCalendar lines for the component.
- */
-function buildComponent(object, includeX) {
-    if (object["@type"] === TYPE_EVENT)
-        return buildEvent(object, includeX);
-    if (object["@type"] === TYPE_TASK)
-        return buildTask(object, includeX);
-    return [];
-}
-/**
- * Build a VEVENT component.
- * @param event Event object.
- * @param includeX Whether to include X-JSCALENDAR.
- * @return VEVENT lines.
- */
-function buildEvent(event, includeX) {
-    const lines = [];
-    lines.push("BEGIN:VEVENT");
-    lines.push(`UID:${escapeText(event.uid)}`);
-    lines.push(`DTSTAMP:${formatUtcDateTime(event.updated)}`);
-    if (event.sequence !== undefined)
-        lines.push(`SEQUENCE:${event.sequence}`);
-    if (event.title)
-        lines.push(`SUMMARY:${escapeText(event.title)}`);
-    if (event.description)
-        lines.push(`DESCRIPTION:${escapeText(event.description)}`);
-    const dtStart = formatLocalDateTime(event.start);
-    if (event.timeZone) {
-        lines.push(`DTSTART;TZID=${event.timeZone}:${dtStart}`);
-    }
-    else {
-        lines.push(`DTSTART:${dtStart}`);
-    }
-    if (event.duration)
-        lines.push(`DURATION:${event.duration}`);
-    if (event.status)
-        lines.push(`STATUS:${event.status.toUpperCase()}`);
-    appendRecurrence(lines, event.recurrenceRules);
-    if (includeX) {
-        lines.push(`X-JSCALENDAR:${escapeText(JSON.stringify(event))}`);
-    }
-    lines.push("END:VEVENT");
-    return lines;
-}
-/**
- * Build a VTODO component.
- * @param task Task object.
- * @param includeX Whether to include X-JSCALENDAR.
- * @return VTODO lines.
- */
-function buildTask(task, includeX) {
-    const lines = [];
-    lines.push("BEGIN:VTODO");
-    lines.push(`UID:${escapeText(task.uid)}`);
-    lines.push(`DTSTAMP:${formatUtcDateTime(task.updated)}`);
-    if (task.sequence !== undefined)
-        lines.push(`SEQUENCE:${task.sequence}`);
-    if (task.title)
-        lines.push(`SUMMARY:${escapeText(task.title)}`);
-    if (task.description)
-        lines.push(`DESCRIPTION:${escapeText(task.description)}`);
-    if (task.start) {
-        const dtStart = formatLocalDateTime(task.start);
-        if (task.timeZone) {
-            lines.push(`DTSTART;TZID=${task.timeZone}:${dtStart}`);
-        }
-        else {
-            lines.push(`DTSTART:${dtStart}`);
-        }
-    }
-    if (task.due) {
-        const due = formatLocalDateTime(task.due);
-        if (task.timeZone) {
-            lines.push(`DUE;TZID=${task.timeZone}:${due}`);
-        }
-        else {
-            lines.push(`DUE:${due}`);
-        }
-    }
-    if (task.percentComplete !== undefined) {
-        lines.push(`PERCENT-COMPLETE:${task.percentComplete}`);
-    }
-    if (task.progress) {
-        lines.push(`STATUS:${task.progress.toUpperCase()}`);
-    }
-    appendRecurrence(lines, task.recurrenceRules);
-    if (includeX) {
-        lines.push(`X-JSCALENDAR:${escapeText(JSON.stringify(task))}`);
-    }
-    lines.push("END:VTODO");
-    return lines;
-}
-/**
- * Append RRULE lines for recurrence rules.
- * @param lines Lines to append to.
- * @param rules Recurrence rules.
- * @return Nothing.
- */
-function appendRecurrence(lines, rules) {
-    if (!rules)
-        return;
-    for (const rule of rules) {
-        const rrule = recurrenceRuleToRRule(rule);
-        if (rrule)
-            lines.push(`RRULE:${rrule}`);
-    }
-}
-/**
- * Convert a RecurrenceRule to an RRULE string.
- * @param rule Recurrence rule.
- * @return RRULE value or null.
- */
-function recurrenceRuleToRRule(rule) {
-    const parts = [];
-    parts.push(`FREQ=${rule.frequency.toUpperCase()}`);
-    if (rule.interval)
-        parts.push(`INTERVAL=${rule.interval}`);
-    if (rule.count)
-        parts.push(`COUNT=${rule.count}`);
-    if (rule.until)
-        parts.push(`UNTIL=${formatLocalDateTime(rule.until)}`);
-    if (rule.byDay?.length) {
-        const days = rule.byDay
-            .map((day) => `${day.nthOfPeriod ?? ""}${day.day.toUpperCase()}`)
-            .join(",");
-        parts.push(`BYDAY=${days}`);
-    }
-    if (rule.byMonthDay?.length)
-        parts.push(`BYMONTHDAY=${rule.byMonthDay.join(",")}`);
-    if (rule.byMonth?.length)
-        parts.push(`BYMONTH=${rule.byMonth.join(",")}`);
-    if (rule.byYearDay?.length)
-        parts.push(`BYYEARDAY=${rule.byYearDay.join(",")}`);
-    if (rule.byWeekNo?.length)
-        parts.push(`BYWEEKNO=${rule.byWeekNo.join(",")}`);
-    if (rule.byHour?.length)
-        parts.push(`BYHOUR=${rule.byHour.join(",")}`);
-    if (rule.byMinute?.length)
-        parts.push(`BYMINUTE=${rule.byMinute.join(",")}`);
-    if (rule.bySecond?.length)
-        parts.push(`BYSECOND=${rule.bySecond.join(",")}`);
-    if (rule.bySetPosition?.length)
-        parts.push(`BYSETPOS=${rule.bySetPosition.join(",")}`);
-    if (rule.firstDayOfWeek)
-        parts.push(`WKST=${rule.firstDayOfWeek.toUpperCase()}`);
-    if (rule.rscale)
-        parts.push(`RSCALE=${rule.rscale.toUpperCase()}`);
-    if (rule.skip)
-        parts.push(`SKIP=${rule.skip.toUpperCase()}`);
-    return parts.join(";");
-}
-/**
- * Format a UTCDateTime for iCalendar.
- * @param value UTCDateTime string.
- * @return iCalendar-formatted UTCDateTime.
- */
-function formatUtcDateTime(value) {
-    const normalized = normalizeUtcDateTime(value);
-    return normalized
-        .replace(/[-:]/g, "")
-        .replace(/\.\d+Z$/, "Z")
-        .replace(/Z$/, "Z");
-}
-/**
- * Format a LocalDateTime for iCalendar.
- * @param value LocalDateTime string.
- * @return iCalendar-formatted LocalDateTime.
- */
-function formatLocalDateTime(value) {
-    return value
-        .replace(/[-:]/g, "")
-        .replace(/\.\d+$/, "")
-        .replace(/Z$/, "");
-}
-/**
- * Escape text for iCalendar content lines.
- * @param value Raw text.
- * @return Escaped text.
- */
-function escapeText(value) {
-    return value
-        .replace(/\\/g, "\\\\")
-        .replace(/\n/g, "\\n")
-        .replace(/;/g, "\\;")
-        .replace(/,/g, "\\,");
-}
-/**
- * Fold iCalendar lines to 75 octets per RFC.
- * @param lines Lines to fold.
- * @return Folded lines.
- */
-function foldLines(lines) {
-    const result = [];
-    for (const line of lines) {
-        if (line.length <= 75) {
-            result.push(line);
-            continue;
-        }
-        let remaining = line;
-        result.push(remaining.slice(0, 75));
-        remaining = remaining.slice(75);
-        while (remaining.length > 0) {
-            result.push(` ${remaining.slice(0, 74)}`);
-            remaining = remaining.slice(74);
-        }
-    }
-    return result;
-}
-/**
- * Strip group entries for X-JSCALENDAR-GROUP payload.
- * @param group Group object.
- * @return Group without entries.
- */
-function stripEntries(group) {
-    const { entries: _entries, ...rest } = group;
-    return rest;
-}

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export { JsCal } from "./jscal.js";
-export { ValidationError } from "./validate.js";
-export type * from "./types.js";

package/dist/index.js

@@ -1,2 +0,0 @@
-export { JsCal } from "./jscal.js";
-export { ValidationError } from "./validate.js";

package/dist/jscal/base.d.ts

@@ -1,89 +0,0 @@
-import type { Alert, Id, JSCalendarObject, Location, Participant, PatchLike, VirtualLocation } from "../types.js";
-import type { UpdateOptions } from "./types.js";
-export declare abstract class Base<T extends JSCalendarObject, TPatch extends PatchLike, TSelf extends Base<T, TPatch, TSelf>> {
-    data: T;
-    /**
-     * Create a new base instance that wraps a JSCalendar object.
-     * @param data Underlying JSCalendar data.
-     * @return Result.
-     */
-    constructor(data: T);
-    /**
-     * Wrap updated data in a new instance.
-     * @param data Updated JSCalendar data.
-     * @return New instance containing the data.
-     */
-    protected abstract wrap(data: T): TSelf;
-    /**
-     * Return a deep-cloned plain object for safe serialization.
-     * @return Cloned JSCalendar data.
-     */
-    eject(): T;
-    /**
-     * Clone the current instance with a deep-cloned payload.
-     * @return New instance with cloned data.
-     */
-    clone(): TSelf;
-    /**
-     * Read a field value from the underlying data.
-     * @param key Field key.
-     * @return Field value.
-     */
-    get<K extends keyof T>(key: K): T[K];
-    /**
-     * Set a field value and update metadata as needed.
-     * @param key Field key.
-     * @param value Field value.
-     * @return New instance with the updated field.
-     */
-    set<K extends keyof T>(key: K, value: T[K]): TSelf;
-    /**
-     * Apply a PatchObject and touch updated/sequence metadata.
-     * @param patch Patch to apply.
-     * @param options Update options.
-     * @return New instance with applied patch.
-     */
-    patch(patch: TPatch, options?: UpdateOptions): TSelf;
-    /**
-     * Add a physical location and return a new instance.
-     * @param location Location data (without @type).
-     * @param id Optional location ID.
-     * @return New instance with the added location.
-     */
-    addLocation(location: Omit<Location, "@type"> & Partial<Pick<Location, "@type">>, id?: Id): TSelf;
-    /**
-     * Add a virtual location and return a new instance.
-     * @param location Virtual location data (without @type).
-     * @param id Optional virtual location ID.
-     * @return New instance with the added virtual location.
-     */
-    addVirtualLocation(location: Omit<VirtualLocation, "@type"> & Partial<Pick<VirtualLocation, "@type">>, id?: Id): TSelf;
-    /**
-     * Add a participant and return a new instance.
-     * @param participant Participant data (without @type).
-     * @param id Optional participant ID.
-     * @return New instance with the added participant.
-     */
-    addParticipant(participant: Omit<Participant, "@type"> & Partial<Pick<Participant, "@type">>, id?: Id): TSelf;
-    /**
-     * Add an alert and return a new instance.
-     * @param alert Alert data (without @type).
-     * @param id Optional alert ID.
-     * @return New instance with the added alert.
-     */
-    addAlert(alert: Omit<Alert, "@type"> & Partial<Pick<Alert, "@type">>, id?: Id): TSelf;
-    /**
-     * Update updated/sequence metadata for modified keys.
-     * @param keys Modified keys.
-     * @param options Update options.
-     * @return Updated instance.
-     */
-    protected touchKeys(data: T, keys: string[], options?: UpdateOptions): T;
-    /**
-     * Update updated/sequence metadata for PatchObject changes.
-     * @param patch Patch applied to the object.
-     * @param options Update options.
-     * @return Updated instance.
-     */
-    protected touchFromPatch(data: T, patch: PatchLike, options?: UpdateOptions): T;
-}

package/dist/jscal/base.js

@@ -1,173 +0,0 @@
-import { applyPatch } from "../patch.js";
-import { deepClone, isNumberValue, nowUtc } from "../utils.js";
-import { validateJsCalendarObject } from "../validate.js";
-import { KEY_PARTICIPANTS } from "./constants.js";
-import { applyAlertDefaults, applyParticipantDefaults } from "./defaults.js";
-import { createId } from "./ids.js";
-export class Base {
-    data;
-    /**
-     * Create a new base instance that wraps a JSCalendar object.
-     * @param data Underlying JSCalendar data.
-     * @return Result.
-     */
-    constructor(data) {
-        this.data = data;
-    }
-    /**
-     * Return a deep-cloned plain object for safe serialization.
-     * @return Cloned JSCalendar data.
-     */
-    eject() {
-        return deepClone(this.data);
-    }
-    /**
-     * Clone the current instance with a deep-cloned payload.
-     * @return New instance with cloned data.
-     */
-    clone() {
-        return this.wrap(deepClone(this.data));
-    }
-    /**
-     * Read a field value from the underlying data.
-     * @param key Field key.
-     * @return Field value.
-     */
-    get(key) {
-        return this.data[key];
-    }
-    /**
-     * Set a field value and update metadata as needed.
-     * @param key Field key.
-     * @param value Field value.
-     * @return New instance with the updated field.
-     */
-    set(key, value) {
-        const next = deepClone(this.data);
-        next[key] = value;
-        const touched = this.touchKeys(next, [String(key)]);
-        return this.wrap(touched);
-    }
-    /**
-     * Apply a PatchObject and touch updated/sequence metadata.
-     * @param patch Patch to apply.
-     * @param options Update options.
-     * @return New instance with applied patch.
-     */
-    patch(patch, options = {}) {
-        const next = applyPatch(this.data, patch);
-        if (options.validate !== false) {
-            validateJsCalendarObject(next);
-        }
-        const touched = this.touchFromPatch(next, patch, options);
-        return this.wrap(touched);
-    }
-    /**
-     * Add a physical location and return a new instance.
-     * @param location Location data (without @type).
-     * @param id Optional location ID.
-     * @return New instance with the added location.
-     */
-    addLocation(location, id) {
-        const actualId = id ?? createId();
-        const next = deepClone(this.data);
-        if (!next.locations)
-            next.locations = {};
-        next.locations[actualId] = { ...location, "@type": "Location" };
-        const touched = this.touchKeys(next, ["locations"]);
-        return this.wrap(touched);
-    }
-    /**
-     * Add a virtual location and return a new instance.
-     * @param location Virtual location data (without @type).
-     * @param id Optional virtual location ID.
-     * @return New instance with the added virtual location.
-     */
-    addVirtualLocation(location, id) {
-        const actualId = id ?? createId();
-        const next = deepClone(this.data);
-        if (!next.virtualLocations)
-            next.virtualLocations = {};
-        const name = location.name ?? "";
-        next.virtualLocations[actualId] = { ...location, name, "@type": "VirtualLocation" };
-        const touched = this.touchKeys(next, ["virtualLocations"]);
-        return this.wrap(touched);
-    }
-    /**
-     * Add a participant and return a new instance.
-     * @param participant Participant data (without @type).
-     * @param id Optional participant ID.
-     * @return New instance with the added participant.
-     */
-    addParticipant(participant, id) {
-        const actualId = id ?? createId();
-        const next = deepClone(this.data);
-        if (!next.participants)
-            next.participants = {};
-        const filled = applyParticipantDefaults({ ...participant, "@type": "Participant" });
-        next.participants[actualId] = filled;
-        const touched = this.touchKeys(next, ["participants"], { sequence: false });
-        return this.wrap(touched);
-    }
-    /**
-     * Add an alert and return a new instance.
-     * @param alert Alert data (without @type).
-     * @param id Optional alert ID.
-     * @return New instance with the added alert.
-     */
-    addAlert(alert, id) {
-        const actualId = id ?? createId();
-        const next = deepClone(this.data);
-        if (!next.alerts)
-            next.alerts = {};
-        const filled = applyAlertDefaults({ ...alert, "@type": "Alert" });
-        next.alerts[actualId] = filled;
-        const touched = this.touchKeys(next, ["alerts"]);
-        return this.wrap(touched);
-    }
-    /**
-     * Update updated/sequence metadata for modified keys.
-     * @param keys Modified keys.
-     * @param options Update options.
-     * @return Updated instance.
-     */
-    touchKeys(data, keys, options = {}) {
-        if (options.touch === false)
-            return data;
-        const now = options.now ?? nowUtc;
-        data.updated = now();
-        if (options.sequence === false)
-            return data;
-        const onlyParticipants = keys.length > 0 && keys.every((key) => key === KEY_PARTICIPANTS);
-        if (!onlyParticipants) {
-            const current = isNumberValue(data.sequence) ? data.sequence : 0;
-            data.sequence = current + 1;
-        }
-        return data;
-    }
-    /**
-     * Update updated/sequence metadata for PatchObject changes.
-     * @param patch Patch applied to the object.
-     * @param options Update options.
-     * @return Updated instance.
-     */
-    touchFromPatch(data, patch, options = {}) {
-        if (options.touch === false)
-            return data;
-        const now = options.now ?? nowUtc;
-        data.updated = now();
-        if (options.sequence === false)
-            return data;
-        const pointers = Object.keys(patch);
-        const onlyParticipants = pointers.length > 0 &&
-            pointers.every((pointer) => {
-                const normalized = pointer.startsWith("/") ? pointer.slice(1) : pointer;
-                return normalized.startsWith("participants");
-            });
-        if (!onlyParticipants) {
-            const current = isNumberValue(data.sequence) ? data.sequence : 0;
-            data.sequence = current + 1;
-        }
-        return data;
-    }
-}