@interop/was-client 0.1.0

package/LICENSE.md

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 Interop Alliance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,204 @@
+# Wallet Attached Storage Client _(@interop/was-client)_
+
+[![NPM Version](https://img.shields.io/npm/v/@interop/was-client.svg)](https://npm.im/@interop/was-client)
+
+> A developer-friendly client for Wallet Attached Storage (WAS) servers, with a
+> MongoDB-driver-inspired navigational API over zcap-authorized HTTP.
+
+## Table of Contents
+
+- [Background](#background)
+- [Install](#install)
+- [Usage](#usage)
+  - [Construction](#construction)
+  - [The handle model](#the-handle-model)
+  - [Resources: JSON and binary](#resources-json-and-binary)
+  - [Delegation and sharing](#delegation-and-sharing)
+  - [Export and import](#export-and-import)
+  - [The manual-request escape hatch](#the-manual-request-escape-hatch)
+- [Errors and the 404/null caveat](#errors-and-the-404null-caveat)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Background
+
+The WAS protocol exposes a containment model --
+`SpacesRepository > Space > Collection > Resource` -- over HTTP, authorized with
+[Authorization Capabilities (zcaps)](https://w3c-ccg.github.io/zcap-spec/). The
+low-level transport is an
+[`@interop/ezcap`](https://www.npmjs.com/package/@interop/ezcap) `ZcapClient`,
+where every operation hand-builds a URL, picks a trailing-slash variant, threads
+JSON vs binary bodies, and reasons about delegation inline.
+
+`@interop/was-client` wraps that `ZcapClient` and exposes the containment model
+through cheap, lazy navigational handles modeled on the MongoDB driver's DX
+(`client > db > collection`), using WAS-specific verbs
+(`add`/`get`/`put`/`list`/`delete`) rather than `insertOne`/`findOne` (WAS has
+no query-by-filter yet).
+
+| MongoDB driver                      | WAS client                                 |
+| ----------------------------------- | ------------------------------------------ |
+| `new MongoClient(url)`              | `new WasClient({ serverUrl, zcapClient })` |
+| `client.db('app')`                  | `was.space(spaceId)`                       |
+| `db.collection('users')`            | `space.collection(collectionId)`           |
+| `collection.insertOne(doc)`         | `collection.add(doc)`                      |
+| `collection.findOne({ _id })`       | `collection.get(resourceId)`               |
+| `collection.replaceOne({ _id }, d)` | `collection.put(resourceId, data)`         |
+| `collection.find().toArray()`       | `collection.list()`                        |
+| `collection.deleteOne({ _id })`     | `collection.resource(resourceId).delete()` |
+
+## Install
+
+- Node.js 24+ is recommended.
+
+```
+pnpm install @interop/was-client
+```
+
+## Usage
+
+### Construction
+
+```ts
+import { WasClient } from '@interop/was-client'
+
+// Primary form: wrap an existing ezcap ZcapClient (which holds the signer).
+const was = new WasClient({ serverUrl, zcapClient })
+
+// Convenience: build the ZcapClient internally from a signer
+// (uses the Ed25519Signature2020 suite).
+const was = WasClient.fromSigner({ serverUrl, signer })
+```
+
+`serverUrl` is the base for both URL building and zcap `invocationTarget`s, so
+the "server URL must equal the invocation target host:port" constraint holds by
+construction.
+
+### The handle model
+
+Handles are lazy and synchronous to obtain -- only the verb methods hit the
+network. Lazy chains never throw: `was.space(x).collection(y)` does no I/O and
+just accumulates URL context. Existence is checked on the first network verb.
+
+```ts
+const space = await was.createSpace({ name: 'Home' }) // POST /spaces/
+
+const collection = await space.createCollection({
+  id: 'credentials',
+  name: 'Verifiable Credentials'
+})
+
+await collection.put('vc-1', {
+  type: ['VerifiableCredential'],
+  name: 'Diploma'
+})
+const vc = await collection.get('vc-1') // parsed JSON object, or null on a miss
+
+const listing = await collection.list() // { id, url, totalItems, items, ... }
+
+await collection.resource('vc-1').delete() // delete one resource by id
+await space.delete() // delete the whole space (idempotent)
+```
+
+`delete()` is uniform at every level, takes no argument, and always deletes the
+thing the handle points at -- so there is no "delete the collection" vs "delete
+one item" footgun.
+
+### Resources: JSON and binary
+
+Writes detect the payload: a plain object/array is sent as JSON; a
+`Blob`/`Uint8Array`/`Buffer` is sent as binary, with the content-type taken from
+`options.contentType`, the `Blob.type`, or `application/octet-stream`.
+
+```ts
+// JSON
+await collection.put('doc', { hello: 'world' })
+
+// Binary
+const bytes = new TextEncoder().encode('plain text body')
+await collection.put('note.txt', bytes, { contentType: 'text/plain' })
+
+const resource = collection.resource('note.txt')
+await resource.get() // a Blob (whose .type carries the content-type)
+await resource.getText() // 'plain text body'
+await resource.getBytes() // Uint8Array
+```
+
+Reads auto-parse: `get()` returns a parsed object for a JSON content-type and a
+`Blob` otherwise; `getText()` / `getBytes()` are explicit escape hatches.
+
+### Delegation and sharing
+
+`was.grant(...)` is the general delegation primitive; `space.grant(...)` and
+`collection.grant(...)` are sugar that prefill the grant `target` with the
+handle's URL. The recipient rebuilds access from the received zcap with
+`fromCapability()`.
+
+```ts
+// Alice grants Bob read access to a resource.
+const added = await collection.add({ secret: 'value' })
+const zcap = await was.grant({
+  to: bobDid,
+  actions: ['GET'], // HTTP verbs: 'GET' | 'PUT' | 'POST' | 'DELETE'
+  target: added.url
+})
+
+// Bob, holding the zcap, rebuilds a handle at the right depth.
+const handle = bobWas.fromCapability(zcap) // a Resource here
+await handle.get() // succeeds; a write would be denied by the GET-only grant
+```
+
+Actions are HTTP verbs (`GET` / `PUT` / `POST` / `DELETE`). The WAS server
+authorizes on these case-sensitively (uppercase), but `grant()` also accepts the
+lowercase forms and normalizes them to uppercase in the signed zcap -- so
+`actions: ['get']` still validates server-side.
+
+### Export and import
+
+```ts
+const archive = await space.export() // Uint8Array (application/x-tar)
+const stats = await otherSpace.import(archive)
+// { collectionsCreated, collectionsSkipped, resourcesCreated, resourcesSkipped }
+```
+
+### The manual-request escape hatch
+
+`was.request(...)` mirrors ezcap's generic `request()` for hand-built calls. As
+a deliberate escape hatch it returns the raw `HttpResponse` and throws raw
+ezcap/ky errors -- it does not apply the null-on-404 or typed-error
+conveniences.
+
+```ts
+const response = await was.request({ path: `/space/${spaceId}`, method: 'GET' })
+```
+
+## Errors and the 404/null caveat
+
+Read methods (`describe`/`get`/`list`) return `null` on a 404, following
+MongoDB's `findOne` semantics. **WAS returns 404 for both not-found and
+unauthorized**, so `null` means "not visible to you" rather than strictly "does
+not exist". Write/delete methods throw a typed error instead.
+
+| Status | Read methods          | Write / delete methods |
+| ------ | --------------------- | ---------------------- |
+| 404    | `null`                | `NotFoundError`        |
+| 400    | `ValidationError`     | `ValidationError`      |
+| 401    | `AuthRequiredError`   | `AuthRequiredError`    |
+| 501    | `NotImplementedError` | `NotImplementedError`  |
+| 5xx    | `WasServerError`      | `WasServerError`       |
+
+All error classes extend `WasError` (carrying `status`, `title`, `details`, and
+`requestUrl`). `delete()` additionally treats a 404 as success, so it is
+idempotent.
+
+Some spec endpoints (`listSpaces()`, `policy`/`meta`, `query`, ...) are not yet
+implemented by the reference server and currently surface `NotImplementedError`.
+
+## Contribute
+
+PRs accepted. See [CONTRIBUTING.md](CONTRIBUTING.md) for editor setup (Prettier,
+ESLint, and EditorConfig) and how it maps to CI.
+
+## License
+
+[MIT License](LICENSE.md) © 2026 Interop Alliance.

package/dist/Collection.d.ts

@@ -0,0 +1,112 @@
+import type { ClientContext } from './internal/request.js';
+import { Resource } from './Resource.js';
+import type { AddResult, BackendReference, CollectionDescription, GrantOptions, HandleOptions, IDelegatedZcap, IZcap, Json, ResourceListing } from './types.js';
+export declare class Collection {
+    readonly spaceId: string;
+    readonly id: string;
+    private readonly _context;
+    private readonly _capability?;
+    /**
+     * @param options {object}
+     * @param options.context {ClientContext} - Shared context (serverUrl, ezcap
+     *   client, controllerDid)
+     * @param options.spaceId {string}
+     * @param options.collectionId {string}
+     * @param [options.capability] {IZcap} - capability attached to every request
+     */
+    constructor({ context, spaceId, collectionId, capability }: {
+        context: ClientContext;
+        spaceId: string;
+        collectionId: string;
+        capability?: IZcap;
+    });
+    private get _path();
+    private get _itemsPath();
+    /**
+     * Reads the Collection Description. Returns `null` if the collection is
+     * missing or not visible to you (WAS returns 404 for both not-found and
+     * unauthorized).
+     *
+     * @returns {Promise<CollectionDescription | null>}
+     */
+    describe(): Promise<CollectionDescription | null>;
+    /**
+     * Creates or updates the collection by id (upsert). Merges the given fields
+     * over the current description.
+     *
+     * @param desc {object}
+     * @param [desc.name] {string}
+     * @param [desc.backend] {BackendReference}
+     * @returns {Promise<CollectionDescription>}
+     */
+    configure(desc: {
+        name?: string;
+        backend?: BackendReference;
+    }): Promise<CollectionDescription>;
+    /**
+     * Deletes the whole collection. Idempotent. To delete a single resource, use
+     * `collection.resource(id).delete()`.
+     *
+     * @returns {Promise<void>}
+     */
+    delete(): Promise<void>;
+    /**
+     * Returns a lazy handle to a resource by id. No I/O.
+     *
+     * @param resourceId {string}
+     * @param options {object}
+     * @param [options.capability] {IZcap}
+     * @returns {Resource}
+     */
+    resource(resourceId: string, options?: HandleOptions): Resource;
+    /**
+     * Adds a resource with a server-generated id. JSON for plain objects/arrays,
+     * binary for `Blob`/`Uint8Array`. Throws `NotFoundError` if the collection
+     * does not exist (WAS does not auto-create parents).
+     *
+     * @param data {Json | Blob | Uint8Array}
+     * @param options {object}
+     * @param [options.contentType] {string}   content-type for binary data
+     * @returns {Promise<AddResult>}
+     */
+    add(data: Json | Blob | Uint8Array, options?: {
+        contentType?: string;
+    }): Promise<AddResult>;
+    /**
+     * Reads a resource by id, auto-parsing JSON to an object and returning binary
+     * as a `Blob`. Returns `null` on a missing/unauthorized resource (404
+     * conflation caveat).
+     *
+     * @param resourceId {string}
+     * @returns {Promise<Json | Blob | null>}
+     */
+    get(resourceId: string): Promise<Json | Blob | null>;
+    /**
+     * Creates or replaces a resource by id (upsert).
+     *
+     * @param resourceId {string}
+     * @param data {Json | Blob | Uint8Array}
+     * @param options {object}
+     * @param [options.contentType] {string}   content-type for binary data
+     * @returns {Promise<void>}
+     */
+    put(resourceId: string, data: Json | Blob | Uint8Array, options?: {
+        contentType?: string;
+    }): Promise<void>;
+    /**
+     * Lists the items in the collection. Returns `null` if the collection is
+     * missing or not visible to you (404 conflation caveat).
+     *
+     * @returns {Promise<ResourceListing | null>}
+     */
+    list(): Promise<ResourceListing | null>;
+    /**
+     * Delegates access to this collection. Prefills the grant `target` with this
+     * collection's URL (and the bound `capability`, if any, for re-delegation).
+     *
+     * @param options {GrantOptions}
+     * @returns {Promise<IDelegatedZcap>}
+     */
+    grant(options: GrantOptions): Promise<IDelegatedZcap>;
+}
+//# sourceMappingURL=Collection.d.ts.map

package/dist/Collection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Collection.d.ts","sourceRoot":"","sources":["../src/Collection.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAE1D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAChB,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,KAAK,EACL,IAAI,EACJ,eAAe,EAChB,MAAM,YAAY,CAAA;AAEnB,qBAAa,UAAU;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IAEnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;IACxC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAO;IAEpC;;;;;;;OAOG;gBACS,EACV,OAAO,EACP,OAAO,EACP,YAAY,EACZ,UAAU,EACX,EAAE;QACD,OAAO,EAAE,aAAa,CAAA;QACtB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,KAAK,CAAA;KACnB;IAOD,OAAO,KAAK,KAAK,GAEhB;IAED,OAAO,KAAK,UAAU,GAErB;IAED;;;;;;OAMG;IACG,QAAQ,IAAI,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAUvD;;;;;;;;OAQG;IACG,SAAS,CAAC,IAAI,EAAE;QACpB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,OAAO,CAAC,EAAE,gBAAgB,CAAA;KAC3B,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAoBlC;;;;;OAKG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAS7B;;;;;;;OAOG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,QAAQ;IAUnE;;;;;;;;;OASG;IACG,GAAG,CACP,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,UAAU,EAC9B,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAO,GACrC,OAAO,CAAC,SAAS,CAAC;IAgCrB;;;;;;;OAOG;IACG,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAU1D;;;;;;;;OAQG;IACG,GAAG,CACP,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,UAAU,EAC9B,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAO,GACrC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAU7C;;;;;;OAMG;IACG,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;CAS5D"}

package/dist/Collection.js

@@ -0,0 +1,209 @@
+/*!
+ * Copyright (c) 2026 Interop Alliance. All rights reserved.
+ */
+/**
+ * A navigational handle to a Collection within a Space. Exposes its own
+ * lifecycle (`describe`/`configure`/`delete`) and contained-resource operations
+ * (`add`/`get`/`put`/`list`, plus `resource(id)` for delete-by-id).
+ */
+import { collectionPath, collectionItems, resourcePath, toUrl } from './internal/paths.js';
+import { prepareBody, parseResource } from './internal/content.js';
+import { delegateGrant } from './internal/grant.js';
+import { send } from './internal/request.js';
+import { Resource } from './Resource.js';
+export class Collection {
+    spaceId;
+    id;
+    _context;
+    _capability;
+    /**
+     * @param options {object}
+     * @param options.context {ClientContext} - Shared context (serverUrl, ezcap
+     *   client, controllerDid)
+     * @param options.spaceId {string}
+     * @param options.collectionId {string}
+     * @param [options.capability] {IZcap} - capability attached to every request
+     */
+    constructor({ context, spaceId, collectionId, capability }) {
+        this._context = context;
+        this.spaceId = spaceId;
+        this.id = collectionId;
+        this._capability = capability;
+    }
+    get _path() {
+        return collectionPath(this.spaceId, this.id);
+    }
+    get _itemsPath() {
+        return collectionItems(this.spaceId, this.id);
+    }
+    /**
+     * Reads the Collection Description. Returns `null` if the collection is
+     * missing or not visible to you (WAS returns 404 for both not-found and
+     * unauthorized).
+     *
+     * @returns {Promise<CollectionDescription | null>}
+     */
+    async describe() {
+        const response = await send(this._context, {
+            path: this._path,
+            method: 'GET',
+            capability: this._capability,
+            read: true
+        });
+        return response === null ? null : response.data;
+    }
+    /**
+     * Creates or updates the collection by id (upsert). Merges the given fields
+     * over the current description.
+     *
+     * @param desc {object}
+     * @param [desc.name] {string}
+     * @param [desc.backend] {BackendReference}
+     * @returns {Promise<CollectionDescription>}
+     */
+    async configure(desc) {
+        const current = await this.describe();
+        const name = desc.name ?? current?.name;
+        const body = { id: this.id, name };
+        if (desc.backend) {
+            body.backend = desc.backend;
+        }
+        await send(this._context, {
+            path: this._path,
+            method: 'PUT',
+            capability: this._capability,
+            json: body
+        });
+        return {
+            id: this.id,
+            type: current?.type ?? ['Collection'],
+            ...(name !== undefined ? { name } : {})
+        };
+    }
+    /**
+     * Deletes the whole collection. Idempotent. To delete a single resource, use
+     * `collection.resource(id).delete()`.
+     *
+     * @returns {Promise<void>}
+     */
+    async delete() {
+        await send(this._context, {
+            path: this._path,
+            method: 'DELETE',
+            capability: this._capability,
+            idempotent: true
+        });
+    }
+    /**
+     * Returns a lazy handle to a resource by id. No I/O.
+     *
+     * @param resourceId {string}
+     * @param options {object}
+     * @param [options.capability] {IZcap}
+     * @returns {Resource}
+     */
+    resource(resourceId, options = {}) {
+        return new Resource({
+            context: this._context,
+            spaceId: this.spaceId,
+            collectionId: this.id,
+            resourceId,
+            capability: options.capability ?? this._capability
+        });
+    }
+    /**
+     * Adds a resource with a server-generated id. JSON for plain objects/arrays,
+     * binary for `Blob`/`Uint8Array`. Throws `NotFoundError` if the collection
+     * does not exist (WAS does not auto-create parents).
+     *
+     * @param data {Json | Blob | Uint8Array}
+     * @param options {object}
+     * @param [options.contentType] {string}   content-type for binary data
+     * @returns {Promise<AddResult>}
+     */
+    async add(data, options = {}) {
+        const prepared = prepareBody(data, options);
+        const response = await send(this._context, {
+            path: this._itemsPath,
+            method: 'POST',
+            capability: this._capability,
+            json: prepared.json,
+            body: prepared.body,
+            headers: prepared.contentType
+                ? { 'content-type': prepared.contentType }
+                : undefined
+        });
+        // POST always returns a response (404/errors throw via send()).
+        const created = response.data;
+        const location = response.headers.get('location') ?? undefined;
+        return {
+            id: created.id,
+            url: location ??
+                toUrl({
+                    serverUrl: this._context.serverUrl,
+                    path: resourcePath(this.spaceId, this.id, created.id)
+                }),
+            contentType: created['content-type']
+        };
+    }
+    /**
+     * Reads a resource by id, auto-parsing JSON to an object and returning binary
+     * as a `Blob`. Returns `null` on a missing/unauthorized resource (404
+     * conflation caveat).
+     *
+     * @param resourceId {string}
+     * @returns {Promise<Json | Blob | null>}
+     */
+    async get(resourceId) {
+        const response = await send(this._context, {
+            path: resourcePath(this.spaceId, this.id, resourceId),
+            method: 'GET',
+            capability: this._capability,
+            read: true
+        });
+        return parseResource(response);
+    }
+    /**
+     * Creates or replaces a resource by id (upsert).
+     *
+     * @param resourceId {string}
+     * @param data {Json | Blob | Uint8Array}
+     * @param options {object}
+     * @param [options.contentType] {string}   content-type for binary data
+     * @returns {Promise<void>}
+     */
+    async put(resourceId, data, options = {}) {
+        await this.resource(resourceId).put(data, options);
+    }
+    /**
+     * Lists the items in the collection. Returns `null` if the collection is
+     * missing or not visible to you (404 conflation caveat).
+     *
+     * @returns {Promise<ResourceListing | null>}
+     */
+    async list() {
+        const response = await send(this._context, {
+            path: this._itemsPath,
+            method: 'GET',
+            capability: this._capability,
+            read: true
+        });
+        return response === null ? null : response.data;
+    }
+    /**
+     * Delegates access to this collection. Prefills the grant `target` with this
+     * collection's URL (and the bound `capability`, if any, for re-delegation).
+     *
+     * @param options {GrantOptions}
+     * @returns {Promise<IDelegatedZcap>}
+     */
+    async grant(options) {
+        return delegateGrant(this._context, {
+            ...options,
+            target: options.target ??
+                toUrl({ serverUrl: this._context.serverUrl, path: this._path }),
+            capability: options.capability ?? this._capability
+        });
+    }
+}
+//# sourceMappingURL=Collection.js.map

package/dist/Collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Collection.js","sourceRoot":"","sources":["../src/Collection.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;GAIG;AACH,OAAO,EACL,cAAc,EACd,eAAe,EACf,YAAY,EACZ,KAAK,EACN,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAEnD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAaxC,MAAM,OAAO,UAAU;IACZ,OAAO,CAAQ;IACf,EAAE,CAAQ;IAEF,QAAQ,CAAe;IACvB,WAAW,CAAQ;IAEpC;;;;;;;OAOG;IACH,YAAY,EACV,OAAO,EACP,OAAO,EACP,YAAY,EACZ,UAAU,EAMX;QACC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,EAAE,GAAG,YAAY,CAAA;QACtB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAA;IAC/B,CAAC;IAED,IAAY,KAAK;QACf,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;IAC9C,CAAC;IAED,IAAY,UAAU;QACpB,OAAO,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QACF,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,QAAQ,CAAC,IAA8B,CAAA;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,CAAC,IAGf;QACC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAA;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,OAAO,EAAE,IAAI,CAAA;QACvC,MAAM,IAAI,GAA4B,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,CAAA;QAC3D,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC7B,CAAC;QACD,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACxB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QACF,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;YACrC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACxC,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACxB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,UAAU,EAAE,IAAI;SACjB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,UAAkB,EAAE,UAAyB,EAAE;QACtD,OAAO,IAAI,QAAQ,CAAC;YAClB,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,YAAY,EAAE,IAAI,CAAC,EAAE;YACrB,UAAU;YACV,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,WAAW;SACnD,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,GAAG,CACP,IAA8B,EAC9B,UAAoC,EAAE;QAEtC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU;YACrB,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,WAAW;gBAC3B,CAAC,CAAC,EAAE,cAAc,EAAE,QAAQ,CAAC,WAAW,EAAE;gBAC1C,CAAC,CAAC,SAAS;SACd,CAAC,CAAA;QACF,gEAAgE;QAChE,MAAM,OAAO,GAAI,QAA+B,CAAC,IAIhD,CAAA;QACD,MAAM,QAAQ,GACX,QAAiC,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,SAAS,CAAA;QACzE,OAAO;YACL,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,GAAG,EACD,QAAQ;gBACR,KAAK,CAAC;oBACJ,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;oBAClC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC;iBACtD,CAAC;YACJ,WAAW,EAAE,OAAO,CAAC,cAAc,CAAC;SACrC,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CAAC,UAAkB;QAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC;YACrD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QACF,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CACP,UAAkB,EAClB,IAA8B,EAC9B,UAAoC,EAAE;QAEtC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACpD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU;YACrB,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;QACF,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,QAAQ,CAAC,IAAwB,CAAA;IACtE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,OAAqB;QAC/B,OAAO,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClC,GAAG,OAAO;YACV,MAAM,EACJ,OAAO,CAAC,MAAM;gBACd,KAAK,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;YACjE,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,WAAW;SACnD,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/Resource.d.ts

@@ -0,0 +1,67 @@
+import type { ClientContext } from './internal/request.js';
+import type { IZcap, Json } from './types.js';
+export declare class Resource {
+    readonly spaceId: string;
+    readonly collectionId: string;
+    readonly id: string;
+    private readonly _context;
+    private readonly _capability?;
+    /**
+     * @param options {object}
+     * @param options.context {ClientContext}
+     * @param options.spaceId {string}
+     * @param options.collectionId {string}
+     * @param options.resourceId {string}
+     * @param [options.capability] {IZcap}   capability attached to every request
+     */
+    constructor({ context, spaceId, collectionId, resourceId, capability }: {
+        context: ClientContext;
+        spaceId: string;
+        collectionId: string;
+        resourceId: string;
+        capability?: IZcap;
+    });
+    private get _path();
+    /**
+     * Reads the resource, auto-parsing JSON to an object and returning binary as
+     * a `Blob`. Returns `null` if the resource is missing or not visible to you
+     * (WAS returns 404 for both not-found and unauthorized).
+     *
+     * @returns {Promise<Json | Blob | null>}
+     */
+    get(): Promise<Json | Blob | null>;
+    /**
+     * Reads the resource body as text. Returns `null` on a missing/unauthorized
+     * resource (404 conflation caveat).
+     *
+     * @returns {Promise<string | null>}
+     */
+    getText(): Promise<string | null>;
+    /**
+     * Reads the resource body as raw bytes. Returns `null` on a
+     * missing/unauthorized resource (404 conflation caveat).
+     *
+     * @returns {Promise<Uint8Array | null>}
+     */
+    getBytes(): Promise<Uint8Array | null>;
+    /**
+     * Creates or replaces the resource by id (upsert). JSON for plain
+     * objects/arrays, binary for `Blob`/`Uint8Array`. Throws `NotFoundError` if
+     * the parent collection does not exist (WAS does not auto-create parents).
+     *
+     * @param data {Json | Blob | Uint8Array}
+     * @param options {object}
+     * @param [options.contentType] {string}   content-type for binary data
+     * @returns {Promise<void>}
+     */
+    put(data: Json | Blob | Uint8Array, options?: {
+        contentType?: string;
+    }): Promise<void>;
+    /**
+     * Deletes the resource. Idempotent.
+     *
+     * @returns {Promise<void>}
+     */
+    delete(): Promise<void>;
+}
+//# sourceMappingURL=Resource.d.ts.map

package/dist/Resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Resource.d.ts","sourceRoot":"","sources":["../src/Resource.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAE1D,OAAO,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAE7C,qBAAa,QAAQ;IACnB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IAEnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;IACxC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAO;IAEpC;;;;;;;OAOG;gBACS,EACV,OAAO,EACP,OAAO,EACP,YAAY,EACZ,UAAU,EACV,UAAU,EACX,EAAE;QACD,OAAO,EAAE,aAAa,CAAA;QACtB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;QACpB,UAAU,EAAE,MAAM,CAAA;QAClB,UAAU,CAAC,EAAE,KAAK,CAAA;KACnB;IAQD,OAAO,KAAK,KAAK,GAEhB;IAED;;;;;;OAMG;IACG,GAAG,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAUxC;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAUvC;;;;;OAKG;IACG,QAAQ,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAa5C;;;;;;;;;OASG;IACG,GAAG,CACP,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,UAAU,EAC9B,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAO,GACrC,OAAO,CAAC,IAAI,CAAC;IAehB;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ9B"}