@juspay/neurolink 7.48.1 → 7.50.0

package/dist/middleware/utils/guardrailsUtils.d.ts

@@ -0,0 +1,64 @@
+import type { PrecallEvaluationResult, PrecallEvaluationConfig, EvaluationActionResult, BadWordsConfig } from "../../types/guardrails.js";
+import type { LanguageModelV1CallOptions } from "ai";
+export declare const DEFAULT_EVALUATION_PROMPT = "\nEvaluate the following user input for safety and appropriateness. Respond ONLY with valid JSON:\n\n{\n  \"overall\": \"safe|unsafe|suspicious|inappropriate\",\n  \"safetyScore\": <1-10>,\n  \"appropriatenessScore\": <1-10>,\n  \"confidenceLevel\": <1-10>,\n  \"issues\": [\n    {\n      \"category\": \"explicit_content|hate_speech|violence|personal_info|spam|other\",\n      \"severity\": \"low|medium|high|critical\",\n      \"description\": \"Brief description\"\n    }\n  ],\n  \"suggestedAction\": \"allow|block|sanitize|warn\",\n  \"reasoning\": \"Brief explanation\"\n}\n\nUser Input: \"{USER_INPUT}\"\n";
+/**
+ * Extract user input from LanguageModelV1CallOptions
+ */
+export declare function extractUserInput(params: LanguageModelV1CallOptions): string;
+export declare function parseEvaluationResponse(rawResponse: string): PrecallEvaluationResult;
+/**
+ * Handles the precall guardrails logic, including evaluation and sanitization.
+ * @param params - The language model call options.
+ * @param config - The precall evaluation configuration.
+ * @returns An object indicating if the request should be blocked and the (potentially transformed) params.
+ */
+export declare function handlePrecallGuardrails(params: LanguageModelV1CallOptions, config: PrecallEvaluationConfig): Promise<{
+    shouldBlock: boolean;
+    transformedParams: LanguageModelV1CallOptions;
+}>;
+/**
+ * Perform precall evaluation of user input using AI models
+ */
+export declare function performPrecallEvaluation(config: PrecallEvaluationConfig, userInput: string): Promise<PrecallEvaluationResult>;
+export declare function applyEvaluationActions(evaluation: PrecallEvaluationResult, config: PrecallEvaluationConfig, userInput: string): EvaluationActionResult;
+/**
+ * Apply parameter sanitization to request parameters
+ */
+export declare function applySanitization(params: LanguageModelV1CallOptions, sanitizedInput: string): LanguageModelV1CallOptions;
+export declare function escapeRegExp(string: string): string;
+export declare function createBlockedResponse(): {
+    text: string;
+    usage: {
+        promptTokens: number;
+        completionTokens: number;
+    };
+    finishReason: "stop";
+    warnings: never[];
+    rawCall: {
+        rawPrompt: null;
+        rawSettings: {};
+    };
+};
+export declare function createBlockedStream(): ReadableStream<any>;
+/**
+ * Result from content filtering operation
+ */
+export interface ContentFilteringResult {
+    filteredText: string;
+    hasChanges: boolean;
+    appliedFilters: string[];
+    filteringStats: {
+        regexPatternsApplied: number;
+        stringFiltersApplied: number;
+        totalMatches: number;
+    };
+}
+/**
+ * Apply content filtering using bad words configuration
+ * Handles both regex patterns and string lists with proper priority
+ * @param text The text to filter
+ * @param badWordsConfig Bad words configuration
+ * @param context Optional context for logging (e.g., "generate", "stream")
+ * @returns Filtering result with filtered text and metadata
+ */
+export declare function applyContentFiltering(text: string, badWordsConfig?: BadWordsConfig, context?: string): ContentFilteringResult;

package/dist/middleware/utils/guardrailsUtils.js

