agentid-sdk 0.1.23 → 0.1.25

package/README.md

@@ -99,6 +99,7 @@ const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY! });
 const secured = agent.wrapOpenAI(openai, {
   system_id: process.env.AGENTID_SYSTEM_ID!,
   user_id: "customer-123",
+  expected_languages: ["en"],
 });
 
 const response = await secured.chat.completions.create({
@@ -109,6 +110,8 @@ const response = await secured.chat.completions.create({
 console.log(response.choices[0]?.message?.content ?? "");
 ```
 
+> Scope note: AgentID compliance/risk controls apply to the specific SDK-wrapped LLM calls (`guard()`, `wrapOpenAI()`, LangChain callback-wrapped flows). They do not automatically classify unrelated code paths in your whole monolithic application.
+
 ### LangChain Integration
 
 ```bash
@@ -125,6 +128,7 @@ import { StringOutputParser } from "@langchain/core/output_parsers";
 const agent = new AgentID();
 const handler = new AgentIDCallbackHandler(agent, {
   system_id: process.env.AGENTID_SYSTEM_ID!,
+  expected_languages: ["en"],
 });
 
 const prompt = ChatPromptTemplate.fromTemplate("Answer in one sentence: {question}");
@@ -159,6 +163,27 @@ await agent.log({
 });
 ```
 
+### Transparency Badge (Article 50 UI Evidence)
+
+When rendering disclosure UI, log proof-of-render telemetry so you can demonstrate the end-user actually saw the badge.
+
+```tsx
+import { AgentIDTransparencyBadge } from "agentid-sdk";
+
+<AgentIDTransparencyBadge
+  telemetry={{
+    systemId: process.env.NEXT_PUBLIC_AGENTID_SYSTEM_ID!,
+    // Prefer a backend relay endpoint so no secret key is exposed in browser code.
+    ingestUrl: "/api/agentid/transparency-render",
+    headers: { "x-agentid-system-id": process.env.NEXT_PUBLIC_AGENTID_SYSTEM_ID! },
+    userId: "customer-123",
+  }}
+  placement="chat-header"
+/>;
+```
+
+On mount, the component asynchronously emits `event_type: "transparency_badge_rendered"` to the AgentID ingest endpoint.
+
 ## 6. Advanced Configuration
 
 ### Custom identity / role metadata

package/dist/{agentid-BmsXTOCc.d.mts → agentid-B5Y1g2Ko.d.mts}

@@ -3,7 +3,9 @@ type CapabilityConfig = {
     strict_security_mode: boolean;
     failure_mode: "fail_open" | "fail_close";
     block_on_heuristic: boolean;
+    inject_transparency_metadata: boolean;
     block_pii_leakage: boolean;
+    enable_sdk_pii_masking?: boolean;
     block_db_access: boolean;
     block_code_execution: boolean;
     block_toxicity: boolean;
@@ -15,6 +17,7 @@ interface GuardParams {
     model?: string;
     user_id?: string;
     client_event_id?: string;
+    expected_languages?: string[];
     client_capabilities?: {
         capabilities: {
             has_feedback_handler: boolean;
@@ -30,12 +33,34 @@ interface GuardResponse {
     transformed_input?: string;
     guard_event_id?: string;
     client_event_id?: string;
+    guard_latency_ms?: number;
     shadow_mode?: boolean;
     simulated_decision?: "allowed" | "masked" | "blocked";
+    shadow_blocked?: boolean;
+    policy_pack_matcher_backend?: "rust_wasm" | "js_hybrid" | "legacy_fallback";
+    policy_pack_scan_profile?: "expected_languages" | "auto_detected" | "global_high_priority" | "core_en_fallback";
+    policy_pack_scan_mode?: "full" | "segmented";
+    exotic_language_detected?: boolean;
+    langid_primary?: string;
+    langid_confidence?: "high" | "medium" | "low";
+    langid_secondary?: string[];
+    langid_mixed?: boolean;
+    langid_source?: "input_detection" | "input_detection_with_hint";
+    transparency?: TransparencyMetadata;
+}
+interface TransparencyMetadata {
+    is_ai_generated: true;
+    disclosure: "You are interacting with an AI.";
+    article: "EU_AI_ACT_ARTICLE_50";
+    injection_mode: "deterministic";
 }
 interface RequestOptions {
     apiKey?: string;
 }
+type InjectionScanRequestOptions = RequestOptions & {
+    clientEventId?: string;
+    systemId?: string;
+};
 interface LogParams {
     event_id?: string;
     system_id?: string;
@@ -47,7 +72,7 @@ interface LogParams {
     latency?: number;
     user_id?: string;
     metadata?: Record<string, unknown>;
-    event_type?: "start" | "complete" | "error" | "human_override" | "security_alert" | "security_block" | "security_policy_violation";
+    event_type?: "start" | "complete" | "error" | "human_override" | "security_alert" | "security_block" | "security_policy_violation" | "transparency_badge_rendered";
     severity?: "info" | "warning" | "error" | "high";
     timestamp?: string;
     client_capabilities?: {
@@ -66,6 +91,7 @@ type AgentIDConfig = {
     aiScanEnabled?: boolean;
     storePii?: boolean;
     strictMode?: boolean;
+    failureMode?: "fail_open" | "fail_close";
     guardTimeoutMs?: number;
     ingestTimeoutMs?: number;
 };
@@ -78,14 +104,25 @@ declare class SecurityBlockError extends Error {
     reason: string;
     constructor(reason?: string);
 }
+declare class DependencyError extends Error {
+    dependency: "ingest";
+    reason: string;
+    status: number | null;
+    constructor(params: {
+        dependency: "ingest";
+        reason: string;
+        status: number | null;
+    });
+}
 declare class AgentID {
     private baseUrl;
     private apiKey;
-    private piiMasking;
+    private configuredPiiMasking;
     private checkInjection;
     private aiScanEnabled;
     private storePii;
     private strictMode;
+    private configuredFailureMode;
     private guardTimeoutMs;
     private ingestTimeoutMs;
     private pii;
@@ -93,6 +130,9 @@ declare class AgentID {
     private injectionScanner;
     private recentGuardVerdicts;
     constructor(config?: AgentIDConfig);
+    get piiMasking(): boolean | undefined;
+    private resolveEffectivePiiMasking;
+    getEffectivePiiMasking(options?: RequestOptions): boolean;
     private buildClientCapabilities;
     private resolveApiKey;
     private resolveClientEventId;
@@ -102,6 +142,7 @@ declare class AgentID {
     getCapabilityConfig(force?: boolean, options?: RequestOptions): Promise<CapabilityConfig>;
     private getCachedCapabilityConfig;
     private resolveEffectiveStrictMode;
+    private maybeRaiseStrictIngestDependencyError;
     private shouldRunLocalInjectionScan;
     prepareInputForDispatch(params: {
         input: string;
@@ -109,7 +150,7 @@ declare class AgentID {
         stream: boolean;
         skipInjectionScan?: boolean;
     }, options?: RequestOptions): Promise<PreparedInput>;
-    scanPromptInjection(input: string, options?: RequestOptions): Promise<void>;
+    scanPromptInjection(input: string, options?: InjectionScanRequestOptions): Promise<void>;
     private withMaskedOpenAIRequest;
     private logSecurityPolicyViolation;
     private logGuardFallback;
@@ -144,10 +185,12 @@ declare class AgentID {
     wrapOpenAI<T>(openai: T, options: {
         system_id: string;
         user_id?: string;
+        expected_languages?: string[];
+        expectedLanguages?: string[];
         apiKey?: string;
         api_key?: string;
         resolveApiKey?: (request: Record<string, unknown>) => string | undefined;
     }): T;
 }
 
-export { AgentID as A, type GuardParams as G, type LogParams as L, type PreparedInput as P, type RequestOptions as R, SecurityBlockError as S, type GuardResponse as a };
+export { AgentID as A, DependencyError as D, type GuardParams as G, type LogParams as L, type PreparedInput as P, type RequestOptions as R, SecurityBlockError as S, type TransparencyMetadata as T, type GuardResponse as a };

package/dist/{agentid-BmsXTOCc.d.ts → agentid-B5Y1g2Ko.d.ts}

@@ -3,7 +3,9 @@ type CapabilityConfig = {
     strict_security_mode: boolean;
     failure_mode: "fail_open" | "fail_close";
     block_on_heuristic: boolean;
+    inject_transparency_metadata: boolean;
     block_pii_leakage: boolean;
+    enable_sdk_pii_masking?: boolean;
     block_db_access: boolean;
     block_code_execution: boolean;
     block_toxicity: boolean;
@@ -15,6 +17,7 @@ interface GuardParams {
     model?: string;
     user_id?: string;
     client_event_id?: string;
+    expected_languages?: string[];
     client_capabilities?: {
         capabilities: {
             has_feedback_handler: boolean;
@@ -30,12 +33,34 @@ interface GuardResponse {
     transformed_input?: string;
     guard_event_id?: string;
     client_event_id?: string;
+    guard_latency_ms?: number;
     shadow_mode?: boolean;
     simulated_decision?: "allowed" | "masked" | "blocked";
+    shadow_blocked?: boolean;
+    policy_pack_matcher_backend?: "rust_wasm" | "js_hybrid" | "legacy_fallback";
+    policy_pack_scan_profile?: "expected_languages" | "auto_detected" | "global_high_priority" | "core_en_fallback";
+    policy_pack_scan_mode?: "full" | "segmented";
+    exotic_language_detected?: boolean;
+    langid_primary?: string;
+    langid_confidence?: "high" | "medium" | "low";
+    langid_secondary?: string[];
+    langid_mixed?: boolean;
+    langid_source?: "input_detection" | "input_detection_with_hint";
+    transparency?: TransparencyMetadata;
+}
+interface TransparencyMetadata {
+    is_ai_generated: true;
+    disclosure: "You are interacting with an AI.";
+    article: "EU_AI_ACT_ARTICLE_50";
+    injection_mode: "deterministic";
 }
 interface RequestOptions {
     apiKey?: string;
 }
+type InjectionScanRequestOptions = RequestOptions & {
+    clientEventId?: string;
+    systemId?: string;
+};
 interface LogParams {
     event_id?: string;
     system_id?: string;
@@ -47,7 +72,7 @@ interface LogParams {
     latency?: number;
     user_id?: string;
     metadata?: Record<string, unknown>;
-    event_type?: "start" | "complete" | "error" | "human_override" | "security_alert" | "security_block" | "security_policy_violation";
+    event_type?: "start" | "complete" | "error" | "human_override" | "security_alert" | "security_block" | "security_policy_violation" | "transparency_badge_rendered";
     severity?: "info" | "warning" | "error" | "high";
     timestamp?: string;
     client_capabilities?: {
@@ -66,6 +91,7 @@ type AgentIDConfig = {
     aiScanEnabled?: boolean;
     storePii?: boolean;
     strictMode?: boolean;
+    failureMode?: "fail_open" | "fail_close";
     guardTimeoutMs?: number;
     ingestTimeoutMs?: number;
 };
@@ -78,14 +104,25 @@ declare class SecurityBlockError extends Error {
     reason: string;
     constructor(reason?: string);
 }
+declare class DependencyError extends Error {
+    dependency: "ingest";
+    reason: string;
+    status: number | null;
+    constructor(params: {
+        dependency: "ingest";
+        reason: string;
+        status: number | null;
+    });
+}
 declare class AgentID {
     private baseUrl;
     private apiKey;
-    private piiMasking;
+    private configuredPiiMasking;
     private checkInjection;
     private aiScanEnabled;
     private storePii;
     private strictMode;
+    private configuredFailureMode;
     private guardTimeoutMs;
     private ingestTimeoutMs;
     private pii;
@@ -93,6 +130,9 @@ declare class AgentID {
     private injectionScanner;
     private recentGuardVerdicts;
     constructor(config?: AgentIDConfig);
+    get piiMasking(): boolean | undefined;
+    private resolveEffectivePiiMasking;
+    getEffectivePiiMasking(options?: RequestOptions): boolean;
     private buildClientCapabilities;
     private resolveApiKey;
     private resolveClientEventId;
@@ -102,6 +142,7 @@ declare class AgentID {
     getCapabilityConfig(force?: boolean, options?: RequestOptions): Promise<CapabilityConfig>;
     private getCachedCapabilityConfig;
     private resolveEffectiveStrictMode;
+    private maybeRaiseStrictIngestDependencyError;
     private shouldRunLocalInjectionScan;
     prepareInputForDispatch(params: {
         input: string;
@@ -109,7 +150,7 @@ declare class AgentID {
         stream: boolean;
         skipInjectionScan?: boolean;
     }, options?: RequestOptions): Promise<PreparedInput>;
-    scanPromptInjection(input: string, options?: RequestOptions): Promise<void>;
+    scanPromptInjection(input: string, options?: InjectionScanRequestOptions): Promise<void>;
     private withMaskedOpenAIRequest;
     private logSecurityPolicyViolation;
     private logGuardFallback;
@@ -144,10 +185,12 @@ declare class AgentID {
     wrapOpenAI<T>(openai: T, options: {
         system_id: string;
         user_id?: string;
+        expected_languages?: string[];
+        expectedLanguages?: string[];
         apiKey?: string;
         api_key?: string;
         resolveApiKey?: (request: Record<string, unknown>) => string | undefined;
     }): T;
 }
 
-export { AgentID as A, type GuardParams as G, type LogParams as L, type PreparedInput as P, type RequestOptions as R, SecurityBlockError as S, type GuardResponse as a };
+export { AgentID as A, DependencyError as D, type GuardParams as G, type LogParams as L, type PreparedInput as P, type RequestOptions as R, SecurityBlockError as S, type TransparencyMetadata as T, type GuardResponse as a };