@sockethub/platform-carddav 1.0.0-beta.5 → 1.0.0-beta.6

package/README.md

@@ -122,6 +122,11 @@ book and send it back as `"object": { "syncToken": "..." }` to receive only
 what changed since then. When `truncated` is `true`, store the new token and
 sync again until it is `false`.
 
+Send `"object": { "tokenOnly": true }` to get the address book's current
+`syncToken` with empty `items` and `removed`, without listing every contact.
+Read it before loading the contacts you need, then sync with it later. A
+server that exposes no token returns `carddav:sync-unsupported`.
+
 On `carddav:sync-token-invalid`, drop the stored token and sync again without
 one. On `carddav:sync-unsupported`, the server does not offer WebDAV Sync; fall
 back to `query`. Other sync errors are `carddav:sync-failed`. A server that

package/dist/index.d.ts

@@ -21,6 +21,10 @@ export default class CardDav implements PlatformInterface {
      * the result being complete. `carddav:sync-token-invalid` means start
      * over without a token; `carddav:sync-unsupported` means fall back to
      * `query`.
+     *
+     * With `object.tokenOnly: true`, returns the address book's current
+     * token and no contacts, so a client can start tracking changes
+     * without downloading every contact first.
      */
     sync(job: ActivityStream, credentials: CardDavCredentials, done: PlatformCallback): void;
     create(job: ActivityStream, credentials: CardDavCredentials, done: PlatformCallback): void;

package/dist/index.js

@@ -42989,6 +42989,35 @@ class DavClient {
     }
     return this.readMultistatus(response);
   }
+  async currentSyncToken(collection) {
+    const response = await this.request(collection, {
+      method: "PROPFIND",
+      headers: {
+        depth: "0",
+        "content-type": "application/xml; charset=utf-8"
+      },
+      body: `<?xml version="1.0" encoding="utf-8"?>
+<d:propfind xmlns:d="DAV:"><d:prop><d:sync-token/></d:prop></d:propfind>`
+    });
+    if (response.status === 404)
+      return rejectDavResponse(response, `${this.errorPrefix}:not-found`);
+    if (response.status !== 207) {
+      await response.body?.cancel().catch(() => {});
+      throw new DavFailure(`${this.errorPrefix}:invalid-response`);
+    }
+    let responses;
+    try {
+      responses = asArray(parseDavXml(await response.text(), {
+        parseTagValue: false
+      }).multistatus?.response);
+    } catch {
+      throw new DavFailure(`${this.errorPrefix}:invalid-response`);
+    }
+    const token = successfulProps(responses[0] ?? {})["sync-token"];
+    if (typeof token !== "string" || token.trim() === "")
+      throw new DavFailure(`${this.errorPrefix}:sync-unsupported`);
+    return token.trim();
+  }
   async syncCollection(collection, prop, syncToken, namespaces = "") {
     const response = await this.request(collection, {
       method: "REPORT",
@@ -43427,7 +43456,7 @@ var ActivityStreamSchema = {
 var package_default = {
   name: "@sockethub/schemas",
   description: "JSON schema files for validating Sockethub Activity Streams",
-  version: "3.0.0-beta.5",
+  version: "3.0.0-beta.6",
   type: "module",
   private: false,
   author: "Nick Jennings <nick@silverbucket.net>",
@@ -43497,7 +43526,7 @@ var package_default = {
     "ajv-formats": "^2.1.1",
     "ajv-formats-draft2019": "^1.6.1"
   },
-  gitHead: "cc4ffdd9714ebbd8372a88c4f2d795974e04029e",
+  gitHead: "604f3da8850a19a4fd5f5e5dcec10bf283e9085e",
   types: "./dist/index.d.ts"
 };
 
@@ -44647,7 +44676,7 @@ class CardDavClient extends DavClient {
 var package_default2 = {
   name: "@sockethub/platform-carddav",
   description: "A Sockethub platform for CardDAV address books and contacts",
-  version: "1.0.0-beta.5",
+  version: "1.0.0-beta.6",
   type: "module",
   private: false,
   license: "LGPL-3.0+",
@@ -44676,21 +44705,21 @@ var package_default2 = {
     test: "bun test src/"
   },
   dependencies: {
-    "@sockethub/dav": "^1.0.0-beta.5",
-    "@sockethub/schemas": "^3.0.0-beta.5"
+    "@sockethub/dav": "^1.0.0-beta.6",
+    "@sockethub/schemas": "^3.0.0-beta.6"
   },
   devDependencies: {
     "@types/bun": "latest"
   },
   peerDependencies: {
-    "@sockethub/server": "^5.0.0-beta.5"
+    "@sockethub/server": "^5.0.0-beta.6"
   },
   peerDependenciesMeta: {
     "@sockethub/server": {
       optional: true
     }
   },
-  gitHead: "cc4ffdd9714ebbd8372a88c4f2d795974e04029e"
+  gitHead: "604f3da8850a19a4fd5f5e5dcec10bf283e9085e"
 };
 
 // src/schema.ts
@@ -44823,7 +44852,8 @@ var syncToken = { type: "string", minLength: 1, maxLength: 4096 };
 var sync = {
   type: "object",
   additionalProperties: false,
-  properties: { syncToken }
+  properties: { syncToken, tokenOnly: { const: true } },
+  not: { required: ["syncToken", "tokenOnly"] }
 };
 var deletion = {
   type: "object",
@@ -44904,7 +44934,8 @@ var PlatformCardDavSchema = {
           contact2,
           query,
           deletion,
-          { ...sync, required: ["syncToken"] }
+          { ...sync, required: ["syncToken"] },
+          { ...sync, required: ["tokenOnly"] }
         ]
       }
     }
@@ -45080,7 +45111,12 @@ class CardDav {
   sync(job, credentials, done) {
     const client = this.client(credentials);
     const input = job.object ?? {};
-    this.book(client, credentials, job.target?.id ?? "").then((book) => client.sync(book, input.syncToken)).then((result) => done(null, {
+    this.book(client, credentials, job.target?.id ?? "").then((book) => input.tokenOnly ? client.currentSyncToken(new URL(book.id)).then((syncToken) => ({
+      items: [],
+      removed: [],
+      syncToken,
+      truncated: false
+    })) : client.sync(book, input.syncToken)).then((result) => done(null, {
       "@context": CONTEXT,
       ...job.id ? { id: job.id } : {},
       type: "collection",
@@ -45169,4 +45205,4 @@ export {
   parseVCard
 };
 
-//# debugId=A470017A427BECB364756E2164756E21
+//# debugId=9916E0836EEA9D2664756E2164756E21