@memberjunction/ai 3.3.0 → 4.0.0

package/dist/generic/baseImage.d.ts

@@ -1,89 +1,349 @@
-/// <reference types="node" />
-import { BaseModel, BaseResult, ModelUsage } from "./baseModel";
+import { BaseModel, BaseResult, ModelUsage } from "./baseModel.js";
+/**
+ * Represents a single generated image from an image generation request.
+ * Supports multiple formats for maximum flexibility with different providers.
+ */
 export declare class GeneratedImage {
+    /**
+     * Raw binary image data. Either data or url will be populated, not both.
+     */
     data?: Buffer;
+    /**
+     * Base64-encoded image data. Convenience representation of the data field.
+     * If data is populated, base64 will also be populated with the encoded value.
+     */
     base64?: string;
+    /**
+     * URL to the generated image. Some providers return URLs instead of direct data.
+     * Either url or data will be populated, not both.
+     * URLs may be temporary and expire after a period of time.
+     */
     url?: string;
+    /**
+     * The image format/encoding
+     */
     format: 'png' | 'jpg' | 'jpeg' | 'webp' | 'gif';
+    /**
+     * Width of the generated image in pixels
+     */
     width?: number;
+    /**
+     * Height of the generated image in pixels
+     */
     height?: number;
+    /**
+     * Provider-specific index when multiple images are generated
+     */
     index?: number;
+    /**
+     * Optional content filter results from the provider
+     */
     contentFilterResults?: ContentFilterResult;
 }
+/**
+ * Content filter/safety results from image generation
+ */
 export interface ContentFilterResult {
+    /**
+     * Whether the image was filtered/blocked
+     */
     filtered: boolean;
+    /**
+     * Reason for filtering if applicable
+     */
     reason?: string;
+    /**
+     * Provider-specific category information
+     */
     categories?: Record<string, boolean>;
 }
+/**
+ * Result of an image generation request
+ */
 export declare class ImageGenerationResult extends BaseResult {
+    /**
+     * Array of generated images. May contain multiple images if n > 1 was requested.
+     */
     images: GeneratedImage[];
+    /**
+     * Some providers (like OpenAI DALL-E 3) may revise the prompt for safety or quality.
+     * The revised prompt used for generation is returned here.
+     */
     revisedPrompt?: string;
+    /**
+     * Usage information if provided by the model
+     */
     usage?: ModelUsage;
+    /**
+     * Provider-specific metadata
+     */
     metadata?: Record<string, unknown>;
 }
+/**
+ * Size specification for image generation.
+ * Common sizes supported by most providers.
+ */
 export type ImageSize = '256x256' | '512x512' | '1024x1024' | '1024x1792' | '1792x1024' | '1536x1024' | '1024x1536' | string;
+/**
+ * Quality level for image generation
+ */
 export type ImageQuality = 'standard' | 'hd' | 'low' | 'medium' | 'high';
+/**
+ * Style preset for image generation
+ */
 export type ImageStyle = 'vivid' | 'natural' | 'photorealistic' | 'artistic' | 'anime' | string;
+/**
+ * Response format - how the generated image should be returned
+ */
 export type ImageResponseFormat = 'url' | 'b64_json' | 'buffer';
+/**
+ * Parameters for text-to-image generation
+ */
 export declare class ImageGenerationParams {
+    /**
+     * Model name/ID to use for generation
+     */
     model?: string;
+    /**
+     * Text prompt describing the image to generate. Required.
+     */
     prompt: string;
+    /**
+     * Negative prompt - things to avoid in the generated image.
+     * Not all providers support this.
+     */
     negativePrompt?: string;
+    /**
+     * Number of images to generate. Default is 1.
+     * Some providers have limits on the maximum number.
+     */
     n?: number;
+    /**
+     * Size of the generated image(s)
+     */
     size?: ImageSize;
+    /**
+     * Quality level for the generated image
+     */
     quality?: ImageQuality;
+    /**
+     * Style preset for the generated image
+     */
     style?: ImageStyle;
+    /**
+     * How the generated image should be returned
+     */
     outputFormat?: ImageResponseFormat;
+    /**
+     * Optional seed for reproducible generation.
+     * Not all providers support seeding.
+     */
     seed?: number;
+    /**
+     * Aspect ratio as an alternative to explicit size.
+     * Format: "width:height" e.g., "16:9", "1:1", "9:16"
+     */
     aspectRatio?: string;
+    /**
+     * User identifier for tracking/abuse prevention
+     */
     user?: string;
+    /**
+     * Provider-specific additional parameters
+     */
     providerOptions?: Record<string, unknown>;
 }
