@axonflow/sdk 2.3.0 → 3.3.1

package/README.md

@@ -5,14 +5,64 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue.svg)](https://www.typescriptlang.org/)
 
+> **Evaluating AxonFlow in production?** We're opening limited Design Partner slots.
+>
+> Free 30-minute architecture and incident-readiness review, priority issue triage, roadmap input, and early feature access.
+>
+> [Apply here](https://getaxonflow.com/design-partner?utm_source=readme_sdk_typescript) or email [design-partners@getaxonflow.com](mailto:design-partners@getaxonflow.com).
+>
+> No commitment required. We reply within 48 hours.
+
+> **AxonFlow Feedback Week (Feb 5–12, 2026)** — We're shipping 3 improvements from user feedback.
+>
+> [Share feedback](https://github.com/getaxonflow/axonflow/discussions/239) or email [hello@getaxonflow.com](mailto:hello@getaxonflow.com) for private feedback.
+
 Add invisible AI governance to your applications in 3 lines of code. No UI changes. No user training. Just drop-in enterprise protection.
 
+## How This SDK Fits with AxonFlow
+
+This SDK is a client library for interacting with a running AxonFlow control plane. It is used from application or agent code to send execution context, policies, and requests at runtime.
+
+A deployed AxonFlow platform (self-hosted or cloud) is required for end-to-end AI governance. SDKs alone are not sufficient—the platform and SDKs are designed to be used together.
+
+### Architecture Overview (2 min)
+
+If you're new to AxonFlow, this short video shows how the control plane and SDKs work together in a real production setup:
+
+[![AxonFlow Architecture Overview](https://img.youtube.com/vi/WwQXHKuZhxc/maxresdefault.jpg)](https://youtu.be/WwQXHKuZhxc)
+
+▶️ [Watch on YouTube](https://youtu.be/WwQXHKuZhxc)
+
 ## Installation
 
 ```bash
 npm install @axonflow/sdk
 ```
 
+### Install from Source
+
+```bash
+git clone https://github.com/getaxonflow/axonflow-sdk-typescript.git
+cd axonflow-sdk-typescript && npm install && npm run build && npm link
+# In your project: npm link @axonflow/sdk
+```
+
+## Evaluation Tier (Free License)
+
+Need more capacity than Community without moving to Enterprise? Evaluation uses the same core features with higher limits:
+
+| Limit | Community | Evaluation (Free) | Enterprise |
+|-------|-----------|-------------------|------------|
+| Tenant policies | 20 | 50 | Unlimited |
+| Org-wide policies | 0 | 5 | Unlimited |
+| Audit retention | 3 days | 14 days | 3650 days |
+| Concurrent executions | 5 | 25 | Unlimited |
+| Execution history | 50 | 500 | Unlimited |
+
+Also includes higher limits for LLM providers and MAP planning.
+
+[Get a free Evaluation license](https://getaxonflow.com/evaluation-license?utm_source=readme_sdk_typescript_eval) · [Full tier matrix](https://docs.getaxonflow.com/docs/features/community-vs-enterprise)
+
 ## Quick Start
 
 ### Gateway Mode (Recommended)
@@ -419,7 +469,7 @@ const axonflow = new AxonFlow({
 
 ### VPC Private Endpoint (Low-Latency)
 
-For customers running within AWS VPC, use the private endpoint for sub-10ms latency:
+For customers running within AWS VPC, use the private endpoint for lowest latency:
 
 ```typescript
 const axonflow = new AxonFlow({
@@ -428,11 +478,13 @@ const axonflow = new AxonFlow({
   endpoint: 'https://vpc-private-endpoint.getaxonflow.com:8443',  // VPC private endpoint
   mode: 'production'
 });
+
+// VPC deployment provides lowest latency due to intra-VPC routing
 ```
 
-**Performance:**
-- Public endpoint: ~100ms (internet routing)
-- VPC private endpoint: <10ms P99 (intra-VPC routing)
+**Network Latency Characteristics:**
+- Public endpoint: Higher latency (internet routing overhead)
+- VPC private endpoint: Lower latency (intra-VPC routing)
 
 **Note:** VPC endpoints require AWS VPC peering setup with AxonFlow infrastructure.
 
@@ -519,11 +571,92 @@ try {
    });
    ```
 
+## Examples
+
+Complete working examples for all features are available in the [examples folder](https://github.com/getaxonflow/axonflow/tree/main/examples).
+
+### Community Features
+
+```typescript
+// PII Detection - Automatically detect sensitive data
+const result = await axonflow.getPolicyApprovedContext({
+  userToken: 'user-123',
+  query: 'My SSN is 123-45-6789'
+});
+// result.approved = true, result.requiresRedaction = true (SSN detected)
+
+// SQL Injection Detection - Block prohibited queries
+const result = await axonflow.getPolicyApprovedContext({
+  userToken: 'user-123',
+  query: "SELECT * FROM users WHERE role = 'admin'"
+});
+// result.approved = false, result.blockReason = "SQL query policy violation"
+
+// Static Policies - List and manage built-in policies
+const policies = await axonflow.listPolicies();
+// Returns: [{name: "pii-detection", enabled: true}, ...]
+
+// Dynamic Policies - Create runtime policies
+await axonflow.createDynamicPolicy({
+  name: 'block-competitor-queries',
+  conditions: { contains: ['competitor', 'pricing'] },
+  action: 'block'
+});
+
+// MCP Connectors - Query external data sources
+const resp = await axonflow.queryConnector('postgres-db', 'SELECT name FROM customers', {});
+// resp.data contains query results
+
+// Multi-Agent Planning - Orchestrate complex workflows
+const plan = await axonflow.generatePlan('Research AI regulations', 'legal');
+const result = await axonflow.executePlan(plan.planId);
+
+// Audit Logging - Track all LLM interactions
+await axonflow.auditLLMCall({
+  contextId: ctx.contextId,
+  responseSummary: 'AI response summary',
+  provider: 'openai',
+  model: 'gpt-4',
+  tokenUsage: { promptTokens: 100, completionTokens: 200, totalTokens: 300 },
+  latencyMs: 450
+});
+```
+
+### Enterprise Features
+
+These features require an AxonFlow Enterprise license:
+
+```typescript
+// Code Governance - Automated PR reviews with AI
+const prResult = await axonflow.reviewPullRequest({
+  repoOwner: 'your-org',
+  repoName: 'your-repo',
+  prNumber: 123,
+  checkTypes: ['security', 'style', 'performance']
+});
+
+// Cost Controls - Budget management for LLM usage
+const budget = await axonflow.getBudget('team-engineering');
+// Returns: { limit: 1000.00, used: 234.56, remaining: 765.44 }
+
+// MCP Policy Enforcement - Automatic PII redaction in connector responses
+const resp = await axonflow.queryConnector('postgres', 'SELECT * FROM customers', {});
+// resp.policyInfo.redacted = true
+// resp.policyInfo.redactedFields = ['ssn', 'credit_card']
+```
+
+For enterprise features, contact [sales@getaxonflow.com](mailto:sales@getaxonflow.com).
+
 ## Support
 
-- Documentation: https://docs.axonflow.com
-- Email: support@axonflow.com
-- GitHub: https://github.com/axonflow/sdk-typescript
+- **Documentation**: https://docs.getaxonflow.com
+- **Issues**: https://github.com/getaxonflow/axonflow-sdk-typescript/issues
+- **Email**: dev@getaxonflow.com
+
+If you are evaluating AxonFlow in a company setting and cannot open a public issue, you can share feedback or blockers confidentially here:
+[Anonymous evaluation feedback form](https://getaxonflow.com/feedback)
+
+No email required. Optional contact if you want a response.
 
 ## MCP Connector Marketplace
 
@@ -673,6 +806,48 @@ console.log('Message sent:', result.success);
 
 For complete connector documentation, see [https://docs.getaxonflow.com/mcp](https://docs.getaxonflow.com/mcp)
 
+## MCP Policy Features (v3.3.0)
+
+### Exfiltration Detection
+
+Prevent large-scale data extraction with automatic row and byte limits:
+
+```typescript
+// Query with exfiltration limits (default: 10K rows, 10MB)
+const response = await axonflow.queryConnector('postgres', 'SELECT * FROM customers', {});
+
+// Check exfiltration info
+if (response.policyInfo?.exfiltrationCheck?.exceeded) {
+  console.log('Data limit exceeded:', response.policyInfo.exfiltrationCheck.limitType);
+  // limitType: 'rows' | 'bytes'
+}
+
+// Configure limits via environment:
+// MCP_MAX_ROWS_PER_QUERY=1000
+// MCP_MAX_BYTES_PER_QUERY=5242880
+```
+
+### Dynamic Policy Evaluation
+
+Enable Orchestrator-based policy evaluation for rate limiting, budget controls, and more:
+
+```typescript
+// Response includes dynamic policy info when enabled
+const response = await axonflow.queryConnector('postgres', 'SELECT id FROM users', {});
+
+// Check dynamic policy evaluation results
+const dynamicInfo = response.policyInfo?.dynamicPolicyInfo;
+if (dynamicInfo?.orchestratorReachable) {
+  console.log('Policies evaluated:', dynamicInfo.policiesEvaluated);
+  dynamicInfo.matchedPolicies?.forEach(policy => {
+    console.log(`  ${policy.policyName}: ${policy.action}`);
+  });
+}
+
+// Enable via environment:
+// MCP_DYNAMIC_POLICIES_ENABLED=true
+```
+
 ## Multi-Agent Planning (MAP)
 
 Generate and execute complex multi-step plans using AI agent orchestration:
@@ -803,4 +978,6 @@ const axonflow = new AxonFlow({
 
 ## License
 
-MIT
+MIT
+
+<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=4970d33a-d1ab-4baf-880c-1670f3c6cf0e" />