mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-01-01 08:08:49 +01:00
* WIP: search tool integration * WIP: Add web search capabilities and API key management to agent actions * WIP: web search capability to agent configuration and selection * WIP: Add web search capability to backend agent configuration * WIP: add web search option to default agent form values * WIP: add attachments for web search * feat: add plugin for processing web search citations * WIP: first pass, Citation UI * chore: remove console.log * feat: Add AnimatedTabs component for tabbed UI functionality * refactor: AnimatedTabs component with CSS animations and stable ID generation * WIP example content * feat: SearchContext for managing search results apart from MessageContext * feat: Enhance AnimatedTabs with underline animation and state management * WIP: first pass, Implement dynamic tab functionality in Sources component with search results integration * fix: Update class names for improved styling in Sources and AnimatedTabs components * feat: Improve styling and layout in Sources component with enhanced button and item designs * feat: Refactor Sources component to integrate OGDialog for source display and improve layout * style: Update background color in SourceItem and SourcesGroup components for improved visibility * refactor: Sources component to enhance SourceItem structure and improve favicon handling * style: Adjust font size of domain text in SourceItem for better readability * feat: Add localization for citation source and details in CompositeCitation component * style: add theming to Citation components * feat: Enhance SourceItem component with dialog support and improved hovercard functionality * feat: Add localization for sources tab and image alt text in Sources component * style: Replace divs with spans for better semantic structure in CompositeCitation and Citation components * refactor: Sources component to use useMemo for tab generation and improve performance * chore: bump @librechat/agents to v2.4.318 * chore: update search result types * fix: search results retrieval in ContentParts component, re-render attachments when expected * feat: update sources style/types to use latest search result structure * style: enhance Dialog (expanded) SourceItem component with link wrapping and improved styling * style: update ImageItem component styling for improved title visibility * refactor: remove SourceItemBase component and adjust SourceItem layout for improved styling * chore: linting twcss order * fix: prevent FileAttachment from rendering search attachments * fix: append underscore to responseMessageId for unique identification to prevent mapping of previous latest message's attachments * chore: remove unused parameter 'useSpecs' from loadTools function * chore: twcss order * WIP: WebSearch Tool UI * refactor: add limit parameter to StackedFavicons for customizable source display * refactor: optimize search results memoization by making more granular and separate conerns * refactor: integrated StackedFavicons to WebSearch mid-run * chore: bump @librechat/agents to expose handleToolCallChunks * chore: use typedefs from dedicated file instead of defining them in AgentClient module * WIP: first pass, search progress results * refactor: move createOnSearchResults function to a dedicated search module * chore: bump @librechat/agents to v2.4.320 * WIP: first pass, search results processed UX * refactor: consolidate context variables in createOnSearchResults function * chore: bump @librechat/agents to v2.4.321 * feat: add guidelines for web search tool response formatting in loadTools function * feat: add isLast prop to Part component and update WebSearch logic for improved state handling * style: update Hovercard styles for improved UI consistency * feat: export FaviconImage component for improved accessibility in other modules * refactor: export getCleanDomain function and use FaviconImage in Citation component for improved source representation * refactor: implement SourceHovercard component for consistency and DRY compliance * fix: replace <p> with <span> for snippet and title in SourceItem and SourceHovercard for consistency * style: `not-prose` * style: remove 'not-prose' class for consistency in SourceItem, Citation, and SourceHovercard components, adjust style classes * refactor: `imageUrl` on hover and prevent duplicate sources * refactor: enhance SourcesGroup dialog layout and improve source item presentation * refactor: reorganize Web Components, save in same directory * feat: add 'news' refType to refTypeMap for citation sources * style: adjust Hovercard width for improved layout * refactor: update tool usage guidelines for improved clarity and execution * chore: linting * feat: add Web Search badge with initial permissions and local storage logic * feat: add webSearch support to interface and permissions schemas * feat: implement Web Search API key management and localization updates * feat: refactor Web Search API key handling and integrate new search API key form * fix: remove unnecessary visibility state from FileAttachment component * feat: update WebSearch component to use Globe icon and localized search label * feat: enhance ApiKeyDialog with dropdown for reranker selection and update translations * feat: implement dropdown menus for engine, scraper, and reranker selection in ApiKeyDialog * chore: linting and add unknown instead of `any` type * feat: refactor ApiKeyDialog and useAuthSearchTool for improved API key management * refactor: update ocrSchema to use template literals for default apiKey and baseURL * feat: add web search configuration and utility functions for environment variable extraction * fix: ensure filepath is defined before checking its prefix in useAttachmentHandler * feat: enhance web search functionality with improved configuration and environment variable extraction for authFields * fix: update auth type in TPluginAction and TUpdateUserPlugins to use Partial<Record<string, string>> * feat: implement web search authentication verification and enhance webSearchAuth structure * feat: enhance ephemeral agent handling with new web search capability and type definition * feat: enhance isEphemeralAgent function to include web search selection * feat: refactor verifyWebSearchAuth to improve key handling and authentication checks * feat: implement loadWebSearchAuth function for improved web search authentication handling * feat: enhance web search authentication with new configuration options and refactor related types * refactor: rename search engine to search provider and update related localization keys * feat: update verifyWebSearchAuth to handle multiple authentication types and improve error handling * feat: update ApiKeyDialog to accept authTypes prop and remove isUserProvided check * feat: add tests for extractWebSearchEnvVars and loadWebSearchAuth functions * feat: enhance loadWebSearchAuth to support specific service checks for providers, scrapers, and rerankers * fix: update web search configuration key and adjust auth result handling in loadTools function * feat: add new progress key for repeated web searching and update localization * chore: bump @librechat/agents to 2.4.322 * feat: enhance loadTools function to include ISO time and improve search tool logging * feat: update StackedFavicons to handle negative start index and improve citation attribution styling and text * chore: update .gitignore to categorize AI-related files * fix: mobile responsiveness of sources/citations hovercards * feat: enhance source display with improved line clamping for better readability * chore: bump @librechat/agents to v2.4.33 * feat: add handling for image sources in references mapping * chore: bump librechat-data-provider version to 0.7.84 * chore: bump @librechat/agents version to 2.4.34 * fix: update auth handling to support multiple auth types in tools and allow key configuration in agent panel * chore: remove redundant agent attribution text from search form * fix: web search auth uninstall * refactor: convert CheckboxButton to a forwardRef component and update setValue callback signature * feat: add triggerRef prop to ApiKeyDialog components for improved dialog control * feat: integrate triggerRef in CodeInterpreter and WebSearch components for enhanced dialog management * feat: enhance ApiKeyDialog with additional links for Firecrawl and Jina API key guidance * feat: implement web search configuration handling in ApiKeyDialog and add tests for dropdown visibility * fix: update webSearchConfig reference in config route for correct payload assignment * feat: update ApiKeyDialog to conditionally render sections based on authTypes and modify loadWebSearchAuth to correctly categorize authentication types * feat: refactor ApiKeyDialog and related tests to use SearchCategories and RerankerTypes enums and remove nested ternaries * refactor: move ThinkingButton rendering to improve layout consistency in ContentParts * feat: integrate search context into Markdown component to conditionally include unicodeCitation plugin * chore: bump @librechat/agents to v2.4.35 * chore: remove unused 18n key * ci: add WEB_SEARCH permission testing and update AppService tests for new webSearch configuration * ci: add more comprehensive tests for loadWebSearchAuth to validate authentication handling and authTypes structure * chore: remove debugging console log from web.spec.ts to clean up test output
391 lines
12 KiB
TypeScript
391 lines
12 KiB
TypeScript
import React, {
|
|
memo,
|
|
useState,
|
|
useRef,
|
|
useEffect,
|
|
useCallback,
|
|
useMemo,
|
|
forwardRef,
|
|
useReducer,
|
|
} from 'react';
|
|
import { useRecoilValue, useRecoilCallback } from 'recoil';
|
|
import type { LucideIcon } from 'lucide-react';
|
|
import CodeInterpreter from './CodeInterpreter';
|
|
import type { BadgeItem } from '~/common';
|
|
import { useChatBadges } from '~/hooks';
|
|
import { Badge } from '~/components/ui';
|
|
import MCPSelect from './MCPSelect';
|
|
import WebSearch from './WebSearch';
|
|
import store from '~/store';
|
|
|
|
interface BadgeRowProps {
|
|
showEphemeralBadges?: boolean;
|
|
onChange: (badges: Pick<BadgeItem, 'id'>[]) => void;
|
|
onToggle?: (badgeId: string, currentActive: boolean) => void;
|
|
conversationId?: string | null;
|
|
isInChat: boolean;
|
|
}
|
|
|
|
interface BadgeWrapperProps {
|
|
badge: BadgeItem;
|
|
isEditing: boolean;
|
|
isInChat: boolean;
|
|
onToggle: (badge: BadgeItem) => void;
|
|
onDelete: (id: string) => void;
|
|
onMouseDown: (e: React.MouseEvent, badge: BadgeItem, isActive: boolean) => void;
|
|
badgeRefs: React.MutableRefObject<Record<string, HTMLDivElement>>;
|
|
}
|
|
|
|
const BadgeWrapper = React.memo(
|
|
forwardRef<HTMLDivElement, BadgeWrapperProps>(
|
|
({ badge, isEditing, isInChat, onToggle, onDelete, onMouseDown, badgeRefs }, ref) => {
|
|
const atomBadge = useRecoilValue(badge.atom);
|
|
const isActive = badge.atom ? atomBadge : false;
|
|
|
|
return (
|
|
<div
|
|
ref={(el) => {
|
|
if (el) {
|
|
badgeRefs.current[badge.id] = el;
|
|
}
|
|
if (typeof ref === 'function') {
|
|
ref(el);
|
|
} else if (ref) {
|
|
ref.current = el;
|
|
}
|
|
}}
|
|
onMouseDown={(e) => onMouseDown(e, badge, isActive)}
|
|
className={isEditing ? 'ios-wiggle badge-icon h-full' : 'badge-icon h-full'}
|
|
>
|
|
<Badge
|
|
id={badge.id}
|
|
icon={badge.icon as LucideIcon}
|
|
label={badge.label}
|
|
isActive={isActive}
|
|
isEditing={isEditing}
|
|
isAvailable={badge.isAvailable}
|
|
isInChat={isInChat}
|
|
onToggle={() => onToggle(badge)}
|
|
onBadgeAction={() => onDelete(badge.id)}
|
|
/>
|
|
</div>
|
|
);
|
|
},
|
|
),
|
|
(prevProps, nextProps) =>
|
|
prevProps.badge.id === nextProps.badge.id &&
|
|
prevProps.isEditing === nextProps.isEditing &&
|
|
prevProps.isInChat === nextProps.isInChat &&
|
|
prevProps.onToggle === nextProps.onToggle &&
|
|
prevProps.onDelete === nextProps.onDelete &&
|
|
prevProps.onMouseDown === nextProps.onMouseDown &&
|
|
prevProps.badgeRefs === nextProps.badgeRefs,
|
|
);
|
|
|
|
BadgeWrapper.displayName = 'BadgeWrapper';
|
|
|
|
interface DragState {
|
|
draggedBadge: BadgeItem | null;
|
|
mouseX: number;
|
|
offsetX: number;
|
|
insertIndex: number | null;
|
|
draggedBadgeActive: boolean;
|
|
}
|
|
|
|
type DragAction =
|
|
| {
|
|
type: 'START_DRAG';
|
|
badge: BadgeItem;
|
|
mouseX: number;
|
|
offsetX: number;
|
|
insertIndex: number;
|
|
isActive: boolean;
|
|
}
|
|
| { type: 'UPDATE_POSITION'; mouseX: number; insertIndex: number }
|
|
| { type: 'END_DRAG' };
|
|
|
|
const dragReducer = (state: DragState, action: DragAction): DragState => {
|
|
switch (action.type) {
|
|
case 'START_DRAG':
|
|
return {
|
|
draggedBadge: action.badge,
|
|
mouseX: action.mouseX,
|
|
offsetX: action.offsetX,
|
|
insertIndex: action.insertIndex,
|
|
draggedBadgeActive: action.isActive,
|
|
};
|
|
case 'UPDATE_POSITION':
|
|
return {
|
|
...state,
|
|
mouseX: action.mouseX,
|
|
insertIndex: action.insertIndex,
|
|
};
|
|
case 'END_DRAG':
|
|
return {
|
|
draggedBadge: null,
|
|
mouseX: 0,
|
|
offsetX: 0,
|
|
insertIndex: null,
|
|
draggedBadgeActive: false,
|
|
};
|
|
default:
|
|
return state;
|
|
}
|
|
};
|
|
|
|
function BadgeRow({
|
|
showEphemeralBadges,
|
|
conversationId,
|
|
onChange,
|
|
onToggle,
|
|
isInChat,
|
|
}: BadgeRowProps) {
|
|
const [orderedBadges, setOrderedBadges] = useState<BadgeItem[]>([]);
|
|
const [dragState, dispatch] = useReducer(dragReducer, {
|
|
draggedBadge: null,
|
|
mouseX: 0,
|
|
offsetX: 0,
|
|
insertIndex: null,
|
|
draggedBadgeActive: false,
|
|
});
|
|
|
|
const badgeRefs = useRef<Record<string, HTMLDivElement>>({});
|
|
const containerRef = useRef<HTMLDivElement>(null);
|
|
const animationFrame = useRef<number | null>(null);
|
|
const containerRectRef = useRef<DOMRect | null>(null);
|
|
|
|
const allBadges = useChatBadges();
|
|
const isEditing = useRecoilValue(store.isEditingBadges);
|
|
|
|
const badges = useMemo(
|
|
() => allBadges.filter((badge) => badge.isAvailable !== false),
|
|
[allBadges],
|
|
);
|
|
|
|
const toggleBadge = useRecoilCallback(
|
|
({ snapshot, set }) =>
|
|
async (badgeAtom: any) => {
|
|
const current = await snapshot.getPromise(badgeAtom);
|
|
set(badgeAtom, !current);
|
|
},
|
|
[],
|
|
);
|
|
|
|
useEffect(() => {
|
|
setOrderedBadges((prev) => {
|
|
const currentIds = new Set(prev.map((b) => b.id));
|
|
const newBadges = badges.filter((b) => !currentIds.has(b.id));
|
|
return newBadges.length > 0 ? [...prev, ...newBadges] : prev;
|
|
});
|
|
}, [badges]);
|
|
|
|
const tempBadges = dragState.draggedBadge
|
|
? orderedBadges.filter((b) => b.id !== dragState.draggedBadge?.id)
|
|
: orderedBadges;
|
|
const ghostBadge = dragState.draggedBadge || null;
|
|
|
|
const calculateInsertIndex = useCallback(
|
|
(currentMouseX: number): number => {
|
|
if (!dragState.draggedBadge || !containerRef.current || !containerRectRef.current) {
|
|
return 0;
|
|
}
|
|
const relativeMouseX = currentMouseX - containerRectRef.current.left;
|
|
const refs = tempBadges.map((b) => badgeRefs.current[b.id]).filter(Boolean);
|
|
if (refs.length === 0) {
|
|
return 0;
|
|
}
|
|
let idx = 0;
|
|
for (let i = 0; i < refs.length; i++) {
|
|
const rect = refs[i].getBoundingClientRect();
|
|
const relativeLeft = rect.left - containerRectRef.current.left;
|
|
const relativeCenter = relativeLeft + rect.width / 2;
|
|
if (relativeMouseX < relativeCenter) {
|
|
break;
|
|
}
|
|
idx = i + 1;
|
|
}
|
|
return idx;
|
|
},
|
|
[dragState.draggedBadge, tempBadges],
|
|
);
|
|
|
|
const handleMouseDown = useCallback(
|
|
(e: React.MouseEvent, badge: BadgeItem, isActive: boolean) => {
|
|
if (!isEditing || !containerRef.current) {
|
|
return;
|
|
}
|
|
const el = badgeRefs.current[badge.id];
|
|
if (!el) {
|
|
return;
|
|
}
|
|
const rect = el.getBoundingClientRect();
|
|
const offsetX = e.clientX - rect.left;
|
|
const mouseX = e.clientX;
|
|
const initialIndex = orderedBadges.findIndex((b) => b.id === badge.id);
|
|
containerRectRef.current = containerRef.current.getBoundingClientRect();
|
|
dispatch({
|
|
type: 'START_DRAG',
|
|
badge,
|
|
mouseX,
|
|
offsetX,
|
|
insertIndex: initialIndex,
|
|
isActive,
|
|
});
|
|
},
|
|
[isEditing, orderedBadges],
|
|
);
|
|
|
|
const handleMouseMove = useCallback(
|
|
(e: MouseEvent) => {
|
|
if (!dragState.draggedBadge) {
|
|
return;
|
|
}
|
|
if (animationFrame.current) {
|
|
cancelAnimationFrame(animationFrame.current);
|
|
}
|
|
animationFrame.current = requestAnimationFrame(() => {
|
|
const newMouseX = e.clientX;
|
|
const newInsertIndex = calculateInsertIndex(newMouseX);
|
|
if (newInsertIndex !== dragState.insertIndex) {
|
|
dispatch({ type: 'UPDATE_POSITION', mouseX: newMouseX, insertIndex: newInsertIndex });
|
|
} else {
|
|
dispatch({
|
|
type: 'UPDATE_POSITION',
|
|
mouseX: newMouseX,
|
|
insertIndex: dragState.insertIndex,
|
|
});
|
|
}
|
|
});
|
|
},
|
|
[dragState.draggedBadge, dragState.insertIndex, calculateInsertIndex],
|
|
);
|
|
|
|
const handleMouseUp = useCallback(() => {
|
|
if (dragState.draggedBadge && dragState.insertIndex !== null) {
|
|
const otherBadges = orderedBadges.filter((b) => b.id !== dragState.draggedBadge?.id);
|
|
const newBadges = [
|
|
...otherBadges.slice(0, dragState.insertIndex),
|
|
dragState.draggedBadge,
|
|
...otherBadges.slice(dragState.insertIndex),
|
|
];
|
|
setOrderedBadges(newBadges);
|
|
onChange(newBadges.map((badge) => ({ id: badge.id })));
|
|
}
|
|
dispatch({ type: 'END_DRAG' });
|
|
containerRectRef.current = null;
|
|
}, [dragState.draggedBadge, dragState.insertIndex, orderedBadges, onChange]);
|
|
|
|
const handleDelete = useCallback(
|
|
(badgeId: string) => {
|
|
const newBadges = orderedBadges.filter((b) => b.id !== badgeId);
|
|
setOrderedBadges(newBadges);
|
|
onChange(newBadges.map((badge) => ({ id: badge.id })));
|
|
},
|
|
[orderedBadges, onChange],
|
|
);
|
|
|
|
const handleBadgeToggle = useCallback(
|
|
(badge: BadgeItem) => {
|
|
if (badge.atom) {
|
|
toggleBadge(badge.atom);
|
|
}
|
|
if (onToggle) {
|
|
onToggle(badge.id, !!badge.atom);
|
|
}
|
|
},
|
|
[toggleBadge, onToggle],
|
|
);
|
|
|
|
useEffect(() => {
|
|
if (!dragState.draggedBadge) {
|
|
return;
|
|
}
|
|
document.addEventListener('mousemove', handleMouseMove);
|
|
document.addEventListener('mouseup', handleMouseUp);
|
|
return () => {
|
|
document.removeEventListener('mousemove', handleMouseMove);
|
|
document.removeEventListener('mouseup', handleMouseUp);
|
|
if (animationFrame.current) {
|
|
cancelAnimationFrame(animationFrame.current);
|
|
animationFrame.current = null;
|
|
}
|
|
};
|
|
}, [dragState.draggedBadge, handleMouseMove, handleMouseUp]);
|
|
|
|
return (
|
|
<div ref={containerRef} className="relative flex flex-wrap items-center gap-2">
|
|
{tempBadges.map((badge, index) => (
|
|
<React.Fragment key={badge.id}>
|
|
{dragState.draggedBadge && dragState.insertIndex === index && ghostBadge && (
|
|
<div className="badge-icon h-full">
|
|
<Badge
|
|
id={ghostBadge.id}
|
|
icon={ghostBadge.icon as LucideIcon}
|
|
label={ghostBadge.label}
|
|
isActive={dragState.draggedBadgeActive}
|
|
isEditing={isEditing}
|
|
isAvailable={ghostBadge.isAvailable}
|
|
isInChat={isInChat}
|
|
/>
|
|
</div>
|
|
)}
|
|
<BadgeWrapper
|
|
badge={badge}
|
|
isEditing={isEditing}
|
|
isInChat={isInChat}
|
|
onToggle={handleBadgeToggle}
|
|
onDelete={handleDelete}
|
|
onMouseDown={handleMouseDown}
|
|
badgeRefs={badgeRefs}
|
|
/>
|
|
</React.Fragment>
|
|
))}
|
|
{dragState.draggedBadge && dragState.insertIndex === tempBadges.length && ghostBadge && (
|
|
<div className="badge-icon h-full">
|
|
<Badge
|
|
id={ghostBadge.id}
|
|
icon={ghostBadge.icon as LucideIcon}
|
|
label={ghostBadge.label}
|
|
isActive={dragState.draggedBadgeActive}
|
|
isEditing={isEditing}
|
|
isAvailable={ghostBadge.isAvailable}
|
|
isInChat={isInChat}
|
|
/>
|
|
</div>
|
|
)}
|
|
{showEphemeralBadges === true && (
|
|
<>
|
|
<WebSearch conversationId={conversationId} />
|
|
<CodeInterpreter conversationId={conversationId} />
|
|
<MCPSelect conversationId={conversationId} />
|
|
</>
|
|
)}
|
|
{ghostBadge && (
|
|
<div
|
|
className="ghost-badge h-full"
|
|
style={{
|
|
position: 'absolute',
|
|
top: 0,
|
|
left: 0,
|
|
transform: `translateX(${dragState.mouseX - dragState.offsetX - (containerRectRef.current?.left || 0)}px)`,
|
|
zIndex: 10,
|
|
pointerEvents: 'none',
|
|
}}
|
|
>
|
|
<Badge
|
|
id={ghostBadge.id}
|
|
icon={ghostBadge.icon as LucideIcon}
|
|
label={ghostBadge.label}
|
|
isActive={dragState.draggedBadgeActive}
|
|
isAvailable={ghostBadge.isAvailable}
|
|
isInChat={isInChat}
|
|
isEditing
|
|
isDragging
|
|
/>
|
|
</div>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export default memo(BadgeRow);
|