@valence-ai/sdk 0.2.0 → 0.2.1

package/README.md

@@ -2,16 +2,16 @@
 
 The Valence SDK is the integration layer for connecting an application to Valence AI.
 
-It is designed for teams that want one integration path across development and production. You use the SDK to run or report security scans, upload findings into Valence AI, send live runtime signals, and optionally add runtime review hooks around sensitive actions. The goal is to give your application a direct path into the Valence AI control plane without requiring persistent repo handover.
+It is designed for teams that need a single integration path across development, CI, and live environments. The SDK provides the primitives required to run or report security scans, ingest security issues into Valence AI, stream live runtime telemetry, and optionally enforce review gates around sensitive actions. The objective is to connect an application directly to the Valence AI control plane without requiring persistent repository handover.
 
 It supports the full Valence AI flow:
 
 - run local or CI security scans
-- upload findings into Valence AI
+- ingest security issues into Valence AI
 - send live runtime signals from local, staging, or production
 - add runtime review hooks for sensitive actions when needed
 
-Valence AI is findings-first. Start with scans and runtime reporting, then add runtime review controls only for the workflows that need them.
+Valence AI is security-issue first. Start with scan ingestion and runtime reporting, then enable runtime review controls only for workflows that require pre-execution validation.
 
 ## Package
 
@@ -53,7 +53,7 @@ const client = createValenceClient({
 
 ## Run a local scan
 
-Use `runLocalSecurityScan` to scan the current project and upload findings to Valence AI through the shared findings pipeline.
+Use `runLocalSecurityScan` to scan the current project and ingest security issues into Valence AI through the shared issue pipeline.
 
 ```ts
 import { createValenceClient, runLocalSecurityScan } from '@valence-ai/sdk';
@@ -79,7 +79,7 @@ const result = await runLocalSecurityScan(
   }
 );
 
-console.log(`Uploaded ${result.findings.length} findings`);
+console.log(`Uploaded ${result.findings.length} security issues`);
 ```
 
 Current local scan coverage includes:
@@ -88,9 +88,9 @@ Current local scan coverage includes:
 - public environment variable exposure checks
 - dependency issues from `npm audit`
 
-## Report findings directly
+## Report security issues directly
 
-If your CI job or custom scanner already produced findings, upload them directly with `reportFindings`.
+If your CI job or custom scanner already produced issue records, upload them directly with `reportFindings`.
 
 ```ts
 await client.reportFindings({
@@ -118,13 +118,13 @@ await client.reportFindings({
 });
 ```
 
-## Report runtime findings
+## Report runtime security issues
 
-Use runtime finding helpers when you want live application behavior to show up in Valence AI alongside scan results.
+Use the runtime issue helpers when you want live application behavior to appear in Valence AI alongside scan results.
 
 ### Hook runtime decisions automatically
 
-Use `createRuntimeFindingHooks` to turn runtime decisions into findings uploaded through the shared `/api/findings` pipeline.
+Use `createRuntimeFindingHooks` to convert runtime decisions into security issues ingested through the shared `/api/findings` pipeline.
 
 ```ts
 import {
@@ -156,7 +156,7 @@ const guard = createToolExecutionGuard(
 );
 ```
 
-By default, runtime findings are created for:
+By default, runtime security issues are created for:
 
 - blocked actions
 - review-required actions
@@ -281,13 +281,13 @@ type DecisionResponse = {
 
 ## Runtime behavior
 
-- local scan findings go to `/api/findings`
-- CI findings go to `/api/findings`
-- runtime findings go to `/api/findings`
+- local scan issues go to `/api/findings`
+- CI issues go to `/api/findings`
+- runtime issues go to `/api/findings`
 - sensitive runtime reviews go to `/api/decide`
 - `dryRun: true` uses `/api/simulate`
 
-The main product path is findings ingestion. The decision endpoints only matter when you enable runtime review hooks for sensitive actions.
+The primary product path is security-issue ingestion. The decision endpoints only matter when you enable runtime review hooks for sensitive actions.
 
 ## Error handling
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@valence-ai/sdk",
-  "version": "0.2.0",
-  "description": "SDK for connecting applications to Valence AI for findings, runtime signals, and optional runtime review flows.",
+  "version": "0.2.1",
+  "description": "SDK for connecting applications to Valence AI for security issues, runtime signals, and optional runtime review flows.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/praveensahu-dev/Valence-AI.git",
@@ -44,7 +44,7 @@
     "sdk",
     "security",
     "appsec",
-    "findings",
+    "issues",
     "runtime",
     "scanner",
     "guardrails"