@koreshield/koreshield 0.1.4

package/dist/index.d.mts

@@ -0,0 +1,201 @@
+/**
+ * KoreShield JavaScript/TypeScript SDK Types
+ */
+interface KoreShieldConfig {
+    /** KoreShield proxy base URL */
+    baseURL: string;
+    /** API key for authentication (optional, can be set via environment) */
+    apiKey?: string;
+    /** Request timeout in milliseconds */
+    timeout?: number;
+    /** Enable debug logging */
+    debug?: boolean;
+    /** Custom headers to include in all requests */
+    headers?: Record<string, string>;
+}
+interface SecurityOptions {
+    /** Sensitivity level: 'low', 'medium', 'high' */
+    sensitivity?: 'low' | 'medium' | 'high';
+    /** Action on detection: 'allow', 'warn', 'block' */
+    defaultAction?: 'allow' | 'warn' | 'block';
+    /** Enable/disable specific security features */
+    features?: {
+        sanitization?: boolean;
+        detection?: boolean;
+        policyEnforcement?: boolean;
+    };
+}
+interface ChatCompletionRequest {
+    model: string;
+    messages: Array<{
+        role: 'system' | 'user' | 'assistant';
+        content: string;
+    }>;
+    temperature?: number;
+    max_tokens?: number;
+    top_p?: number;
+    frequency_penalty?: number;
+    presence_penalty?: number;
+    stop?: string | string[];
+    stream?: boolean;
+    [key: string]: any;
+}
+interface ChatCompletionResponse {
+    id: string;
+    object: string;
+    created: number;
+    model: string;
+    choices: Array<{
+        index: number;
+        message: {
+            role: string;
+            content: string;
+        };
+        finish_reason: string;
+    }>;
+    usage: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    };
+}
+interface SecurityEvent {
+    id: string;
+    timestamp: string;
+    type: 'attack_detected' | 'request_blocked' | 'sanitization_applied';
+    severity: 'low' | 'medium' | 'high' | 'critical';
+    description: string;
+    details?: Record<string, any>;
+    requestId?: string;
+}
+interface MetricsResponse {
+    requests_total: number;
+    requests_blocked: number;
+    attacks_detected: number;
+    avg_response_time: number;
+    active_connections: number;
+    uptime_seconds: number;
+}
+interface KoreShieldError extends Error {
+    code: string;
+    statusCode?: number;
+    details?: Record<string, any>;
+}
+type ProviderType = 'openai' | 'anthropic' | 'deepseek' | 'gemini' | 'azure';
+interface ProviderConfig {
+    type: ProviderType;
+    apiKey?: string;
+    baseURL?: string;
+    organization?: string;
+    project?: string;
+}
+
+/**
+ * KoreShield Core Client
+ */
+
+declare class KoreShieldClient {
+    private client;
+    private config;
+    constructor(config: KoreShieldConfig);
+    /**
+     * Create a chat completion request through KoreShield
+     */
+    createChatCompletion(request: ChatCompletionRequest, securityOptions?: SecurityOptions): Promise<ChatCompletionResponse>;
+    /**
+     * Get security events/logs
+     */
+    getSecurityEvents(limit?: number, offset?: number, type?: string, severity?: string): Promise<SecurityEvent[]>;
+    /**
+     * Get metrics and statistics
+     */
+    getMetrics(): Promise<MetricsResponse>;
+    /**
+     * Get Prometheus metrics in text format
+     */
+    getPrometheusMetrics(): Promise<string>;
+    /**
+     * Health check
+     */
+    health(): Promise<{
+        status: string;
+        version: string;
+        uptime: number;
+    }>;
+    /**
+     * Update security configuration
+     */
+    updateSecurityConfig(options: SecurityOptions): Promise<void>;
+    /**
+     * Test connection to KoreShield
+     */
+    testConnection(): Promise<boolean>;
+    private handleError;
+}
+
+declare class KoreShieldOpenAI {
+    private client;
+    constructor(config: KoreShieldConfig);
+    /**
+     * Chat completions API (OpenAI-compatible)
+     */
+    chat(_completions: any): Promise<{
+        create: (request: ChatCompletionRequest, securityOptions?: SecurityOptions) => Promise<ChatCompletionResponse>;
+    }>;
+    /**
+     * Get underlying KoreShield client for advanced operations
+     */
+    getClient(): KoreShieldClient;
+}
+/**
+ * Factory function to create OpenAI-compatible instance
+ */
+declare function createKoreShieldOpenAI(config: KoreShieldConfig): KoreShieldOpenAI;
+
+/**
+ * KoreShield Utility Functions
+ */
+
+/**
+ * Validate KoreShield configuration
+ */
+declare function validateConfig(config: KoreShieldConfig): {
+    valid: boolean;
+    errors: string[];
+};
+/**
+ * Create a KoreShield client with environment variable defaults
+ */
+declare function createClient(config?: Partial<KoreShieldConfig>): KoreShieldClient;
+/**
+ * Sanitize user input for safe LLM processing
+ */
+declare function sanitizeInput(input: string): string;
+/**
+ * Check if a response contains potentially unsafe content
+ */
+declare function checkResponseSafety(response: string): {
+    safe: boolean;
+    issues: string[];
+    severity: 'low' | 'medium' | 'high';
+};
+/**
+ * Format chat messages for KoreShield
+ */
+declare function formatMessages(messages: Array<{
+    role: string;
+    content: string;
+}>): {
+    role: string;
+    content: string;
+}[];
+/**
+ * Sleep utility for rate limiting
+ */
+declare function sleep(ms: number): Promise<void>;
+/**
+ * Retry utility with exponential backoff
+ */
+declare function retry<T>(fn: () => Promise<T>, maxRetries?: number, baseDelay?: number): Promise<T>;
+
+export { ChatCompletionRequest, ChatCompletionResponse, KoreShieldClient, KoreShieldConfig, KoreShieldError, KoreShieldOpenAI, MetricsResponse, ProviderConfig, ProviderType, SecurityEvent, SecurityOptions, checkResponseSafety, createClient, createKoreShieldOpenAI, KoreShieldClient as default, formatMessages, retry, sanitizeInput, sleep, validateConfig };

