@interop/was-client 0.51.0 → 0.53.0

package/dist/sync/provisioning.js

@@ -2,6 +2,8 @@
 // sync module does not pull the EDV crypto graph for one number.
 import { EDV_SCHEME_VERSION } from '../edv/constants.js';
 import { ValidationError, WasError } from '../errors.js';
+import { compareAndSwap } from '../internal/cas.js';
+import { isGovernedDescriptor } from '../internal/describe.js';
 /**
  * The Space display name applied at creation when the caller names none.
  */
@@ -31,10 +33,60 @@ function rethrowProvisioningFailure(err, context) {
     }
     throw new Error(context, { cause: err });
 }
+/**
+ * The read-then-guarded-create both ensures share: the value is read and, when
+ * present, kept as-is; when absent, `create` runs the `If-None-Match: *` write,
+ * and when that fails for ANY reason the value is re-read, and a value now
+ * present is adopted as the winner of a create race instead of failing. The race is detected by the re-read rather than by the
+ * failure's status because the server answers a lost race with whatever check
+ * the rival's description trips first: a 412 from the precondition, but also
+ * a 400 or 409 from the encryption-descriptor transition rules when the rival
+ * already installed key epochs. When nothing can be read back, the create's
+ * own failure is rethrown, so a genuine failure keeps its type.
+ *
+ * A `create` that resolves `undefined` (a server that answered the create with
+ * no body) also falls through to the re-read; that value being unreadable is
+ * the one case reported as its own error.
+ *
+ * @param options {object}
+ * @param options.read {function}   reads the value; `null` when absent
+ * @param options.create {function}   the guarded write; resolves the created
+ *   value, or `undefined` when the server echoed none
+ * @param options.unreadable {string}   the error message when a create
+ *   succeeded but the value cannot be read back
+ * @returns {Promise<{ value: T; created: boolean }>}   the value now present
+ *   and whether this call created it
+ */
+async function readOrCreate({ read, create, unreadable }) {
+    const current = await read();
+    if (current !== null) {
+        return { value: current, created: false };
+    }
+    let created = false;
+    let failure;
+    try {
+        const value = await create();
+        created = true;
+        if (value !== undefined) {
+            return { value, created };
+        }
+    }
+    catch (err) {
+        failure = err;
+    }
+    const latest = await read();
+    if (latest !== null) {
+        return { value: latest, created };
+    }
+    if (created) {
+        throw new ValidationError(unreadable);
+    }
+    throw failure;
+}
 /**
  * Ensures the controller's Space exists and one synced collection is
  * configured, without overwriting anything already there. The Space is
- * described first and configured only when absent -- an existing Space keeps
+ * described first and created only when absent -- an existing Space keeps
  * its name AND its controller, so `controllerDid` is used only at creation
  * (a joined client re-running this never rewrites the description). The
  * collection likewise: when absent, an `'edv'` collection is created with the
@@ -42,16 +94,29 @@ function rethrowProvisioningFailure(err, context) {
  * the server stores only ciphertext it can never decrypt and validates every
  * write against the declared envelope wire format -- the same version the
  * cipher binds into each envelope's AEAD-protected header, so descriptor and
- * envelopes cannot drift; a `'plaintext'` collection is created without one,
- * with `force` so the descriptor-less upsert can create a fresh collection
- * (running full-tier, a 404 from the pre-merge describe really means absent).
- * An existing collection that lacks a descriptor an `'edv'` spec calls for
+ * envelopes cannot drift; a `'plaintext'` or `'governed'` collection is created
+ * without one. Both creates are guarded (`If-None-Match: *`), so two clients
+ * booting at once cannot both create, and the loser adopts the winner's
+ * description instead of failing. Against a server that ignores the
+ * precondition the create is an unconditional upsert, and the loser of a race
+ * can overwrite the winner's display name; the server merges the rest of the
+ * winner's description forward.
+ *
+ * An existing collection that lacks the descriptor an `'edv'` spec calls for
  * gets the late in-place declaration (set-once on the server); one that
  * already carries a descriptor -- possibly with appended key epochs -- is
- * left untouched, epochs and display name included. A public collection gets
- * the collection-level world-read grant (`setPublic`, what makes a resource
- * URL in it resolve for anyone) only when its policy does not already say so.
- * Runs full-tier -- the client invokes its own root authority.
+ * left untouched, epochs and display name included. An existing `'governed'`
+ * collection is never written to: the server refuses to govern a Description
+ * that carries a client-written descriptor (`encryption-immutable`), and a
+ * governed Collection's served `encryption` is the derived member, which a
+ * Description PUT may not carry (`encryption-history-log-governed`). So an
+ * existing collection whose descriptor is client-written (no `history`
+ * member) cannot become governed, and a `'governed'` spec over it throws
+ * `ValidationError` here rather than letting the caller's log create fail
+ * with the server's 409. A public collection gets the collection-level
+ * world-read grant (`setPublic`, what makes a resource URL in it resolve for
+ * anyone) only when its policy does not already say so. Runs full-tier -- the
+ * client invokes its own root authority.
  *
  * @param options {object}
  * @param options.was {WasClient}
@@ -59,7 +124,14 @@ function rethrowProvisioningFailure(err, context) {
  * @param options.controllerDid {string}   the Space controller (e.g. `did:key`);
  *   used only when the Space does not exist yet
  * @param options.collectionId {string}    the WAS collection id
- * @param [options.encryption] {'edv' | 'plaintext'}   defaults to `'edv'`
+ * @param [options.encryption] {'edv' | 'plaintext' | 'governed'}   how the
+ *   collection's `encryption` member is settled; defaults to `'edv'`.
+ *   `'edv'` declares the descriptor here, `'plaintext'` declares none, and
+ *   `'governed'` leaves the member to the server, which derives it from the
+ *   collection's history log. Declaring that governance is the caller's next
+ *   step, through the log's guarded create --
+ *   `logGovernedDescriptorStore(...).create` or
+ *   `resourceLogStore({ collection }).create`
  * @param [options.isPublic] {boolean}   grant collection-level world read
  * @param [options.spaceName] {string}   the Space display name, applied only at
  *   Space creation; defaults to `'WAS Space'`
@@ -91,28 +163,66 @@ export async function ensureSpaceAndCollection({ was, spaceId, controllerDid, co
     }
     try {
         const collection = space.collection(collectionId);
-        const current = await collection.describe();
-        if (current === null) {
-            await collection.configure(encryption === 'edv'
-                ? {
-                    name: collectionName,
-                    current,
-                    encryption: EDV_DESCRIPTOR
-                }
-                : { name: collectionName, current, force: true });
+        // A `'governed'` or `'plaintext'` collection takes the descriptor-less
+        // create: a governed `encryption` member is the server's to derive.
+        const { value: read, created } = await readOrCreate({
+            read: () => collection.describeWithEtag(),
+            create: () => collection.replaceDescription(encryption === 'edv'
+                ? { name: collectionName, encryption: EDV_DESCRIPTOR }
+                : { name: collectionName }, { ifNoneMatch: true }),
+            unreadable: `Collection "${collectionId}" in space "${spaceId}" was ` +
+                'created but cannot be read back.'
+        });
+        const current = read.description;
+        if (encryption === 'governed' &&
+            current.encryption !== undefined &&
+            !isGovernedDescriptor(current.encryption)) {
+            throw new ValidationError(`Collection "${collectionId}" in space "${spaceId}" carries a ` +
+                'client-written encryption descriptor, so it cannot be governed by ' +
+                'a history log: the server keeps a declared descriptor immutable.');
         }
-        else if (encryption === 'edv' && current.encryption === undefined) {
+        if (!created && encryption === 'edv' && current.encryption === undefined) {
             // The late in-place declaration: adding a descriptor to a collection
             // that lacks one is allowed (set-once), while re-sending one over an
             // existing descriptor would drop its appended key epochs -- which is
-            // exactly why an existing descriptor is never touched.
-            await collection.configure({
-                name: current.name ?? collectionName,
-                current,
-                encryption: EDV_DESCRIPTOR
+            // exactly why an existing descriptor is never touched. The write is
+            // compare-and-swapped against the description just read, so a rival
+            // declaration landing in between is re-read and adopted as-is rather
+            // than tripping `encryption-immutable` or being overwritten.
+            let reusable = read;
+            await compareAndSwap({
+                store: {
+                    read: async () => {
+                        const latest = reusable !== null ? reusable : await collection.describeWithEtag();
+                        reusable = null;
+                        if (latest === null) {
+                            throw new ValidationError(`Collection "${collectionId}" in space "${spaceId}" vanished ` +
+                                'while its encryption was being declared.');
+                        }
+                        return { value: latest.description, etag: latest.etag };
+                    },
+                    // Replace semantics: every writable field is carried forward.
+                    replace: async (next, { ifMatch }) => {
+                        await collection.replaceDescription({
+                            name: next.name,
+                            backend: next.backend,
+                            encryption: next.encryption
+                        }, { ifMatch });
+                    }
+                },
+                operation: 'Encryption declaration',
+                mutate: latest => latest.encryption === undefined
+                    ? {
+                        ...latest,
+                        name: latest.name ?? collectionName,
+                        encryption: EDV_DESCRIPTOR
+                    }
+                    : null
             });
         }
-        if (isPublic && !(await collection.isPublic())) {
+        // A collection this call just created has no policy document yet, so the
+        // read that would find it non-public is skipped.
+        if (isPublic && (created || !(await collection.isPublic()))) {
             await collection.setPublic();
         }
     }
@@ -125,11 +235,13 @@ export async function ensureSpaceAndCollection({ was, spaceId, controllerDid, co
  * there -- the Space half of {@link ensureSpaceAndCollection}, split out so a
  * caller provisioning SEVERAL collections into one Space pays for it once
  * rather than once per collection. An existing Space keeps its name AND its
- * controller, so `controllerDid` is used only at creation.
+ * controller, so `controllerDid` is used only at creation. The create is
+ * guarded (`If-None-Match: *`), so a Space created concurrently keeps its
+ * `type` array (accepted at creation only) and is adopted by the loser.
  *
- * Costs one `GET` on a settled Space, and one `GET` plus one `PUT` on a fresh
- * one: the description read here is threaded into `configure`, which therefore
- * does not re-read it.
+ * Costs one `GET` on a settled Space, and one `GET` plus one guarded `PUT`
+ * (`If-None-Match: *`) on a fresh one; a lost create race costs one more `GET`
+ * to adopt the winner.
  *
  * @param options {object}
  * @param options.was {WasClient}
@@ -145,15 +257,12 @@ export async function ensureSpaceAndCollection({ was, spaceId, controllerDid, co
 export async function ensureSpace({ was, spaceId, controllerDid, spaceName = DEFAULT_SPACE_NAME }) {
     const space = was.space(spaceId);
     try {
-        const current = await space.describe();
-        if (current !== null) {
-            return current;
-        }
-        return await space.configure({
-            name: spaceName,
-            controller: controllerDid,
-            current
+        const { value } = await readOrCreate({
+            read: () => space.describe(),
+            create: async () => (await space.replaceDescription({ name: spaceName, controller: controllerDid }, { ifNoneMatch: true })).description,
+            unreadable: `Space "${spaceId}" was created but cannot be read back.`
         });
+        return value;
     }
     catch (err) {
         rethrowProvisioningFailure(err, `Failed to configure WAS space "${spaceId}" for "${controllerDid}".`);

package/dist/sync/provisioning.js.map

@@ -1 +1 @@
-{"version":3,"file":"provisioning.js","sourceRoot":"","sources":["../../src/sync/provisioning.ts"],"names":[],"mappings":"AAoBA,6EAA6E;AAC7E,iEAAiE;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAExD;;GAEG;AACH,MAAM,kBAAkB,GAAG,WAAW,CAAA;AAEtC;;;GAGG;AACH,MAAM,cAAc,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAW,CAAA;AAE9E;;;;;;;;;;;;;GAaG;AACH,SAAS,0BAA0B,CAAC,GAAY,EAAE,OAAe;IAC/D,IAAI,GAAG,YAAY,QAAQ,EAAE,CAAC;QAC5B,MAAM,GAAG,CAAA;IACX,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;AAC1C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,EAC7C,GAAG,EACH,OAAO,EACP,aAAa,EACb,YAAY,EACZ,UAAU,GAAG,KAAK,EAClB,QAAQ,GAAG,KAAK,EAChB,SAAS,GAAG,kBAAkB,EAC9B,cAAc,GAAG,YAAY,EAC7B,gBAAgB,EAWjB;IACC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAEhC,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,WAAW,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAA;IAC/D,CAAC;SAAM,IAAI,gBAAgB,CAAC,EAAE,KAAK,OAAO,EAAE,CAAC;QAC3C,qEAAqE;QACrE,oEAAoE;QACpE,uEAAuE;QACvE,oEAAoE;QACpE,gCAAgC;QAChC,MAAM,IAAI,eAAe,CACvB,yBAAyB,gBAAgB,CAAC,EAAE,4BAA4B;YACtE,uBAAuB,OAAO,KAAK,CACtC,CAAA;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAA;QACjD,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAA;QAC3C,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,MAAM,UAAU,CAAC,SAAS,CACxB,UAAU,KAAK,KAAK;gBAClB,CAAC,CAAC;oBACE,IAAI,EAAE,cAAc;oBACpB,OAAO;oBACP,UAAU,EAAE,cAAc;iBAC3B;gBACH,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CACnD,CAAA;QACH,CAAC;aAAM,IAAI,UAAU,KAAK,KAAK,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACpE,qEAAqE;YACrE,qEAAqE;YACrE,qEAAqE;YACrE,uDAAuD;YACvD,MAAM,UAAU,CAAC,SAAS,CAAC;gBACzB,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,cAAc;gBACpC,OAAO;gBACP,UAAU,EAAE,cAAc;aAC3B,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,QAAQ,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YAC/C,MAAM,UAAU,CAAC,SAAS,EAAE,CAAA;QAC9B,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,0BAA0B,CACxB,GAAG,EACH,mCAAmC,YAAY,eAAe,OAAO,IAAI,CAC1E,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,EAChC,GAAG,EACH,OAAO,EACP,aAAa,EACb,SAAS,GAAG,kBAAkB,EAM/B;IACC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAChC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAA;QACtC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,SAAS,CAAC;YAC3B,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,aAAa;YACzB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,0BAA0B,CACxB,GAAG,EACH,kCAAkC,OAAO,UAAU,aAAa,IAAI,CACrE,CAAA;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"provisioning.js","sourceRoot":"","sources":["../../src/sync/provisioning.ts"],"names":[],"mappings":"AA0BA,6EAA6E;AAC7E,iEAAiE;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAE9D;;GAEG;AACH,MAAM,kBAAkB,GAAG,WAAW,CAAA;AAEtC;;;GAGG;AACH,MAAM,cAAc,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAW,CAAA;AAE9E;;;;;;;;;;;;;GAaG;AACH,SAAS,0BAA0B,CAAC,GAAY,EAAE,OAAe;IAC/D,IAAI,GAAG,YAAY,QAAQ,EAAE,CAAC;QAC5B,MAAM,GAAG,CAAA;IACX,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;AAC1C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,KAAK,UAAU,YAAY,CAAI,EAC7B,IAAI,EACJ,MAAM,EACN,UAAU,EAKX;IACC,MAAM,OAAO,GAAG,MAAM,IAAI,EAAE,CAAA;IAC5B,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IAC3C,CAAC;IACD,IAAI,OAAO,GAAG,KAAK,CAAA;IACnB,IAAI,OAAgB,CAAA;IACpB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,MAAM,EAAE,CAAA;QAC5B,OAAO,GAAG,IAAI,CAAA;QACd,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAA;QAC3B,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,GAAG,GAAG,CAAA;IACf,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAA;IAC3B,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAA;IACnC,CAAC;IACD,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,IAAI,eAAe,CAAC,UAAU,CAAC,CAAA;IACvC,CAAC;IACD,MAAM,OAAO,CAAA;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,EAC7C,GAAG,EACH,OAAO,EACP,aAAa,EACb,YAAY,EACZ,UAAU,GAAG,KAAK,EAClB,QAAQ,GAAG,KAAK,EAChB,SAAS,GAAG,kBAAkB,EAC9B,cAAc,GAAG,YAAY,EAC7B,gBAAgB,EAWjB;IACC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAEhC,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,WAAW,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAA;IAC/D,CAAC;SAAM,IAAI,gBAAgB,CAAC,EAAE,KAAK,OAAO,EAAE,CAAC;QAC3C,qEAAqE;QACrE,oEAAoE;QACpE,uEAAuE;QACvE,oEAAoE;QACpE,gCAAgC;QAChC,MAAM,IAAI,eAAe,CACvB,yBAAyB,gBAAgB,CAAC,EAAE,4BAA4B;YACtE,uBAAuB,OAAO,KAAK,CACtC,CAAA;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAA;QACjD,uEAAuE;QACvE,oEAAoE;QACpE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,YAAY,CAAC;YAClD,IAAI,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE;YACzC,MAAM,EAAE,GAAG,EAAE,CACX,UAAU,CAAC,kBAAkB,CAC3B,UAAU,KAAK,KAAK;gBAClB,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE;gBACtD,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,EAC5B,EAAE,WAAW,EAAE,IAAI,EAAE,CACtB;YACH,UAAU,EACR,eAAe,YAAY,eAAe,OAAO,QAAQ;gBACzD,kCAAkC;SACrC,CAAC,CAAA;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAA;QAChC,IACE,UAAU,KAAK,UAAU;YACzB,OAAO,CAAC,UAAU,KAAK,SAAS;YAChC,CAAC,oBAAoB,CAAC,OAAO,CAAC,UAAU,CAAC,EACzC,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,eAAe,YAAY,eAAe,OAAO,cAAc;gBAC7D,oEAAoE;gBACpE,kEAAkE,CACrE,CAAA;QACH,CAAC;QACD,IAAI,CAAC,OAAO,IAAI,UAAU,KAAK,KAAK,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACzE,qEAAqE;YACrE,qEAAqE;YACrE,qEAAqE;YACrE,oEAAoE;YACpE,oEAAoE;YACpE,qEAAqE;YACrE,6DAA6D;YAC7D,IAAI,QAAQ,GAAuB,IAAI,CAAA;YACvC,MAAM,cAAc,CAAwB;gBAC1C,KAAK,EAAE;oBACL,IAAI,EAAE,KAAK,IAAI,EAAE;wBACf,MAAM,MAAM,GACV,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,gBAAgB,EAAE,CAAA;wBACpE,QAAQ,GAAG,IAAI,CAAA;wBACf,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;4BACpB,MAAM,IAAI,eAAe,CACvB,eAAe,YAAY,eAAe,OAAO,aAAa;gCAC5D,0CAA0C,CAC7C,CAAA;wBACH,CAAC;wBACD,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,WAAW,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAA;oBACzD,CAAC;oBACD,8DAA8D;oBAC9D,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;wBACnC,MAAM,UAAU,CAAC,kBAAkB,CACjC;4BACE,IAAI,EAAE,IAAI,CAAC,IAAI;4BACf,OAAO,EAAE,IAAI,CAAC,OAAO;4BACrB,UAAU,EAAE,IAAI,CAAC,UAAU;yBAC5B,EACD,EAAE,OAAO,EAAE,CACZ,CAAA;oBACH,CAAC;iBACF;gBACD,SAAS,EAAE,wBAAwB;gBACnC,MAAM,EAAE,MAAM,CAAC,EAAE,CACf,MAAM,CAAC,UAAU,KAAK,SAAS;oBAC7B,CAAC,CAAC;wBACE,GAAG,MAAM;wBACT,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,cAAc;wBACnC,UAAU,EAAE,cAAc;qBAC3B;oBACH,CAAC,CAAC,IAAI;aACX,CAAC,CAAA;QACJ,CAAC;QACD,yEAAyE;QACzE,iDAAiD;QACjD,IAAI,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC;YAC5D,MAAM,UAAU,CAAC,SAAS,EAAE,CAAA;QAC9B,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,0BAA0B,CACxB,GAAG,EACH,mCAAmC,YAAY,eAAe,OAAO,IAAI,CAC1E,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,EAChC,GAAG,EACH,OAAO,EACP,aAAa,EACb,SAAS,GAAG,kBAAkB,EAM/B;IACC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAChC,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,YAAY,CAAC;YACnC,IAAI,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE;YAC5B,MAAM,EAAE,KAAK,IAAI,EAAE,CACjB,CACE,MAAM,KAAK,CAAC,kBAAkB,CAC5B,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,EAC9C,EAAE,WAAW,EAAE,IAAI,EAAE,CACtB,CACF,CAAC,WAAW;YACf,UAAU,EAAE,UAAU,OAAO,wCAAwC;SACtE,CAAC,CAAA;QACF,OAAO,KAAK,CAAA;IACd,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,0BAA0B,CACxB,GAAG,EACH,kCAAkC,OAAO,UAAU,aAAa,IAAI,CACrE,CAAA;IACH,CAAC;AACH,CAAC"}

package/dist/types.d.ts

@@ -136,23 +136,22 @@ export interface FindPage {
  * path that takes precedence over the Collection's declared `encryption`
  * descriptor AND skips the descriptor-discovery round-trip:
  *
- * - `{ scheme }` -- treat the collection as encrypted under `scheme`, pulling
- *   keys from the client's keystore. For the `edv` scheme, pass a full
- *   epoch-bearing `CollectionEncryption` descriptor as the override (a bare
- *   `{ scheme: 'edv' }` is refused fail-closed: routing needs the key-epoch
- *   roster).
- * - `{ scheme, keys }` -- additionally supply the key material inline (opaque to
- *   core; the encryption provider interprets it per `scheme`) instead of the
- *   keystore.
+ * - a `CollectionEncryption` descriptor -- treat the collection as encrypted
+ *   under it, pulling keys from the client's keystore. The descriptor is
+ *   forwarded whole to the provider, so pass the full epoch-bearing form (a
+ *   bare `{ scheme: 'edv' }` is refused fail-closed: routing needs the
+ *   key-epoch roster).
+ * - the same descriptor with `keys` -- additionally supply the key material
+ *   inline (opaque to core; the encryption provider interprets it per
+ *   `scheme`) instead of the keystore.
  * - `'plaintext'` -- force plaintext even if a descriptor / keystore would encrypt.
  *
  * The non-`'plaintext'` forms require the `WasClient` to be constructed with an
- * `encryption` provider (which turns a scheme + keys into a codec).
+ * `encryption` provider (which turns a descriptor + keys into a codec).
  */
