@sockethub/platform-caldav 1.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,187 @@
+# `@sockethub/platform-caldav`
+
+Sockethub platform for discovering CalDAV calendars and reading, creating,
+updating, and deleting events (`VEVENT`) and tasks (`VTODO`).
+
+Requests accept only public HTTPS services by default. Administrators can opt
+in to HTTP with `packageConfig.allowInsecureHttp` and private-network targets
+with `packageConfig.allowPrivateAddresses`; these are server settings and
+cannot be enabled by a connected client. Credentials and OAuth tokens are sent
+only to the configured origin. Every calendar and item target is checked
+against the authenticated account before it is used.
+
+## Authentication
+
+Send credentials using either a username and password (normally an app
+password) or an OAuth access token obtained by the application. Sockethub uses
+the token as an HTTP Bearer token; it does not run an OAuth authorization UI.
+
+```json
+{
+  "type": "credentials",
+  "actor": { "id": "caldav:alice", "type": "person" },
+  "object": {
+    "type": "credentials",
+    "url": "https://calendar.example/dav/",
+    "token": "oauth-access-token"
+  }
+}
+```
+
+For Basic authentication, replace `token` with `username` and `password`. The
+URL can be a service root; discovery also tries `/.well-known/caldav`.
+Cross-origin redirects are rejected, so configure the provider's final CalDAV
+origin when its discovery URL redirects elsewhere.
+
+## Actions
+
+- `fetch`: discover calendars and their event/task support.
+- `query`: read items from one discovered calendar, optionally filtering by
+  component type or UTC date range.
+- `create`: create an event or task with collision protection.
+- `update`: replace an item only when its ETag still matches.
+- `delete`: delete an item only when its ETag still matches.
+
+Use `sc.contextFor("caldav")` for `@context` and pass an acknowledgement
+callback for each message.
+
+### Discover calendars
+
+```json
+{
+  "type": "fetch",
+  "actor": { "id": "caldav:alice", "type": "person" }
+}
+```
+
+The collection contains calendar objects such as:
+
+```json
+{
+  "id": "https://calendar.example/calendars/alice/personal/",
+  "type": "calendar",
+  "name": "Personal",
+  "color": "#3a87ad",
+  "components": ["event", "task"]
+}
+```
+
+### Query items
+
+```json
+{
+  "type": "query",
+  "actor": { "id": "caldav:alice", "type": "person" },
+  "target": {
+    "id": "https://calendar.example/calendars/alice/personal/",
+    "type": "calendar"
+  },
+  "object": {
+    "type": "event",
+    "startTime": "2026-08-01T00:00:00Z",
+    "endTime": "2026-09-01T00:00:00Z"
+  }
+}
+```
+
+Each returned item contains its resource `id`, `uid`, `etag`, and
+`updateSupported`. Keep the ETag for later update or delete requests. Use date
+ranges for large calendars; responses larger than 10 MiB are rejected.
+
+### Create an event
+
+```json
+{
+  "type": "create",
+  "actor": { "id": "caldav:alice", "type": "person" },
+  "target": {
+    "id": "https://calendar.example/calendars/alice/personal/",
+    "type": "calendar"
+  },
+  "object": {
+    "type": "event",
+    "name": "Project planning",
+    "startTime": "2026-08-03T15:00:00",
+    "endTime": "2026-08-03T16:00:00",
+    "timeZone": "Europe/Prague",
+    "recurrence": {
+      "frequency": "weekly",
+      "count": 4,
+      "byDay": ["MO"]
+    },
+    "organizer": {
+      "email": "alice@example.com",
+      "name": "Alice"
+    },
+    "attendees": [
+      {
+        "email": "bob@example.com",
+        "role": "required",
+        "rsvp": true
+      }
+    ],
+    "reminders": [{ "trigger": "-PT15M", "action": "display" }],
+    "attachments": [
+      {
+        "url": "https://example.com/agenda.pdf",
+        "mediaType": "application/pdf"
+      }
+    ]
+  }
+}
+```
+
+Timed values use RFC 3339 with a UTC offset, or a local date-time plus an IANA
+`timeZone`. All-day values use `YYYY-MM-DD`; an event's end date is exclusive.
+Named time zones include a `VTIMEZONE` definition generated from the server's
+IANA timezone data.
+The optional `uid` field must not contain `%`, `/`, or `\`; omit it to let
+Sockethub generate a safe UID.
+Attachments can use a URL or base64 `data`. Email reminders additionally need
+a `recipients` array. Tasks support `due`, `status`, `completedTime`, and
+`percentComplete`.
+
+### Update and delete
+
+Update sends the complete event or task returned by `query`, including `id`,
+`uid`, and `etag`. Increment `sequence` when changing scheduling information.
+An update is rejected when `updateSupported` is false, which protects recurrence
+exceptions, exclusion dates, and multi-component resources from being lost.
+Properties outside Sockethub's item model, such as `CATEGORIES` and `X-`
+properties, are not preserved when an otherwise supported item is updated.
+
+```json
+{
+  "type": "delete",
+  "actor": { "id": "caldav:alice", "type": "person" },
+  "target": {
+    "id": "https://calendar.example/calendars/alice/personal/",
+    "type": "calendar"
+  },
+  "object": {
+    "id": "https://calendar.example/calendars/alice/personal/item.ics",
+    "type": "event",
+    "etag": "\"server-version\""
+  }
+}
+```
+
+If another client changed the item, update/delete returns `caldav:conflict`.
+Query again, reconcile the change, and retry with the new ETag.
+
+## Interoperability and security
+
+The implementation follows WebDAV/CalDAV discovery, calendar-query REPORT,
+iCalendar content-line escaping/folding, and conditional PUT/DELETE semantics.
+The integration suite exercises the complete event and VTODO lifecycle against
+Radicale. Provider-specific OAuth authorization and token refresh remain the
+calling application's responsibility, because Sockethub receives credentials
+only after authorization.
+
+Queries currently return calendar snapshots. CalDAV sync tokens (RFC 6578) are
+the intended follow-up for efficient incremental synchronization.
+
+Stable errors include `caldav:authentication-failed`,
+`caldav:connection-failed`, `caldav:invalid-calendar`,
+`caldav:invalid-resource`, `caldav:unsupported-component`,
+`caldav:conflict`, and `caldav:not-found`.

package/dist/dav.d.ts

@@ -0,0 +1,36 @@
+import type { CalendarDescription, CalendarItem, QueryInput } from "./types.js";
+export declare class CalDavFailure extends Error {
+    readonly code: string;
+    constructor(code: string, cause?: unknown);
+}
+export declare class CalDavClient {
+    private timeoutMs;
+    private readonly dispatcher;
+    private readonly authorization;
+    readonly serviceUrl: URL;
+    constructor(url: string, authentication: {
+        username: string;
+        password: string;
+    } | {
+        token: string;
+    }, timeoutMs?: number, networkOptions?: {
+        allowPrivateAddresses?: boolean;
+        allowInsecureHttp?: boolean;
+    });
+    close(): Promise<void>;
+    private assertAllowed;
+    private request;
+    private propfind;
+    discoverCalendars(): Promise<CalendarDescription[]>;
+    private discoverFrom;
+    create(calendar: CalendarDescription, uid: string, body: string): Promise<{
+        id: string;
+        etag?: string;
+    }>;
+    query(calendar: CalendarDescription, query?: QueryInput): Promise<CalendarItem[]>;
+    update(id: string, etag: string, body: string): Promise<{
+        id: string;
+        etag?: string;
+    }>;
+    delete(id: string, etag: string): Promise<void>;
+}

package/dist/ical.d.ts

@@ -0,0 +1,11 @@
+import type { CalendarItem, CalendarObjectInput } from "./types.js";
+/** Fold one iCalendar content line at 75 UTF-8 octets (74 after continuation). */
+export declare function foldLine(line: string): string;
+export declare function buildICalendar(input: CalendarObjectInput, now?: Date): {
+    uid: string;
+    body: string;
+};
+/** Parse the interoperable item fields returned by CalDAV multiget/query responses. */
+export declare function parseICalendar(body: string, id: string, etag?: string): CalendarItem;
+/** Whether rewriting this resource can preserve all recurrence semantics. */
+export declare function isUpdateSupported(body: string): boolean;

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import type { ActivityStream, PlatformCallback, PlatformInterface, PlatformSchemaStruct, PlatformSession, StatelessPlatformConfig } from "@sockethub/schemas";
+import type { CalDavCredentials } from "./types.js";
+export declare function assertCalendarResource(calendarId: string, resourceId: string): void;
+export default class CalDav implements PlatformInterface {
+    private readonly log;
+    config: StatelessPlatformConfig;
+    constructor(session: PlatformSession);
+    get schema(): PlatformSchemaStruct;
+    isInitialized(): boolean;
+    cleanup(done: PlatformCallback): void;
+    fetch(job: ActivityStream, credentials: CalDavCredentials, done: PlatformCallback): void;
+    create(job: ActivityStream, credentials: CalDavCredentials, done: PlatformCallback): void;
+    query(job: ActivityStream, credentials: CalDavCredentials, done: PlatformCallback): void;
+    update(job: ActivityStream, credentials: CalDavCredentials, done: PlatformCallback): void;
+    delete(job: ActivityStream, credentials: CalDavCredentials, done: PlatformCallback): void;
+    private client;
+    private calendar;
+    private assertResource;
+    private mutationResponse;
+    private fail;
+}
+export { buildICalendar, foldLine } from "./ical.js";
+export { PlatformCalDavSchema } from "./schema.js";