avantgate 1.6.0 → 1.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -4
- package/package.json +17 -2
package/README.md
CHANGED
|
@@ -33,13 +33,54 @@ flowchart LR
|
|
|
33
33
|
|
|
34
34
|
---
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## 🖥️ GateWall Cockpit — Self-Hosted AI-WAF & Governance Console (`gatewall/`)
|
|
37
37
|
|
|
38
|
-
While the
|
|
38
|
+
While the **AvantGate SDK** provides zero-infrastructure, in-process control inside your application runtime, the included **GateWall Cockpit** (`gatewall/`) provides a full-featured, self-hosted visual control plane, real-time audit inspector, and Human-in-the-Loop approval.
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
```mermaid
|
|
41
|
+
flowchart LR
|
|
42
|
+
Agent[🤖 AvantGate Agent / SDK] -- "POST /api/v1/ingest/events<br/>(Async Telemetry)" --> GateWall["🛡️ GateWall Cockpit<br/>(Next.js + SQLite)"]
|
|
43
|
+
GateWall -- "SSE /api/v1/realtime" --> Browser["💻 Web Dashboard<br/>(http://localhost:3000)"]
|
|
44
|
+
Browser -- "POST /api/v1/approvals<br/>(Approve / Reject)" --> GateWall
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### 🚀 Quickstart: Run GateWall Cockpit
|
|
48
|
+
|
|
49
|
+
#### Option 1: One-Line Docker Compose (Recommended)
|
|
50
|
+
```bash
|
|
51
|
+
docker compose up -d
|
|
52
|
+
# or: npm run gatewall:docker
|
|
53
|
+
```
|
|
54
|
+
Open **`http://localhost:3000`** in your browser 🎉. Traces and audit sessions are automatically persisted.
|
|
55
|
+
|
|
56
|
+
#### Option 2: Run with Bun or Node.js
|
|
57
|
+
```bash
|
|
58
|
+
cd gatewall
|
|
59
|
+
bun install # or npm install
|
|
60
|
+
bun run dev # or npm run dev
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
### 🛡️ Cockpit Capabilities & Modules
|
|
66
|
+
|
|
67
|
+
| Module | Description |
|
|
68
|
+
|---|---|
|
|
69
|
+
| **🔒 Dual-Channel PII Inspector** | Visually compare the sequestered local escrow (`rawPayload`) against the redacted summary dispatched to the model (`llmSummary`). Highlights detected PII (emails, API keys, IBANs, phone numbers). |
|
|
70
|
+
| **🧑⚖️ Human-in-the-Loop (HITL) Queue** | Real-time queue intercepting high-impact tool executions (`WAITING_APPROVAL`) with an interactive dashboard to inspect parameters and click **Approve** or **Reject**. |
|
|
71
|
+
| **⚡ Real-Time Streaming (SSE)** | Low-latency Server-Sent Events (`/api/v1/realtime`) updating session trees, metrics, and alerts dynamically without manual page refresh. |
|
|
72
|
+
| **💰 FinOps & Token Tracking** | Automated token cost estimation and USD burn tracking across providers (GPT-4o, Claude 3.5 Sonnet, DeepSeek, etc.). |
|
|
73
|
+
| **🛡️ Loop Shield (Anti-Cycle Guard)** | Early visual detection of recursive agent loops and aberrant repetitive tool execution cycles. |
|
|
74
|
+
| **💾 Zero-External-DB SQLite Storage** | Zero setup overhead: persistent storage uses embedded SQLite (`gatewall/data/gatewall.db`) without requiring PostgreSQL, Redis, or ClickHouse. |
|
|
75
|
+
|
|
76
|
+
> 💡 **Agent Integration Recipes:** See [Connecting an Agent to GateWall Cockpit](docs/examples.md#12-connecting-an-agent-to-gatewall-cockpit-gatewall) in `docs/examples.md` for complete code recipes using `HttpTelemetryExporter` (`avantgate/agent`), direct HTTP ingestion, and React front-end streaming (`avantgate/client`).
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
### ☁️ Enterprise & Managed Cloud
|
|
41
81
|
|
|
42
|
-
|
|
82
|
+
Looking for enterprise multi-tenant RBAC, SSO/SAML, managed VPC sidecars, or on-premise air-gapped compliance?
|
|
83
|
+
Contact our team at [contact@gatewall.fr](mailto:contact@gatewall.fr) for private previews and enterprise deployment options.
|
|
43
84
|
|
|
44
85
|
---
|
|
45
86
|
|
|
@@ -94,6 +135,7 @@ yarn add avantgate zod
|
|
|
94
135
|
| `avantgate/finance` | Financial data normalizer (accounting parentheses, EU/US/UK/CH currencies & magnitudes). |
|
|
95
136
|
| `avantgate/agent` | *(Preview / Experimental)* Durable step runner, Human-in-the-Loop, dual-channel PII tool isolation & storage adapters. |
|
|
96
137
|
| `avantgate/workflow` | Deterministic sequential state machine, automatic reverse Saga rollback, durable HITL checkpoints & agent tool conversion. |
|
|
138
|
+
| `avantgate/client` | Lightweight front-end SDK (< 1.7 KB) & React hook to stream browser security alerts & metrics directly to GateWall. |
|
|
97
139
|
|
|
98
140
|
---
|
|
99
141
|
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "avantgate",
|
|
3
|
-
"version": "1.6.
|
|
3
|
+
"version": "1.6.1",
|
|
4
4
|
"description": "Zero-infrastructure, in-process AI Application Firewall (AI-WAF) & privacy control plane for TypeScript: real-time prompt guardrails, zero-egress PII redaction, agent tool isolation, anti-IDOR defense, pre-flight token budgets, and multi-model failover.",
|
|
5
|
-
"author": "
|
|
5
|
+
"author": "Gatewall Team",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"keywords": [
|
|
8
8
|
"avantgate",
|
|
9
|
+
"gatewall",
|
|
9
10
|
"ai-waf",
|
|
10
11
|
"guardrails",
|
|
11
12
|
"prompt-injection",
|
|
@@ -88,6 +89,12 @@
|
|
|
88
89
|
"test:agent": "tsx tests/agent/step-runner.test.ts && tsx tests/agent/isolated-tool.test.ts && tsx tests/agent/dto-pattern.test.ts && tsx tests/agent/tool-patterns.test.ts && tsx tests/agent/storage-adapters.test.ts && tsx tests/agent/tool-aliasing.test.ts && tsx tests/agent/tool-chaining.test.ts && tsx tests/agent/tool-storage.test.ts && tsx tests/agent/telemetry-exporter.test.ts && tsx tests/agent/platform-adapter.test.ts && tsx tests/agent/tool-governance.test.ts && tsx tests/agent/tool-impact.test.ts",
|
|
89
90
|
"test:workflow": "tsx tests/workflow/workflow-saga.test.ts && tsx tests/workflow/workflow-abort.test.ts",
|
|
90
91
|
"test:client": "tsx tests/client/browser-exporter.test.ts",
|
|
92
|
+
"test:demo": "tsx tests/agent/prospect-ai-demo-scenario.test.ts",
|
|
93
|
+
"gatewall": "npm --prefix gatewall run dev",
|
|
94
|
+
"gatewall:dev": "npm --prefix gatewall run dev",
|
|
95
|
+
"gatewall:build": "npm --prefix gatewall run build",
|
|
96
|
+
"gatewall:start": "npm --prefix gatewall run start",
|
|
97
|
+
"gatewall:docker": "docker compose up -d",
|
|
91
98
|
"lint": "tsc --noEmit",
|
|
92
99
|
"prepublishOnly": "npm run build && npm test"
|
|
93
100
|
},
|
|
@@ -103,5 +110,13 @@
|
|
|
103
110
|
},
|
|
104
111
|
"publishConfig": {
|
|
105
112
|
"access": "public"
|
|
113
|
+
},
|
|
114
|
+
"repository": {
|
|
115
|
+
"type": "git",
|
|
116
|
+
"url": "git+https://github.com/thienban/avantGate.git"
|
|
117
|
+
},
|
|
118
|
+
"homepage": "https://github.com/thienban/avantGate#readme",
|
|
119
|
+
"bugs": {
|
|
120
|
+
"url": "https://github.com/thienban/avantGate/issues"
|
|
106
121
|
}
|
|
107
122
|
}
|