@sockethub/platform-caldav 1.0.0-beta.0 → 1.0.0-beta.2

package/README.md

@@ -8,9 +8,26 @@ subscription links, without a CalDAV account.
 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.
+cannot be enabled by a connected client. Address checks use the shared
+outbound URL guard, including IPv6 embeddings of private ranges and the
+local-use NAT64 prefix `64:ff9b:1::/48`. See
+[Outbound URL guard](../../docs/configuration.md#outbound-url-guard).
+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.
+
+## Discovery cache
+
+Each `query`, `create`, `update`, and `delete` needs the account's calendar list to
+check the target. The platform caches that discovery result in memory for
+`packageConfig.discoveryCacheTtlMs` (default `300000`, 5 minutes; `0`
+disables the cache). Entries are keyed by an HMAC of the protocol, service URL,
+and credentials. The HMAC uses a per-process random secret, and only
+collection metadata is stored. A `fetch` always discovers fresh. Within the TTL,
+a calendar added on the server is not visible to targeted actions, and a removed
+one is still accepted as a target (the server then rejects the request). An
+authentication, not-found, or unknown-calendar error drops the entry, so the next
+request rediscovers. The cache is lost when the platform process restarts.
 
 ## Authentication
 
@@ -205,7 +222,8 @@ 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
+a `recipients` array. Events support `status` (`tentative`, `confirmed`, or
+`cancelled`). Tasks support `due`, `status`, `completedTime`, and
 `percentComplete`.
 
 ### Update and delete

package/dist/index.d.ts

@@ -13,7 +13,10 @@ export default class CalDav implements PlatformInterface {
     private readonly log;
     private readonly fetchImpl;
     private feedDispatcher?;
-    config: StatelessPlatformConfig;
+    private readonly discovery;
+    config: StatelessPlatformConfig & {
+        discoveryCacheTtlMs: number;
+    };
     constructor(session: PlatformSession, fetchImpl?: FeedFetch);
     get schema(): PlatformSchemaStruct;
     isInitialized(): boolean;
@@ -42,6 +45,7 @@ export default class CalDav implements PlatformInterface {
      */
     private fetchFeed;
     private feedUrl;
+    private discoveryKey;
     private calendar;
     private assertResource;
     private mutationResponse;