@reclaimprotocol/client 0.1.23 → 0.1.24

package/README.md

@@ -1,6 +1,6 @@
 # @reclaimprotocol/client
 
-Typed SDK/HTTP client SDK for the Reclaim Protocol — the programmatic way to use Reclaim Protocol to verify **data points** about your users (a follower count, an account balance, an order). Can be directly integrated by apps to request verification for their users using Reclaim Protocol and verify the results.
+The typed HTTP client and SDK for Reclaim Protocol — the programmatic way to verify **data points** about your users, such as a follower count, an account balance, or an order. Integrate it directly into your app to request a verification and to verify the result you get back.
 
 One package gives you:
 
@@ -96,7 +96,7 @@ curl -X POST "$BUILDER_URL/verifications/sessions" \
 # → 201 { "id": "…", "verificationUrl": "…", "status": "pending", "mode": "…", … }
 ```
 
-### 4. Receive & verify the result
+### 4. Receive and verify the result
 
 When the end-user finishes, the Builder POSTs to your `callbackUrl`. Pass the request body to `results.receive`. It decrypts (if encrypted) and verifies the signature + nested proofs, and **throws if the result is invalid** — so reaching the `result` branch means it's verified.
 
@@ -129,7 +129,7 @@ Whichever you use, at runtime your backend needs only the org secret (to authent
 
 ### `createReclaim(config)`
 
-Returns a `Reclaim` with four namespaces (`sessions`, `callbacks`, `keypair`, `results`) plus an `api` escape hatch.
+Returns a `Reclaim` with four namespaces — `sessions`, `callbacks`, `keypair`, and `results` — plus an `api` escape hatch.
 
 | `ReclaimConfig` field | type | required | notes |
 |---|---|---|---|
@@ -198,7 +198,7 @@ try {
   // result.payload is verified
 } catch (err) {
   if (err instanceof ResultVerificationError) {
-    console.error(err.reason, err.outcome)  // e.g. 'expired' / 'bad-signature' / 'invalid-proof'
+    console.error(err.reason, err.outcome)  // 'expired', 'bad-signature', 'invalid-proof', …
   } else {
     throw err
   }
@@ -214,7 +214,7 @@ A non-terminal `event` delivery is not a result and never throws — it returns
 const { data } = await reclaim.api('GetVerificationSession', { params: { sessionId } })
 ```
 
