@registrystack/client 0.29.0 → 0.31.0

package/README.md

@@ -1,7 +1,7 @@
 # @registrystack/client
 
-One versioned Node.js package for the Discovery, Evidence, Relay, and Base
-Registry Engine client APIs in Registry Stack.
+One versioned Node.js package for the Discovery, Evidence, Relay, Base Registry
+Engine, and Casework client APIs in Registry Stack.
 
 ## Install
 
@@ -11,17 +11,20 @@ npm install "@registrystack/client@<version>"
 
 Requires Node.js 22.12 or newer. Supported targets are macOS arm64, Linux
 arm64 with glibc, and Linux x64 with glibc; installing the package pulls in
-one platform-specific optional dependency containing all four native
+one platform-specific optional dependency containing all five native
 bindings.
 
 ## Usage
 
 ```js
-const { discovery, evidence, relay, breg } = require('@registrystack/client');
+const { discovery, evidence, relay, breg, casework } = require('@registrystack/client');
 
 const registry = new breg.BaseRegistryClient({
   baseUrl: 'https://registry.example.invalid/',
 });
+const work = new casework.CaseworkClient({
+  baseUrl: 'https://casework.example.invalid/',
+});
 ```
 
 ## Products
@@ -32,6 +35,8 @@ const registry = new breg.BaseRegistryClient({
   assertions.
 - `relay`: Registry Relay, scoped read-only APIs over existing sources.
 - `breg`: Base Registry Engine, records, contracts, writes, and lifecycle.
+- `casework`: Registry Casework, staff inbox, claims, drafts, decisions,
+  recovery, history, holdings, and directory bootstrap.
 
 Each product remains in its own namespace because its routing,
 authentication, errors, and verification rules are different.
@@ -63,7 +68,8 @@ consumer does not need it.
 ## Base Registry Engine notes
 
 `breg.BaseRegistryClient.registryContract()` returns caller-filtered
-`operations` with typed field, request, and list-query descriptors; those
+`operations` with typed field, readable request field, request, and list-query
+descriptors; those
 descriptions grant no authority, so select the opaque create, patch, and
 lifecycle authorities from that same contract before executing a mutation.
 Methods ending in `Json` keep values exact across the Node number boundary:
@@ -73,6 +79,14 @@ mutation automatically. See
 [Exact JSON in Node](https://docs.registrystack.org/reference/client-api/#exact-json-in-node)
 for the full rules.
 
+`breg.verifyWebhookDelivery({ method, path, headers, body, key })` authenticates
+the exact bytes of one Version 1 webhook delivery. The result returns
+`deliveryTime` and `idempotencyKey`; the receiver must bound clock skew and
+deduplicate once-only effects on authenticated `source` plus `id`, or on an
+application business key. See
+[Verify a webhook delivery](https://docs.registrystack.org/reference/client-api/#verify-a-webhook-delivery)
+for a receiver example.
+
 ## Versioning
 
 Install the exact client version that matches the deployment. The unified
@@ -81,6 +95,21 @@ standalone client packages remain available for earlier versions, but the
 release process does not publish new standalone versions once this package
 is active.
 
+The `casework` namespace is part of the unified package beginning with
+Registry Stack v0.30.0.
+
+## Casework notes
+
+The Casework module is for a trusted server host. Each call takes that request's
+bearer token and selected Casework profile; source-reading calls also take the
+selected source profile. The client does not retain them. Browsers should send
+only the host's session cookie. Claim, release, and decide consume the
+caller-filtered action returned on the item, including its exact route and
+`ifMatch` revision. Mutations require a caller-controlled idempotency key and
+are never retried automatically. After a lost response, use
+`recoverDecisionByKey` with the original key so recovery does not depend on the
+attempt identifier being received.
+
 ## Documentation
 
 - [Client API reference](https://docs.registrystack.org/reference/client-api/)