mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-15 11:00:47 +02:00
# Description of Changes Upgrades embedPDF from v2.5.0 to v2.6.0 and migrates from unmaintained pdf-lib to @cantoo/pdf-lib fork. Adds defensive error handling for malformed PDFs and improves bridge lifecycle management. ### Changes **Dependencies** - Upgrade all @embedpdf/* packages from ^2.5.0 to ^2.6.0 - Replace pdf-lib with @cantoo/pdf-lib (maintained fork with better TypeScript support) **PDF Viewer Infrastructure (attachment/bookmark fix)** - Add useDocumentReady hook to track document lifecycle across bridges - Implement defensive bridge cleanup to prevent stale registrations - Fix race condition in document ready state detection by subscribing to events before checking state **Link Extraction (updated to cantoo/pdf-lib)** - Add graceful error handling for PDFs with invalid catalog structures - Extract enhanced link metadata (tooltips, colors, border styles, highlight modes) - Return empty results instead of throwing on malformed PDFs - Add validation for link creation (destination page bounds, rect dimensions, color values) **Signature Flattening (updated to cantoo/pdf-lib)** - Improve SVG embedding with three-tier fallback strategy (native vector, rasterized PNG, placeholder) - Add proper Unicode handling for PDF form tooltips via PDFString.decodeText() - Extract SVG utilities into cleaner strategy pattern **Form Field Processing (updated to cantoo/pdf-lib)** - Add support for display labels vs export values in dropdown/list fields per PDF spec 12.7.4.4 - Implement caching for expensive field property lookups - Add proper handling of malformed /Opt arrays <!-- Please provide a summary of the changes, including: - What was changed - Why the change was made - Any challenges encountered Closes #(issue_number) --> --- ## Checklist ### General - [X] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [X] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [X] I have performed a self-review of my own code - [X] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [X] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details. --------- Signed-off-by: Balázs Szücs <[email protected]>
188 lines
5.9 KiB
TypeScript
188 lines
5.9 KiB
TypeScript
import { useEffect, useState, useRef } from 'react';
|
|
import { useSearch } from '@embedpdf/plugin-search/react';
|
|
import { useViewer } from '@app/contexts/ViewerContext';
|
|
import { useActiveDocumentId } from '@app/components/viewer/useActiveDocumentId';
|
|
import { useDocumentReady } from '@app/components/viewer/hooks/useDocumentReady';
|
|
|
|
interface SearchResult {
|
|
pageIndex: number;
|
|
rects: Array<{
|
|
origin: { x: number; y: number };
|
|
size: { width: number; height: number };
|
|
}>;
|
|
}
|
|
|
|
/**
|
|
* SearchAPIBridge - Updated for embedPDF v2.6.0
|
|
* Connects the PDF search plugin to the shared ViewerContext.
|
|
*/
|
|
export function SearchAPIBridge() {
|
|
const activeDocumentId = useActiveDocumentId();
|
|
const documentReady = useDocumentReady();
|
|
|
|
// Don't render the inner component until we have a valid document ID and document is ready
|
|
if (!activeDocumentId || !documentReady) {
|
|
return null;
|
|
}
|
|
|
|
return <SearchAPIBridgeInner documentId={activeDocumentId} />;
|
|
}
|
|
|
|
function SearchAPIBridgeInner({ documentId }: { documentId: string }) {
|
|
const { provides: search } = useSearch(documentId);
|
|
const { registerBridge, scrollActions } = useViewer();
|
|
|
|
// Keep search ref updated to avoid re-running effects when object reference changes
|
|
const searchRef = useRef(search);
|
|
const isSearchingRef = useRef(false);
|
|
const lastScrolledIndexRef = useRef<number | null>(null);
|
|
|
|
useEffect(() => {
|
|
searchRef.current = search;
|
|
}, [search]);
|
|
|
|
const [localState, setLocalState] = useState({
|
|
results: null as SearchResult[] | null,
|
|
activeIndex: 0
|
|
});
|
|
|
|
// Subscribe to search result changes from EmbedPDF
|
|
const subscriptionRef = useRef<(() => void) | null>(null);
|
|
|
|
useEffect(() => {
|
|
// Cleanup previous subscription
|
|
if (subscriptionRef.current) {
|
|
subscriptionRef.current();
|
|
subscriptionRef.current = null;
|
|
}
|
|
|
|
if (!search) return;
|
|
|
|
subscriptionRef.current = search.onSearchResultStateChange?.((state: any) => {
|
|
if (!state) return;
|
|
|
|
const newState = {
|
|
results: state.results || null,
|
|
activeIndex: (state.activeResultIndex || 0) + 1 // Convert to 1-based index
|
|
};
|
|
|
|
setLocalState(prevState => {
|
|
// Only update if state actually changed
|
|
if (prevState.results !== newState.results || prevState.activeIndex !== newState.activeIndex) {
|
|
return newState;
|
|
}
|
|
return prevState;
|
|
});
|
|
}) ?? null;
|
|
|
|
return () => {
|
|
if (subscriptionRef.current) {
|
|
subscriptionRef.current();
|
|
subscriptionRef.current = null;
|
|
}
|
|
};
|
|
}, [search]);
|
|
|
|
// Extract primitive values from localState to avoid object reference dependencies
|
|
const localResults = localState.results;
|
|
const localActiveIndex = localState.activeIndex;
|
|
|
|
// Scroll to active result when it changes (for next/previous navigation)
|
|
useEffect(() => {
|
|
if (!localResults || localResults.length === 0) {
|
|
lastScrolledIndexRef.current = null;
|
|
return;
|
|
}
|
|
|
|
// Only scroll if the active index actually changed
|
|
const activeResultIndex = localActiveIndex - 1; // Convert back to 0-based
|
|
if (activeResultIndex >= 0 &&
|
|
activeResultIndex < localResults.length &&
|
|
lastScrolledIndexRef.current !== activeResultIndex) {
|
|
const activeResult = localResults[activeResultIndex];
|
|
if (activeResult) {
|
|
const pageNumber = activeResult.pageIndex + 1; // Convert to 1-based page number
|
|
scrollActions.scrollToPage(pageNumber);
|
|
lastScrolledIndexRef.current = activeResultIndex;
|
|
}
|
|
}
|
|
}, [localResults, localActiveIndex, scrollActions]);
|
|
|
|
// Register bridge whenever state changes
|
|
useEffect(() => {
|
|
const currentSearch = searchRef.current;
|
|
if (currentSearch) {
|
|
registerBridge('search', {
|
|
state: { results: localResults, activeIndex: localActiveIndex },
|
|
api: {
|
|
search: async (query: string) => {
|
|
// Prevent overlapping searches
|
|
if (isSearchingRef.current) {
|
|
return null;
|
|
}
|
|
|
|
if (!currentSearch?.startSearch || !currentSearch?.searchAllPages) {
|
|
return null;
|
|
}
|
|
|
|
isSearchingRef.current = true;
|
|
|
|
try {
|
|
currentSearch.startSearch();
|
|
const results = await currentSearch.searchAllPages(query);
|
|
return results;
|
|
} catch (error: any) {
|
|
// Handle abort errors gracefully - these occur when searches overlap
|
|
if (error?.type === 'abort' || error?.message?.includes('abort')) {
|
|
// Silently handle abort - this is expected when user types quickly
|
|
return null;
|
|
}
|
|
console.error('Search failed:', error);
|
|
return null;
|
|
} finally {
|
|
isSearchingRef.current = false;
|
|
}
|
|
},
|
|
clear: () => {
|
|
try {
|
|
if (currentSearch?.stopSearch) {
|
|
currentSearch.stopSearch();
|
|
}
|
|
} catch (error) {
|
|
console.warn('Error stopping search:', error);
|
|
}
|
|
setLocalState({ results: null, activeIndex: 0 });
|
|
},
|
|
next: () => {
|
|
try {
|
|
currentSearch?.nextResult?.();
|
|
} catch (error) {
|
|
console.warn('Error navigating to next result:', error);
|
|
}
|
|
},
|
|
previous: () => {
|
|
try {
|
|
currentSearch?.previousResult?.();
|
|
} catch (error) {
|
|
console.warn('Error navigating to previous result:', error);
|
|
}
|
|
},
|
|
goToResult: (index: number) => {
|
|
try {
|
|
currentSearch?.goToResult?.(index);
|
|
} catch (error) {
|
|
console.warn('Error going to result:', error);
|
|
}
|
|
},
|
|
}
|
|
});
|
|
}
|
|
|
|
return () => {
|
|
registerBridge('search', null);
|
|
};
|
|
}, [localResults, localActiveIndex, registerBridge]);
|
|
|
|
return null;
|
|
}
|