@interop/was-client 0.9.2 → 0.11.0

package/dist/WasClient.d.ts

@@ -15,7 +15,7 @@ import type { EncryptionProvider } from './codec.js';
 import { Space } from './Space.js';
 import { Collection } from './Collection.js';
 import { Resource } from './Resource.js';
-import type { GrantOptions, HandleOptions, IDelegatedZcap, ISigner, IZcap, Json, RequestInput, CollectionResourcesList, SpaceListing } from './types.js';
+import type { GrantOptions, HandleOptions, IDelegatedZcap, ISigner, IZcap, Json, RequestInput, CollectionResourcesList, ResourceSummary, SpaceListing } from './types.js';
 export declare class WasClient {
     readonly serverUrl: string;
     readonly zcapClient: ZcapClient;
@@ -110,10 +110,24 @@ export declare class WasClient {
     publicRead({ resourceUrl }: {
         resourceUrl: string;
     }): Promise<Json | Blob | null>;
+    /**
+     * Reads the first page of a public (`PublicCanRead`) collection listing with an
+     * unsigned `GET` and packages the means to follow its `next` links. Returns
+     * `null` if the collection is missing or not publicly readable (404 conflation
+     * caveat).
+     *
+     * @param collectionUrl {string}   the absolute collection URL
+     * @returns {Promise<PageWalk | null>}
+     */
+    private _publicListWalk;
     /**
      * Lists a public (`PublicCanRead`) collection by its URL with no authorization
      * -- an unsigned `GET` -- e.g. to browse a blog published as a public-read
-     * collection. Returns `null` if the collection is missing or not publicly
+     * collection. Transparently follows the server's `next` pagination links,
+     * buffering every page into a single list (the returned envelope omits `next`).
+     * For a large collection prefer `publicListCollectionPages()` or
+     * `publicListCollectionItems()`, which stream one page at a time and allow
+     * stopping early. Returns `null` if the collection is missing or not publicly
      * readable (404 conflation caveat).
      *
      * @param options {object}
@@ -123,6 +137,33 @@ export declare class WasClient {
     publicListCollection({ collectionUrl }: {
         collectionUrl: string;
     }): Promise<CollectionResourcesList | null>;
+    /**
+     * Lazily yields a public collection listing one page at a time, following the
+     * server's `next` links on demand with unsigned `GET`s. Use this to stream a
+     * large public collection in constant memory or to stop early. Yields nothing
+     * if the collection is missing or not publicly readable (404 conflation
+     * caveat).
+     *
+     * @param options {object}
+     * @param options.collectionUrl {string}   the absolute collection URL
+     * @returns {AsyncGenerator<CollectionResourcesList>}
+     */
+    publicListCollectionPages({ collectionUrl }: {
+        collectionUrl: string;
+    }): AsyncGenerator<CollectionResourcesList>;
+    /**
+     * Lazily yields each item of a public collection across every page, flattening
+     * `publicListCollectionPages()`. Yields the listing's `ResourceSummary` entries
+     * (id / url / contentType / name), not the resource bodies. Yields nothing if
+     * the collection is missing or not publicly readable (404 conflation caveat).
+     *
+     * @param options {object}
+     * @param options.collectionUrl {string}   the absolute collection URL
+     * @returns {AsyncGenerator<ResourceSummary>}
+     */
+    publicListCollectionItems({ collectionUrl }: {
+        collectionUrl: string;
+    }): AsyncGenerator<ResourceSummary>;
     /**
      * Rebuilds an access handle from a received capability, returning a handle at
      * the depth implied by the capability's `invocationTarget` (space /

package/dist/WasClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WasClient.d.ts","sourceRoot":"","sources":["../src/WasClient.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;GAOG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAOxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,cAAc,EACd,OAAO,EACP,KAAK,EACL,IAAI,EACJ,YAAY,EACZ,uBAAuB,EACvB,YAAY,EACb,MAAM,YAAY,CAAA;AAEnB,qBAAa,SAAS;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;IAC/B,QAAQ,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAExC;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,UAAU,EACV,UAAU,EACX,EAAE;QACD,SAAS,EAAE,MAAM,CAAA;QACjB,UAAU,EAAE,UAAU,CAAA;QACtB,UAAU,CAAC,EAAE,kBAAkB,CAAA;KAChC;IAMD;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,CAAC,EAChB,SAAS,EACT,MAAM,EACN,UAAU,EACX,EAAE;QACD,SAAS,EAAE,MAAM,CAAA;QACjB,MAAM,EAAE,OAAO,CAAA;QACf,UAAU,CAAC,EAAE,kBAAkB,CAAA;KAChC,GAAG,SAAS;IASb;;;;;OAKG;IACH,IAAI,aAAa,IAAI,MAAM,CAQ1B;IAED,OAAO,KAAK,QAAQ,GAOnB;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,KAAK;IAQ1D;;;;;;;;;;OAUG;IACG,WAAW,CACf,IAAI,GAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC7D,OAAO,CAAC,KAAK,CAAC;IAkBjB;;;;;;;;;OASG;IACG,UAAU,IAAI,OAAO,CAAC,YAAY,CAAC;IAQzC;;;;;;;;;OASG;IACG,UAAU,CAAC,EACf,WAAW,EACZ,EAAE;QACD,WAAW,EAAE,MAAM,CAAA;KACpB,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAS/B;;;;;;;;;OASG;IACG,oBAAoB,CAAC,EACzB,aAAa,EACd,EAAE;QACD,aAAa,EAAE,MAAM,CAAA;KACtB,GAAG,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC;IAY3C;;;;;;;OAOG;IACH,cAAc,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,QAAQ;IAmC1D;;;;;;;;OAQG;IACG,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAI3D;;;;;;;;OAQG;IACG,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;CAG5D"}
+{"version":3,"file":"WasClient.d.ts","sourceRoot":"","sources":["../src/WasClient.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;GAOG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AASxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,cAAc,EACd,OAAO,EACP,KAAK,EACL,IAAI,EACJ,YAAY,EACZ,uBAAuB,EACvB,eAAe,EACf,YAAY,EACb,MAAM,YAAY,CAAA;AAEnB,qBAAa,SAAS;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;IAC/B,QAAQ,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAExC;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,UAAU,EACV,UAAU,EACX,EAAE;QACD,SAAS,EAAE,MAAM,CAAA;QACjB,UAAU,EAAE,UAAU,CAAA;QACtB,UAAU,CAAC,EAAE,kBAAkB,CAAA;KAChC;IAMD;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,CAAC,EAChB,SAAS,EACT,MAAM,EACN,UAAU,EACX,EAAE;QACD,SAAS,EAAE,MAAM,CAAA;QACjB,MAAM,EAAE,OAAO,CAAA;QACf,UAAU,CAAC,EAAE,kBAAkB,CAAA;KAChC,GAAG,SAAS;IASb;;;;;OAKG;IACH,IAAI,aAAa,IAAI,MAAM,CAQ1B;IAED,OAAO,KAAK,QAAQ,GAOnB;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,KAAK;IAQ1D;;;;;;;;;;OAUG;IACG,WAAW,CACf,IAAI,GAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC7D,OAAO,CAAC,KAAK,CAAC;IAiBjB;;;;;;;;;OASG;IACG,UAAU,IAAI,OAAO,CAAC,YAAY,CAAC;IAQzC;;;;;;;;;OASG;IACG,UAAU,CAAC,EACf,WAAW,EACZ,EAAE;QACD,WAAW,EAAE,MAAM,CAAA;KACpB,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAS/B;;;;;;;;OAQG;YACW,eAAe;IA2B7B;;;;;;;;;;;;;OAaG;IACG,oBAAoB,CAAC,EACzB,aAAa,EACd,EAAE;QACD,aAAa,EAAE,MAAM,CAAA;KACtB,GAAG,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC;IAK3C;;;;;;;;;;OAUG;IACI,yBAAyB,CAAC,EAC/B,aAAa,EACd,EAAE;QACD,aAAa,EAAE,MAAM,CAAA;KACtB,GAAG,cAAc,CAAC,uBAAuB,CAAC;IAQ3C;;;;;;;;;OASG;IACI,yBAAyB,CAAC,EAC/B,aAAa,EACd,EAAE;QACD,aAAa,EAAE,MAAM,CAAA;KACtB,GAAG,cAAc,CAAC,eAAe,CAAC;IAQnC;;;;;;;OAOG;IACH,cAAc,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,QAAQ;IA+C1D;;;;;;;;OAQG;IACG,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAI3D;;;;;;;;OAQG;IACG,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;CAG5D"}

package/dist/WasClient.js

@@ -13,7 +13,8 @@ import { ZcapClient } from '@interop/ezcap';
 import { Ed25519Signature2020 } from '@interop/ed25519-signature';
 import { spacesRoot } from './internal/paths.js';
 import { send, rawRequest, unsignedRequest } from './internal/request.js';
-import { parseResource, readJsonData } from './internal/content.js';
+import { createdId, parseResource, readJsonData } from './internal/content.js';
+import { collectPages, walkPages } from './internal/pagination.js';
 import { delegateGrant } from './internal/grant.js';
 import { ValidationError } from './errors.js';
 import { Space } from './Space.js';
@@ -120,8 +121,7 @@ export class WasClient {
             method: 'POST',
             json: body
         });
-        const created = response.data;
-        return this.space(created.id);
+        return this.space(createdId(response));
     }
     /**
      * Lists the spaces in the repository visible to the wrapped signer, as a
@@ -159,16 +159,15 @@ export class WasClient {
         return parseResource(response);
     }
     /**
-     * Lists a public (`PublicCanRead`) collection by its URL with no authorization
-     * -- an unsigned `GET` -- e.g. to browse a blog published as a public-read
-     * collection. Returns `null` if the collection is missing or not publicly
-     * readable (404 conflation caveat).
+     * Reads the first page of a public (`PublicCanRead`) collection listing with an
+     * unsigned `GET` and packages the means to follow its `next` links. Returns
+     * `null` if the collection is missing or not publicly readable (404 conflation
+     * caveat).
      *
-     * @param options {object}
-     * @param options.collectionUrl {string}   the absolute collection URL
-     * @returns {Promise<CollectionResourcesList | null>}
+     * @param collectionUrl {string}   the absolute collection URL
+     * @returns {Promise<PageWalk | null>}
      */
-    async publicListCollection({ collectionUrl }) {
+    async _publicListWalk(collectionUrl) {
         // The collection listing endpoint is the trailing-slash items URL.
         const url = collectionUrl.endsWith('/')
             ? collectionUrl
@@ -177,7 +176,73 @@ export class WasClient {
         if (response === null) {
             return null;
         }
-        return (await readJsonData(response));
+        return {
+            first: (await readJsonData(response)),
+            firstUrl: url,
+            fetchPage: async (pageUrl) => {
+                const pageResponse = await unsignedRequest({
+                    url: pageUrl,
+                    method: 'GET',
+                    read: true
+                });
+                return pageResponse === null
+                    ? null
+                    : (await readJsonData(pageResponse));
+            }
+        };
+    }
+    /**
+     * Lists a public (`PublicCanRead`) collection by its URL with no authorization
+     * -- an unsigned `GET` -- e.g. to browse a blog published as a public-read
+     * collection. Transparently follows the server's `next` pagination links,
+     * buffering every page into a single list (the returned envelope omits `next`).
+     * For a large collection prefer `publicListCollectionPages()` or
+     * `publicListCollectionItems()`, which stream one page at a time and allow
+     * stopping early. Returns `null` if the collection is missing or not publicly
+     * readable (404 conflation caveat).
+     *
+     * @param options {object}
+     * @param options.collectionUrl {string}   the absolute collection URL
+     * @returns {Promise<CollectionResourcesList | null>}
+     */
+    async publicListCollection({ collectionUrl }) {
+        const walk = await this._publicListWalk(collectionUrl);
+        return walk === null ? null : collectPages(walk);
+    }
+    /**
+     * Lazily yields a public collection listing one page at a time, following the
+     * server's `next` links on demand with unsigned `GET`s. Use this to stream a
+     * large public collection in constant memory or to stop early. Yields nothing
+     * if the collection is missing or not publicly readable (404 conflation
+     * caveat).
+     *
+     * @param options {object}
+     * @param options.collectionUrl {string}   the absolute collection URL
+     * @returns {AsyncGenerator<CollectionResourcesList>}
+     */
+    async *publicListCollectionPages({ collectionUrl }) {
+        const walk = await this._publicListWalk(collectionUrl);
+        if (walk === null) {
+            return;
+        }
+        yield* walkPages(walk);
+    }
+    /**
+     * Lazily yields each item of a public collection across every page, flattening
+     * `publicListCollectionPages()`. Yields the listing's `ResourceSummary` entries
+     * (id / url / contentType / name), not the resource bodies. Yields nothing if
+     * the collection is missing or not publicly readable (404 conflation caveat).
+     *
+     * @param options {object}
+     * @param options.collectionUrl {string}   the absolute collection URL
+     * @returns {AsyncGenerator<ResourceSummary>}
+     */
+    async *publicListCollectionItems({ collectionUrl }) {
+        for await (const page of this.publicListCollectionPages({
+            collectionUrl
+        })) {
+            yield* page.items;
+        }
     }
     /**
      * Rebuilds an access handle from a received capability, returning a handle at
@@ -188,8 +253,19 @@ export class WasClient {
      * @returns {Space | Collection | Resource}
      */
     fromCapability(zcap) {
-        const { pathname } = new URL(zcap.invocationTarget);
-        const segments = pathname.split('/').filter(Boolean);
+        let pathname;
+        try {
+            ;
+            ({ pathname } = new URL(zcap.invocationTarget));
+        }
+        catch (err) {
+            throw new ValidationError(`invocationTarget "${zcap.invocationTarget}" is not a valid ` +
+                'absolute URL.', { cause: err });
+        }
+        // Decode each path segment before splitting it back into handle ids: the
+        // path builders re-encode every id with encodeURIComponent, so passing a
+        // still-encoded segment through would double-encode it.
+        const segments = pathname.split('/').filter(Boolean).map(decodeURIComponent);
         if (segments[0] !== 'space') {
             throw new ValidationError(`Cannot derive a handle from invocationTarget "${zcap.invocationTarget}".`);
         }

package/dist/WasClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"WasClient.js","sourceRoot":"","sources":["../src/WasClient.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;GAOG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAEhD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACzE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAaxC,MAAM,OAAO,SAAS;IACX,SAAS,CAAQ;IACjB,UAAU,CAAY;IACtB,UAAU,CAAqB;IAExC;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,UAAU,EACV,UAAU,EAKX;QACC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,CAAC,EAChB,SAAS,EACT,MAAM,EACN,UAAU,EAKX;QACC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC;YAChC,UAAU,EAAE,oBAAoB;YAChC,gBAAgB,EAAE,MAAM;YACxB,gBAAgB,EAAE,MAAM;SACzB,CAAC,CAAA;QACF,OAAO,IAAI,SAAS,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;OAKG;IACH,IAAI,aAAa;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAA;QAC/C,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,eAAe,CACvB,oDAAoD,CACrD,CAAA;QACH,CAAC;QACD,OAAO,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAW,CAAA;IAC1C,CAAC;IAED,IAAY,QAAQ;QAClB,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAe,EAAE,UAAyB,EAAE;QAChD,OAAO,IAAI,KAAK,CAAC;YACf,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,OAAO;YACP,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,WAAW,CACf,OAA4D,EAAE;QAE9D,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,aAAa,CAAA;QACxD,MAAM,IAAI,GAA4B,EAAE,UAAU,EAAE,CAAA;QACpD,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;QACnB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACvB,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,UAAU,EAAE;YAClB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QACF,MAAM,OAAO,GAAI,QAA+B,CAAC,IAAsB,CAAA;QACvE,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,UAAU,EAAE;YAClB,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;QACF,OAAQ,QAA+B,CAAC,IAAoB,CAAA;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAU,CAAC,EACf,WAAW,EAGZ;QACC,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;YACrC,GAAG,EAAE,WAAW;YAChB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QACF,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,oBAAoB,CAAC,EACzB,aAAa,EAGd;QACC,mEAAmE;QACnE,MAAM,GAAG,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC;YACrC,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,GAAG,aAAa,GAAG,CAAA;QACvB,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;QAC1E,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,CAAC,MAAM,YAAY,CAAC,QAAQ,CAAC,CAA4B,CAAA;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,IAAW;QACxB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACnD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACpD,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,eAAe,CACvB,iDAAiD,IAAI,CAAC,gBAAgB,IAAI,CAC3E,CAAA;QACH,CAAC;QACD,MAAM,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAA;QACtD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,eAAe,CACvB,qBAAqB,IAAI,CAAC,gBAAgB,oBAAoB,CAC/D,CAAA;QACH,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC7B,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,IAAI,QAAQ,CAAC;gBAClB,OAAO;gBACP,OAAO;gBACP,YAAY,EAAE,YAAsB;gBACpC,UAAU;gBACV,UAAU,EAAE,IAAI;aACjB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,IAAI,UAAU,CAAC;gBACpB,OAAO;gBACP,OAAO;gBACP,YAAY;gBACZ,UAAU,EAAE,IAAI;aACjB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,IAAI,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAA;IAC1D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CAAC,OAAqB;QAC/B,OAAO,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,CAAC,OAAqB;QACjC,OAAO,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC3C,CAAC;CACF"}
+{"version":3,"file":"WasClient.js","sourceRoot":"","sources":["../src/WasClient.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;GAOG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAEhD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACzE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAC9E,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAElE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAcxC,MAAM,OAAO,SAAS;IACX,SAAS,CAAQ;IACjB,UAAU,CAAY;IACtB,UAAU,CAAqB;IAExC;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,UAAU,EACV,UAAU,EAKX;QACC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,CAAC,EAChB,SAAS,EACT,MAAM,EACN,UAAU,EAKX;QACC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC;YAChC,UAAU,EAAE,oBAAoB;YAChC,gBAAgB,EAAE,MAAM;YACxB,gBAAgB,EAAE,MAAM;SACzB,CAAC,CAAA;QACF,OAAO,IAAI,SAAS,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;OAKG;IACH,IAAI,aAAa;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAA;QAC/C,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,eAAe,CACvB,oDAAoD,CACrD,CAAA;QACH,CAAC;QACD,OAAO,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAW,CAAA;IAC1C,CAAC;IAED,IAAY,QAAQ;QAClB,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAe,EAAE,UAAyB,EAAE;QAChD,OAAO,IAAI,KAAK,CAAC;YACf,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,OAAO;YACP,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,WAAW,CACf,OAA4D,EAAE;QAE9D,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,aAAa,CAAA;QACxD,MAAM,IAAI,GAA4B,EAAE,UAAU,EAAE,CAAA;QACpD,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;QACnB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACvB,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,UAAU,EAAE;YAClB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;IACxC,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,UAAU,EAAE;YAClB,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;QACF,OAAQ,QAA+B,CAAC,IAAoB,CAAA;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAU,CAAC,EACf,WAAW,EAGZ;QACC,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;YACrC,GAAG,EAAE,WAAW;YAChB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QACF,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,eAAe,CAC3B,aAAqB;QAErB,mEAAmE;QACnE,MAAM,GAAG,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC;YACrC,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,GAAG,aAAa,GAAG,CAAA;QACvB,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;QAC1E,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO;YACL,KAAK,EAAE,CAAC,MAAM,YAAY,CAAC,QAAQ,CAAC,CAA4B;YAChE,QAAQ,EAAE,GAAG;YACb,SAAS,EAAE,KAAK,EAAC,OAAO,EAAC,EAAE;gBACzB,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC;oBACzC,GAAG,EAAE,OAAO;oBACZ,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,IAAI;iBACX,CAAC,CAAA;gBACF,OAAO,YAAY,KAAK,IAAI;oBAC1B,CAAC,CAAC,IAAI;oBACN,CAAC,CAAE,CAAC,MAAM,YAAY,CAAC,YAAY,CAAC,CAA6B,CAAA;YACrE,CAAC;SACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,oBAAoB,CAAC,EACzB,aAAa,EAGd;QACC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAA;QACtD,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,CAAC,yBAAyB,CAAC,EAC/B,aAAa,EAGd;QACC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAA;QACtD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAM;QACR,CAAC;QACD,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IACxB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,CAAC,yBAAyB,CAAC,EAC/B,aAAa,EAGd;QACC,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,yBAAyB,CAAC;YACtD,aAAa;SACd,CAAC,EAAE,CAAC;YACH,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAA;QACnB,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,IAAW;QACxB,IAAI,QAAgB,CAAA;QACpB,IAAI,CAAC;YACH,CAAC;YAAA,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAA;QAClD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,eAAe,CACvB,qBAAqB,IAAI,CAAC,gBAAgB,mBAAmB;gBAC3D,eAAe,EACjB,EAAE,KAAK,EAAE,GAAG,EAAE,CACf,CAAA;QACH,CAAC;QACD,yEAAyE;QACzE,yEAAyE;QACzE,wDAAwD;QACxD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;QAC5E,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,eAAe,CACvB,iDAAiD,IAAI,CAAC,gBAAgB,IAAI,CAC3E,CAAA;QACH,CAAC;QACD,MAAM,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAA;QACtD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,eAAe,CACvB,qBAAqB,IAAI,CAAC,gBAAgB,oBAAoB,CAC/D,CAAA;QACH,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC7B,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,IAAI,QAAQ,CAAC;gBAClB,OAAO;gBACP,OAAO;gBACP,YAAY,EAAE,YAAsB;gBACpC,UAAU;gBACV,UAAU,EAAE,IAAI;aACjB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,IAAI,UAAU,CAAC;gBACpB,OAAO;gBACP,OAAO;gBACP,YAAY;gBACZ,UAAU,EAAE,IAAI;aACjB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,IAAI,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAA;IAC1D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CAAC,OAAqB;QAC/B,OAAO,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,CAAC,OAAqB;QACjC,OAAO,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC3C,CAAC;CACF"}

package/dist/codec.d.ts

@@ -31,7 +31,7 @@
  *   silently writing plaintext.
  */
 import type { HttpResponse } from '@interop/http-client';
-import type { Json } from './types.js';
+import type { Json, ResourceData, ResourceMetadataCustom } from './types.js';
 /**
  * The result of {@link ResourceCodec.encode}: the stored representation of a
  * write, plus the id to store it under.
@@ -43,7 +43,13 @@ import type { Json } from './types.js';
  * - `json` / `body` -- mutually exclusive payloads, mirroring the request
  *   layer: `json` for a structured body, `body` for raw bytes.
  * - `contentType` -- the content type to send for a `body` write (e.g.
- *   `application/edv+json` for an encrypted envelope).
+ *   `application/jose+json` for an encrypted envelope).
+ * - `resourceContentType` -- the plaintext content type of the resource, when it
+ *   differs from the stored `contentType`. An encrypting codec sets this to the
+ *   caller's resolved type (e.g. `image/png`) while `contentType` stays the
+ *   opaque envelope type, so `add()` can report the real type in
+ *   {@link AddResult.contentType}. Absent for the identity codec (its
+ *   `contentType` already is the resource type).
  * - `ifMatch` / `ifNoneMatch` -- an optional conditional-write precondition the
  *   codec computed (e.g. the EDV codec maps its `sequence` onto an `If-Match`
  *   ETag for lost-update-safe updates, or `If-None-Match: *` for a fresh
@@ -55,6 +61,7 @@ export interface EncodedWrite {
     json?: object;
     body?: Uint8Array | Blob;
     contentType?: string;
+    resourceContentType?: string;
     ifMatch?: string;
     ifNoneMatch?: boolean;
 }
@@ -65,12 +72,15 @@ export interface EncodedWrite {
  */
 export interface ResourceCodec {
     /**
-     * Whether server-visible custom metadata (`resource.setName` / `setTags` /
-     * `setMeta`) is permitted. The identity codec allows it; an encrypting codec
-     * forbids it (the values would be stored as server-visible plaintext -- a
-     * leak), so those methods throw on an encrypted collection.
+     * How this codec stores a Resource's user-writable metadata (`custom`:
+     * `name` / `tags`, set via `resource.setName` / `setTags` / `setMeta`). The
+     * identity codec stores it as server-visible plaintext (`'plaintext'`); an
+     * encrypting codec stores it as an opaque envelope (`'encrypted'`) -- the same
+     * way it stores content -- so `name` / `tags` never reach the server in the
+     * clear. A mode rather than a boolean so a future scheme that stores metadata
+     * differently can extend the union.
      */
-    readonly allowsServerMetadata: boolean;
+    readonly metadataMode: 'plaintext' | 'encrypted';
     /**
      * Whether this codec drives optimistic-concurrency (conditional) writes. When
      * `true`, the write path pre-reads the current stored resource and passes it
@@ -88,7 +98,7 @@ export interface ResourceCodec {
      *
      * @param input {object}
      * @param [input.id] {string}                       resource id (absent on add)
-     * @param input.data {Json | Blob | Uint8Array}     the plaintext value
+     * @param input.data {ResourceData}                 the plaintext value
      * @param [input.contentType] {string}              caller-supplied content type
      * @param [input.current] {HttpResponse | null}     the current stored response
      *   (or `null` if absent), supplied only when {@link conditionalWrites} is set,
@@ -97,7 +107,7 @@ export interface ResourceCodec {
      */
     encode(input: {
         id?: string;
-        data: Json | Blob | Uint8Array;
+        data: ResourceData;
         contentType?: string;
         current?: HttpResponse | null;
     }): Promise<EncodedWrite>;
@@ -110,6 +120,35 @@ export interface ResourceCodec {
      * @returns {Promise<Json | Blob>}
      */
     decode(response: HttpResponse): Promise<Json | Blob>;
+    /**
+     * Transforms a caller's user-writable metadata (`custom`) into the value to
+     * store under `custom` on a `PUT .../meta` write. The identity codec returns
+     * `custom` unchanged (server-visible plaintext `{ name, tags }`); an
+     * encrypting codec returns an opaque encryption envelope, so `name` / `tags`
+     * are never server-visible.
+     *
+     * @param input {object}
+     * @param input.custom {ResourceMetadataCustom}   the plaintext user metadata
+     * @returns {Promise<{ custom: object }>}   the value to store under `custom`
+     */
+    encodeMeta(input: {
+        custom: ResourceMetadataCustom;
+    }): Promise<{
+        custom: object;
+    }>;
+    /**
+     * Inverts {@link encodeMeta}: transforms the stored `custom` value read from
+     * `.../meta` back into the caller's plaintext `{ name, tags }`. The identity
+     * codec returns `stored.custom ?? {}` unchanged; an encrypting codec decrypts
+     * the envelope. An absent `custom` (no metadata written) decodes to `{}`.
+     *
+     * @param stored {object}
+     * @param [stored.custom] {unknown}   the stored `custom` value from `/meta`
+     * @returns {Promise<ResourceMetadataCustom>}
+     */
+    decodeMeta(stored: {
+        custom?: unknown;
+    }): Promise<ResourceMetadataCustom>;
 }
 /**
  * The keystore + codec factory for encrypted collections. Injected into

package/dist/codec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../src/codec.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAA;IAEtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAEpC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAK,EAAE;QACZ,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,UAAU,CAAA;QAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;KAC9B,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAEzB;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;CACrD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,KAAK,EAAE;QACd,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;QACpB,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAA;CAClC"}
+{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../src/codec.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AAE5E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;OAQG;IACH,QAAQ,CAAC,YAAY,EAAE,WAAW,GAAG,WAAW,CAAA;IAEhD;;;;;;;;OAQG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAEpC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAK,EAAE;QACZ,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,IAAI,EAAE,YAAY,CAAA;QAClB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;KAC9B,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAEzB;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;IAEpD;;;;;;;;;;OAUG;IACH,UAAU,CAAC,KAAK,EAAE;QAChB,MAAM,EAAE,sBAAsB,CAAA;KAC/B,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAE/B;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;CAC1E;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,KAAK,EAAE;QACd,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;QACpB,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAA;CAClC"}

package/dist/edv/EdvCodec.d.ts

@@ -11,11 +11,11 @@
  * app's `resolveKeys`; they never reach the server, which stores only opaque
  * JWE envelopes.
  *
- * This reuses `EdvClientCore`'s encrypt/decrypt primitives (the same JWE
- * machinery as the standalone `WasTransport`), but here the WAS Resource CRUD --
- * the transport role -- is played by core was-client's `Collection`/`Resource`
- * I/O, so the codec is a pure encode/decode transform and needs no transport of
- * its own.
+ * This reuses `EdvClientCore`'s transport-free `documentCipher` (its public
+ * `EdvDocumentCipher` -- the same JWE machinery as the standalone
+ * `WasTransport`), but here the WAS Resource CRUD -- the transport role -- is
+ * played by core was-client's `Collection`/`Resource` I/O, so the codec is a
+ * pure encode/decode transform and needs no transport of its own.
  *
  * Scope (documents-only):
  *
@@ -24,9 +24,12 @@
  *   a human-readable id is rejected (it would leak onto the URL). Carry a
  *   human-readable label inside the encrypted content instead. (Blind-derived
  *   ids are a deferred future item.)
- * - **Small binary as a single JWE.** A `Blob`/`Uint8Array` under the size cap
- *   is wrapped and encrypted as one document; an oversized one is rejected
- *   (chunked encrypted blobs need the server's `chunked-streams` affordance).
+ * - **Inline non-JSON as a single JWE.** A `Blob`/`Uint8Array` under the size cap
+ *   is encrypted as one document -- stored as a legible UTF-8 string for a
+ *   text-family type (else base64) -- with the plaintext content type and the
+ *   encoding carried in the document `meta`. An oversized one is
+ *   rejected (large chunked encrypted blobs need the server's `chunked-streams`
+ *   affordance).
  * - **Enforced sequence (conditional writes).** The codec sets
  *   `conditionalWrites`, so the write path pre-reads the current envelope and
  *   hands it to `encode`: an update advances `sequence` from its prior value and
@@ -35,23 +38,25 @@
  *   surfaces as a `PreconditionFailedError` (412) -- the lost-update guard --
  *   rather than the old advisory last-writer-wins. Against a backend that does
  *   not advertise `conditional-writes` (no ETag) it degrades to advisory.
- * - **No server-visible metadata.** `allowsServerMetadata` is `false`, so
- *   `setName`/`setTags` throw on an encrypted collection (the core seam enforces
- *   this).
+ * - **Encrypted metadata.** `metadataMode` is `'encrypted'`, so a Resource's
+ *   user-writable `custom` (`name`/`tags`, via `setName`/`setTags`/`setMeta`) is
+ *   encrypted into an EDV Document envelope with the same `documentCipher` used
+ *   for content and stored opaquely under `/meta`; the server never sees
+ *   plaintext `name`/`tags`. A reader with the keys decrypts it back
+ *   transparently via `meta()`.
  */
 import { EdvClientCore } from '@interop/edv-client';
 import type { HttpResponse } from '@interop/http-client';
 import type { IKeyAgreementKey, IKeyResolver } from '@interop/data-integrity-core';
 import type { EncodedWrite, EncryptionProvider, ResourceCodec } from '../codec.js';
-import type { Json } from '../types.js';
-import { EDV_CONTENT_TYPE } from './WasTransport.js';
+import type { Json, ResourceData, ResourceMetadataCustom } from '../types.js';
 /**
  * A {@link ResourceCodec} that encrypts on write and decrypts on read using an
- * `EdvClientCore`'s JWE primitives. One instance is bound per encrypted
+ * `EdvClientCore`'s public `documentCipher`. One instance is bound per encrypted
  * collection handle.
  */
 export declare class EdvCodec implements ResourceCodec {
-    readonly allowsServerMetadata = false;
+    readonly metadataMode: "encrypted";
     readonly conditionalWrites = true;
     private readonly _edv;
     private readonly _keyAgreementKey;
@@ -75,7 +80,7 @@ export declare class EdvCodec implements ResourceCodec {
      */
     encode({ id, data, contentType, current }: {
         id?: string;
-        data: Json | Blob | Uint8Array;
+        data: ResourceData;
         contentType?: string;
         current?: HttpResponse | null;
     }): Promise<EncodedWrite>;
@@ -87,35 +92,90 @@ export declare class EdvCodec implements ResourceCodec {
         json(): Promise<unknown>;
     }): Promise<Json | Blob>;
     /**
-     * Resolves a caller value to the EDV document `content`: a JSON object/array
-     * passes through; a `Blob`/`Uint8Array` (under the cap) is wrapped as a
-     * base64 blob record; a bare primitive is rejected (mirroring the plaintext
-     * `prepareBody` contract).
+     * @inheritdoc
+     *
+     * Encrypts the user-writable `custom` into an EDV Document envelope
+     * (`{ jwe, ... }`) with the same `documentCipher.encrypt` used for content --
+     * `custom` becomes the document `content`. The envelope's own `sequence` is
+     * inert (metadata concurrency is the server's plaintext `metaVersion`, not the
+     * envelope), so each write re-encrypts fresh with no `update`.
+     */
+    encodeMeta({ custom }: {
+        custom: ResourceMetadataCustom;
+    }): Promise<{
+        custom: object;
+    }>;
+    /**
+     * @inheritdoc
+     *
+     * Decrypts the stored `custom` envelope back to plaintext `{ name, tags }`. An
+     * absent `custom` (no metadata written yet, or cleared) decodes to `{}`; a
+     * present value must be an EDV envelope (else {@link EncryptionError}, the
+     * `_assertEnvelope` guard), so a foreign plaintext `custom` fails closed.
+     */
+    decodeMeta({ custom }: {
+        custom?: unknown;
+    }): Promise<ResourceMetadataCustom>;
+    /**
+     * Asserts that a document read from an encrypted collection is an EDV envelope
+     * (`{ jwe, ... }`) before it is handed to the cipher. A plaintext or foreign
+     * resource -- one written without this codec -- carries no `jwe`, which would
+     * otherwise make the EDV core throw a raw `TypeError`. Surfacing a typed
+     * `EncryptionError` keeps the fail-closed contract legible to callers.
      *
-     * @param data {Json | Blob | Uint8Array}
-     * @param [contentType] {string}
-     * @returns {Promise<object>}
+     * @param doc {unknown}
+     * @param context {string}   the operation in progress (`read` / `update`),
+     *   for the message
+     * @returns {asserts doc is IEncryptedDocument}
      */
-    private _toContent;
+    private _assertEnvelope;
     /**
-     * Wraps binary bytes as an EDV document content record, enforcing the
-     * single-document size cap.
+     * Splits a caller value into a decrypted EDV document `{ content, meta }`,
+     * carrying the plaintext content type and inline-encoding discriminator in
+     * `meta`. Three cases:
+     *
+     * 1. JSON object/array to `content` verbatim, `meta = { contentType }` (no
+     *   `encoding`); the shape of `content` is never inspected on read, so a
+     *   caller object shaped like `{ text }` / `{ bytes }` round-trips as itself.
+     * 2. Text (`Blob`/`Uint8Array` of a text-family type that is valid UTF-8)
+     *   to `content = { text }`, `meta = { contentType, encoding: 'utf-8' }`;
+     *   stored legibly with no base64 inflation.
+     * 3. Binary (any other `Blob`/`Uint8Array`) to `content = { bytes: base64 }`,
+     *   `meta = { contentType, encoding: 'base64' }`.
      *
-     * @param bytes {Uint8Array}
-     * @param contentType {string}
-     * @returns {object}
+     * A bare primitive is rejected (mirroring the plaintext `prepareBody`
+     * contract). The binary/text content type resolves as
+     * `contentType || blob.type || guessContentTypeFromId(id) || octet-stream`,
+     * mirroring `prepareBody`.
+     *
+     * @param data {ResourceData}
+     * @param [contentType] {string}   caller-supplied content type
+     * @param [id] {string}            resource id, for the extension guess
+     * @returns {Promise<{ content: Record<string, unknown>; meta:
+     *   Record<string, unknown> }>}
      */
-    private _blobContent;
+    private _toDocument;
     /**
-     * Reconstructs a caller value from decrypted EDV document content: a `Blob`
-     * for a wrapped blob record, otherwise the JSON content verbatim.
+     * Reconstructs a caller value from a decrypted EDV document, discriminating
+     * on `meta.encoding`:
+     *
+     * - `'utf-8'` to a `Blob` typed `meta.contentType` from `content.text`.
+     * - `'base64'` to a `Blob` typed `meta.contentType` from `content.bytes`.
+     * - absent (or `meta` absent) to `content` returned verbatim as JSON.
+     *
+     * A malformed inner shape (an encoding that does not match its container key's
+     * type) throws {@link EncryptionError} -- the decrypted-document analogue of
+     * `_assertEnvelope`'s outer guard.
      *
      * @param content {unknown}
+     * @param [meta] {Record<string, unknown>}
      * @returns {Json | Blob}
      */
-    private _fromContent;
+    private _fromDocument;
 }
-/** The per-collection key material an EDV codec is built from. */
+/**
+ * The per-collection key material an EDV codec is built from.
+ */
 export interface EdvKeys {
     keyAgreementKey: IKeyAgreementKey;
     keyResolver: IKeyResolver;
@@ -139,8 +199,8 @@ export interface EdvKeys {
  *   `{ keyAgreementKey, keyResolver }`, or `null` if this client holds no keys
  *   for it (fail-closed -- not a plaintext signal)
  * @param [options.contentType] {string}   stored envelope content type;
- *   defaults to `application/json`. Pass `EDV_CONTENT_TYPE`
- *   (`application/edv+json`) against a server that registers an
+ *   defaults to `application/json`. Pass `JOSE_CONTENT_TYPE`
+ *   (`application/jose+json`) against a server that registers an
  *   `application/*+json` parser.
  * @param [options.maxBlobBytes] {number}   single-document binary cap (default
  *   1 MiB)
@@ -154,5 +214,4 @@ export declare function createEdvEncryption({ resolveKeys, contentType, maxBlobB
     contentType?: string;
     maxBlobBytes?: number;
 }): EncryptionProvider;
-export { EDV_CONTENT_TYPE };
 //# sourceMappingURL=EdvCodec.d.ts.map

package/dist/edv/EdvCodec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EdvCodec.d.ts","sourceRoot":"","sources":["../../src/edv/EdvCodec.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,KAAK,EAEV,gBAAgB,EAChB,YAAY,EACb,MAAM,8BAA8B,CAAA;AACrC,OAAO,KAAK,EACV,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACd,MAAM,aAAa,CAAA;AAGpB,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAsEpD;;;;GAIG;AACH,qBAAa,QAAS,YAAW,aAAa;IAC5C,QAAQ,CAAC,oBAAoB,SAAQ;IACrC,QAAQ,CAAC,iBAAiB,QAAO;IAEjC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAe;IACpC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;IACrC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAQ;IAEtC;;;;;;OAMG;gBACS,EACV,GAAG,EACH,eAAe,EACf,WAAW,EACX,YAAY,EACb,EAAE;QACD,GAAG,EAAE,aAAa,CAAA;QAClB,eAAe,EAAE,gBAAgB,CAAA;QACjC,WAAW,EAAE,MAAM,CAAA;QACnB,YAAY,EAAE,MAAM,CAAA;KACrB;IAOD;;OAEG;IACG,MAAM,CAAC,EACX,EAAE,EACF,IAAI,EACJ,WAAW,EACX,OAAO,EACR,EAAE;QACD,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,UAAU,CAAA;QAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;KAC9B,GAAG,OAAO,CAAC,YAAY,CAAC;IA+CzB;;OAEG;IACG,MAAM,CAAC,QAAQ,EAAE;QACrB,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;KACzB,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAWxB;;;;;;;;;OASG;YACW,UAAU;IAuBxB;;;;;;;OAOG;IACH,OAAO,CAAC,YAAY;IAYpB;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;CAarB;AAKD,kEAAkE;AAClE,MAAM,WAAW,OAAO;IACtB,eAAe,EAAE,gBAAgB,CAAA;IACjC,WAAW,EAAE,YAAY,CAAA;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,WAAW,EACX,WAAkC,EAClC,YAAqC,EACtC,EAAE;IACD,WAAW,EAAE,CAAC,GAAG,EAAE;QACjB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;KACrB,KAAK,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,kBAAkB,CAyBrB;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAA"}
+{"version":3,"file":"EdvCodec.d.ts","sourceRoot":"","sources":["../../src/edv/EdvCodec.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,KAAK,EAEV,gBAAgB,EAChB,YAAY,EACb,MAAM,8BAA8B,CAAA;AACrC,OAAO,KAAK,EACV,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACd,MAAM,aAAa,CAAA;AAQpB,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AA0D7E;;;;GAIG;AACH,qBAAa,QAAS,YAAW,aAAa;IAC5C,QAAQ,CAAC,YAAY,EAAG,WAAW,CAAS;IAC5C,QAAQ,CAAC,iBAAiB,QAAO;IAEjC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAe;IACpC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;IACrC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAQ;IAEtC;;;;;;OAMG;gBACS,EACV,GAAG,EACH,eAAe,EACf,WAAW,EACX,YAAY,EACb,EAAE;QACD,GAAG,EAAE,aAAa,CAAA;QAClB,eAAe,EAAE,gBAAgB,CAAA;QACjC,WAAW,EAAE,MAAM,CAAA;QACnB,YAAY,EAAE,MAAM,CAAA;KACrB;IAOD;;OAEG;IACG,MAAM,CAAC,EACX,EAAE,EACF,IAAI,EACJ,WAAW,EACX,OAAO,EACR,EAAE;QACD,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,IAAI,EAAE,YAAY,CAAA;QAClB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;KAC9B,GAAG,OAAO,CAAC,YAAY,CAAC;IAiEzB;;OAEG;IACG,MAAM,CAAC,QAAQ,EAAE;QACrB,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;KACzB,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAYxB;;;;;;;;OAQG;IACG,UAAU,CAAC,EACf,MAAM,EACP,EAAE;QACD,MAAM,EAAE,sBAAsB,CAAA;KAC/B,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAmB/B;;;;;;;OAOG;IACG,UAAU,CAAC,EACf,MAAM,EACP,EAAE;QACD,MAAM,CAAC,EAAE,OAAO,CAAA;KACjB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAYnC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,eAAe;IAkBvB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;YACW,WAAW;IAoEzB;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,aAAa;CA+BtB;AAsBD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,eAAe,EAAE,gBAAgB,CAAA;IACjC,WAAW,EAAE,YAAY,CAAA;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,WAAW,EACX,WAAkC,EAClC,YAAqC,EACtC,EAAE;IACD,WAAW,EAAE,CAAC,GAAG,EAAE;QACjB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;KACrB,KAAK,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,kBAAkB,CAyBrB"}