@sockethub/platform-carddav 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,124 @@
+# `@sockethub/platform-carddav`
+
+Sockethub platform for discovering CardDAV address books and searching,
+creating, updating, and deleting vCard contacts.
+
+The platform accepts public HTTPS services by default. Administrators may opt
+in to HTTP or private-network services with `allowInsecureHttp` and
+`allowPrivateAddresses`. Authentication supports Basic, Digest, or a
+caller-provided Bearer token through the standard Sockethub credentials flow.
+
+## Authentication
+
+Send credentials before performing CardDAV actions. Use either a username and
+password (normally an app password) or a Bearer token obtained by the
+application.
+
+```json
+{
+  "type": "credentials",
+  "actor": { "id": "carddav:alice", "type": "person" },
+  "object": {
+    "type": "credentials",
+    "url": "https://contacts.example/dav/",
+    "username": "alice",
+    "password": "app-password"
+  }
+}
+```
+
+For Bearer authentication, replace `username` and `password` with `token`. The
+URL may be a service root; Sockethub discovers the account's address books from
+that endpoint.
+
+## Actions
+
+- `fetch`: discover address books.
+- `query`: list or search contacts.
+- `create`: create a vCard with collision protection.
+- `update`: update a vCard only when its ETag still matches.
+- `delete`: delete a vCard only when its ETag still matches.
+
+Use `sc.contextFor("carddav")` as the request context.
+
+### Discover address books
+
+```json
+{
+  "@context": [
+    "https://www.w3.org/ns/activitystreams",
+    "https://sockethub.org/ns/context/v1.jsonld",
+    "https://sockethub.org/ns/context/platform/carddav/v1.jsonld"
+  ],
+  "type": "fetch",
+  "actor": { "id": "carddav:alice", "type": "person" }
+}
+```
+
+### Search contacts
+
+```json
+{
+  "@context": [
+    "https://www.w3.org/ns/activitystreams",
+    "https://sockethub.org/ns/context/v1.jsonld",
+    "https://sockethub.org/ns/context/platform/carddav/v1.jsonld"
+  ],
+  "type": "query",
+  "actor": { "id": "carddav:alice", "type": "person" },
+  "target": {
+    "id": "https://contacts.example/addressbooks/alice/personal/",
+    "type": "addressBook"
+  },
+  "object": {
+    "type": "contactQuery",
+    "text": "Bob",
+    "fields": ["name", "email"],
+    "limit": 50
+  }
+}
+```
+
+### Create a contact
+
+```json
+{
+  "@context": [
+    "https://www.w3.org/ns/activitystreams",
+    "https://sockethub.org/ns/context/v1.jsonld",
+    "https://sockethub.org/ns/context/platform/carddav/v1.jsonld"
+  ],
+  "type": "create",
+  "actor": { "id": "carddav:alice", "type": "person" },
+  "target": {
+    "id": "https://contacts.example/addressbooks/alice/personal/",
+    "type": "addressBook"
+  },
+  "object": {
+    "type": "person",
+    "name": "Bob Example",
+    "givenName": "Bob",
+    "familyName": "Example",
+    "emails": [
+      { "value": "bob@example.com", "types": ["work"], "preferred": true }
+    ],
+    "photoUrls": ["https://example.com/bob.jpg"]
+  }
+}
+```
+
+Update sends the complete contact returned by `query`, including `id`, `uid`,
+and `etag`. The server re-fetches the current vCard using that ETag before
+writing. Unknown properties and parameters from the authoritative stored card
+are retained, preventing an application from accidentally erasing data it does
+not understand.
+
+Only HTTP(S) `PHOTO` URIs appear as `photoUrls`. CardDAV never downloads those
+images. Existing inline photos are hidden from responses and preserved during
+updates. Supplying `photoUrls` explicitly replaces all stored photos; an empty
+array removes them.
+
+The initial implementation reads vCard 3.0 and 4.0 and writes vCard 4.0. Stable
+errors use the `carddav:` prefix, including `authentication-failed`,
+`unsupported-authentication`, `invalid-address-book`, `invalid-resource`,
+`conflict`, `not-found`, and `unsupported-update`.

package/dist/dav.d.ts

@@ -0,0 +1,24 @@
+import { type DavAuthentication, DavClient, DavFailure, type DavNetworkOptions } from "@sockethub/dav";
+import type { AddressBookDescription, Contact, ContactInput, ContactQuery } from "./types.js";
+export { DavFailure as CardDavFailure };
+export declare class CardDavClient extends DavClient {
+    constructor(url: string, authentication: DavAuthentication, timeoutMs?: number, networkOptions?: DavNetworkOptions);
+    discoverAddressBooks(): Promise<AddressBookDescription[]>;
+    private discoverFrom;
+    query(book: AddressBookDescription, query?: ContactQuery): Promise<Contact[]>;
+    create(book: AddressBookDescription, input: ContactInput): Promise<{
+        id: string;
+        uid: string;
+        etag?: string;
+    }>;
+    update(input: ContactInput & {
+        id: string;
+        uid: string;
+        etag: string;
+    }): Promise<{
+        id: string;
+        uid: string;
+        etag: string;
+    }>;
+    delete(id: string, etag: string): Promise<void>;
+}

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import type { ActivityStream, PlatformCallback, PlatformInterface, PlatformSchemaStruct, PlatformSession, StatelessPlatformConfig } from "@sockethub/schemas";
+import type { CardDavCredentials } from "./types.js";
+export default class CardDav implements PlatformInterface {
+    private readonly log;
+    config: StatelessPlatformConfig;
+    constructor(session: PlatformSession);
+    get schema(): PlatformSchemaStruct;
+    isInitialized(): boolean;
+    cleanup(done: PlatformCallback): void;
+    fetch(job: ActivityStream, credentials: CardDavCredentials, done: PlatformCallback): void;
+    query(job: ActivityStream, credentials: CardDavCredentials, done: PlatformCallback): void;
+    create(job: ActivityStream, credentials: CardDavCredentials, done: PlatformCallback): void;
+    update(job: ActivityStream, credentials: CardDavCredentials, done: PlatformCallback): void;
+    delete(job: ActivityStream, credentials: CardDavCredentials, done: PlatformCallback): void;
+    private client;
+    private book;
+    private mutation;
+    private fail;
+}
+export { CardDavClient, CardDavFailure } from "./dav.js";
+export { PlatformCardDavSchema } from "./schema.js";
+export { buildVCard, parseVCard } from "./vcard.js";