+/**
+ * Parameters for image editing/inpainting
+ */
 export declare class ImageEditParams {
+    /**
+     * Model name/ID to use for editing
+     */
     model?: string;
+    /**
+     * The original image to edit. Can be a Buffer, base64 string, or URL.
+     */
     image: Buffer | string;
+    /**
+     * Text prompt describing the edit to make
+     */
     prompt: string;
+    /**
+     * Mask image indicating which areas to edit.
+     * Transparent/white areas will be regenerated.
+     * Can be a Buffer, base64 string, or URL.
+     */
     mask?: Buffer | string;
+    /**
+     * Negative prompt - things to avoid
+     */
     negativePrompt?: string;
+    /**
+     * Number of edited images to generate
+     */
     n?: number;
+    /**
+     * Size of the output image(s)
+     */
     size?: ImageSize;
+    /**
+     * How the result should be returned
+     */
     outputFormat?: ImageResponseFormat;
+    /**
+     * Provider-specific additional parameters
+     */
     providerOptions?: Record<string, unknown>;
 }
+/**
+ * Parameters for creating image variations
+ */
 export declare class ImageVariationParams {
+    /**
+     * Model name/ID to use for variations
+     */
     model?: string;
+    /**
+     * The original image to create variations of.
+     * Can be a Buffer, base64 string, or URL.
+     */
     image: Buffer | string;
+    /**
+     * Optional prompt to guide the variation
+     */
     prompt?: string;
+    /**
+     * Number of variations to generate
+     */
     n?: number;
+    /**
+     * Size of the output image(s)
+     */
     size?: ImageSize;
+    /**
+     * How the result should be returned
+     */
     outputFormat?: ImageResponseFormat;
+    /**
+     * Strength of variation (0-1). Higher values create more different images.
+     */
     strength?: number;
+    /**
+     * Provider-specific additional parameters
+     */
     providerOptions?: Record<string, unknown>;
 }
+/**
+ * Information about an available image generation model
+ */
 export declare class ImageModelInfo {
+    /**
+     * Model identifier
+     */
     id: string;
+    /**
+     * Human-readable model name
+     */
     name: string;
+    /**
+     * Model description
+     */
     description?: string;
+    /**
+     * Supported image sizes
+     */
     supportedSizes?: ImageSize[];
+    /**
+     * Maximum number of images per request
+     */
     maxImages?: number;
+    /**
+     * Whether the model supports image editing/inpainting
+     */
     supportsEditing?: boolean;
+    /**
+     * Whether the model supports image variations
+     */
     supportsVariations?: boolean;
+    /**
+     * Whether the model supports negative prompts
+     */
     supportsNegativePrompt?: boolean;
+    /**
+     * Whether the model supports seeded generation
+     */
     supportsSeed?: boolean;
 }
