@juspay/neurolink 9.1.1 → 9.2.0

package/dist/image-gen/types.d.ts

@@ -0,0 +1,237 @@
+/**
+ * Image Generation Service Types
+ *
+ * Type definitions for AI-powered image generation with support for
+ * reference images, PDFs, and configurable providers/models.
+ *
+ * @packageDocumentation
+ * @module @juspay/neurolink/image-gen
+ * @category ImageGeneration
+ */
+/**
+ * Supported image generation providers
+ */
+export type ImageGenProvider = "vertex" | "openai" | "anthropic" | "bedrock";
+/**
+ * Supported aspect ratios
+ */
+export type AspectRatio = "1:1" | "16:9" | "9:16" | "4:3" | "3:4" | "3:2" | "2:3";
+/**
+ * Supported style presets
+ */
+export type StylePreset = "realistic" | "photorealistic" | "artistic" | "cartoon" | "anime" | "watercolor" | "oil-painting" | "sketch" | "digital-art" | "3d-render";
+/**
+ * Options for image generation requests
+ */
+export interface ImageGenOptions {
+    /**
+     * Text prompt describing the image to generate
+     * Should be detailed and specific for best results
+     */
+    prompt: string;
+    /**
+     * Reference images for style/content guidance (optional)
+     * Can be Buffer (raw data) or string (base64 encoded)
+     * Max 5 images recommended
+     */
+    images?: (Buffer | string)[];
+    /**
+     * Reference PDF files for context (optional)
+     * Used for generating images based on document content
+     * Max 1 PDF recommended
+     */
+    pdfFiles?: Buffer[];
+    /**
+     * Override default model
+     * e.g., "imagen-3.0-generate-001", "dall-e-3"
+     */
+    model?: string;
+    /**
+     * Override default provider
+     * e.g., "vertex", "openai"
+     */
+    provider?: ImageGenProvider | string;
+    /**
+     * Region for provider (e.g., for Vertex AI)
+     */
+    region?: string;
+    /**
+     * What to avoid in the generated image (optional)
+     * e.g., "blurry, low quality, text overlays"
+     */
+    negativePrompt?: string;
+    /**
+     * Aspect ratio for the generated image
+     * e.g., "16:9", "1:1", "4:3", "9:16"
+     */
+    aspectRatio?: AspectRatio | string;
+    /**
+     * Style preset for the image
+     * e.g., "realistic", "artistic", "cartoon", "watercolor", "photorealistic"
+     */
+    style?: StylePreset | string;
+    /**
+     * Number of images to generate (default: 1)
+     */
+    numberOfImages?: number;
+    /**
+     * Sampling temperature for generation (0-1)
+     * Higher values = more creative/random
+     */
+    temperature?: number;
+}
+/**
+ * Result of an image generation request
+ */
+export interface ImageGenResult {
+    /**
+     * Whether generation was successful
+     */
+    success: boolean;
+    /**
+     * Generated image as Buffer (if successful)
+     */
+    imageBuffer?: Buffer;
+    /**
+     * Generated image as base64 string (if successful)
+     */
+    base64?: string;
+    /**
+     * MIME type of the generated image
+     * e.g., "image/png", "image/jpeg"
+     */
+    mimeType?: string;
+    /**
+     * Model used for generation
+     */
+    model?: string;
+    /**
+     * Provider used for generation
+     */
+    provider?: string;
+    /**
+     * Error message if generation failed
+     */
+    error?: string;
+    /**
+     * Time taken for generation in milliseconds
+     */
+    generationTimeMs?: number;
+    /**
+     * Additional metadata from the provider
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Configuration for the ImageGenService
+ */
+export interface ImageGenConfig {
+    /**
+     * Whether image generation is enabled
+     */
+    enabled: boolean;
+    /**
+     * Default model to use for generation
+     */
+    defaultModel: string;
+    /**
+     * Default provider for image generation
+     */
+    defaultProvider: ImageGenProvider | string;
+    /**
+     * Default region for the provider (if applicable)
+     */
+    defaultRegion?: string;
+    /**
+     * Timeout for generation requests in milliseconds
+     */
+    timeout: number;
+    /**
+     * Default temperature for generation
+     */
+    defaultTemperature?: number;
+    /**
+     * Maximum number of images per request
+     */
+    maxImages?: number;
+    /**
+     * Maximum number of reference images allowed
+     */
+    maxReferenceImages?: number;
+    /**
+     * Maximum number of reference PDFs allowed
+     */
+    maxReferencePdfs?: number;
+}
+/**
+ * Default configuration for image generation
+ */
+export declare const DEFAULT_IMAGE_GEN_CONFIG: ImageGenConfig;
+/**
+ * Tool parameters for AI model use
+ */
+export interface ImageGenToolParams {
+    /**
+     * Detailed description of the image to generate
+     */
+    prompt: string;
+    /**
+     * What to avoid in the generated image (optional)
+     */
+    negativePrompt?: string;
+    /**
+     * Aspect ratio like "16:9", "1:1", "4:3" (optional)
+     */
+    aspectRatio?: AspectRatio | string;
+    /**
+     * Style like "realistic", "artistic", "cartoon" (optional)
+     */
+    style?: StylePreset | string;
+}
+/**
+ * Response from the image generation tool
+ */
+export interface ImageGenToolResponse {
+    /**
+     * Whether the tool execution was successful
+     */
+    success: boolean;
+    /**
+     * Data URI of the generated image (if successful)
+     * Format: data:image/png;base64,...
+     */
+    image?: string;
+    /**
+     * Human-readable message about the result
+     */
+    message?: string;
+    /**
+     * Error message if execution failed
+     */
+    error?: string;
+}
+/**
+ * Context for tool execution (optional)
+ */
+export interface ImageGenToolContext {
+    /**
+     * Reference images to use for generation
+     */
+    referenceImages?: (Buffer | string)[];
+    /**
+     * Reference PDFs to use for generation
+     */
+    referencePdfs?: Buffer[];
+    /**
+     * User ID for tracking/logging
+     */
+    userId?: string;
+    /**
+     * Session ID for tracking/logging
+     */
+    sessionId?: string;
+    /**
+     * Additional metadata
+     */
+    metadata?: Record<string, unknown>;
+}

package/dist/image-gen/types.js

@@ -0,0 +1,24 @@
+/**
+ * Image Generation Service Types
+ *
+ * Type definitions for AI-powered image generation with support for
+ * reference images, PDFs, and configurable providers/models.
+ *
+ * @packageDocumentation
+ * @module @juspay/neurolink/image-gen
+ * @category ImageGeneration
+ */
+/**
+ * Default configuration for image generation
+ */
+export const DEFAULT_IMAGE_GEN_CONFIG = {
+    enabled: true,
+    defaultModel: "imagen-3.0-generate-001",
+    defaultProvider: "vertex",
+    defaultRegion: "global",
+    timeout: 120000,
+    defaultTemperature: 0.75,
+    maxImages: 4,
+    maxReferenceImages: 5,
+    maxReferencePdfs: 1,
+};

package/dist/lib/agent/directTools.d.ts

@@ -219,12 +219,12 @@ export declare const directAgentTools: {
         content: z.ZodString;
         mode: z.ZodDefault<z.ZodEnum<["create", "overwrite", "append"]>>;
     }, "strip", z.ZodTypeAny, {
-        path: string;
         content: string;
+        path: string;
         mode: "create" | "overwrite" | "append";
     }, {
-        path: string;
         content: string;
+        path: string;
         mode?: "create" | "overwrite" | "append" | undefined;
     }>, {
         success: boolean;
@@ -249,8 +249,8 @@ export declare const directAgentTools: {
         written?: undefined;
     }> & {
         execute: (args: {
-            path: string;
             content: string;
+            path: string;
             mode: "create" | "overwrite" | "append";
         }, options: import("ai").ToolExecutionOptions) => PromiseLike<{
             success: boolean;

package/dist/lib/image-gen/ImageGenService.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Image Generation Service
+ *
+ * Handles AI image generation using NeuroLink SDK with configurable providers
+ * and models. Supports reference images and PDFs for contextual generation.
+ *
+ * @packageDocumentation
+ * @module @juspay/neurolink/image-gen
+ * @category ImageGeneration
+ *
+ * @example
+ * ```typescript
+ * import { ImageGenService } from '@juspay/neurolink';
+ *
+ * const service = new ImageGenService();
+ *
+ * const result = await service.generate({
+ *   prompt: 'A serene mountain landscape at sunset',
+ *   style: 'photorealistic',
+ *   aspectRatio: '16:9'
+ * });
+ *
+ * if (result.success && result.imageBuffer) {
+ *   fs.writeFileSync('output.png', result.imageBuffer);
+ * }
+ * ```
+ */
+import type { ImageGenConfig, ImageGenOptions, ImageGenResult } from "./types.js";
+/**
+ * Image generation service for AI-powered image creation
+ *
+ * Uses NeuroLink SDK to generate images with support for:
+ * - Multiple providers (Vertex AI, OpenAI, etc.)
+ * - Reference images for style guidance
+ * - PDF documents for contextual generation
+ * - Configurable aspect ratios and styles
+ *
+ * @example Basic usage
+ * ```typescript
+ * const service = new ImageGenService();
+ * const result = await service.generate({
+ *   prompt: 'A cute robot playing chess'
+ * });
+ * ```
+ *
+ * @example With custom configuration
+ * ```typescript
+ * const service = new ImageGenService({
+ *   defaultProvider: 'openai',
+ *   defaultModel: 'dall-e-3',
+ *   timeout: 60000
+ * });
+ * ```
+ */
+export declare class ImageGenService {
+    private config;
+    private neurolinkInstance;
+    private instanceId;
+    /**
+     * Create a new ImageGenService instance
+     *
+     * @param config - Optional configuration overrides
+     */
+    constructor(config?: Partial<ImageGenConfig>);
+    /**
+     * Get or create the NeuroLink instance
+     * Uses dynamic import to avoid circular dependencies
+     *
+     * @returns NeuroLink instance for image generation
+     */
+    private getNeuroLink;
+    /**
+     * Generate an image from a text prompt
+     *
+     * @param options - Generation options including prompt, style, etc.
+     * @returns Promise resolving to generation result
+     *
+     * @example Simple generation
+     * ```typescript
+     * const result = await service.generate({
+     *   prompt: 'A futuristic cityscape'
+     * });
+     * ```
+     *
+     * @example With reference images
+     * ```typescript
+     * const referenceImage = fs.readFileSync('style-reference.jpg');
+     * const result = await service.generate({
+     *   prompt: 'A portrait in this style',
+     *   images: [referenceImage],
+     *   aspectRatio: '1:1'
+     * });
+     * ```
+     */
+    generate(options: ImageGenOptions): Promise<ImageGenResult>;
+    /**
+     * Extract image data from various result formats
+     *
+     * Handles multiple output formats:
+     * - result.imageOutput?.base64
+     * - result.images?.[0]
+     * - data:image URI in content
+     * - Buffer directly
+     *
+     * @param result - Raw result from NeuroLink generate
+     * @returns Extracted image data or null
+     */
+    private extractImageFromResult;
+    /**
+     * Check if image generation is enabled
+     */
+    isEnabled(): boolean;
+    /**
+     * Get the default model
+     */
+    getModel(): string;
+    /**
+     * Get the default provider
+     */
+    getProvider(): string;
+    /**
+     * Get the service configuration
+     */
+    getConfig(): Readonly<ImageGenConfig>;
+    /**
+     * Get the service instance ID (for debugging)
+     */
+    getInstanceId(): string;
+    /**
+     * Update service configuration
+     *
+     * @param config - Partial configuration to merge
+     */
+    updateConfig(config: Partial<ImageGenConfig>): void;
+    /**
+     * Enable image generation
+     */
+    enable(): void;
+    /**
+     * Disable image generation
+     */
+    disable(): void;
+}