guardrail-plug-sdk 1.0.0

package/dist/Guardrail.d.ts

@@ -0,0 +1,20 @@
+import { SDKChatRequest, SDKChatResponse } from './types.js';
+export interface GuardrailOptions {
+    endpoint?: string;
+    apiKey: string;
+    provider?: 'openai' | 'gemini' | 'ollama' | 'mock' | string;
+    model?: string;
+    applicationName?: string;
+}
+export declare class Guardrail {
+    private endpoint;
+    private apiKey;
+    private provider;
+    private model;
+    private applicationName;
+    constructor(options: GuardrailOptions);
+    /**
+     * Routes chat completions through the Guardrail Middleware Gateway
+     */
+    chat(request: SDKChatRequest): Promise<SDKChatResponse>;
+}

package/dist/Guardrail.js

@@ -0,0 +1,49 @@
+export class Guardrail {
+    endpoint;
+    apiKey;
+    provider;
+    model;
+    applicationName;
+    constructor(options) {
+        this.endpoint = options.endpoint || 'http://localhost:5050';
+        this.apiKey = options.apiKey;
+        this.provider = options.provider || 'openai';
+        this.model = options.model || 'gpt-4o-mini';
+        this.applicationName = options.applicationName || 'SDK Application';
+        if (!this.apiKey) {
+            throw new Error('[Guardrail SDK] Initialisation Error: API Key (apiKey) is required.');
+        }
+    }
+    /**
+     * Routes chat completions through the Guardrail Middleware Gateway
+     */
+    async chat(request) {
+        try {
+            const response = await fetch(`${this.endpoint}/api/chat`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    'Authorization': `Bearer ${this.apiKey}`
+                },
+                body: JSON.stringify({
+                    messages: request.messages,
+                    userId: request.userId || 'sdk_user',
+                    sessionId: request.sessionId || 'sdk_session',
+                    provider: request.provider || this.provider,
+                    model: request.model || this.model,
+                    applicationName: request.applicationName || this.applicationName,
+                    metadata: request.metadata || {}
+                })
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                throw new Error(`Guardrail Middleware Error [${response.status}]: ${errorText}`);
+            }
+            return await response.json();
+        }
+        catch (err) {
+            console.error('[Guardrail SDK] Chat Request Failed:', err.message);
+            throw err;
+        }
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Guardrail.js';
+export * from './types.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './Guardrail.js';
+export * from './types.js';

package/dist/types.d.ts

@@ -0,0 +1,87 @@
+export interface Message {
+    role: 'user' | 'assistant' | 'system';
+    content: string;
+}
+export interface SDKChatRequest {
+    messages: Message[];
+    userId?: string;
+    sessionId?: string;
+    provider?: string;
+    model?: string;
+    applicationName?: string;
+    metadata?: Record<string, any>;
+    groundingSource?: 'kb' | 'web';
+}
+export interface Citation {
+    citationId: string;
+    documentId: string;
+    documentName: string;
+    content: string;
+    score: number;
+}
+export interface Claim {
+    claim: string;
+    status: 'SUPPORTED' | 'PARTIALLY_SUPPORTED' | 'UNSUPPORTED';
+    explanation: string;
+    citationId?: string;
+}
+export interface PolicyResult {
+    decision: 'APPROVED' | 'FLAGGED' | 'BLOCKED';
+    violatedRules: string[];
+    explanation: string;
+}
+export interface TokenUsage {
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+}
+export interface Metrics {
+    totalLatencyMs: number;
+    llmLatencyMs: number;
+    ragLatencyMs: number;
+    verificationLatencyMs: number;
+    tokenUsage: TokenUsage;
+    costUsd: number;
+}
+export interface SDKChatResponse {
+    auditId: string;
+    text: string;
+    decision: 'APPROVED' | 'FLAGGED' | 'BLOCKED';
+    hallucinationScore: number;
+    factualTrustScore: number;
+    riskLevel: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    citations: Citation[];
+    claims: Claim[];
+    policyExplanation: string;
+    metrics: Metrics;
+    rawThinking?: string;
+    thinkingClaims?: Claim[];
+    rawResponseBeforeBlock?: string;
+}
+export interface UploadedDocument {
+    id: string;
+    name: string;
+    type: string;
+    uploadedAt: string;
+    size: number;
+    status: 'indexing' | 'indexed' | 'failed';
+    version: number;
+    owner?: string;
+}
+export interface DocumentChunk {
+    id: string;
+    documentId: string;
+    documentName: string;
+    content: string;
+    embedding?: number[];
+    metadata?: Record<string, any>;
+}
+export interface ProviderConfig {
+    providerId: string;
+    name: string;
+    enabled: boolean;
+    defaultModel: string;
+    apiKey?: string;
+    healthStatus: 'healthy' | 'unhealthy' | 'unknown';
+    latency: number;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "guardrail-plug-sdk",
+  "version": "1.0.0",
+  "description": "A plug-and-play AI Auditing & Hallucination Detection SDK. Intercepts LLM inputs/outputs, verifies factual grounding against your knowledge base, and blocks or flags unverified responses.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sharma-10-personal/ai-authentication-plugin.git"
+  },
+  "keywords": [
+    "ai",
+    "guardrail",
+    "hallucination",
+    "auditing",
+    "middleware",
+    "llm",
+    "gemini",
+    "openai",
+    "rag",
+    "fact-checking",
+    "trust-score",
+    "policy-engine",
+    "sdk"
+  ],
+  "author": "Sharma S S <sharmas@wekancode.com>",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/sharma-10-personal/ai-authentication-plugin/issues"
+  },
+  "homepage": "https://github.com/sharma-10-personal/ai-authentication-plugin#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^20.11.24",
+    "typescript": "^5.3.3"
+  }
+}