+/**
+ * Base class for all image generation models.
+ * Each AI provider will have a sub-class implementing the abstract methods.
+ * Not all sub-classes will support all methods - use GetSupportedMethods()
+ * to determine what methods are available for a specific provider.
+ */
 export declare abstract class BaseImageGenerator extends BaseModel {
+    /**
+     * Generate image(s) from a text prompt.
+     * This is the primary method for text-to-image generation.
+     *
+     * @param params Parameters controlling the image generation
+     * @returns Result containing generated image(s)
+     */
     abstract GenerateImage(params: ImageGenerationParams): Promise<ImageGenerationResult>;
+    /**
+     * Edit an existing image using a text prompt and optional mask.
+     * Also known as inpainting. The mask specifies which areas to regenerate.
+     *
+     * @param params Parameters for the edit operation
+     * @returns Result containing edited image(s)
+     * @throws Error if not supported by this provider
+     */
     abstract EditImage(params: ImageEditParams): Promise<ImageGenerationResult>;
+    /**
+     * Create variations of an existing image.
+     * Generates new images that are similar to the input but with variations.
+     *
+     * @param params Parameters for the variation operation
+     * @returns Result containing image variations
+     * @throws Error if not supported by this provider
+     */
     abstract CreateVariation(params: ImageVariationParams): Promise<ImageGenerationResult>;
+    /**
+     * Get information about available image generation models from this provider.
+     *
+     * @returns Array of available model information
+     */
     abstract GetModels(): Promise<ImageModelInfo[]>;
+    /**
+     * Get the list of methods supported by this provider.
+     * Use this to check capabilities before calling methods that may not be implemented.
+     *
+     * @returns Array of supported method names
+     */
     abstract GetSupportedMethods(): Promise<string[]>;
+    /**
+     * Helper method to convert image input (Buffer, base64, or URL) to the format
+     * required by the specific provider. Subclasses can override as needed.
+     *
+     * @param input Image as Buffer, base64 string, or URL
+     * @returns Normalized image data
+     */
     protected normalizeImageInput(input: Buffer | string): Promise<{
         buffer: Buffer;
         base64: string;
     }>;
+    /**
+     * Helper method to create a successful result with proper timing
+     */
     protected createSuccessResult(startTime: Date, images: GeneratedImage[]): ImageGenerationResult;
+    /**
+     * Helper method to create an error result with proper timing
+     */
     protected createErrorResult(startTime: Date, errorMessage: string): ImageGenerationResult;
 }
+/**
+ * @deprecated Use BaseImageGenerator instead. This class is kept for backward compatibility.
+ */
 export declare abstract class BaseDiffusion extends BaseImageGenerator {
 }
 //# sourceMappingURL=baseImage.d.ts.map