-## Crypto & key helpers
+## Crypto and key helpers
 
 ```ts
 // Eth encryption keys (consumer side)

package/lib/client.d.ts

@@ -11,7 +11,7 @@ export type ReclaimClientOptions = {
 };
 /**
  * Core HTTP client. Shared by the SDK entrypoint, MCP server, and CLI —
- * extend behaviour here rather than duplicating it across surfaces.
+ * extend behavior here rather than duplicating it across surfaces.
  *
  * Per @reclaimprotocol/app conventions, validation lives in the openapi
  * spec; this client forwards requests and maps RFC 9457 problem responses

package/lib/client.js

@@ -21,7 +21,7 @@ import { throwProblemError } from "./errors.js";
 import { ROUTES } from "./routes.gen.js";
 /**
  * Core HTTP client. Shared by the SDK entrypoint, MCP server, and CLI —
- * extend behaviour here rather than duplicating it across surfaces.
+ * extend behavior here rather than duplicating it across surfaces.
  *
  * Per @reclaimprotocol/app conventions, validation lives in the openapi
  * spec; this client forwards requests and maps RFC 9457 problem responses
@@ -81,7 +81,7 @@ export class ReclaimClient {
         if (__classPrivateFieldGet(this, _ReclaimClient_token, "f")) {
             headers['Authorization'] = `Bearer ${__classPrivateFieldGet(this, _ReclaimClient_token, "f")}`;
         }
-        // Per-request header parameters (e.g. `If-Match` for optimistic
+        // Per-request header parameters (for example, `If-Match` for optimistic
         // concurrency). Applied last so spec-declared headers win over the
         // client-wide defaults, but never override Authorization.
         if (args.headers) {
@@ -97,9 +97,9 @@ export class ReclaimClient {
             headers,
         };
         // Write methods always carry a JSON body (defaulting to `{}`) plus a
-        // Content-Type. Some endpoints — e.g. the auth-only attach session —
-        // take an empty body, and omitting Content-Type makes the server
-        // reject the request with `415 unsupported media type`.
+        // Content-Type. Some endpoints — for example, the auth-only attach session
+        // — take an empty body, and omitting Content-Type makes the server reject
+        // the request with `415 unsupported media type`.
         const method = op.method.toLowerCase();
         if (method !== 'get' && method !== 'head') {
             init.body = JSON.stringify(args.body ?? {});

package/lib/eip191.js

@@ -1,7 +1,7 @@
 /**
  * EIP-191 / `personal_sign` primitives shared by the verification paths
  * (attestor-proof recovery) and by callers that need to *produce* a
- * personal_sign signature with a raw eth key (e.g. the old-devtools
+ * personal_sign signature with a raw eth key (for example, the old-devtools
  * link-app flow) — without pulling in a full wallet library.
  */
 import { keccak_256 } from '@noble/hashes/sha3.js';

package/lib/result.d.ts

@@ -31,9 +31,10 @@ export interface VerifyResultOutcome {
  * (which only relays the ciphertext). Consumers never call this — they only
  * {@link decryptCallback}.
  *
- * `plaintext` is bytes (e.g. `new TextEncoder().encode(JSON.stringify(jws))`);
- * returns the ciphertext as a base64url string (single token, never starts with
- * `{`, so {@link decryptCallback} can tell it apart from a plaintext JWS JSON).
+ * `plaintext` is bytes (for example, `new
+ * TextEncoder().encode(JSON.stringify(jws))`); returns the ciphertext as a
+ * base64url string (single token, never starts with `{`, so {@link
+ * decryptCallback} can tell it apart from a plaintext JWS JSON).
  */
 export declare function encryptForEthPublicKey(publicJwk: Jwk, plaintext: Uint8Array): Promise<string>;
 /**
@@ -110,7 +111,7 @@ export interface VerifyResultFullOutcome extends VerifyResultOutcome {
  *     // result is verified — use result.payload
  *   } catch (err) {
  *     if (err instanceof ResultVerificationError) {
- *       // e.g. 'expired', { payload, … }
+ *       // for example, 'expired', { payload, … }
  *       console.error(err.reason, err.outcome)
  *     }
  *   }

package/lib/result.js

@@ -25,9 +25,10 @@ import { addressFromUncompressedPubkey, secp } from "./secp.js";
  * (which only relays the ciphertext). Consumers never call this — they only
  * {@link decryptCallback}.
  *
- * `plaintext` is bytes (e.g. `new TextEncoder().encode(JSON.stringify(jws))`);
- * returns the ciphertext as a base64url string (single token, never starts with
- * `{`, so {@link decryptCallback} can tell it apart from a plaintext JWS JSON).
+ * `plaintext` is bytes (for example, `new
+ * TextEncoder().encode(JSON.stringify(jws))`); returns the ciphertext as a
+ * base64url string (single token, never starts with `{`, so {@link
+ * decryptCallback} can tell it apart from a plaintext JWS JSON).
  */
 export async function encryptForEthPublicKey(publicJwk, plaintext) {
     // Uncompressed `0x04`‖X‖Y bytes — what eciesjs accepts as the recipient key.
@@ -150,7 +151,7 @@ function contentHash(params) {
  *     // result is verified — use result.payload
  *   } catch (err) {
  *     if (err instanceof ResultVerificationError) {
- *       // e.g. 'expired', { payload, … }
+ *       // for example, 'expired', { payload, … }
  *       console.error(err.reason, err.outcome)
  *     }
  *   }

package/lib/routes.gen.d.ts

@@ -3,6 +3,10 @@ export declare const ROUTES: {
         readonly method: "post";
         readonly path: "/orgs/{orgId}/invite";
     };
+    readonly ActivateFixWithAiRepair: {
+        readonly method: "post";
+        readonly path: "/v/{sessionId}/fix-with-ai/activate";
+    };
     readonly AddOrgMember: {
         readonly method: "post";
         readonly path: "/orgs/{orgId}/members";
@@ -51,6 +55,10 @@ export declare const ROUTES: {
         readonly method: "get";
         readonly path: "/admin/sessions";
     };
+    readonly AdminSetProviderFixWithAi: {
+        readonly method: "put";
+        readonly path: "/admin/providers/{providerId}/fix-with-ai";
+    };
     readonly AdminSetUserOrgLimit: {
         readonly method: "put";
         readonly path: "/users/{userId}/org-limit";
@@ -115,6 +123,10 @@ export declare const ROUTES: {
         readonly method: "post";
         readonly path: "/orgs/{orgId}/billing/credits/checkout";
     };
+    readonly CreateFixWithAiSession: {
+        readonly method: "post";
+        readonly path: "/v/{sessionId}/fix-with-ai";
+    };
     readonly CreateManualTransaction: {
         readonly method: "post";
         readonly path: "/admin/billing/transactions";
@@ -219,6 +231,10 @@ export declare const ROUTES: {
         readonly method: "get";
         readonly path: "/og/explore.png";
     };
+    readonly FixWithAiRecovery: {
+        readonly method: "get";
+        readonly path: "/v/{sessionId}/fix-with-ai";
+    };
     readonly GetImage: {
         readonly method: "get";
         readonly path: "/images/{imageId}";

package/lib/routes.gen.js

@@ -4,6 +4,7 @@
 // to regenerate. Do not edit by hand.
 export const ROUTES = {
     "AcceptOrgInvite": { "method": "post", "path": "/orgs/{orgId}/invite" },
+    "ActivateFixWithAiRepair": { "method": "post", "path": "/v/{sessionId}/fix-with-ai/activate" },
     "AddOrgMember": { "method": "post", "path": "/orgs/{orgId}/members" },
     "AddStaffMember": { "method": "post", "path": "/admin/staff" },
     "AddVerificationClientKey": { "method": "post", "path": "/admin/verification-clients/{clientId}/keys" },
@@ -16,6 +17,7 @@ export const ROUTES = {
     "AdminProviders": { "method": "get", "path": "/admin/providers" },
     "AdminReviews": { "method": "get", "path": "/admin/reviews" },
     "AdminSessions": { "method": "get", "path": "/admin/sessions" },
+    "AdminSetProviderFixWithAi": { "method": "put", "path": "/admin/providers/{providerId}/fix-with-ai" },
     "AdminSetUserOrgLimit": { "method": "put", "path": "/users/{userId}/org-limit" },
     "AdminSubscribeOrgPlan": { "method": "post", "path": "/admin/orgs/{orgId}/billing/subscribe" },
     "AdminThemes": { "method": "get", "path": "/admin/themes" },
@@ -32,6 +34,7 @@ export const ROUTES = {
     "CreateBillingPortalSession": { "method": "post", "path": "/orgs/{orgId}/billing/portal" },
     "CreateCallbackSubscription": { "method": "post", "path": "/verifications/callback-subscriptions" },
     "CreateCreditCheckoutSession": { "method": "post", "path": "/orgs/{orgId}/billing/credits/checkout" },
+    "CreateFixWithAiSession": { "method": "post", "path": "/v/{sessionId}/fix-with-ai" },
     "CreateManualTransaction": { "method": "post", "path": "/admin/billing/transactions" },
     "CreateOrg": { "method": "post", "path": "/orgs" },
     "CreateOrgCallbackSubscription": { "method": "post", "path": "/orgs/{orgId}/callback-subscriptions" },
@@ -58,6 +61,7 @@ export const ROUTES = {
     "DisposeVerificationSession": { "method": "post", "path": "/v/{sessionId}/dispose" },
     "Docs": { "method": "get", "path": "/docs" },
     "ExplorePreviewImage": { "method": "get", "path": "/og/explore.png" },
+    "FixWithAiRecovery": { "method": "get", "path": "/v/{sessionId}/fix-with-ai" },
     "GetImage": { "method": "get", "path": "/images/{imageId}" },
     "GetMe": { "method": "get", "path": "/me" },
     "GetOrg": { "method": "get", "path": "/orgs/{orgId}" },

package/lib/secp.js

@@ -1,7 +1,7 @@
 /**
  * Shared `@noble/secp256k1` instance with the v3 hash hooks wired once
  * (sign + recover need SHA-256 / HMAC-SHA256). Import `secp` from here — never
- * set `secp.hashes` ad-hoc — so the hooks are guaranteed initialised before any
+ * set `secp.hashes` ad-hoc — so the hooks are guaranteed initialized before any
  * sign/verify/recover call, regardless of import order.
  */
 import { hmac } from '@noble/hashes/hmac.js';