-export type EncryptionOverride = {
-    scheme: string;
+export type EncryptionOverride = (CollectionEncryption & {
     keys?: unknown;
-} | 'plaintext';
+}) | 'plaintext';
 /**
  * Options accepted by every handle factory (`space()`, `collection()`,
  * `resource()`). A bound `capability` is attached to every request the handle

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EACV,KAAK,EACL,cAAc,EACd,SAAS,EACV,MAAM,mCAAmC,CAAA;AAC1C,OAAO,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAA;AAEjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,YAAY,EAAE,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AAE/D;;;;;GAKG;AACH,YAAY,EACV,MAAM,EACN,WAAW,EACX,cAAc,EACd,iBAAiB,EACjB,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,cAAc,EACd,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,uBAAuB,EACvB,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,KAAK,EACV,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,uBAAuB,CAAA;AAE9B;;;;;;;;;;GAUG;AACH,MAAM,MAAM,2BAA2B,GACnC,sBAAsB,GACtB;IACE,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAEL;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,wBAAwB,GAAG,WAAW,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAA;AAEhF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,CAAA;AAErD;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B,UAAU,CAAC,EAAE,oBAAoB,CAAA;IACjC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;AAC5D,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AACD,MAAM,MAAM,SAAS,GAAG,IAAI,EAAE,CAAA;AAC9B,MAAM,MAAM,IAAI,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAAA;AAEzD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,SAAS,GAAG,IAAI,GAAG,UAAU,CAAA;AAErE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;KAAE,CAAC,CAAA;IAC/C,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,kBAAkB,GAC5B;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,WAAW,CAAA;AAElD;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,KAAK,CAAA;IAClB;;;OAGG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAA;CAChC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,KAAK,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,IAAI,GAAG,UAAU,CAAA;IACxB,UAAU,CAAC,EAAE,KAAK,CAAA;CACnB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EACV,KAAK,EACL,cAAc,EACd,SAAS,EACV,MAAM,mCAAmC,CAAA;AAC1C,OAAO,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAA;AAEjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,YAAY,EAAE,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AAE/D;;;;;GAKG;AACH,YAAY,EACV,MAAM,EACN,WAAW,EACX,cAAc,EACd,iBAAiB,EACjB,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,cAAc,EACd,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,uBAAuB,EACvB,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,KAAK,EACV,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,uBAAuB,CAAA;AAE9B;;;;;;;;;;GAUG;AACH,MAAM,MAAM,2BAA2B,GACnC,sBAAsB,GACtB;IACE,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAEL;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,wBAAwB,GAAG,WAAW,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAA;AAEhF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,CAAA;AAErD;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B,UAAU,CAAC,EAAE,oBAAoB,CAAA;IACjC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;AAC5D,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AACD,MAAM,MAAM,SAAS,GAAG,IAAI,EAAE,CAAA;AAC9B,MAAM,MAAM,IAAI,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAAA;AAEzD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,SAAS,GAAG,IAAI,GAAG,UAAU,CAAA;AAErE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;KAAE,CAAC,CAAA;IAC/C,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,kBAAkB,GAC5B,CAAC,oBAAoB,GAAG;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,GAAG,WAAW,CAAA;AAE3D;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,KAAK,CAAA;IAClB;;;OAGG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAA;CAChC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,KAAK,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,IAAI,GAAG,UAAU,CAAA;IACxB,UAAU,CAAC,EAAE,KAAK,CAAA;CACnB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@interop/was-client",
   "description": "A developer-friendly client for Wallet Attached Storage (WAS) servers.",
-  "version": "0.51.0",
+  "version": "0.53.0",
   "type": "module",
   "scripts": {
     "build": "pnpm run clear && tsc",
@@ -68,7 +68,7 @@
     "@interop/http-client": "^1.0.5",
     "@interop/minimal-cipher": "^7.10.0",
     "@interop/storage-core": "^0.11.0",
-    "@interop/vh-resource-log": "^0.4.1",
+    "@interop/vh-resource-log": "^0.4.2",
     "@interop/x25519-key-agreement-key": "^5.3.0",
     "@noble/hashes": "^2.3.0",
     "@scure/base": "^2.3.0",