@juspay/neurolink 5.0.0 → 5.2.0

package/dist/lib/providers/openAI.d.ts

@@ -1,28 +1,28 @@
 import type { ZodType, ZodTypeDef } from "zod";
-import { type StreamTextResult, type ToolSet, type Schema, type GenerateTextResult, type LanguageModelV1 } from "ai";
-import type { AIProvider, TextGenerationOptions, StreamTextOptions, EnhancedGenerateTextResult } from "../core/types.js";
-export declare class OpenAI implements AIProvider {
-    private modelName;
+import { type Schema, type LanguageModelV1 } from "ai";
+import { AIProviderName } from "../core/types.js";
+import type { StreamOptions, StreamResult } from "../types/stream-types.js";
+import { BaseProvider } from "../core/base-provider.js";
+/**
+ * OpenAI Provider v2 - BaseProvider Implementation
+ * Migrated to use factory pattern with exact Google AI provider pattern
+ */
+export declare class OpenAIProvider extends BaseProvider {
     private model;
-    constructor(modelName?: string | null);
+    constructor(modelName?: string);
+    protected getProviderName(): AIProviderName;
+    protected getDefaultModel(): string;
     /**
-     * Get the underlying model for function calling
+     * Returns the Vercel AI SDK model instance for OpenAI
      */
-    getModel(): LanguageModelV1;
-    streamText(optionsOrPrompt: StreamTextOptions | string, analysisSchema?: ZodType<unknown, ZodTypeDef, unknown> | Schema<unknown>): Promise<StreamTextResult<ToolSet, unknown> | null>;
-    generateText(optionsOrPrompt: TextGenerationOptions | string, analysisSchema?: ZodType<unknown, ZodTypeDef, unknown> | Schema<unknown>): Promise<GenerateTextResult<ToolSet, unknown> | null>;
+    protected getAISDKModel(): LanguageModelV1;
+    protected handleProviderError(error: any): Error;
     /**
-     * Alias for generateText() - CLI-SDK consistency
-     * @param optionsOrPrompt - TextGenerationOptions object or prompt string
-     * @param analysisSchema - Optional schema for output validation
-     * @returns Promise resolving to GenerateTextResult or null
+     * executeGenerate method removed - generation is now handled by BaseProvider.
+     * For details on the changes and migration steps, refer to the BaseProvider documentation
+     * and the migration guide in the project repository.
      */
-    generate(optionsOrPrompt: TextGenerationOptions | string, analysisSchema?: ZodType<unknown, ZodTypeDef, unknown> | Schema<unknown>): Promise<EnhancedGenerateTextResult | null>;
-    /**
-     * Short alias for generateText() - CLI-SDK consistency
-     * @param optionsOrPrompt - TextGenerationOptions object or prompt string
-     * @param analysisSchema - Optional schema for output validation
-     * @returns Promise resolving to GenerateTextResult or null
-     */
-    gen(optionsOrPrompt: TextGenerationOptions | string, analysisSchema?: ZodType<unknown, ZodTypeDef, unknown> | Schema<unknown>): Promise<EnhancedGenerateTextResult | null>;
+    protected executeStream(options: StreamOptions, analysisSchema?: ZodType<unknown, ZodTypeDef, unknown> | Schema<unknown>): Promise<StreamResult>;
+    private validateStreamOptions;
 }
+export default OpenAIProvider;

package/dist/lib/providers/openAI.js

@@ -1,276 +1,112 @@
 import { openai } from "@ai-sdk/openai";
-import { streamText, generateText, Output, } from "ai";
+import { streamText } from "ai";
+import { AIProviderName } from "../core/types.js";
+import { BaseProvider } from "../core/base-provider.js";
 import { logger } from "../utils/logger.js";
-import { createTimeoutController, getDefaultTimeout, TimeoutError, } from "../utils/timeout.js";
+import { createTimeoutController, TimeoutError, } from "../utils/timeout.js";
 import { DEFAULT_MAX_TOKENS } from "../core/constants.js";
-import { evaluateResponse } from "../core/evaluation.js";
-// Default system context
-const DEFAULT_SYSTEM_CONTEXT = {
-    systemPrompt: "You are a helpful AI assistant.",
-};
 // Configuration helpers
 const getOpenAIApiKey = () => {
     const apiKey = process.env.OPENAI_API_KEY;
     if (!apiKey) {
-        // 🔧 FIX: Enhanced error message with setup instructions
-        throw new Error(`❌ OPENAI Provider Configuration Error
-
-Missing required environment variables: OPENAI_API_KEY
-
-🔧 Step 1: Get Credentials
-Get your API key from https://platform.openai.com/api-keys
-
-💡 Step 2: Add to your .env file (or export in CLI):
-OPENAI_API_KEY="sk-proj-your-openai-api-key"
-# Optional:
-OPENAI_MODEL="gpt-4o"
-OPENAI_BASE_URL="https://api.openai.com"
-
-🚀 Step 3: Test the setup:
-npx neurolink generate "Hello" --provider openai
-
-📖 Full setup guide: https://docs.neurolink.ai/providers/openai`);
+        throw new Error(`❌ OPENAI Provider Configuration Error\n\nMissing required environment variables: OPENAI_API_KEY\n\n🔧 Step 1: Get Credentials\n1. Visit: https://platform.openai.com/api-keys\n2. Create new API key\n3. Copy the key\n\n🔧 Step 2: Set Environment Variable\nAdd to your .env file:\nOPENAI_API_KEY=your_api_key_here\n\n🔧 Step 3: Restart Application\nRestart your application to load the new environment variables.`);
     }
     return apiKey;
 };
 const getOpenAIModel = () => {
     return process.env.OPENAI_MODEL || "gpt-4o";
 };
-// OpenAI class with enhanced error handling
-export class OpenAI {
-    modelName;
+/**
+ * OpenAI Provider v2 - BaseProvider Implementation
+ * Migrated to use factory pattern with exact Google AI provider pattern
+ */
+export class OpenAIProvider extends BaseProvider {
     model;
     constructor(modelName) {
-        const functionTag = "OpenAI.constructor";
-        this.modelName = modelName || getOpenAIModel();
-        try {
-            logger.debug(`[${functionTag}] Function called`, {
-                modelName: this.modelName,
-            });
-            // Set OpenAI API key as environment variable
-            process.env.OPENAI_API_KEY = getOpenAIApiKey();
-            this.model = openai(this.modelName);
-            logger.debug(`[${functionTag}] Function result`, {
-                modelName: this.modelName,
-                success: true,
-            });
-        }
-        catch (err) {
-            logger.debug(`[${functionTag}] Exception`, {
-                message: "Error in initializing OpenAI",
-                modelName: this.modelName,
-                err: String(err),
-            });
-            throw err;
-        }
+        super(modelName, AIProviderName.OPENAI);
+        // Set OpenAI API key as environment variable (required by @ai-sdk/openai)
+        process.env.OPENAI_API_KEY = getOpenAIApiKey();
+        // Initialize model
+        this.model = openai(this.modelName);
+        logger.debug("OpenAIProviderV2 initialized", {
+            model: this.modelName,
+            provider: this.providerName,
+        });
+    }
+    // ===================
+    // ABSTRACT METHOD IMPLEMENTATIONS
+    // ===================
+    getProviderName() {
+        return AIProviderName.OPENAI;
+    }
+    getDefaultModel() {
+        return getOpenAIModel();
     }
     /**
-     * Get the underlying model for function calling
+     * Returns the Vercel AI SDK model instance for OpenAI
      */
-    getModel() {
+    getAISDKModel() {
         return this.model;
     }
-    async streamText(optionsOrPrompt, analysisSchema) {
-        const functionTag = "OpenAI.streamText";
-        const provider = "openai";
-        let chunkCount = 0;
-        try {
-            // Parse parameters - support both string and options object
-            const options = typeof optionsOrPrompt === "string"
-                ? { prompt: optionsOrPrompt }
-                : optionsOrPrompt;
-            const { prompt, temperature = 0.7, maxTokens = DEFAULT_MAX_TOKENS, systemPrompt = DEFAULT_SYSTEM_CONTEXT.systemPrompt, schema, timeout = getDefaultTimeout(provider, "stream"), } = options;
-            // Use schema from options or fallback parameter
-            const finalSchema = schema || analysisSchema;
-            logger.debug(`[${functionTag}] Stream text started`, {
-                provider,
-                modelName: this.modelName,
-                promptLength: prompt.length,
-                temperature,
-                maxTokens,
-                timeout,
-            });
-            // Create timeout controller if timeout is specified
-            const timeoutController = createTimeoutController(timeout, provider, "stream");
-            const streamOptions = {
-                model: this.model,
-                prompt: prompt,
-                system: systemPrompt,
-                temperature,
-                maxTokens,
-                // Add abort signal if available
-                ...(timeoutController && {
-                    abortSignal: timeoutController.controller.signal,
-                }),
-                onError: (event) => {
-                    const error = event.error;
-                    const errorMessage = error instanceof Error ? error.message : String(error);
-                    const errorStack = error instanceof Error ? error.stack : undefined;
-                    logger.debug(`[${functionTag}] Stream text error`, {
-                        provider,
-                        modelName: this.modelName,
-                        error: errorMessage,
-                        stack: errorStack,
-                        promptLength: prompt.length,
-                        chunkCount,
-                    });
-                },
-                onFinish: (event) => {
-                    logger.debug(`[${functionTag}] Stream text finished`, {
-                        provider,
-                        modelName: this.modelName,
-                        finishReason: event.finishReason,
-                        usage: event.usage,
-                        totalChunks: chunkCount,
-                        promptLength: prompt.length,
-                        responseLength: event.text?.length || 0,
-                    });
-                },
-                onChunk: (event) => {
-                    chunkCount++;
-                    logger.debug(`[${functionTag}] Stream text chunk`, {
-                        provider,
-                        modelName: this.modelName,
-                        chunkNumber: chunkCount,
-                        chunkLength: event.chunk.text?.length || 0,
-                        chunkType: event.chunk.type,
-                    });
-                },
-            };
-            if (finalSchema) {
-                streamOptions.experimental_output = Output.object({
-                    schema: finalSchema,
-                });
-            }
-            const result = streamText(streamOptions);
-            // For streaming, we can't clean up immediately, but the timeout will auto-clean
-            // The user should handle the stream and any timeout errors
-            return result;
+    handleProviderError(error) {
+        if (error instanceof TimeoutError) {
+            return new Error(`OpenAI request timed out: ${error.message}`);
+        }
+        if (error?.message?.includes("API_KEY_INVALID") ||
+            error?.message?.includes("Invalid API key")) {
+            return new Error("Invalid OpenAI API key. Please check your OPENAI_API_KEY environment variable.");
         }
-        catch (err) {
-            // Log timeout errors specifically
-            if (err instanceof TimeoutError) {
-                logger.debug(`[${functionTag}] Timeout error`, {
-                    provider,
-                    modelName: this.modelName,
-                    timeout: err.timeout,
-                    message: err.message,
-                });
-            }
-            else {
-                logger.debug(`[${functionTag}] Exception`, {
-                    provider,
-                    modelName: this.modelName,
-                    message: "Error in streaming text",
-                    err: String(err),
-                });
-            }
-            throw err; // Re-throw error to trigger fallback
+        if (error?.message?.includes("rate limit")) {
+            return new Error("OpenAI rate limit exceeded. Please try again later.");
         }
+        return new Error(`OpenAI error: ${error?.message || "Unknown error"}`);
     }
-    async generateText(optionsOrPrompt, analysisSchema) {
-        const functionTag = "OpenAI.generateText";
-        const provider = "openai";
-        const startTime = Date.now();
+    /**
+     * executeGenerate method removed - generation is now handled by BaseProvider.
+     * For details on the changes and migration steps, refer to the BaseProvider documentation
+     * and the migration guide in the project repository.
+     */
+    async executeStream(options, analysisSchema) {
+        this.validateStreamOptions(options);
+        const timeout = this.getTimeout(options);
+        const timeoutController = createTimeoutController(timeout, this.providerName, "stream");
         try {
-            // Parse parameters - support both string and options object
-            const options = typeof optionsOrPrompt === "string"
-                ? { prompt: optionsOrPrompt }
-                : optionsOrPrompt;
-            const { prompt, temperature = 0.7, maxTokens = DEFAULT_MAX_TOKENS, systemPrompt = DEFAULT_SYSTEM_CONTEXT.systemPrompt, schema, timeout = getDefaultTimeout(provider, "generate"), } = options;
-            // Use schema from options or fallback parameter
-            const finalSchema = schema || analysisSchema;
-            logger.debug(`[${functionTag}] Generate text started`, {
-                provider,
-                modelName: this.modelName,
-                promptLength: prompt.length,
-                temperature,
-                maxTokens,
-                timeout,
-            });
-            // Create timeout controller if timeout is specified
-            const timeoutController = createTimeoutController(timeout, provider, "generate");
-            const generateOptions = {
+            const result = await streamText({
                 model: this.model,
-                prompt: prompt,
-                system: systemPrompt,
-                temperature,
-                maxTokens,
-                // Add abort signal if available
-                ...(timeoutController && {
-                    abortSignal: timeoutController.controller.signal,
-                }),
-            };
-            if (finalSchema) {
-                generateOptions.experimental_output = Output.object({
-                    schema: finalSchema,
-                });
-            }
-            try {
-                const result = await generateText(generateOptions);
-                // Clean up timeout if successful
-                timeoutController?.cleanup();
-                logger.debug(`[${functionTag}] Generate text completed`, {
-                    provider,
-                    modelName: this.modelName,
-                    usage: result.usage,
-                    finishReason: result.finishReason,
-                    responseLength: result.text?.length || 0,
-                    timeout,
-                });
-                // Add analytics if enabled
-                if (options.enableAnalytics) {
-                    const { createAnalytics } = await import("./analytics-helper.js");
-                    result.analytics = createAnalytics(provider, this.modelName, result, Date.now() - startTime, options.context);
-                }
-                // Add evaluation if enabled
-                if (options.enableEvaluation) {
-                    result.evaluation = await evaluateResponse(prompt, result.text, options.context, options.evaluationDomain, options.toolUsageContext, options.conversationHistory);
+                prompt: options.input.text,
+                system: options.systemPrompt,
+                temperature: options.temperature,
+                maxTokens: options.maxTokens || DEFAULT_MAX_TOKENS,
+                tools: options.tools,
+                toolChoice: "auto",
+                abortSignal: timeoutController?.controller.signal,
+            });
+            timeoutController?.cleanup();
+            // Transform stream to match StreamResult interface
+            const transformedStream = async function* () {
+                for await (const chunk of result.textStream) {
+                    yield { content: chunk };
                 }
-                return result;
-            }
-            finally {
-                // Always cleanup timeout
-                timeoutController?.cleanup();
-            }
+            };
+            return {
+                stream: transformedStream(),
+                provider: this.providerName,
+                model: this.modelName,
+            };
         }
-        catch (err) {
-            // Log timeout errors specifically
-            if (err instanceof TimeoutError) {
-                logger.debug(`[${functionTag}] Timeout error`, {
-                    provider,
-                    modelName: this.modelName,
-                    timeout: err.timeout,
-                    message: err.message,
-                });
-            }
-            else {
-                logger.debug(`[${functionTag}] Exception`, {
-                    provider,
-                    modelName: this.modelName,
-                    message: "Error in generating text",
-                    err: String(err),
-                });
-            }
-            throw err; // Re-throw error to trigger fallback
+        catch (error) {
+            timeoutController?.cleanup();
+            throw this.handleProviderError(error);
         }
     }
-    /**
-     * Alias for generateText() - CLI-SDK consistency
-     * @param optionsOrPrompt - TextGenerationOptions object or prompt string
-     * @param analysisSchema - Optional schema for output validation
-     * @returns Promise resolving to GenerateTextResult or null
-     */
-    async generate(optionsOrPrompt, analysisSchema) {
-        return this.generateText(optionsOrPrompt, analysisSchema);
-    }
-    /**
-     * Short alias for generateText() - CLI-SDK consistency
-     * @param optionsOrPrompt - TextGenerationOptions object or prompt string
-     * @param analysisSchema - Optional schema for output validation
-     * @returns Promise resolving to GenerateTextResult or null
-     */
-    async gen(optionsOrPrompt, analysisSchema) {
-        return this.generateText(optionsOrPrompt, analysisSchema);
+    // ===================
+    // PRIVATE VALIDATION METHODS
+    // ===================
+    validateStreamOptions(options) {
+        if (!options.input?.text || options.input.text.trim().length === 0) {
+            throw new Error("Input text is required and cannot be empty");
+        }
     }
 }
+// Export for factory registration
+export default OpenAIProvider;

package/dist/lib/sdk/tool-extension.d.ts

@@ -0,0 +1,181 @@
+/**
+ * NeuroLink SDK Tool Extension System
+ * Allows developers to register custom tools that integrate with AI providers
+ */
+import { z } from "zod";
+import type { Tool } from "ai";
+import { logger } from "../utils/logger.js";
+/**
+ * Custom tool interface for SDK users
+ */
+export interface CustomTool {
+    /**
+     * Tool description that helps AI understand when to use it
+     */
+    description: string;
+    /**
+     * Parameters schema using Zod or JSON Schema
+     */
+    parameters?: z.ZodSchema | Record<string, any>;
+    /**
+     * Tool execution function
+     */
+    execute: (args: any, context?: ToolContext) => Promise<any> | any;
+    /**
+     * Optional metadata
+     */
+    category?: string;
+    version?: string;
+    author?: string;
+    /**
+     * Optional configuration
+     */
+    config?: {
+        timeout?: number;
+        retries?: number;
+        rateLimit?: {
+            requests: number;
+            window: number;
+        };
+    };
+}
+/**
+ * Context provided to tools during execution
+ */
+export interface ToolContext {
+    /**
+     * Call another tool
+     */
+    callTool: (name: string, args: any) => Promise<any>;
+    /**
+     * Current session information
+     */
+    session: {
+        id: string;
+        userId?: string;
+        provider?: string;
+        model?: string;
+    };
+    /**
+     * Logger instance
+     */
+    logger: typeof logger;
+}
+/**
+ * Tool middleware function
+ */
+export type ToolMiddleware = (toolName: string, args: any, next: () => Promise<any>, context: ToolContext) => Promise<any>;
+/**
+ * Tool permission configuration
+ */
+export interface ToolPermissions {
+    allowlist?: string[];
+    denylist?: string[];
+    requireApproval?: string[];
+    customValidator?: (toolName: string, args: any) => boolean | Promise<boolean>;
+}
+/**
+ * Converts a custom tool to Vercel AI SDK format
+ */
+export declare function convertToAISDKTool(name: string, customTool: CustomTool): Tool;
+/**
+ * Tool registry for managing custom tools
+ */
+export declare class ToolRegistry {
+    private tools;
+    private middleware;
+    private permissions;
+    private rateLimits;
+    /**
+     * Simple rate limiting check with automatic cleanup
+     */
+    private checkRateLimit;
+    /**
+     * Register a custom tool
+     */
+    register(name: string, tool: CustomTool): void;
+    /**
+     * Register multiple tools at once
+     */
+    registerMany(tools: Record<string, CustomTool>): void;
+    /**
+     * Unregister a tool
+     */
+    unregister(name: string): boolean;
+    /**
+     * Get a tool by name
+     */
+    get(name: string): CustomTool | undefined;
+    /**
+     * Get all registered tools
+     */
+    getAll(): Map<string, CustomTool>;
+    /**
+     * Convert all tools to AI SDK format
+     */
+    toAISDKTools(): Record<string, Tool>;
+    /**
+     * Add middleware
+     */
+    use(middleware: ToolMiddleware): void;
+    /**
+     * Set permissions
+     */
+    setPermissions(permissions: ToolPermissions): void;
+    /**
+     * Check if a tool is allowed
+     */
+    private isToolAllowed;
+    /**
+     * Execute a tool with middleware
+     */
+    execute(name: string, args: any, context: ToolContext): Promise<any>;
+}
+/**
+ * Create a simple tool helper
+ */
+export declare function createTool(config: CustomTool): CustomTool;
+/**
+ * Create an async tool helper
+ */
+export declare function createAsyncTool(config: Omit<CustomTool, "execute"> & {
+    execute: (args: any, context?: ToolContext) => Promise<any>;
+}): CustomTool;
+/**
+ * Create a batch tool that processes multiple items
+ */
+export declare function createBatchTool<T, R>(config: Omit<CustomTool, "execute" | "parameters"> & {
+    parameters: z.ZodSchema<{
+        items: T[];
+    }>;
+    processItem: (item: T, context?: ToolContext) => Promise<R> | R;
+    batchSize?: number;
+}): CustomTool;
+/**
+ * Tool testing utilities
+ */
+export declare const TestUtils: {
+    /**
+     * Create a mock tool context
+     */
+    mockContext(overrides?: Partial<ToolContext>): ToolContext;
+    /**
+     * Test a tool with mock data
+     */
+    testTool(tool: CustomTool, testCases: Array<{
+        input: any;
+        expected?: any;
+    }>): Promise<({
+        input: any;
+        output: any;
+        success: boolean;
+        matches: boolean | undefined;
+        error?: undefined;
+    } | {
+        input: any;
+        error: string;
+        success: boolean;
+        output?: undefined;
+        matches?: undefined;
+    })[]>;
+};