@assertion-runtime/sdk-node 0.1.0 → 0.1.1

package/README.md

@@ -1,6 +1,40 @@
-# Assertion Runtime Node SDK
+# Assertion Runtime API
 
-## Output lint
+## Setup
+1. Create a Supabase project and run `supabase/schema.sql`.
+2. Create a project row and API key hash (SHA-256 of your key).
+3. Copy `.env.example` to `.env.local` and fill values.
 
-Use `emitFinding(output, { endpoint, apiKey })` to lint an output string. The SDK applies simple heuristics, captures
-best-effort emission site metadata, and emits a finding only when the output looks risky.
+### Supabase setup
+- **Project URL:** Supabase dashboard -> Project Settings -> API -> Project URL
+- **Service role key:** Supabase dashboard -> Project Settings -> API -> service_role key
+- **Schema:** `apps/runtime-api/supabase/schema.sql`
+
+### API key setup
+Add an API key row in `api_keys` with a SHA-256 hash of your key:
+```
+sha256(<plain-text-api-key>)
+```
+Use the `projects.id` value in `project_id`.
+
+### Local fallback auth (optional)
+Set `ASSR_API_KEY` + `ASSR_FALLBACK_PROJECT_ID` in `.env.local` for local-only testing.
+Requests can then authenticate with `Authorization: Bearer <ASSR_API_KEY>`.
+
+## Endpoints
+- `POST /findings` - ingest output lint finding
+- `GET /findings` - list findings
+- `GET /findings/:id` - fetch a single finding
+- `POST /sdk-diagnostics` - ingest SDK diagnostics payload
+
+## Notes
+- Findings are immutable and stored as-is.
+- Use `ASSR_ALLOW_IN_MEMORY=true` only for local scaffolding.
+- For local-only testing, you can set `ASSR_API_KEY` + `ASSR_FALLBACK_PROJECT_ID`.
+
+## Build + run
+```
+npm run build -w packages/core
+npm run build -w apps/runtime-api
+npm run start -w apps/runtime-api
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@assertion-runtime/sdk-node",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": false,
   "type": "module",
   "main": "dist/index.js",