@silmaril-security/sdk 0.3.1 → 0.4.2

package/dist/index.d.ts

@@ -1,147 +1,5 @@
-import { BaseCallbackHandler } from '@langchain/core/callbacks/base';
-
-declare const HookLabel: {
-    readonly USER_INPUT: "user_input";
-    readonly SYSTEM_PROMPT: "system_prompt";
-    readonly TOOL_CALL: "tool_call";
-    readonly TOOL_RESPONSE: "tool_response";
-    readonly LLM_OUTPUT: "llm_output";
-    readonly UNKNOWN: "unknown";
-};
-type HookLabel = (typeof HookLabel)[keyof typeof HookLabel];
-declare const FirewallHook: {
-    readonly LLM_START: "on_llm_start";
-    readonly CHAT_MODEL_START: "on_chat_model_start";
-    readonly TOOL_START: "on_tool_start";
-    readonly RETRIEVER_START: "on_retriever_start";
-    readonly LLM_END: "on_llm_end";
-    readonly TOOL_END: "on_tool_end";
-    readonly RETRIEVER_END: "on_retriever_end";
-};
-type FirewallHook = (typeof FirewallHook)[keyof typeof FirewallHook];
-declare const DEFAULT_HOOKS: ReadonlySet<FirewallHook>;
-declare const INPUT_HOOKS: ReadonlySet<FirewallHook>;
-declare const OUTPUT_HOOKS: ReadonlySet<FirewallHook>;
-declare const ALL_HOOKS: ReadonlySet<FirewallHook>;
-declare const FIREWALL_HOOK_TO_LABEL: Readonly<Record<FirewallHook, HookLabel>>;
-declare function resolveHooks(hooks: Iterable<FirewallHook | string> | undefined): ReadonlySet<FirewallHook>;
-declare function prependHook(text: string, hook: HookLabel | string | undefined | null): string;
-declare function prependToolName(text: string, toolName: string | undefined | null): string;
-
-type Prediction = "BENIGN" | "MALICIOUS";
-interface BlockResult {
-    readonly prediction: Prediction;
-    readonly score: number;
-    readonly threshold: number;
-    readonly primaryOutcome?: string;
-    readonly outcomeScores?: Readonly<Record<string, number>>;
-    readonly detectorScores?: Readonly<Record<string, number>>;
-    readonly detectorCounts?: Readonly<Record<string, number>>;
-}
-interface FirewallOptions {
-    apiKey: string;
-    apiUrl: string;
-    timeoutMs?: number;
-    chunkConcurrency?: number;
-    shadowMode?: boolean;
-}
-type ClassificationMetadata = Readonly<Record<string, unknown>>;
-interface ClassifyOptions {
-    hook?: HookLabel;
-    toolName?: string;
-    metadata?: ClassificationMetadata;
-}
-interface ClassifyBatchOptions {
-    hooks?: readonly HookLabel[];
-    toolNames?: readonly (string | undefined)[];
-    metadata?: readonly (ClassificationMetadata | undefined)[];
-}
-interface LangChainAdapterOptions {
-    hooks?: ReadonlySet<FirewallHook>;
-    includeSystem?: boolean;
-    includeTool?: boolean;
-    failOpen?: boolean;
-    logger?: (message: string, error: unknown) => void;
-    shadowMode?: boolean;
-    onClassify?: (event: ClassifyEvent) => void;
-}
-interface ClassifyEvent {
-    readonly hook: HookLabel;
-    readonly toolName?: string;
-    readonly text: string;
-    readonly result: BlockResult;
-    readonly blocked: boolean;
-    readonly shadowMode: boolean;
-}
-interface MiddlewareOptions {
-    scanInput?: boolean;
-    scanOutput?: boolean;
-    scanToolCalls?: boolean;
-    shadowMode?: boolean;
-    onBlocked?: (err: Error) => void;
-    onClassify?: (event: ClassifyEvent) => void;
-}
-
-interface VercelContentPart {
-    type?: string;
-    text?: string;
-    toolCallId?: string;
-    toolName?: string;
-    args?: unknown;
-    result?: unknown;
-}
-interface VercelPromptMessage {
-    role: string;
-    content: string | ReadonlyArray<VercelContentPart | string>;
-}
-interface VercelToolCall {
-    toolCallType?: string;
-    toolCallId?: string;
-    toolName?: string;
-    args?: unknown;
-}
-interface VercelGenerateResult {
-    text?: string;
-    toolCalls?: ReadonlyArray<VercelToolCall>;
-}
-interface WrapGenerateArgs<TResult extends VercelGenerateResult & Record<string, unknown>> {
-    params: {
-        prompt: ReadonlyArray<VercelPromptMessage>;
-    } & Record<string, unknown>;
-    doGenerate: () => PromiseLike<TResult>;
-}
-interface WrapStreamArgs<TResult extends {
-    stream: ReadableStream<unknown>;
-} & Record<string, unknown>> {
-    params: {
-        prompt: ReadonlyArray<VercelPromptMessage>;
-    } & Record<string, unknown>;
-    doStream: () => PromiseLike<TResult>;
-}
-interface FirewallMiddleware {
-    wrapGenerate: <TResult extends VercelGenerateResult & Record<string, unknown>>(args: WrapGenerateArgs<TResult>) => Promise<TResult>;
-    wrapStream: <TResult extends {
-        stream: ReadableStream<unknown>;
-    } & Record<string, unknown>>(args: WrapStreamArgs<TResult>) => Promise<TResult>;
-}
-
-declare const DEFAULT_TIMEOUT_MS = 10000;
-declare const DEFAULT_CHUNK_CONCURRENCY = 8;
-declare class Firewall {
-    readonly apiKey: string;
-    readonly apiUrl: string;
-    readonly timeoutMs: number;
-    readonly chunkConcurrency: number;
-    readonly shadowMode: boolean;
-    private readonly headers;
-    constructor(options: FirewallOptions);
-    classify(text: string, options?: ClassifyOptions): Promise<BlockResult>;
-    classifyBatch(texts: readonly string[], options?: ClassifyBatchOptions): Promise<BlockResult[]>;
-    asLangChainHandler(options?: LangChainAdapterOptions): Promise<BaseCallbackHandler>;
-    asMiddleware(options?: MiddlewareOptions): FirewallMiddleware;
-    private postWithRetry;
-    private classifySingleChunk;
-}
+import { H as HookLabel, B as BlockResult } from './firewall-DfZCCDU6.js';
+export { A as ALL_HOOKS, C as ClassificationMetadata, a as ClassifyBatchOptions, b as ClassifyEvent, c as ClassifyOptions, D as DEFAULT_CHUNK_CONCURRENCY, d as DEFAULT_HOOKS, e as DEFAULT_TIMEOUT_MS, F as FIREWALL_HOOK_TO_LABEL, f as Firewall, g as FirewallHook, h as FirewallMiddleware, i as FirewallOptions, j as HARMFUL_OUTCOMES, k as HarmfulOutcome, I as INPUT_HOOKS, K as KnownHarmfulOutcome, l as KnownPrimaryOutcome, L as LangChainAdapterOptions, m as LangChainFirewallHandler, M as MiddlewareOptions, O as OUTCOME_DESCRIPTIONS, n as OUTPUT_HOOKS, o as Outcome, P as PRIMARY_OUTCOMES, p as Prediction, q as PrimaryOutcome, U as UnknownOutcome, r as isHarmfulOutcome, s as isPrimaryOutcome, t as normalizeHarmfulOutcome, u as normalizeHarmfulOutcomeMap, v as normalizePrimaryOutcome, w as prependHook, x as prependToolName, y as resolveHooks } from './firewall-DfZCCDU6.js';
 
 interface MalformedInputDetails {
     field?: string;
@@ -151,19 +9,31 @@ interface MalformedInputDetails {
     codePoint?: string;
     reason?: string;
 }
-declare class PromptBlockedException extends Error {
+declare class FirewallBlockedException extends Error {
     readonly score: number;
     readonly threshold: number;
     readonly promptText: string;
     readonly runId: string | undefined;
+    readonly hook: HookLabel | undefined;
+    readonly toolName: string | undefined;
+    readonly toolCallId: string | undefined;
+    readonly result: BlockResult | undefined;
     constructor(params: {
         score: number;
         threshold: number;
         promptText: string;
         runId?: string;
+        hook?: HookLabel;
+        toolName?: string;
+        toolCallId?: string;
+        result?: BlockResult;
     });
     private static formatMessage;
 }
+/** @deprecated Use FirewallBlockedException instead. */
+declare const PromptBlockedException: typeof FirewallBlockedException;
+/** @deprecated Use FirewallBlockedException instead. */
+type PromptBlockedException = FirewallBlockedException;
 declare class SilmarilApiError extends Error {
     readonly status: number;
     readonly statusText: string;
@@ -190,4 +60,4 @@ declare const CHUNK_OVERLAP_CHARS: number;
 declare function sanitizeText(text: string): string;
 declare function chunkText(text: string): string[];
 
-export { ALL_HOOKS, type BlockResult, CHUNK_OVERLAP, CHUNK_OVERLAP_CHARS, CHUNK_WINDOW, CHUNK_WINDOW_CHARS, type ClassificationMetadata, type ClassifyBatchOptions, type ClassifyEvent, type ClassifyOptions, DEFAULT_CHUNK_CONCURRENCY, DEFAULT_HOOKS, DEFAULT_TIMEOUT_MS, FIREWALL_HOOK_TO_LABEL, Firewall, FirewallHook, type FirewallMiddleware, type FirewallOptions, HookLabel, INPUT_HOOKS, type LangChainAdapterOptions, MAX_INPUT_CHARS, MAX_INPUT_TOKENS, type MalformedInputDetails, type MiddlewareOptions, OUTPUT_HOOKS, type Prediction, PromptBlockedException, SilmarilApiError, chunkText, prependHook, prependToolName, resolveHooks, sanitizeText };
+export { BlockResult, CHUNK_OVERLAP, CHUNK_OVERLAP_CHARS, CHUNK_WINDOW, CHUNK_WINDOW_CHARS, FirewallBlockedException, HookLabel, MAX_INPUT_CHARS, MAX_INPUT_TOKENS, type MalformedInputDetails, PromptBlockedException, SilmarilApiError, chunkText, sanitizeText };