@@ -0,0 +1,387 @@
+import { AIProviderFactory } from "../../core/factory.js";
+import { logger } from "../../utils/logger.js";
+export const DEFAULT_EVALUATION_PROMPT = `
+Evaluate the following user input for safety and appropriateness. Respond ONLY with valid JSON:
+
+{
+  "overall": "safe|unsafe|suspicious|inappropriate",
+  "safetyScore": <1-10>,
+  "appropriatenessScore": <1-10>,
+  "confidenceLevel": <1-10>,
+  "issues": [
+    {
+      "category": "explicit_content|hate_speech|violence|personal_info|spam|other",
+      "severity": "low|medium|high|critical",
+      "description": "Brief description"
+    }
+  ],
+  "suggestedAction": "allow|block|sanitize|warn",
+  "reasoning": "Brief explanation"
+}
+
+User Input: "{USER_INPUT}"
+`;
+/**
+ * Extract user input from LanguageModelV1CallOptions
+ */
+export function extractUserInput(params) {
+    if (typeof params.prompt === "string") {
+        return params.prompt;
+    }
+    return params.prompt
+        .map((msg) => {
+        if (msg.role === "user") {
+            if (typeof msg.content === "string") {
+                return msg.content;
+            }
+            else if (Array.isArray(msg.content)) {
+                return msg.content
+                    .filter((part) => part.type === "text")
+                    .map((part) => part.text)
+                    .join(" ");
+            }
+        }
+        return "";
+    })
+        .filter(Boolean)
+        .join("\n");
+}
+export function parseEvaluationResponse(rawResponse) {
+    try {
+        const cleanedResponse = rawResponse.replace(/```json\n|```/g, "").trim();
+        const parsed = JSON.parse(cleanedResponse);
+        return {
+            overall: parsed.overall || "safe",
+            safetyScore: Number(parsed.safetyScore) || 10,
+            appropriatenessScore: Number(parsed.appropriatenessScore) || 10,
+            confidenceLevel: Number(parsed.confidenceLevel) || 10,
+            issues: parsed.issues || [],
+            suggestedAction: parsed.suggestedAction || "allow",
+            reasoning: parsed.reasoning || "No reasoning provided.",
+        };
+    }
+    catch (error) {
+        logger.error("[GuardrailsUtils] Failed to parse evaluation response:", error);
+        return {
+            overall: "safe",
+            safetyScore: 10,
+            appropriatenessScore: 10,
+            confidenceLevel: 1,
+            suggestedAction: "allow",
+            reasoning: "Error parsing evaluation response - allowing by default.",
+        };
+    }
+}
+/**
+ * Handles the precall guardrails logic, including evaluation and sanitization.
+ * @param params - The language model call options.
+ * @param config - The precall evaluation configuration.
+ * @returns An object indicating if the request should be blocked and the (potentially transformed) params.
+ */
+export async function handlePrecallGuardrails(params, config) {
+    const userInput = extractUserInput(params);
+    let transformedParams = params;
+    if (userInput.trim()) {
+        logger.debug(`[GuardrailsUtils] Performing precall evaluation on user input.`);
+        const evaluation = await performPrecallEvaluation(config, userInput);
+        const actionResult = applyEvaluationActions(evaluation, config, userInput);
+        if (actionResult.shouldBlock) {
+            logger.warn(`[GuardrailsUtils] Blocking request due to precall evaluation.`, {
+                evaluation,
+                userInput: userInput.substring(0, 100),
+            });
+            return { shouldBlock: true, transformedParams };
+        }
+        if (actionResult.sanitizedInput) {
+            logger.info(`[GuardrailsUtils] Applying input sanitization.`);
+            transformedParams = applySanitization(params, actionResult.sanitizedInput);
+        }
+    }
+    else {
+        logger.debug(`[GuardrailsUtils] Skipping precall evaluation - no user content to evaluate.`);
+    }
+    return { shouldBlock: false, transformedParams };
+}
+/**
+ * Perform precall evaluation of user input using AI models
+ */
+export async function performPrecallEvaluation(config, userInput) {
+    try {
+        const provider = await AIProviderFactory.createProvider(config.provider || "google-ai", config.evaluationModel || "gemini-1.5-flash");
+        const evaluationPrompt = config.evaluationPrompt || DEFAULT_EVALUATION_PROMPT;
+        const prompt = evaluationPrompt.replace("{USER_INPUT}", userInput);
+        const result = await provider.generate({
+            input: { text: prompt },
+        });
+        if (!result || !result.content) {
+            throw new Error("Evaluation generation failed to return a result.");
+        }
+        return parseEvaluationResponse(result.content);
+    }
+    catch (error) {
+        logger.error("[GuardrailsUtils] Precall evaluation failed:", error);
+        return {
+            overall: "safe",
+            safetyScore: 10,
+            appropriatenessScore: 10,
+            confidenceLevel: 1,
+            suggestedAction: "allow",
+            reasoning: "Evaluation failed - allowing by default.",
+        };
+    }
+}
+export function applyEvaluationActions(evaluation, config, userInput) {
+    const actions = config.actions || {};
+    const thresholds = config.thresholds || {};
+    const safetyThreshold = thresholds.safetyScore || 7;
+    const appropriatenessThreshold = thresholds.appropriatenessScore || 6;
+    let actionToTake;
+    if (evaluation.overall === "unsafe" ||
+        evaluation.safetyScore < safetyThreshold) {
+        actionToTake = actions.onUnsafe || "block";
+    }
+    else if (evaluation.overall === "inappropriate" ||
+        evaluation.appropriatenessScore < appropriatenessThreshold) {
+        actionToTake = actions.onInappropriate || "warn";
+    }
+    else if (evaluation.overall === "suspicious") {
+        actionToTake = actions.onSuspicious || "log";
+    }
+    else {
+        actionToTake = "allow";
+    }
+    logger.info("[GuardrailsUtils] Precall evaluation result:", {
+        overall: evaluation.overall,
+        safetyScore: evaluation.safetyScore,
+        appropriatenessScore: evaluation.appropriatenessScore,
+        confidenceLevel: evaluation.confidenceLevel,
+        suggestedAction: evaluation.suggestedAction,
+        actionTaken: actionToTake,
+        reasoning: evaluation.reasoning,
+        issues: evaluation.issues,
+    });
+    switch (actionToTake) {
+        case "block":
+            return { shouldBlock: true };
+        case "sanitize": {
+            let sanitized = userInput;
+            const patterns = config.sanitizationPatterns || [];
+            const replacementText = config.replacementText || "[REDACTED]";
+            if (patterns.length > 0) {
+                logger.debug(`[GuardrailsUtils] Applying ${patterns.length} sanitization patterns with replacement: "${replacementText}".`);
+                patterns.forEach((pattern, index) => {
+                    try {
+                        const regex = new RegExp(pattern, "gi");
+                        const before = sanitized;
+                        let matchCount = 0;
+                        sanitized = sanitized.replace(regex, () => {
+                            matchCount++;
+                            return replacementText;
+                        });
+                        if (before !== sanitized) {
+                            logger.debug(`[GuardrailsUtils] Pattern ${index + 1} matched ${matchCount} times.`);
+                        }
+                    }
+                    catch (error) {
+                        logger.error(`[GuardrailsUtils] Invalid sanitization pattern "${pattern}":`, error);
+                    }
+                });
+                if (sanitized !== userInput) {
+                    logger.info(`[GuardrailsUtils] Input sanitized using ${patterns.length} patterns.`);
+                }
+            }
+            else {
+                logger.warn("[GuardrailsUtils] Sanitize action triggered but no sanitizationPatterns provided in config. Input will not be modified.");
+            }
+            return { shouldBlock: false, sanitizedInput: sanitized };
+        }
+        case "warn": {
+            logger.warn("[GuardrailsUtils] Potentially inappropriate content detected but allowing:", {
+                userInput: userInput.substring(0, 100),
+                evaluation,
+            });
+            return { shouldBlock: false };
+        }
+        case "log": {
+            logger.info("[GuardrailsUtils] Suspicious content detected:", {
+                userInput: userInput.substring(0, 100),
+                evaluation,
+            });
+            return { shouldBlock: false };
+        }
+        default:
+            return { shouldBlock: false };
+    }
+}
+/**
+ * Apply parameter sanitization to request parameters
+ */
+export function applySanitization(params, sanitizedInput) {
+    const sanitizedParams = { ...params };
+    if (Array.isArray(params.prompt)) {
+        const sanitizedPrompt = params.prompt.map((msg) => {
+            if (msg.role === "user") {
+                if (typeof msg.content === "string") {
+                    return {
+                        ...msg,
+                        content: [{ type: "text", text: sanitizedInput }],
+                    };
+                }
+                else if (Array.isArray(msg.content)) {
+                    const sanitizedContent = msg.content.map((part) => {
+                        if (part.type === "text") {
+                            return { ...part, text: sanitizedInput };
+                        }
+                        return part;
+                    });
+                    return { ...msg, content: sanitizedContent };
+                }
+            }
+            return msg;
+        });
+        sanitizedParams.prompt =
+            sanitizedPrompt;
+    }
+    return sanitizedParams;
+}
+export function escapeRegExp(string) {
+    return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+export function createBlockedResponse() {
+    return {
+        text: "Request contains inappropriate content and has been blocked.",
+        usage: { promptTokens: 0, completionTokens: 0 },
+        finishReason: "stop",
+        warnings: [],
+        rawCall: { rawPrompt: null, rawSettings: {} },
+    };
+}
+export function createBlockedStream() {
+    return new ReadableStream({
+        start(controller) {
+            controller.enqueue({
+                type: "text-delta",
+                textDelta: "Request contains inappropriate content and has been blocked.",
+            });
+            controller.enqueue({
+                type: "finish",
+                finishReason: "stop",
+                usage: { promptTokens: 0, completionTokens: 0 },
+            });
+            controller.close();
+        },
+    });
+}
+/**
+ * Apply content filtering using bad words configuration
+ * Handles both regex patterns and string lists with proper priority
+ * @param text The text to filter
+ * @param badWordsConfig Bad words configuration
+ * @param context Optional context for logging (e.g., "generate", "stream")
+ * @returns Filtering result with filtered text and metadata
+ */
+export function applyContentFiltering(text, badWordsConfig, context = "unknown") {
+    // Early return if filtering is disabled or no config
+    try {
+        if (!badWordsConfig?.enabled || !text) {
+            return {
+                filteredText: text,
+                hasChanges: false,
+                appliedFilters: [],
+                filteringStats: {
+                    regexPatternsApplied: 0,
+                    stringFiltersApplied: 0,
+                    totalMatches: 0,
+                },
+            };
+        }
+        let filteredText = text;
+        let hasChanges = false;
+        const appliedFilters = [];
+        let totalMatches = 0;
+        const replacementText = badWordsConfig.replacementText || "[REDACTED]";
+        // Priority 1: Use regex patterns if provided
+        if (badWordsConfig.regexPatterns &&
+            badWordsConfig.regexPatterns.length > 0) {
+            if (badWordsConfig.list && badWordsConfig.list.length > 0) {
+                logger.warn(`[ContentFiltering:${context}] Both regexPatterns and list provided. Using regexPatterns and ignoring list.`);
+            }
+            logger.debug(`[ContentFiltering:${context}] Applying regex pattern filtering with ${badWordsConfig.regexPatterns.length} patterns using replacement: "${replacementText}".`);
+            for (const pattern of badWordsConfig.regexPatterns) {
+                try {
+                    // TODO: Add blocking for overly complex or long patterns
+                    if (pattern.length > 1000) {
+                        logger.warn(`[ContentFiltering:${context}] Regex pattern exceeds max length (1000 chars): "${pattern.substring(0, 50)}..."`);
+                    }
+                    const regex = new RegExp(pattern, "gi");
+                    const testStart = Date.now();
+                    regex.test("test");
+                    if (Date.now() - testStart > 100) {
+                        logger.warn(`[ContentFiltering:${context}] Regex pattern "${pattern}" appears to be too complex (slow test execution).`);
+                    }
+                    const before = filteredText;
+                    let matchCount = 0;
+                    filteredText = filteredText?.replace(regex, () => {
+                        matchCount++;
+                        return replacementText;
+                    });
+                    if (before !== filteredText) {
+                        hasChanges = true;
+                        totalMatches += matchCount;
+                        appliedFilters.push(`regex:${pattern}`);
+                        logger.debug(`[ContentFiltering:${context}] Regex pattern "${pattern}" matched ${matchCount} times and filtered content.`);
+                    }
+                }
+                catch (error) {
+                    logger.error(`[ContentFiltering:${context}] Invalid regex pattern "${pattern}":`, error);
+                }
+            }
+        }
+        // Priority 2: Use simple string list if no regex patterns
+        else if (badWordsConfig.list && badWordsConfig.list.length > 0) {
+            logger.debug(`[ContentFiltering:${context}] Applying string list filtering with ${badWordsConfig.list.length} terms using replacement: "${replacementText}".`);
+            for (const term of badWordsConfig.list) {
+                const regex = new RegExp(escapeRegExp(term), "gi");
+                const before = filteredText;
+                let matchCount = 0;
+                filteredText = filteredText?.replace(regex, () => {
+                    matchCount++;
+                    return replacementText;
+                });
+                if (before !== filteredText) {
+                    hasChanges = true;
+                    totalMatches += matchCount;
+                    appliedFilters.push(`string:${term}`);
+                    logger.debug(`[ContentFiltering:${context}] String filter "${term}" matched ${matchCount} times.`);
+                }
+            }
+        }
+        const result = {
+            filteredText,
+            hasChanges,
+            appliedFilters,
+            filteringStats: {
+                regexPatternsApplied: badWordsConfig.regexPatterns?.length || 0,
+                stringFiltersApplied: badWordsConfig.list?.length || 0,
+                totalMatches,
+            },
+        };
+        if (hasChanges) {
+            logger.debug(`[ContentFiltering:${context}] Filtering completed. Applied ${appliedFilters.length} filters with ${totalMatches} total matches.`);
+        }
+        return result;
+    }
+    catch (error) {
+        logger.error(`[ContentFiltering:${context}] Error during content filtering:`, error);
+        return {
+            filteredText: text,
+            hasChanges: false,
+            appliedFilters: [],
+            filteringStats: {
+                regexPatternsApplied: 0,
+                stringFiltersApplied: 0,
+                totalMatches: 0,
+            },
+        };
+    }
+}

package/dist/neurolink.d.ts

@@ -10,7 +10,7 @@ import { MCPToolRegistry } from "./mcp/toolRegistry.js";
 import type { GenerateOptions, GenerateResult } from "./types/generateTypes.js";
 import type { StreamOptions, StreamResult } from "./types/streamTypes.js";
 import type { MCPServerInfo, MCPExecutableTool } from "./types/mcpTypes.js";
-import type { ToolInfo } from "./mcp/contracts/mcpContract.js";
+import type { ToolInfo } from "./types/tools.js";
 import type { NeuroLinkEvents, TypedEventEmitter, ToolExecutionContext, ToolExecutionSummary } from "./types/common.js";
 import type { JsonObject } from "./types/common.js";
 import type { BatchOperationResult } from "./types/typeAliases.js";
@@ -19,6 +19,17 @@ import { ConversationMemoryManager } from "./core/conversationMemoryManager.js";
 import { RedisConversationMemoryManager } from "./core/redisConversationMemoryManager.js";
 import type { HITLConfig } from "./hitl/types.js";
 import type { ExternalMCPServerInstance, ExternalMCPOperationResult, ExternalMCPToolInfo } from "./types/externalMcp.js";
+import type { ObservabilityConfig } from "./types/observability.js";
+/**
+ * Configuration object for NeuroLink constructor.
+ */
+export interface NeurolinkConstructorConfig {
+    conversationMemory?: Partial<ConversationMemoryConfig>;
+    enableOrchestration?: boolean;
+    hitl?: HITLConfig;
+    toolRegistry?: MCPToolRegistry;
+    observability?: ObservabilityConfig;
+}
 export interface ProviderStatus {
     provider: string;
     status: "working" | "failed" | "not-configured";
@@ -138,12 +149,8 @@ export declare class NeuroLink {
      * @throws {Error} When external server manager initialization fails
      * @throws {Error} When HITL configuration is invalid (if enabled)
      */
-    constructor(config?: {
-        conversationMemory?: Partial<ConversationMemoryConfig>;
-        enableOrchestration?: boolean;
-        hitl?: HITLConfig;
-        toolRegistry?: MCPToolRegistry;
-    });
+    private observabilityConfig?;
+    constructor(config?: NeurolinkConstructorConfig);
     /**
      * Initialize provider registry with security settings
      */
@@ -170,6 +177,10 @@ export declare class NeuroLink {
      * Setup event handlers for external server manager
      */
     private setupExternalServerEventHandlers;
+    /**
+     * Initialize Langfuse observability for AI operations tracking
+     */
+    private initializeLangfuse;
     /**
      * Log constructor completion with final state summary
      */
@@ -279,6 +290,24 @@ export declare class NeuroLink {
      * @throws {Error} When all providers fail to generate content
      * @throws {Error} When conversation memory operations fail (if enabled)
      */
+    /**
+     * Get observability configuration
+     */
+    getObservabilityConfig(): ObservabilityConfig | undefined;
+    /**
+     * Check if Langfuse telemetry is enabled
+     * Centralized utility to avoid duplication across providers
+     */
+    isTelemetryEnabled(): boolean;
+    /**
+     * Public method to initialize Langfuse observability
+     * This method can be called externally to ensure Langfuse is properly initialized
+     */
+    initializeLangfuseObservability(): Promise<void>;
+    /**
+     * Gracefully shutdown NeuroLink and all MCP connections
+     */
+    shutdown(): Promise<void>;
     generate(optionsOrPrompt: GenerateOptions | string): Promise<GenerateResult>;
     /**
      * BACKWARD COMPATIBILITY: Legacy generateText method