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 { useRecoilValue } from 'recoil';
import { useQuery, useQueryClient } from '@tanstack/react-query';
import { FileSources, QueryKeys, DynamicQueryKeys, dataService } from 'librechat-data-provider';
import type { QueryObserverResult, UseQueryOptions } from '@tanstack/react-query';
import type t from 'librechat-data-provider';
import {
addFileToCache,
getDownloadFilename,
registerDownloadFilename,
unregisterDownloadFilename,
} from '~/utils';
import { isEphemeralAgent } from '~/common';
import store from '~/store';
export const useGetFiles = <TData = t.TFile[] | boolean>(
config?: UseQueryOptions<t.TFile[], unknown, TData>,
): QueryObserverResult<TData, unknown> => {
const queriesEnabled = useRecoilValue<boolean>(store.queriesEnabled);
return useQuery<t.TFile[], unknown, TData>([QueryKeys.files], () => dataService.getFiles(), {
refetchOnWindowFocus: false,
refetchOnReconnect: false,
refetchOnMount: false,
...config,
enabled: (config?.enabled ?? true) === true && queriesEnabled,
});
};
/**
* A short, server-sorted page of the user's files for surfaces that only show
* a handful of recent uploads (composer palette). Kept on a separate query key
* so it never replaces the full `QueryKeys.files` list used by the files panel.
*/
export const useGetRecentFiles = <TData = t.TFile[]>(
limit: number,
config?: UseQueryOptions<t.TFile[], unknown, TData>,
): QueryObserverResult<TData, unknown> => {
const queriesEnabled = useRecoilValue<boolean>(store.queriesEnabled);
return useQuery<t.TFile[], unknown, TData>(
[QueryKeys.files, 'recent', limit],
() => dataService.getFiles({ limit }),
{
refetchOnWindowFocus: false,
refetchOnReconnect: false,
refetchOnMount: false,
...config,
enabled: (config?.enabled ?? true) === true && queriesEnabled && limit > 0,
},
);
};
export const useGetAgentFiles = <TData = t.TFile[]>(
agentId: string | undefined,
config?: UseQueryOptions<t.TFile[], unknown, TData>,
): QueryObserverResult<TData, unknown> => {
const queriesEnabled = useRecoilValue<boolean>(store.queriesEnabled);
return useQuery<t.TFile[], unknown, TData>(
DynamicQueryKeys.agentFiles(agentId ?? ''),
() => (agentId ? dataService.getAgentFiles(agentId) : Promise.resolve([])),
{
refetchOnWindowFocus: false,
refetchOnReconnect: false,
refetchOnMount: false,
...config,
enabled: (config?.enabled ?? true) === true && queriesEnabled && !isEphemeralAgent(agentId),
},
);
};
export const useGetFileConfig = <TData = t.TFileConfig>(
config?: UseQueryOptions<t.TFileConfig, unknown, TData>,
): QueryObserverResult<TData, unknown> => {
return useQuery<t.TFileConfig, unknown, TData>(
[QueryKeys.fileConfig],
() => dataService.getFileConfig(),
{
refetchOnWindowFocus: false,
refetchOnReconnect: false,
refetchOnMount: false,
...config,
},
);
};
type FileDownloadOptions = {
source?: string | null;
direct?: boolean;
purpose?: 'download' | 'preview';
};
export const isDirectDownloadSource = (source?: string | null): boolean =>
source === FileSources.s3 || source === FileSources.cloudfront;
export const revokeDownloadURL = (url?: string | null): void => {
if (!url?.startsWith('blob:')) {
return;
}
unregisterDownloadFilename(url);
window.URL.revokeObjectURL(url);
};
export const useFileDownload = (
userId?: string,
file_id?: string,
options: FileDownloadOptions = {},
): QueryObserverResult<string> => {
const queryClient = useQueryClient();
return useQuery(
[
QueryKeys.fileDownload,
file_id,
options.source ?? '',
options.direct ?? true,
options.purpose ?? 'download',
],
async () => {
if (!userId || !file_id) {
console.warn('No user ID provided for file download');
return;
}
if ((options.direct ?? true) && isDirectDownloadSource(options.source)) {
try {
const directDownload = await dataService.getFileDownloadURL(userId, file_id);
if (directDownload.url) {
return directDownload.url;
}
} catch {
// Fall back to the legacy proxied download for direct URL failures.
}
}
const response = await dataService.getFileDownload(userId, file_id);
const blob = response.data;
const downloadURL = window.URL.createObjectURL(blob);
try {
const metadata: t.TFile | undefined = JSON.parse(
decodeURIComponent(response.headers['x-file-metadata']),
);
if (!metadata) {
console.warn('No metadata found for file download', response.headers);
return downloadURL;
}
registerDownloadFilename(
downloadURL,
getDownloadFilename(metadata.filename, metadata.file_id, metadata.source),
);
addFileToCache(queryClient, metadata);
} catch (e) {
console.error('Error parsing file metadata, skipped updating file query cache', e);
}
return downloadURL;
},
{
enabled: false,
retry: false,
},
);
};
/**
* Blob download for a snapshotted file served through a shared link. Authorized
* by shared-link view permission (public/ACL) rather than the owner's file ACL.
* Idle by default; call `refetch` to download.
*/
export const useSharedFileDownload = (
shareId?: string,
file_id?: string,
purpose: 'download' | 'preview' = 'download',
): QueryObserverResult<string> => {
return useQuery(
[QueryKeys.fileDownload, 'share', shareId ?? '', file_id ?? '', purpose],
async () => {
if (!shareId || !file_id) {
return;
}
const response = await dataService.getSharedFileDownload(shareId, file_id);
return window.URL.createObjectURL(response.data);
},
{
enabled: false,
retry: false,
},
);
};
/** Preview consumers share immutable bytes, never a revocable download URL. */
export const useFilePreviewBlob = (
userId?: string,
fileId?: string,
shareId?: string,
): QueryObserverResult<Blob> =>
useQuery(
[QueryKeys.fileDownload, 'previewBlob', shareId ? 'share' : 'owner', shareId ?? userId, fileId],
async () => {
if (!fileId || (!shareId && !userId)) {
throw new Error('Preview identity unavailable');
}
const response = shareId
? await dataService.getSharedFileDownload(shareId, fileId)
: await dataService.getFileDownload(userId!, fileId);
return response.data;
},
{ enabled: false, retry: false, cacheTime: 0 },
);
export const useCodeOutputDownload = (url = ''): QueryObserverResult<string> => {
return useQuery(
[QueryKeys.fileDownload, url],
async () => {
if (!url) {
console.warn('No user ID provided for file download');
return;
}
const response = await dataService.getCodeOutputDownload(url);
const blob = response.data;
const downloadURL = window.URL.createObjectURL(blob);
return downloadURL;
},
{
enabled: false,
retry: false,
},
);
};
/* Stop on terminal success or after 5 consecutive errors. The cap is
* tracked in a module-level Map keyed by file_id because React Query
* v4 resets `state.fetchFailureCount` to 0 on every fetch dispatch
* (the `'fetch'` action in the reducer), so it can't be used to count
* errors *across* polls. */
export const PREVIEW_MAX_CONSECUTIVE_ERRORS = 5;
const consecutivePreviewErrors = new Map<string, number>();
export const fetchFilePreview = async (fileId: string): Promise<t.TFilePreview> => {
try {
const data = await dataService.getFilePreview(fileId);
consecutivePreviewErrors.delete(fileId);
return data;
} catch (err) {
consecutivePreviewErrors.set(fileId, (consecutivePreviewErrors.get(fileId) ?? 0) + 1);
throw err;
}
};
/** Preview fetch for a snapshotted file served through a shared link. */
export const fetchSharedFilePreview = async (
shareId: string,
fileId: string,
): Promise<t.TFilePreview> => {
try {
const data = await dataService.getSharedFilePreview(shareId, fileId);
consecutivePreviewErrors.delete(fileId);
return data;
} catch (err) {
consecutivePreviewErrors.set(fileId, (consecutivePreviewErrors.get(fileId) ?? 0) + 1);
throw err;
}
};
export const previewRefetchInterval = (
data: t.TFilePreview | undefined,
query: { queryKey: readonly unknown[] },
): number | false => {
const fileId = String(query.queryKey[1] ?? '');
if (data?.status === 'ready' || data?.status === 'failed') {
consecutivePreviewErrors.delete(fileId);
return false;
}
if ((consecutivePreviewErrors.get(fileId) ?? 0) >= PREVIEW_MAX_CONSECUTIVE_ERRORS) {
consecutivePreviewErrors.delete(fileId);
return false;
}
return 2500;
};
/** Test-only: clear the consecutive-error counter. */
export const _resetPreviewErrorCounter = (fileId?: string): void => {
if (fileId) consecutivePreviewErrors.delete(fileId);
else consecutivePreviewErrors.clear();
};
/**
* Poll the lifecycle of an inline file preview while background HTML
* extraction runs.
*
* Caller wires `enabled` to `attachment.status === 'pending'` so the
* query is dormant for terminal-status records. Once enabled, React
* Query's `refetchInterval` runs at 2.5s; see `previewRefetchInterval`
* for the auto-stop rules. Idle by default.
*
* Cache key: `[QueryKeys.filePreview, file_id]`. Sibling components
* watching the same `file_id` get a single shared poller.
*/
export const useFilePreview = (
file_id: string | undefined,
config?: UseQueryOptions<t.TFilePreview, unknown, t.TFilePreview>,
shareId?: string,
): QueryObserverResult<t.TFilePreview, unknown> => {
return useQuery<t.TFilePreview, unknown, t.TFilePreview>(
shareId ? [QueryKeys.filePreview, file_id, shareId] : [QueryKeys.filePreview, file_id],
() =>
shareId ? fetchSharedFilePreview(shareId, file_id ?? '') : fetchFilePreview(file_id ?? ''),
{
refetchOnWindowFocus: false,
refetchOnReconnect: false,
/* Note: `refetchOnMount` left at the React Query default (`true`)
* so a freshly-mounted observer with stale cached data refetches.
* Cross-turn filename reuse keeps the same `file_id`; the cache
* may hold a prior turn's `'ready'` payload. `useAttachmentHandler`
* removes the entry on every new attachment for safety, but this
* default is the second line of defense — without it, an observer
* that mounts before the handler runs would read the stale cache
* and `refetchInterval` would never start polling. (Codex P1
* round-3 review on PR #12957.) */
retry: false,
refetchInterval: previewRefetchInterval,
...config,
enabled: !!file_id && (config?.enabled ?? true),
},
);
};