@chitmark/sdk 0.1.0 → 0.1.1

package/README.md

@@ -1,16 +1,8 @@
 # @chitmark/sdk
 
-Official TypeScript / JavaScript SDK for **Chitmark by Open Agent Ledger** — trust decisions on agent-mediated actions, tuned by business outcomes (`verify` / `feedback` / `challenge`). Day-one wedge: agent-farming defense at signup/trial; outcomes label scoring, not a payments product.
+Official TypeScript / JavaScript SDK for Chitmark — trust decisions on agent-mediated actions, tuned by business outcomes (`verify` / `feedback` / `challenge`).
 
-Three verbs:
-
-| Verb          | Method                 | Endpoint             | When                         |
-| :------------ | :--------------------- | :------------------- | :--------------------------- |
-| **verify**    | `chitmark.verify()`    | `POST /v1/verify`    | At signup / trial / action   |
-| **feedback**  | `chitmark.feedback()`  | `POST /v1/feedback`  | After an outcome is known    |
-| **challenge** | `chitmark.challenge()` | `POST /v1/challenge` | On `challenge` or `degraded` |
-
-**Golden rule:** fail to `challenge`, never to `allow`. Timeouts return a degraded challenge verdict.
+[![npm version](https://img.shields.io/npm/v/@chitmark/sdk.svg)](https://www.npmjs.com/package/@chitmark/sdk)
 
 ## Install
 
@@ -20,12 +12,14 @@ npm install @chitmark/sdk
 pnpm add @chitmark/sdk
 ```
 
+Requires Node ≥ 24.
+
 ## Quick start
 
 ```typescript
 import { Chitmark } from "@chitmark/sdk";
 
-export const chitmark = new Chitmark({
+const chitmark = new Chitmark({
   apiKey: process.env.CHITMARK_API_KEY!,
   // Optional — defaults shown
   onDegraded: "challenge", // NEVER 'allow'
@@ -34,7 +28,7 @@ export const chitmark = new Chitmark({
   env: "production",
 });
 
-const v = await chitmark.verify({
+const verdict = await chitmark.verify({
   action: "signup",
   session: "sess_9f3a",
   surface: "app.acme.com/signup",
@@ -46,17 +40,47 @@ const v = await chitmark.verify({
   },
 });
 
-// Store v.eventId on the account row for feedback joins
-// With piiMode: "hashed", email/ip are minimized before the wire.
+// Persist verdict.eventId on the account row — feedback joins only on that id.
+```
+
+## API
+
+Three verbs:
+
+| Verb          | Method                 | Endpoint             | When                         |
+| :------------ | :--------------------- | :------------------- | :--------------------------- |
+| **verify**    | `chitmark.verify()`    | `POST /v1/verify`    | At signup / trial / action   |
+| **feedback**  | `chitmark.feedback()`  | `POST /v1/feedback`  | After an outcome is known    |
+| **challenge** | `chitmark.challenge()` | `POST /v1/challenge` | On `challenge` or `degraded` |
+
+**Golden rule:** fail to `challenge`, never to `allow`. Timeouts return a degraded challenge verdict.
+
+### Feedback
+
+```typescript
+await chitmark.feedback({
+  eventId: verdict.eventId, // stored at signup
+  outcome: "credit_burn", // outcomes label scoring
+  value: 87.4,
+  unit: "usd",
+});
 ```
 
-## Edge (Cloudflare Workers)
+### PII
+
+| Mode          | Behavior                                                     |
+| :------------ | :----------------------------------------------------------- |
+| `hashed` (default) | SHA-256 email, /24 IP truncation, minimized form fields  |
+| `none`        | Derived/header-shape signals only (Web Bot Auth preserved)   |
+| `raw`         | Tenant opt-in only; triggers higher compliance review        |
+
+## Cloudflare Workers
 
 ```typescript
 import { Chitmark } from "@chitmark/sdk/edge";
 
 const chitmark = new Chitmark({ apiKey: env.CHITMARK_API_KEY });
-const v = await chitmark.verifyRequest(req, { action: "signup" });
+const verdict = await chitmark.verifyRequest(req, { action: "signup" });
 ```
 
 ## Express middleware
@@ -68,29 +92,12 @@ const chitmark = new Chitmark({ apiKey: process.env.CHITMARK_API_KEY! });
 app.post("/signup", chitmarkGate(chitmark, "signup"), signupHandler);
 ```
 
-## PII modes
-
-- **`hashed` (default)** — SHA-256 email, /24 IP truncation, minimized form fields
-- **`none`** — derived/header-shape signals only (Web Bot Auth headers preserved)
-- **`raw`** — tenant opt-in only; triggers higher compliance review
-
-## Feedback
-
-```typescript
-// Store v.eventId on the account row at signup — feedback joins only on that id.
-await chitmark.feedback({
-  eventId: v.eventId,
-  outcome: "credit_burn", // outcomes label scoring
-  value: 87.4,
-  unit: "usd",
-});
-```
-
 ## Resources
 
 - [API reference](https://chitmark.com/docs)
 - [OpenAPI contract](https://chitmark.com/openapi.yaml)
 - [GitHub](https://github.com/nonameuserd/Chitmark)
-- Node ≥ 24 (workers-compatible `@chitmark/sdk/edge` subpath for Cloudflare)
 
-**License:** proprietary — see [LICENSE](LICENSE).
+## License
+
+Proprietary — see [LICENSE](LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chitmark/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Official TypeScript SDK for Chitmark by Open Agent Ledger — trust decisions on agent-mediated actions (verify, feedback, challenge)",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Open Agent Ledger",