package/dist/index.d.ts

@@ -0,0 +1,201 @@
+/**
+ * KoreShield JavaScript/TypeScript SDK Types
+ */
+interface KoreShieldConfig {
+    /** KoreShield proxy base URL */
+    baseURL: string;
+    /** API key for authentication (optional, can be set via environment) */
+    apiKey?: string;
+    /** Request timeout in milliseconds */
+    timeout?: number;
+    /** Enable debug logging */
+    debug?: boolean;
+    /** Custom headers to include in all requests */
+    headers?: Record<string, string>;
+}
+interface SecurityOptions {
+    /** Sensitivity level: 'low', 'medium', 'high' */
+    sensitivity?: 'low' | 'medium' | 'high';
+    /** Action on detection: 'allow', 'warn', 'block' */
+    defaultAction?: 'allow' | 'warn' | 'block';
+    /** Enable/disable specific security features */
+    features?: {
+        sanitization?: boolean;
+        detection?: boolean;
+        policyEnforcement?: boolean;
+    };
+}
+interface ChatCompletionRequest {
+    model: string;
+    messages: Array<{
+        role: 'system' | 'user' | 'assistant';
+        content: string;
+    }>;
+    temperature?: number;
+    max_tokens?: number;
+    top_p?: number;
+    frequency_penalty?: number;
+    presence_penalty?: number;
+    stop?: string | string[];
+    stream?: boolean;
+    [key: string]: any;
+}
+interface ChatCompletionResponse {
+    id: string;
+    object: string;
+    created: number;
+    model: string;
+    choices: Array<{
+        index: number;
+        message: {
+            role: string;
+            content: string;
+        };
+        finish_reason: string;
+    }>;
+    usage: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    };
+}
+interface SecurityEvent {
+    id: string;
+    timestamp: string;
+    type: 'attack_detected' | 'request_blocked' | 'sanitization_applied';
+    severity: 'low' | 'medium' | 'high' | 'critical';
+    description: string;
+    details?: Record<string, any>;
+    requestId?: string;
+}
+interface MetricsResponse {
+    requests_total: number;
+    requests_blocked: number;
+    attacks_detected: number;
+    avg_response_time: number;
+    active_connections: number;
+    uptime_seconds: number;
+}
+interface KoreShieldError extends Error {
+    code: string;
+    statusCode?: number;
+    details?: Record<string, any>;
+}
+type ProviderType = 'openai' | 'anthropic' | 'deepseek' | 'gemini' | 'azure';
+interface ProviderConfig {
+    type: ProviderType;
+    apiKey?: string;
+    baseURL?: string;
+    organization?: string;
+    project?: string;
+}
+
+/**
+ * KoreShield Core Client
+ */
+
+declare class KoreShieldClient {
+    private client;
+    private config;
+    constructor(config: KoreShieldConfig);
+    /**
+     * Create a chat completion request through KoreShield
+     */
+    createChatCompletion(request: ChatCompletionRequest, securityOptions?: SecurityOptions): Promise<ChatCompletionResponse>;
+    /**
+     * Get security events/logs
+     */
+    getSecurityEvents(limit?: number, offset?: number, type?: string, severity?: string): Promise<SecurityEvent[]>;
+    /**
+     * Get metrics and statistics
+     */
+    getMetrics(): Promise<MetricsResponse>;
+    /**
+     * Get Prometheus metrics in text format
+     */
+    getPrometheusMetrics(): Promise<string>;
+    /**
+     * Health check
+     */
+    health(): Promise<{
+        status: string;
+        version: string;
+        uptime: number;
+    }>;
+    /**
+     * Update security configuration
+     */
+    updateSecurityConfig(options: SecurityOptions): Promise<void>;
+    /**
+     * Test connection to KoreShield
+     */
+    testConnection(): Promise<boolean>;
+    private handleError;
+}
+
+declare class KoreShieldOpenAI {
+    private client;
+    constructor(config: KoreShieldConfig);
+    /**
+     * Chat completions API (OpenAI-compatible)
+     */
+    chat(_completions: any): Promise<{
+        create: (request: ChatCompletionRequest, securityOptions?: SecurityOptions) => Promise<ChatCompletionResponse>;
+    }>;
+    /**
+     * Get underlying KoreShield client for advanced operations
+     */
+    getClient(): KoreShieldClient;
+}
+/**
+ * Factory function to create OpenAI-compatible instance
+ */
+declare function createKoreShieldOpenAI(config: KoreShieldConfig): KoreShieldOpenAI;
+
+/**
+ * KoreShield Utility Functions
+ */
+
+/**
+ * Validate KoreShield configuration
+ */
+declare function validateConfig(config: KoreShieldConfig): {
+    valid: boolean;
+    errors: string[];
+};
+/**
+ * Create a KoreShield client with environment variable defaults
+ */
+declare function createClient(config?: Partial<KoreShieldConfig>): KoreShieldClient;
+/**
+ * Sanitize user input for safe LLM processing
+ */
+declare function sanitizeInput(input: string): string;
+/**
+ * Check if a response contains potentially unsafe content
+ */
+declare function checkResponseSafety(response: string): {
+    safe: boolean;
+    issues: string[];
+    severity: 'low' | 'medium' | 'high';
+};
+/**
+ * Format chat messages for KoreShield
+ */
+declare function formatMessages(messages: Array<{
+    role: string;
+    content: string;
+}>): {
+    role: string;
+    content: string;
+}[];
+/**
+ * Sleep utility for rate limiting
+ */
+declare function sleep(ms: number): Promise<void>;
+/**
+ * Retry utility with exponential backoff
+ */
+declare function retry<T>(fn: () => Promise<T>, maxRetries?: number, baseDelay?: number): Promise<T>;
+
+export { ChatCompletionRequest, ChatCompletionResponse, KoreShieldClient, KoreShieldConfig, KoreShieldError, KoreShieldOpenAI, MetricsResponse, ProviderConfig, ProviderType, SecurityEvent, SecurityOptions, checkResponseSafety, createClient, createKoreShieldOpenAI, KoreShieldClient as default, formatMessages, retry, sanitizeInput, sleep, validateConfig };