package/dist/generic/baseImage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseImage.d.ts","sourceRoot":"","sources":["../../src/generic/baseImage.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMhE,qBAAa,cAAc;IAIvB,IAAI,CAAC,EAAE,MAAM,CAAC;IAMd,MAAM,CAAC,EAAE,MAAM,CAAC;IAOhB,GAAG,CAAC,EAAE,MAAM,CAAC;IAKb,MAAM,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAS;IAKxD,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,oBAAoB,CAAC,EAAE,mBAAmB,CAAC;CAC9C;AAKD,MAAM,WAAW,mBAAmB;IAIhC,QAAQ,EAAE,OAAO,CAAC;IAKlB,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC;AAKD,qBAAa,qBAAsB,SAAQ,UAAU;IAIjD,MAAM,EAAE,cAAc,EAAE,CAAM;IAM9B,aAAa,CAAC,EAAE,MAAM,CAAC;IAKvB,KAAK,CAAC,EAAE,UAAU,CAAC;IAKnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAMD,MAAM,MAAM,SAAS,GACf,SAAS,GACT,SAAS,GACT,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,MAAM,CAAC;AAKb,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,IAAI,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;AAKzE,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,gBAAgB,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,CAAC;AAKhG,MAAM,MAAM,mBAAmB,GAAG,KAAK,GAAG,UAAU,GAAG,QAAQ,CAAC;AAKhE,qBAAa,qBAAqB;IAI9B,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,MAAM,EAAE,MAAM,CAAC;IAMf,cAAc,CAAC,EAAE,MAAM,CAAC;IAMxB,CAAC,CAAC,EAAE,MAAM,CAAK;IAKf,IAAI,CAAC,EAAE,SAAS,CAAe;IAK/B,OAAO,CAAC,EAAE,YAAY,CAAc;IAKpC,KAAK,CAAC,EAAE,UAAU,CAAC;IAKnB,YAAY,CAAC,EAAE,mBAAmB,CAAc;IAMhD,IAAI,CAAC,EAAE,MAAM,CAAC;IAMd,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,IAAI,CAAC,EAAE,MAAM,CAAC;IAKd,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAKD,qBAAa,eAAe;IAIxB,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAKvB,MAAM,EAAE,MAAM,CAAC;IAOf,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAKvB,cAAc,CAAC,EAAE,MAAM,CAAC;IAKxB,CAAC,CAAC,EAAE,MAAM,CAAK;IAKf,IAAI,CAAC,EAAE,SAAS,CAAC;IAKjB,YAAY,CAAC,EAAE,mBAAmB,CAAc;IAKhD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAKD,qBAAa,oBAAoB;IAI7B,KAAK,CAAC,EAAE,MAAM,CAAC;IAMf,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAKvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,CAAC,CAAC,EAAE,MAAM,CAAK;IAKf,IAAI,CAAC,EAAE,SAAS,CAAC;IAKjB,YAAY,CAAC,EAAE,mBAAmB,CAAc;IAKhD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAKlB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAKD,qBAAa,cAAc;IAIvB,EAAE,EAAE,MAAM,CAAC;IAKX,IAAI,EAAE,MAAM,CAAC;IAKb,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,cAAc,CAAC,EAAE,SAAS,EAAE,CAAC;IAK7B,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,eAAe,CAAC,EAAE,OAAO,CAAC;IAK1B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAK7B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAKjC,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAQD,8BAAsB,kBAAmB,SAAQ,SAAS;aAQtC,aAAa,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;aAU5E,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;aAUlE,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;aAO7E,SAAS,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;aAQtC,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;cASxC,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IA+BxG,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,qBAAqB;IAS/F,SAAS,CAAC,iBAAiB,CAAC,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,GAAG,qBAAqB;CAK5F;AAKD,8BAAsB,aAAc,SAAQ,kBAAkB;CAC7D"}
+{"version":3,"file":"baseImage.d.ts","sourceRoot":"","sources":["../../src/generic/baseImage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEhE;;;GAGG;AACH,qBAAa,cAAc;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAS;IAExD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,oBAAoB,CAAC,EAAE,mBAAmB,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,UAAU;IACjD;;OAEG;IACH,MAAM,EAAE,cAAc,EAAE,CAAM;IAE9B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACf,SAAS,GACT,SAAS,GACT,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,MAAM,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,IAAI,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,gBAAgB,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,CAAC;AAEhG;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEhE;;GAEG;AACH,qBAAa,qBAAqB;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAK;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAe;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAc;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAc;IAEhD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,qBAAa,eAAe;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAK;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAc;IAEhD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAK;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAc;IAEhD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,qBAAa,cAAc;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,EAAE,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;GAKG;AACH,8BAAsB,kBAAmB,SAAQ,SAAS;IACtD;;;;;;OAMG;aACa,aAAa,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAE5F;;;;;;;OAOG;aACa,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAElF;;;;;;;OAOG;aACa,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAE7F;;;;OAIG;aACa,SAAS,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAEtD;;;;;OAKG;aACa,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAExD;;;;;;OAMG;cACa,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IA4BxG;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,qBAAqB;IAM/F;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,GAAG,qBAAqB;CAK5F;AAED;;GAEG;AACH,8BAAsB,aAAc,SAAQ,kBAAkB;CAC7D"}

package/dist/generic/baseImage.js

@@ -1,47 +1,101 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseDiffusion = exports.BaseImageGenerator = exports.ImageModelInfo = exports.ImageVariationParams = exports.ImageEditParams = exports.ImageGenerationParams = exports.ImageGenerationResult = exports.GeneratedImage = void 0;
-const baseModel_1 = require("./baseModel");
-class GeneratedImage {
+import { BaseModel, BaseResult } from "./baseModel.js";
+/**
+ * Represents a single generated image from an image generation request.
+ * Supports multiple formats for maximum flexibility with different providers.
+ */
+export class GeneratedImage {
     constructor() {
+        /**
+         * The image format/encoding
+         */
         this.format = 'png';
     }
 }
-exports.GeneratedImage = GeneratedImage;
-class ImageGenerationResult extends baseModel_1.BaseResult {
+/**
+ * Result of an image generation request
+ */
+export class ImageGenerationResult extends BaseResult {
     constructor() {
         super(...arguments);
+        /**
+         * Array of generated images. May contain multiple images if n > 1 was requested.
+         */
         this.images = [];
     }
 }
-exports.ImageGenerationResult = ImageGenerationResult;
-class ImageGenerationParams {
+/**
+ * Parameters for text-to-image generation
+ */
+export class ImageGenerationParams {
     constructor() {
+        /**
+         * Number of images to generate. Default is 1.
+         * Some providers have limits on the maximum number.
+         */
         this.n = 1;
+        /**
+         * Size of the generated image(s)
+         */
         this.size = '1024x1024';
+        /**
+         * Quality level for the generated image
+         */
         this.quality = 'standard';
+        /**
+         * How the generated image should be returned
+         */
         this.outputFormat = 'b64_json';
     }
 }
-exports.ImageGenerationParams = ImageGenerationParams;
-class ImageEditParams {
+/**
+ * Parameters for image editing/inpainting
+ */
+export class ImageEditParams {
     constructor() {
+        /**
+         * Number of edited images to generate
+         */
         this.n = 1;
+        /**
+         * How the result should be returned
+         */
         this.outputFormat = 'b64_json';
     }
 }
-exports.ImageEditParams = ImageEditParams;
-class ImageVariationParams {
+/**
+ * Parameters for creating image variations
+ */
+export class ImageVariationParams {
     constructor() {
+        /**
+         * Number of variations to generate
+         */
         this.n = 1;
+        /**
+         * How the result should be returned
+         */
         this.outputFormat = 'b64_json';
     }
 }
-exports.ImageVariationParams = ImageVariationParams;
-class ImageModelInfo {
+/**
+ * Information about an available image generation model
+ */
+export class ImageModelInfo {
 }
-exports.ImageModelInfo = ImageModelInfo;
-class BaseImageGenerator extends baseModel_1.BaseModel {
+/**
+ * Base class for all image generation models.
+ * Each AI provider will have a sub-class implementing the abstract methods.
+ * Not all sub-classes will support all methods - use GetSupportedMethods()
+ * to determine what methods are available for a specific provider.
+ */
+export class BaseImageGenerator extends BaseModel {
+    /**
+     * Helper method to convert image input (Buffer, base64, or URL) to the format
+     * required by the specific provider. Subclasses can override as needed.
+     *
+     * @param input Image as Buffer, base64 string, or URL
+     * @returns Normalized image data
+     */
     async normalizeImageInput(input) {
         let buffer;
         if (Buffer.isBuffer(input)) {
@@ -49,6 +103,7 @@ class BaseImageGenerator extends baseModel_1.BaseModel {
         }
         else if (typeof input === 'string') {
             if (input.startsWith('http://') || input.startsWith('https://')) {
+                // Fetch image from URL
                 const response = await fetch(input);
                 if (!response.ok) {
                     throw new Error(`Failed to fetch image from URL: ${response.statusText}`);
@@ -57,6 +112,7 @@ class BaseImageGenerator extends baseModel_1.BaseModel {
                 buffer = Buffer.from(arrayBuffer);
             }
             else {
+                // Assume base64
                 buffer = Buffer.from(input, 'base64');
             }
         }
@@ -68,19 +124,26 @@ class BaseImageGenerator extends baseModel_1.BaseModel {
             base64: buffer.toString('base64')
         };
     }
+    /**
+     * Helper method to create a successful result with proper timing
+     */
     createSuccessResult(startTime, images) {
         const result = new ImageGenerationResult(true, startTime, new Date());
         result.images = images;
         return result;
     }
+    /**
+     * Helper method to create an error result with proper timing
+     */
     createErrorResult(startTime, errorMessage) {
         const result = new ImageGenerationResult(false, startTime, new Date());
         result.errorMessage = errorMessage;
         return result;
     }
 }
-exports.BaseImageGenerator = BaseImageGenerator;
-class BaseDiffusion extends BaseImageGenerator {
+/**
+ * @deprecated Use BaseImageGenerator instead. This class is kept for backward compatibility.
+ */
+export class BaseDiffusion extends BaseImageGenerator {
 }
-exports.BaseDiffusion = BaseDiffusion;
 //# sourceMappingURL=baseImage.js.map

package/dist/generic/baseImage.js.map

@@ -1 +1 @@
-{"version":3,"file":"baseImage.js","sourceRoot":"","sources":["../../src/generic/baseImage.ts"],"names":[],"mappings":";;;AAAA,2CAAgE;AAMhE,MAAa,cAAc;IAA3B;QAsBI,WAAM,GAA4C,KAAK,CAAC;IAqB5D,CAAC;CAAA;AA3CD,wCA2CC;AAyBD,MAAa,qBAAsB,SAAQ,sBAAU;IAArD;;QAII,WAAM,GAAqB,EAAE,CAAC;IAiBlC,CAAC;CAAA;AArBD,sDAqBC;AAkCD,MAAa,qBAAqB;IAAlC;QAqBI,MAAC,GAAY,CAAC,CAAC;QAKf,SAAI,GAAe,WAAW,CAAC;QAK/B,YAAO,GAAkB,UAAU,CAAC;QAUpC,iBAAY,GAAyB,UAAU,CAAC;IAuBpD,CAAC;CAAA;AAhED,sDAgEC;AAKD,MAAa,eAAe;IAA5B;QA+BI,MAAC,GAAY,CAAC,CAAC;QAUf,iBAAY,GAAyB,UAAU,CAAC;IAMpD,CAAC;CAAA;AA/CD,0CA+CC;AAKD,MAAa,oBAAoB;IAAjC;QAoBI,MAAC,GAAY,CAAC,CAAC;QAUf,iBAAY,GAAyB,UAAU,CAAC;IAWpD,CAAC;CAAA;AAzCD,oDAyCC;AAKD,MAAa,cAAc;CA6C1B;AA7CD,wCA6CC;AAQD,MAAsB,kBAAmB,SAAQ,qBAAS;IAoD5C,KAAK,CAAC,mBAAmB,CAAC,KAAsB;QACtD,IAAI,MAAc,CAAC;QAEnB,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,GAAG,KAAK,CAAC;QACnB,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACnC,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAE9D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC;gBACpC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;gBAC9E,CAAC;gBACD,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;gBACjD,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBAEJ,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAC1C,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QAC3E,CAAC;QAED,OAAO;YACH,MAAM;YACN,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;SACpC,CAAC;IACN,CAAC;IAKS,mBAAmB,CAAC,SAAe,EAAE,MAAwB;QACnE,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC;IAKS,iBAAiB,CAAC,SAAe,EAAE,YAAoB;QAC7D,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QACvE,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;QACnC,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAjGD,gDAiGC;AAKD,MAAsB,aAAc,SAAQ,kBAAkB;CAC7D;AADD,sCACC"}
+{"version":3,"file":"baseImage.js","sourceRoot":"","sources":["../../src/generic/baseImage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAc,MAAM,aAAa,CAAC;AAEhE;;;GAGG;AACH,MAAM,OAAO,cAAc;IAA3B;QAmBI;;WAEG;QACH,WAAM,GAA4C,KAAK,CAAC;IAqB5D,CAAC;CAAA;AAsBD;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,UAAU;IAArD;;QACI;;WAEG;QACH,WAAM,GAAqB,EAAE,CAAC;IAiBlC,CAAC;CAAA;AA+BD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAAlC;QAiBI;;;WAGG;QACH,MAAC,GAAY,CAAC,CAAC;QAEf;;WAEG;QACH,SAAI,GAAe,WAAW,CAAC;QAE/B;;WAEG;QACH,YAAO,GAAkB,UAAU,CAAC;QAOpC;;WAEG;QACH,iBAAY,GAAyB,UAAU,CAAC;IAuBpD,CAAC;CAAA;AAED;;GAEG;AACH,MAAM,OAAO,eAAe;IAA5B;QA4BI;;WAEG;QACH,MAAC,GAAY,CAAC,CAAC;QAOf;;WAEG;QACH,iBAAY,GAAyB,UAAU,CAAC;IAMpD,CAAC;CAAA;AAED;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAAjC;QAiBI;;WAEG;QACH,MAAC,GAAY,CAAC,CAAC;QAOf;;WAEG;QACH,iBAAY,GAAyB,UAAU,CAAC;IAWpD,CAAC;CAAA;AAED;;GAEG;AACH,MAAM,OAAO,cAAc;CA6C1B;AAED;;;;;GAKG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,SAAS;IA6CtD;;;;;;OAMG;IACO,KAAK,CAAC,mBAAmB,CAAC,KAAsB;QACtD,IAAI,MAAc,CAAC;QAEnB,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,GAAG,KAAK,CAAC;QACnB,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACnC,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC9D,uBAAuB;gBACvB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC;gBACpC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;gBAC9E,CAAC;gBACD,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;gBACjD,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACJ,gBAAgB;gBAChB,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAC1C,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QAC3E,CAAC;QAED,OAAO;YACH,MAAM;YACN,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;SACpC,CAAC;IACN,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,SAAe,EAAE,MAAwB;QACnE,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,SAAe,EAAE,YAAoB;QAC7D,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QACvE,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;QACnC,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAgB,aAAc,SAAQ,kBAAkB;CAC7D"}