Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active
TypeScript aianthropicartifactsawsazurechatgptchatgpt-cloneclaudeclonedeepseekgeminigooglegpt-5librechatmcpo1openairesponses-apivisionwebui
import fs from 'fs';
import path from 'path';
import sharp from 'sharp';
import { logger } from '@librechat/data-schemas';
import type { IUser } from '@librechat/data-schemas';
import type { TFile } from 'librechat-data-provider';
import type {
SaveBufferFn,
UploadImageParams,
ImageUploadResult,
ProcessAvatarParams,
} from '~/storage/types';
import { AVATAR_BASE_PATH, DEFAULT_BASE_PATH as defaultBasePath } from '~/storage/constants';
import { convertImageBuffer } from '~/files/format';
export interface ImageServiceDeps {
resizeImageBuffer: (
buffer: Buffer,
resolution: string,
endpoint: string,
) => Promise<{ buffer: Buffer; width: number; height: number; type?: string }>;
updateUser: (userId: string, update: { avatar: string }) => Promise<IUser | null>;
updateFile: (params: { file_id: string }) => Promise<TFile>;
}
export interface ImageServiceConfig {
/** If true, appends ?manual=... to avatar URLs (Firebase/Azure behavior) */
appendManualParam?: boolean;
}
/**
* Unified image service for cloud storage strategies.
* Handles image uploads, URL preparation, and avatar processing
* via an injected `saveBuffer` function, enabling any storage backend
* (S3, CloudFront, Azure, Firebase, etc.) without subclassing.
*/
export class ImageService {
/**
* @param saveBuffer - Strategy-specific function that persists a buffer and returns a download URL.
* @param deps - External dependencies (resize, user/file update callbacks).
* @param config - Optional per-strategy configuration.
*/
constructor(
private saveBuffer: SaveBufferFn,
private deps: ImageServiceDeps,
private config: ImageServiceConfig = {},
) {}
/**
* Resizes, converts, and uploads an image file to cloud storage.
* Deletes the local temp file after a successful upload.
*/
async uploadImage({
req,
file,
file_id,
endpoint,
resolution = 'high',
basePath = defaultBasePath,
}: UploadImageParams): Promise<ImageUploadResult> {
const inputFilePath = file.path;
try {
if (!req.user) {
throw new Error('[ImageService.uploadImage] User not authenticated');
}
const appConfig = req.config;
const inputBuffer = await fs.promises.readFile(inputFilePath);
const {
buffer: resizedBuffer,
width,
height,
type,
} = await this.deps.resizeImageBuffer(inputBuffer, resolution, endpoint);
const userId = req.user.id;
const { buffer: processedBuffer, fileName } = await convertImageBuffer({
buffer: resizedBuffer,
type,
fileName: `${file_id}__${path.basename(inputFilePath)}`,
outputType: appConfig?.imageOutputType ?? 'webp',
});
const downloadURL = await this.saveBuffer({
userId,
buffer: processedBuffer,
fileName,
basePath,
tenantId: req.user.tenantId ?? null,
});
const bytes = processedBuffer.length;
return { filepath: downloadURL, bytes, width, height };
} catch (error) {
logger.error('[ImageService.uploadImage] Error uploading image:', (error as Error).message);
throw error;
} finally {
await fs.promises
.unlink(inputFilePath)
.catch((e: unknown) =>
logger.error(
'[ImageService.uploadImage] Failed to delete temp file:',
(e as Error).message,
),
);
}
}
async prepareImageURL(file: { file_id: string; filepath: string }): Promise<[TFile, string]> {
try {
return await Promise.all([this.deps.updateFile({ file_id: file.file_id }), file.filepath]);
} catch (error) {
logger.error(
'[ImageService.prepareImageURL] Error preparing image URL:',
(error as Error).message,
);
throw error;
}
}
/**
* Processes and uploads an avatar image.
* Detects GIF vs PNG, generates a timestamped filename, and optionally
* persists the URL to the user record when `manual` is `'true'`.
*/
async processAvatar({
buffer,
userId,
manual,
agentId,
basePath = AVATAR_BASE_PATH,
tenantId = null,
}: ProcessAvatarParams): Promise<string> {
try {
const metadata = await sharp(buffer).metadata();
const extension = metadata.format ?? 'png';
const timestamp = new Date().getTime();
const fileName = agentId
? `agent-${agentId}-avatar-${timestamp}.${extension}`
: `avatar-${timestamp}.${extension}`;
const downloadURL = await this.saveBuffer({ userId, buffer, fileName, basePath, tenantId });
const finalURL = this.config.appendManualParam
? `${downloadURL}?manual=${manual === 'true'}`
: downloadURL;
if (manual === 'true' && !agentId) {
await this.deps.updateUser(userId, { avatar: finalURL });
}
return finalURL;
} catch (error) {
logger.error(
'[ImageService.processAvatar] Error processing avatar:',
(error as Error).message,
);
throw error;
}
}
}