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]>
98 lines
3.3 KiB
TypeScript
98 lines
3.3 KiB
TypeScript
import { useEffect, useImperativeHandle } from 'react';
|
|
import { useRedaction as useEmbedPdfRedaction } from '@embedpdf/plugin-redaction/react';
|
|
import { PdfAnnotationSubtype } from '@embedpdf/models';
|
|
import { useRedaction } from '@app/contexts/RedactionContext';
|
|
import { useActiveDocumentId } from '@app/components/viewer/useActiveDocumentId';
|
|
import { useAnnotationCapability } from '@embedpdf/plugin-annotation/react';
|
|
import { useDocumentReady } from '@app/components/viewer/hooks/useDocumentReady';
|
|
|
|
/**
|
|
* Bridges between the EmbedPDF redaction plugin and the Stirling-PDF RedactionContext.
|
|
* Uses the unified redaction mode (toggleRedact/enableRedact/endRedact).
|
|
*/
|
|
export function RedactionAPIBridge() {
|
|
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 <RedactionAPIBridgeInner documentId={activeDocumentId} />;
|
|
}
|
|
|
|
function RedactionAPIBridgeInner({ documentId }: { documentId: string }) {
|
|
const { state, provides: redactionProvides } = useEmbedPdfRedaction(documentId);
|
|
const { provides: annotationProvides } = useAnnotationCapability();
|
|
const {
|
|
redactionApiRef,
|
|
setPendingCount,
|
|
setActiveType,
|
|
setIsRedacting,
|
|
setBridgeReady,
|
|
manualRedactColor
|
|
} = useRedaction();
|
|
|
|
// Mark bridge as ready on mount, not ready on unmount
|
|
useEffect(() => {
|
|
setBridgeReady(true);
|
|
return () => {
|
|
setBridgeReady(false);
|
|
};
|
|
}, [setBridgeReady]);
|
|
|
|
// Sync EmbedPDF state to our context
|
|
useEffect(() => {
|
|
if (state) {
|
|
setPendingCount(state.pendingCount ?? 0);
|
|
setActiveType(state.activeType ?? null);
|
|
setIsRedacting(state.isRedacting ?? false);
|
|
}
|
|
}, [state, setPendingCount, setActiveType, setIsRedacting]);
|
|
|
|
// Synchronize manual redaction color with EmbedPDF
|
|
// Manual redaction uses the 'redact' annotation tool internally
|
|
useEffect(() => {
|
|
const annotationApi = annotationProvides as any;
|
|
if (annotationApi?.setToolDefaults) {
|
|
annotationApi.setToolDefaults('redact', {
|
|
type: PdfAnnotationSubtype.REDACT,
|
|
strokeColor: manualRedactColor,
|
|
color: manualRedactColor,
|
|
overlayColor: manualRedactColor,
|
|
fillColor: manualRedactColor,
|
|
interiorColor: manualRedactColor,
|
|
backgroundColor: manualRedactColor,
|
|
opacity: 1
|
|
});
|
|
}
|
|
}, [annotationProvides, manualRedactColor]);
|
|
|
|
// Expose the EmbedPDF API through our context's ref
|
|
useImperativeHandle(redactionApiRef, () => ({
|
|
toggleRedact: () => {
|
|
redactionProvides?.toggleRedact();
|
|
},
|
|
enableRedact: () => {
|
|
redactionProvides?.enableRedact();
|
|
},
|
|
isRedactActive: () => {
|
|
return redactionProvides?.isRedactActive() ?? false;
|
|
},
|
|
endRedact: () => {
|
|
redactionProvides?.endRedact();
|
|
},
|
|
// Common methods
|
|
commitAllPending: () => {
|
|
redactionProvides?.commitAllPending();
|
|
// Don't set redactionsApplied here - it should only be set after the file is saved
|
|
// The save operation in applyChanges will handle setting/clearing this flag
|
|
},
|
|
getActiveType: () => state?.activeType ?? null,
|
|
getPendingCount: () => state?.pendingCount ?? 0,
|
|
}), [redactionProvides, state]);
|
|
|
|
return null;
|
|
}
|