LibreChat/client/src/components/Web/plugin.ts
Danny Avila b2f44fc90f
🧩 feat: Web Search Config Validations & Clipboard Citation Processing (#7530)
* 🔧 chore: Add missing optional `scraperTimeout` to webSearchSchema

* chore: Add missing optional `scraperTimeout` to web search authentication result

* chore: linting

* feat: Integrate attachment handling and citation processing in message components

- Added `useAttachments` hook to manage message attachments and search results.
- Updated `MessageParts`, `ContentParts`, and `ContentRender` components to utilize the new hook for improved attachment handling.
- Enhanced `useCopyToClipboard` to format citations correctly, including support for composite citations and deduplication.
- Introduced utility functions for citation processing and cleanup.
- Added tests for the new `useCopyToClipboard` functionality to ensure proper citation formatting and handling.

* feat: Add configuration for LibreChat Code Interpreter API and Web Search variables

* fix: Update searchResults type to use SearchResultData for better type safety

* feat: Add web search configuration validation and logging

- Introduced `checkWebSearchConfig` function to validate web search configuration values, ensuring they are environment variable references.
- Added logging for proper configuration and warnings for incorrect values.
- Created unit tests for `checkWebSearchConfig` to cover various scenarios, including valid and invalid configurations.

* docs: Update README to include Web Search feature details

- Added a section for the Web Search feature, highlighting its capabilities to search the internet and enhance AI context.
- Included links for further information on the Web Search functionality.

* ci: Add mock for checkWebSearchConfig in AppService tests

* chore: linting

* feat: Enhance Shared Messages with Web Search UI by adding searchResults prop to SearchContent and MinimalHoverButtons components

* chore: linting

* refactor: remove Meilisearch index sync from importConversations function

* feat: update safeSearch implementation to use SafeSearchTypes enum

* refactor: remove commented-out code in loadTools function

* fix: ensure responseMessageId handles latestMessage ID correctly

* feat: enhance Vite configuration for improved chunking and caching

- Added additional globIgnores for map files in Workbox configuration.
- Implemented high-impact chunking for various large libraries to optimize performance.
- Increased chunkSizeWarningLimit from 1200 to 1500 for better handling of larger chunks.

* refactor: move health check hook to Root, fix bad setState for Temporary state

- Enhanced the `useHealthCheck` hook to initiate health checks only when the user is authenticated.
- Added logic for managing health check intervals and handling window focus events.
- Introduced a new test suite for `useHealthCheck` to cover various scenarios including authentication state changes and error handling.
- Removed the health check invocation from `ChatRoute` and added it to `Root` for global health monitoring.

* fix: update font alias in Vite configuration for correct path resolution
2025-05-24 10:23:17 -04:00

246 lines
7.8 KiB
TypeScript

import { visit } from 'unist-util-visit';
import type { Node } from 'unist';
import type { Citation, CitationNode } from './types';
import { SPAN_REGEX, STANDALONE_PATTERN, CLEANUP_REGEX, COMPOSITE_REGEX } from '~/utils/citations';
/**
* Checks if a standalone marker is truly standalone (not inside a composite block)
*/
function isStandaloneMarker(text: string, position: number): boolean {
const beforeText = text.substring(0, position);
const lastUe200 = beforeText.lastIndexOf('\\ue200');
const lastUe201 = beforeText.lastIndexOf('\\ue201');
return lastUe200 === -1 || (lastUe201 !== -1 && lastUe201 > lastUe200);
}
/**
* Find the next pattern match from the current position
*/
function findNextMatch(
text: string,
position: number,
): { type: string; match: RegExpExecArray | null; index: number } | null {
// Reset regex lastIndex to start from current position
SPAN_REGEX.lastIndex = position;
COMPOSITE_REGEX.lastIndex = position;
STANDALONE_PATTERN.lastIndex = position;
// Find next occurrence of each pattern
const spanMatch = SPAN_REGEX.exec(text);
const compositeMatch = COMPOSITE_REGEX.exec(text);
// For standalone, we need to check each match
let standaloneMatch: RegExpExecArray | null = null;
STANDALONE_PATTERN.lastIndex = position;
// Find the first standalone match that's not inside a composite block
let match: RegExpExecArray | null;
while (!standaloneMatch && (match = STANDALONE_PATTERN.exec(text)) !== null) {
if (isStandaloneMarker(text, match.index)) {
standaloneMatch = match;
}
}
// Find closest match
let nextMatch: RegExpExecArray | null = null;
let matchType = '';
let matchIndex = -1;
let typeIndex = -1;
if (spanMatch && (!nextMatch || spanMatch.index < matchIndex || matchIndex === -1)) {
nextMatch = spanMatch;
matchType = 'span';
matchIndex = spanMatch.index;
// We can use a counter for typeIndex if needed
typeIndex = 0;
}
if (compositeMatch && (!nextMatch || compositeMatch.index < matchIndex || matchIndex === -1)) {
nextMatch = compositeMatch;
matchType = 'composite';
matchIndex = compositeMatch.index;
typeIndex = 0;
}
if (standaloneMatch && (!nextMatch || standaloneMatch.index < matchIndex || matchIndex === -1)) {
nextMatch = standaloneMatch;
matchType = 'standalone';
matchIndex = standaloneMatch.index;
typeIndex = 0;
}
if (!nextMatch) return null;
return { type: matchType, match: nextMatch, index: typeIndex };
}
function processTree(tree: Node) {
visit(tree, 'text', (node, index, parent) => {
const textNode = node as CitationNode;
const parentNode = parent as CitationNode;
if (typeof textNode.value !== 'string') return;
const originalValue = textNode.value;
const segments: Array<CitationNode> = [];
// Single-pass processing through the string
let currentPosition = 0;
// Important change: Create a map to track citation IDs by their position
// This ensures consistent IDs across multiple segments
const citationIds = new Map<number, string>();
const typeCounts = { span: 0, composite: 0, standalone: 0 };
while (currentPosition < originalValue.length) {
const nextMatchInfo = findNextMatch(originalValue, currentPosition);
if (!nextMatchInfo) {
// No more matches, add remaining content with cleanup
const remainingText = originalValue.substring(currentPosition).replace(CLEANUP_REGEX, '');
if (remainingText) {
segments.push({ type: 'text', value: remainingText });
}
break;
}
const { type, match } = nextMatchInfo;
const matchIndex = match!.index;
const matchText = match![0];
// Add cleaned text before this match
if (matchIndex > currentPosition) {
const textBeforeMatch = originalValue
.substring(currentPosition, matchIndex)
.replace(CLEANUP_REGEX, '');
if (textBeforeMatch) {
segments.push({ type: 'text', value: textBeforeMatch });
}
}
// Generate a unique ID for this citation based on its position in the text
const citationId = `${type}-${typeCounts[type as keyof typeof typeCounts]}-${matchIndex}`;
citationIds.set(matchIndex, citationId);
// Process based on match type
switch (type) {
case 'span': {
const spanText = matchText;
const cleanText = spanText.replace(/\\ue203|\\ue204/g, '');
// Look ahead for associated citation
let associatedCitationId: string | null = null;
const endOfSpan = matchIndex + matchText.length;
// Check if there's a citation right after this span
const nextCitation = findNextMatch(originalValue, endOfSpan);
if (
nextCitation &&
(nextCitation.type === 'standalone' || nextCitation.type === 'composite') &&
nextCitation.match!.index - endOfSpan < 5
) {
// Use the ID that will be generated for the next citation
const nextIndex = nextCitation.match!.index;
const nextType = nextCitation.type;
associatedCitationId = `${nextType}-${typeCounts[nextType as keyof typeof typeCounts]}-${nextIndex}`;
}
segments.push({
type: 'highlighted-text',
data: {
hName: 'highlighted-text',
hProperties: { citationId: associatedCitationId },
},
children: [{ type: 'text', value: cleanText }],
});
typeCounts.span++;
break;
}
case 'composite': {
const compositeText = matchText;
// Use a regular expression to extract reference indices
const compositeRefRegex = new RegExp(STANDALONE_PATTERN.source, 'g');
let refMatch: RegExpExecArray | null;
const citations: Array<Citation> = [];
while ((refMatch = compositeRefRegex.exec(compositeText)) !== null) {
const turn = Number(refMatch[1]);
const refType = refMatch[2];
const refIndex = Number(refMatch[3]);
citations.push({
turn,
refType,
index: refIndex,
});
}
if (citations.length > 0) {
segments.push({
type: 'composite-citation',
data: {
hName: 'composite-citation',
hProperties: {
citations,
citationId: citationId,
},
},
});
}
typeCounts.composite++;
break;
}
case 'standalone': {
// Extract reference info
const turn = Number(match![1]);
const refType = match![2];
const refIndex = Number(match![3]);
segments.push({
type: 'citation',
data: {
hName: 'citation',
hProperties: {
citation: {
turn,
refType,
index: refIndex,
},
citationType: 'standalone',
citationId: citationId,
},
},
});
typeCounts.standalone++;
break;
}
}
// Move position forward
currentPosition = matchIndex + matchText.length;
}
// Replace the original node with our segments or clean up the original
if (segments.length > 0 && index !== undefined) {
parentNode.children?.splice(index, 1, ...segments);
return index + segments.length;
} else if (textNode.value !== textNode.value.replace(CLEANUP_REGEX, '')) {
// If we didn't create segments but there are markers to clean up
textNode.value = textNode.value.replace(CLEANUP_REGEX, '');
}
});
}
export function unicodeCitation() {
return (tree: Node) => {
processTree(tree);
};
}