promptguard-sdk 1.7.1 → 1.8.0

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.
@@ -0,0 +1,251 @@
1
+ /**
2
+ * Auto-generated from OpenAPI spec (v1.0.0).
3
+ * DO NOT EDIT — regenerate with: npx ts-node scripts/generate-types-from-spec.ts
4
+ *
5
+ * These are type-only definitions. Custom client logic lives in src/guard.ts,
6
+ * src/client.ts, src/patches/, and src/integrations/ — those files are never
7
+ * modified by this generator.
8
+ */
9
+ /** Request to register a new agent identity. */
10
+ export interface AgentRegisterRequest {
11
+ agent_name: string;
12
+ allowed_tools?: Array<string> | unknown;
13
+ }
14
+ /** Response from agent registration — secret is shown only once. */
15
+ export interface AgentRegisterResponse {
16
+ agent_id: string;
17
+ agent_name: string;
18
+ agent_secret: string;
19
+ credential_prefix: string;
20
+ }
21
+ /** Response from credential rotation. */
22
+ export interface AgentRotateResponse {
23
+ agent_id: string;
24
+ new_secret: string;
25
+ credential_prefix: string;
26
+ old_credential_revoked: boolean;
27
+ }
28
+ /** Statistics for an agent */
29
+ export interface AgentStats {
30
+ agent_id: string;
31
+ total_tool_calls: number;
32
+ blocked_calls: number;
33
+ avg_risk_score: number;
34
+ active_sessions: number;
35
+ anomalies_detected: number;
36
+ }
37
+ /** Response containing the full API key for copy functionality */
38
+ export interface ApiKeyFullResponse {
39
+ id: string;
40
+ name: string;
41
+ prefix: string;
42
+ key: string;
43
+ }
44
+ export interface ApiKeyResponse {
45
+ id: string;
46
+ name: string;
47
+ prefix: string;
48
+ key?: string | unknown;
49
+ project_id: string | unknown;
50
+ project_name: string | unknown;
51
+ permissions: Array<string>;
52
+ is_active: boolean;
53
+ last_used_at: string | unknown;
54
+ expires_at?: string | unknown;
55
+ created_at: string;
56
+ }
57
+ export interface AuthErrorEnvelope {
58
+ error: ErrorDetail;
59
+ }
60
+ /** Request to run the autonomous red team agent. */
61
+ export interface AutonomousRequest {
62
+ budget?: number;
63
+ target_preset?: string;
64
+ enabled_detectors?: Array<string> | unknown;
65
+ }
66
+ export interface CreateApiKeyRequest {
67
+ /** API key name */
68
+ name: string;
69
+ project_id?: string | unknown;
70
+ permissions?: Array<string>;
71
+ expires_at?: string | unknown;
72
+ }
73
+ export interface CreateApiKeyResponse {
74
+ key: string;
75
+ id: string;
76
+ name: string;
77
+ prefix: string;
78
+ }
79
+ /** Request to validate a tool call */
80
+ export interface developer__agent__router__ToolCallRequest {
81
+ agent_id: string;
82
+ tool_name: string;
83
+ arguments: Record<string, unknown>;
84
+ session_id?: string | unknown;
85
+ }
86
+ /** Response from tool call validation */
87
+ export interface developer__agent__router__ToolCallResponse {
88
+ allowed: boolean;
89
+ risk_score: number;
90
+ risk_level: string;
91
+ reason: string;
92
+ warnings?: Array<string>;
93
+ blocked_reasons?: Array<string>;
94
+ }
95
+ export interface developer__projects__schemas__CreateProjectRequest {
96
+ name: string;
97
+ description?: string | unknown;
98
+ fail_mode?: string;
99
+ use_case?: string;
100
+ strictness_level?: string;
101
+ }
102
+ export interface developer__projects__schemas__ProjectResponse {
103
+ id: string;
104
+ name: string;
105
+ description: string | unknown;
106
+ fail_mode: string;
107
+ use_case: string;
108
+ strictness_level: string;
109
+ zero_retention?: boolean;
110
+ created_at: string;
111
+ }
112
+ export interface ErrorDetail {
113
+ /** Human-readable error description */
114
+ message: string;
115
+ /** Error category, e.g. 'authentication_error' */
116
+ type: string;
117
+ /** Machine-readable error code */
118
+ code: string;
119
+ }
120
+ /** Optional rich context from framework integrations. */
121
+ export interface GuardContext {
122
+ /** Framework name, e.g. 'langchain', 'crewai' */
123
+ framework?: string | unknown;
124
+ /** LangChain chain name or pipeline identifier */
125
+ chain_name?: string | unknown;
126
+ /** Agent identifier for multi-agent systems */
127
+ agent_id?: string | unknown;
128
+ /** Session identifier for multi-turn tracking */
129
+ session_id?: string | unknown;
130
+ /** Tool calls in this turn */
131
+ tool_calls?: Array<Record<string, unknown>> | unknown;
132
+ /** Arbitrary framework-specific metadata */
133
+ metadata?: Record<string, unknown> | unknown;
134
+ }
135
+ /** A single message in the conversation. */
136
+ export interface GuardMessage {
137
+ /** Message role: system, user, assistant, tool */
138
+ role: string;
139
+ /** Message text content */
140
+ content?: string;
141
+ }
142
+ /** Request body for the guard endpoint. */
143
+ export interface GuardRequest {
144
+ /** Messages to scan (OpenAI-style message array) */
145
+ messages: Array<GuardMessage>;
146
+ /** Scan direction: 'input' (pre-LLM) or 'output' (post-LLM) */
147
+ direction?: string;
148
+ /** Model being used (for logging) */
149
+ model?: string | unknown;
150
+ /** Optional framework context */
151
+ context?: GuardContext | unknown;
152
+ }
153
+ /** Response from the guard endpoint. */
154
+ export interface GuardResponse {
155
+ /** Policy decision: 'allow', 'block', or 'redact' */
156
+ decision: string;
157
+ /** Unique event identifier for tracking */
158
+ event_id: string;
159
+ /** Confidence score of the decision */
160
+ confidence: number;
161
+ /** Primary threat type detected */
162
+ threat_type?: string | unknown;
163
+ /** Redacted messages (only present when decision='redact') */
164
+ redacted_messages?: Array<GuardMessage> | unknown;
165
+ /** Detailed threat breakdown */
166
+ threats?: Array<ThreatDetail>;
167
+ /** Processing time in milliseconds */
168
+ latency_ms: number;
169
+ }
170
+ export interface HTTPValidationError {
171
+ detail?: Array<ValidationError>;
172
+ }
173
+ /** Request to run a red team test */
174
+ export interface internal__redteam__router__TestRequest {
175
+ custom_prompt?: string | unknown;
176
+ target_preset?: string;
177
+ }
178
+ /** Response from a red team test */
179
+ export interface internal__redteam__router__TestResponse {
180
+ test_name: string;
181
+ prompt: string;
182
+ decision: string;
183
+ reason: string;
184
+ threat_type: string | unknown;
185
+ confidence: number;
186
+ blocked: boolean;
187
+ details: Record<string, unknown>;
188
+ }
189
+ /** Summary of all red team tests */
190
+ export interface internal__redteam__router__TestSummary {
191
+ total_tests: number;
192
+ blocked: number;
193
+ allowed: number;
194
+ block_rate: number;
195
+ results: Array<internal__redteam__router__TestResponse>;
196
+ }
197
+ export interface QuotaErrorDetail {
198
+ message: string;
199
+ /** 'quota_exceeded' or 'spending_limit_exceeded' */
200
+ type: string;
201
+ /** 'monthly_quota_exceeded' or 'spending_limit_exceeded' */
202
+ code: string;
203
+ current_plan: string;
204
+ requests_used: number;
205
+ requests_limit: number;
206
+ upgrade_url: string;
207
+ retry_after?: number | unknown;
208
+ }
209
+ export interface QuotaErrorEnvelope {
210
+ error: QuotaErrorDetail;
211
+ }
212
+ export interface RedactRequest {
213
+ /** Text to redact */
214
+ content: string;
215
+ /** Specific PII types to redact (default: all) */
216
+ pii_types?: Array<string> | unknown;
217
+ }
218
+ export interface RedactResponse {
219
+ original: string;
220
+ redacted: string;
221
+ piiFound: Array<string>;
222
+ }
223
+ export interface ScanRequest {
224
+ /** Text to scan */
225
+ content: string;
226
+ /** Content type: 'prompt' or 'response' */
227
+ type?: string;
228
+ }
229
+ export interface ScanResponse {
230
+ blocked: boolean;
231
+ decision: string;
232
+ reason: string;
233
+ threatType?: string | unknown;
234
+ confidence: number;
235
+ eventId: string;
236
+ processingTimeMs: number;
237
+ }
238
+ /** Individual threat found during scanning. */
239
+ export interface ThreatDetail {
240
+ type: string;
241
+ confidence: number;
242
+ details: string;
243
+ }
244
+ export interface ValidationError {
245
+ loc: Array<string | number>;
246
+ msg: string;
247
+ type: string;
248
+ input?: unknown;
249
+ ctx?: Record<string, unknown>;
250
+ }
251
+ //# sourceMappingURL=api-types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-types.d.ts","sourceRoot":"","sources":["../../src/generated/api-types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,gDAAgD;AAChD,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAA;CACxC;AAED,oEAAoE;AACpE,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,iBAAiB,EAAE,MAAM,CAAA;CAC1B;AAED,yCAAyC;AACzC,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,iBAAiB,EAAE,MAAM,CAAA;IACzB,sBAAsB,EAAE,OAAO,CAAA;CAChC;AAED,8BAA8B;AAC9B,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED,kEAAkE;AAClE,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,UAAU,EAAE,MAAM,GAAG,OAAO,CAAA;IAC5B,YAAY,EAAE,MAAM,GAAG,OAAO,CAAA;IAC9B,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IAC1B,SAAS,EAAE,OAAO,CAAA;IAClB,YAAY,EAAE,MAAM,GAAG,OAAO,CAAA;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,WAAW,CAAA;CACnB;AAED,oDAAoD;AACpD,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAA;CAC5C;AAED,MAAM,WAAW,mBAAmB;IAClC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAA;IACX,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf;AAED,sCAAsC;AACtC,MAAM,WAAW,yCAAyC;IACxD,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAC9B;AAED,yCAAyC;AACzC,MAAM,WAAW,0CAA0C;IACzD,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACxB,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CAChC;AAED,MAAM,WAAW,kDAAkD;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,6CAA6C;IAC5D,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,gBAAgB,EAAE,MAAM,CAAA;IACxB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAA;IACf,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAA;CACb;AAED,yDAAyD;AACzD,MAAM,WAAW,YAAY;IAC3B,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC5B,kDAAkD;IAClD,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC3B,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,8BAA8B;IAC9B,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,CAAA;IACrD,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAA;CAC7C;AAED,4CAA4C;AAC5C,MAAM,WAAW,YAAY;IAC3B,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,2CAA2C;AAC3C,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;IAC7B,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qCAAqC;IACrC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACxB,iCAAiC;IACjC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAA;CACjC;AAED,wCAAwC;AACxC,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAA;IAChB,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,CAAA;IAChB,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAA;IAClB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC9B,8DAA8D;IAC9D,iBAAiB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,OAAO,CAAA;IACjD,gCAAgC;IAChC,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;IAC7B,sCAAsC;IACtC,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;CAChC;AAED,qCAAqC;AACrC,MAAM,WAAW,sCAAsC;IACrD,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAChC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,oCAAoC;AACpC,MAAM,WAAW,uCAAuC;IACtD,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC;AAED,oCAAoC;AACpC,MAAM,WAAW,sCAAsC;IACrD,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAA;CACxD;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAA;IACZ,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,gBAAgB,CAAA;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,kDAAkD;IAClD,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAA;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED,+CAA+C;AAC/C,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B"}
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ /**
3
+ * Auto-generated from OpenAPI spec (v1.0.0).
4
+ * DO NOT EDIT — regenerate with: npx ts-node scripts/generate-types-from-spec.ts
5
+ *
6
+ * These are type-only definitions. Custom client logic lives in src/guard.ts,
7
+ * src/client.ts, src/patches/, and src/integrations/ — those files are never
8
+ * modified by this generator.
9
+ */
10
+ Object.defineProperty(exports, "__esModule", { value: true });
11
+ //# sourceMappingURL=api-types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-types.js","sourceRoot":"","sources":["../../src/generated/api-types.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG"}
package/dist/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const SDK_VERSION = "1.7.0";
1
+ export declare const SDK_VERSION = "1.8.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/dist/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.7.0";
4
+ exports.SDK_VERSION = "1.8.0";
5
5
  //# sourceMappingURL=version.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "promptguard-sdk",
3
- "version": "1.7.1",
3
+ "version": "1.8.0",
4
4
  "description": "Drop-in security for AI applications - AI Firewall SDK with auto-instrumentation",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",