mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-16 19:33:11 +02:00
feat(redaction): update to embedPDF v2.4.0 with unified redaction mode support (#5652)
# Description of Changes Bump to EmbedPDF v2.4.0 plus update to the redaction methods <!-- 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]>
This commit is contained in:
@@ -13,6 +13,7 @@ import { useToolWorkflow } from '@app/contexts/ToolWorkflowContext';
|
||||
import { useRightRailTooltipSide } from '@app/hooks/useRightRailTooltipSide';
|
||||
import { useRedactionMode, useRedaction } from '@app/contexts/RedactionContext';
|
||||
import { defaultParameters, RedactParameters } from '@app/hooks/tools/redact/useRedactParameters';
|
||||
import { RedactionMode } from '@embedpdf/plugin-redaction';
|
||||
|
||||
interface ViewerAnnotationControlsProps {
|
||||
currentView: string;
|
||||
@@ -41,11 +42,11 @@ export default function ViewerAnnotationControls({ currentView, disabled = false
|
||||
const { actions: navActions } = useNavigationActions();
|
||||
const isSignMode = selectedTool === 'sign';
|
||||
const isRedactMode = selectedTool === 'redact';
|
||||
|
||||
|
||||
// Get redaction pending state and navigation guard
|
||||
const { isRedacting: _isRedacting } = useRedactionMode();
|
||||
const { requestNavigation, setHasUnsavedChanges } = useNavigationGuard();
|
||||
const { setRedactionMode, activateTextSelection, setRedactionConfig, setRedactionsApplied, redactionApiRef, setActiveType } = useRedaction();
|
||||
const { setRedactionMode, activateRedact, setRedactionConfig, setRedactionsApplied, redactionApiRef, setActiveType } = useRedaction();
|
||||
|
||||
|
||||
// Check if we're in any annotation tool that should disable the toggle
|
||||
@@ -70,7 +71,7 @@ export default function ViewerAnnotationControls({ currentView, disabled = false
|
||||
|
||||
const { stirlingFiles, stubs } = await createStirlingFilesAndStubs([file], parentStub, 'redact');
|
||||
await fileActions.consumeFiles([state.files.ids[0]], stirlingFiles, stubs);
|
||||
|
||||
|
||||
// Clear unsaved changes flags after successful save
|
||||
setHasUnsavedChanges(false);
|
||||
setRedactionsApplied(false);
|
||||
@@ -113,11 +114,11 @@ export default function ViewerAnnotationControls({ currentView, disabled = false
|
||||
setLeftPanelView('toolContent');
|
||||
|
||||
setRedactionMode(true);
|
||||
// Activate text selection mode after a short delay
|
||||
// Activate unified redact mode after a short delay
|
||||
setTimeout(() => {
|
||||
const currentType = redactionApiRef.current?.getActiveType?.();
|
||||
if (currentType !== 'redactSelection') {
|
||||
activateTextSelection();
|
||||
if (currentType !== RedactionMode.Redact) {
|
||||
activateRedact();
|
||||
}
|
||||
}, 200);
|
||||
};
|
||||
|
||||
@@ -14,51 +14,45 @@ interface ManualRedactionControlsProps {
|
||||
/**
|
||||
* ManualRedactionControls provides UI for manual PDF redaction in the tool panel.
|
||||
* Displays controls for marking text/areas for redaction and applying them.
|
||||
* Uses our RedactionContext which bridges to the EmbedPDF API.
|
||||
*/
|
||||
export default function ManualRedactionControls({ disabled = false }: ManualRedactionControlsProps) {
|
||||
const { t } = useTranslation();
|
||||
|
||||
// Use our RedactionContext which bridges to EmbedPDF
|
||||
const { activateTextSelection, activateMarquee, redactionsApplied, setActiveType } = useRedaction();
|
||||
const { pendingCount, activeType, isRedacting, isBridgeReady } = useRedactionMode();
|
||||
|
||||
const { pendingCount, activeType, isBridgeReady } = useRedactionMode();
|
||||
|
||||
// Get viewer context to manage annotation mode and save changes
|
||||
const { isAnnotationMode, setAnnotationMode, applyChanges, activeFileIndex } = useViewer();
|
||||
|
||||
|
||||
// Get signature context to deactivate annotation tools when switching to redaction
|
||||
const { signatureApiRef } = useSignature();
|
||||
|
||||
|
||||
// Check which tool is active based on activeType
|
||||
const isSelectionActive = activeType === 'redactSelection';
|
||||
const isMarqueeActive = activeType === 'marqueeRedact';
|
||||
|
||||
// Track if we've auto-activated
|
||||
|
||||
// Track if we've auto-activated for the current bridge session
|
||||
const hasAutoActivated = useRef(false);
|
||||
|
||||
|
||||
// Track the previous file index to detect file switches
|
||||
const prevFileIndexRef = useRef<number>(activeFileIndex);
|
||||
|
||||
// Track previous pending count to detect when all redactions are applied
|
||||
const prevPendingCountRef = useRef<number>(pendingCount);
|
||||
|
||||
// Track if we're currently auto-saving to prevent re-entry
|
||||
const isAutoSavingRef = useRef(false);
|
||||
|
||||
// Auto-activate selection mode when the API bridge becomes ready
|
||||
// This ensures at least one tool is selected when entering manual redaction mode
|
||||
// This ensures Mark Text is pre-selected when entering manual redaction mode
|
||||
useEffect(() => {
|
||||
if (isBridgeReady && !disabled && !isRedacting && !hasAutoActivated.current) {
|
||||
if (isBridgeReady && !disabled && !hasAutoActivated.current) {
|
||||
hasAutoActivated.current = true;
|
||||
// Small delay to ensure EmbedPDF is fully ready
|
||||
const timer = setTimeout(() => {
|
||||
// Deactivate annotation mode to show redaction layer
|
||||
setAnnotationMode(false);
|
||||
// Pre-select the Mark Text tool
|
||||
activateTextSelection();
|
||||
}, 100);
|
||||
}, 150);
|
||||
return () => clearTimeout(timer);
|
||||
}
|
||||
}, [isBridgeReady, disabled, isRedacting, activateTextSelection, setAnnotationMode]);
|
||||
}, [isBridgeReady, disabled, activateTextSelection, setAnnotationMode]);
|
||||
|
||||
// Reset auto-activation flag when disabled changes or bridge becomes not ready
|
||||
useEffect(() => {
|
||||
@@ -72,50 +66,19 @@ export default function ManualRedactionControls({ disabled = false }: ManualReda
|
||||
useEffect(() => {
|
||||
if (prevFileIndexRef.current !== activeFileIndex) {
|
||||
prevFileIndexRef.current = activeFileIndex;
|
||||
|
||||
|
||||
// Reset active type to null when switching files
|
||||
// This makes both buttons appear unselected, requiring the user to re-click
|
||||
// which ensures proper activation on the new PDF
|
||||
if (isSelectionActive || isMarqueeActive) {
|
||||
setActiveType(null);
|
||||
}
|
||||
|
||||
// Reset auto-activation flag so new file can auto-activate
|
||||
hasAutoActivated.current = false;
|
||||
}
|
||||
}, [activeFileIndex, isSelectionActive, isMarqueeActive, setActiveType]);
|
||||
|
||||
// Auto-save when all pending redactions have been applied
|
||||
// This triggers when the user clicks "Apply (permanent)" on the last pending redaction
|
||||
useEffect(() => {
|
||||
const hadPendingBefore = prevPendingCountRef.current > 0;
|
||||
const hasNoPendingNow = pendingCount === 0;
|
||||
const wasJustCleared = hadPendingBefore && hasNoPendingNow;
|
||||
|
||||
// Update the ref for next comparison
|
||||
prevPendingCountRef.current = pendingCount;
|
||||
|
||||
// Auto-save when:
|
||||
// - pendingCount just went from > 0 to 0 (user applied the last pending redaction)
|
||||
// - redactionsApplied is true (at least one redaction was committed)
|
||||
// - not already auto-saving
|
||||
// - applyChanges is available
|
||||
if (wasJustCleared && redactionsApplied && !isAutoSavingRef.current && applyChanges) {
|
||||
isAutoSavingRef.current = true;
|
||||
|
||||
// Small delay to ensure UI updates before save
|
||||
const timer = setTimeout(async () => {
|
||||
try {
|
||||
await applyChanges();
|
||||
} finally {
|
||||
isAutoSavingRef.current = false;
|
||||
}
|
||||
}, 100);
|
||||
|
||||
return () => {
|
||||
clearTimeout(timer);
|
||||
isAutoSavingRef.current = false;
|
||||
};
|
||||
}
|
||||
}, [pendingCount, redactionsApplied, applyChanges]);
|
||||
|
||||
const handleSelectionClick = () => {
|
||||
// Deactivate annotation mode and tools to switch to redaction layer
|
||||
if (isAnnotationMode) {
|
||||
@@ -129,7 +92,7 @@ export default function ManualRedactionControls({ disabled = false }: ManualReda
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
if (isSelectionActive && !isAnnotationMode) {
|
||||
// If already active and not coming from annotation mode, switch to marquee
|
||||
activateMarquee();
|
||||
@@ -151,7 +114,7 @@ export default function ManualRedactionControls({ disabled = false }: ManualReda
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
if (isMarqueeActive && !isAnnotationMode) {
|
||||
// If already active and not coming from annotation mode, switch to selection
|
||||
activateTextSelection();
|
||||
@@ -170,7 +133,7 @@ export default function ManualRedactionControls({ disabled = false }: ManualReda
|
||||
// Check if there are unsaved changes to save (pending redactions OR applied redactions)
|
||||
// Save Changes button will apply pending redactions and then save everything
|
||||
const hasUnsavedChanges = pendingCount > 0 || redactionsApplied;
|
||||
|
||||
|
||||
// Check if API is available - use isBridgeReady state instead of ref (refs don't trigger re-renders)
|
||||
const isApiReady = isBridgeReady;
|
||||
|
||||
@@ -181,7 +144,7 @@ export default function ManualRedactionControls({ disabled = false }: ManualReda
|
||||
<Text size="sm" fw={500}>
|
||||
{t('redact.manual.title', 'Redaction Tools')}
|
||||
</Text>
|
||||
|
||||
|
||||
<Text size="xs" c="dimmed">
|
||||
{t('redact.manual.instructions', 'Select text or draw areas on the PDF to mark content for redaction.')}
|
||||
</Text>
|
||||
@@ -196,7 +159,7 @@ export default function ManualRedactionControls({ disabled = false }: ManualReda
|
||||
disabled={disabled || !isApiReady}
|
||||
size="sm"
|
||||
styles={{
|
||||
root: {
|
||||
root: {
|
||||
minWidth: 0,
|
||||
},
|
||||
label: { overflow: 'hidden', textOverflow: 'ellipsis', whiteSpace: 'nowrap' },
|
||||
@@ -214,7 +177,7 @@ export default function ManualRedactionControls({ disabled = false }: ManualReda
|
||||
disabled={disabled || !isApiReady}
|
||||
size="sm"
|
||||
styles={{
|
||||
root: {
|
||||
root: {
|
||||
minWidth: 0,
|
||||
},
|
||||
label: { overflow: 'hidden', textOverflow: 'ellipsis', whiteSpace: 'nowrap' },
|
||||
|
||||
@@ -88,6 +88,7 @@ type AnnotationApiSurface = {
|
||||
deselectAnnotation?: () => void;
|
||||
updateAnnotation?: (pageIndex: number, annotationId: string, patch: AnnotationPatch) => void;
|
||||
onAnnotationEvent?: (listener: (event: AnnotationEvent) => void) => void | (() => void);
|
||||
purgeAnnotation?: (pageIndex: number, annotationId: string) => void;
|
||||
};
|
||||
|
||||
type ToolDefaultsBuilder = (options?: AnnotationToolOptions) => AnnotationDefaults;
|
||||
@@ -372,6 +373,11 @@ export const AnnotationAPIBridge = forwardRef<AnnotationAPI>(function Annotation
|
||||
const api = annotationApi as AnnotationApiSurface | undefined;
|
||||
return api?.getActiveTool?.() ?? null;
|
||||
},
|
||||
|
||||
purgeAnnotation: (pageIndex: number, annotationId: string) => {
|
||||
const api = annotationApi as AnnotationApiSurface | undefined;
|
||||
api?.purgeAnnotation?.(pageIndex, annotationId);
|
||||
},
|
||||
}),
|
||||
[annotationApi, configureAnnotationTool, buildAnnotationDefaults]
|
||||
);
|
||||
|
||||
@@ -146,6 +146,13 @@ export const HistoryAPIBridge = forwardRef<HistoryAPI>(function HistoryAPIBridge
|
||||
return historyApi ? historyApi.canRedo() : false;
|
||||
},
|
||||
|
||||
purgeByMetadata: <T,>(predicate: (metadata: T | undefined) => boolean, topic?: string) => {
|
||||
if (historyApi?.purgeByMetadata) {
|
||||
return historyApi.purgeByMetadata(predicate, topic);
|
||||
}
|
||||
return 0;
|
||||
},
|
||||
|
||||
subscribe: (listener: () => void) => {
|
||||
if (!historyApi?.onHistoryChange) {
|
||||
return () => {};
|
||||
|
||||
@@ -48,7 +48,7 @@ function PanAPIBridgeInner({ documentId }: { documentId: string }) {
|
||||
currentPan.togglePan();
|
||||
},
|
||||
makePanDefault: () => {
|
||||
// v2.3.0: makePanDefault may not exist, enable pan as fallback
|
||||
// v2.5.0: makePanDefault may not exist, enable pan as fallback
|
||||
if ('makePanDefault' in currentPan && typeof (currentPan as any).makePanDefault === 'function') {
|
||||
(currentPan as any).makePanDefault();
|
||||
} else {
|
||||
|
||||
@@ -3,6 +3,11 @@ import { useRedaction as useEmbedPdfRedaction } from '@embedpdf/plugin-redaction
|
||||
import { useRedaction } from '@app/contexts/RedactionContext';
|
||||
import { useActiveDocumentId } from '@app/components/viewer/useActiveDocumentId';
|
||||
|
||||
/**
|
||||
* RedactionAPIBridge - Uses embedPDF v2.5.0
|
||||
* 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();
|
||||
|
||||
@@ -43,13 +48,22 @@ function RedactionAPIBridgeInner({ documentId }: { documentId: string }) {
|
||||
}, [state?.pendingCount, state?.activeType, state?.isRedacting, setPendingCount, setActiveType, setIsRedacting]);
|
||||
|
||||
// Expose the EmbedPDF API through our context's ref
|
||||
// Uses v2.5.0 unified redaction mode
|
||||
useImperativeHandle(redactionApiRef, () => ({
|
||||
toggleRedactSelection: () => {
|
||||
provides?.toggleRedactSelection();
|
||||
// Unified redaction methods (v2.5.0)
|
||||
toggleRedact: () => {
|
||||
provides?.toggleRedact();
|
||||
},
|
||||
toggleMarqueeRedact: () => {
|
||||
provides?.toggleMarqueeRedact();
|
||||
enableRedact: () => {
|
||||
provides?.enableRedact();
|
||||
},
|
||||
isRedactActive: () => {
|
||||
return provides?.isRedactActive() ?? false;
|
||||
},
|
||||
endRedact: () => {
|
||||
provides?.endRedact();
|
||||
},
|
||||
// Common methods
|
||||
commitAllPending: () => {
|
||||
provides?.commitAllPending();
|
||||
// Don't set redactionsApplied here - it should only be set after the file is saved
|
||||
|
||||
@@ -8,32 +8,30 @@ import CheckCircleIcon from '@mui/icons-material/CheckCircle';
|
||||
import { useRedaction } from '@app/contexts/RedactionContext';
|
||||
import { useActiveDocumentId } from '@app/components/viewer/useActiveDocumentId';
|
||||
|
||||
// Use the official EmbedPDF v2.3.0 types
|
||||
export type { RedactionSelectionMenuProps };
|
||||
|
||||
export function RedactionSelectionMenu(props: RedactionSelectionMenuProps) {
|
||||
const activeDocumentId = useActiveDocumentId();
|
||||
|
||||
|
||||
// Don't render until we have a valid document ID
|
||||
if (!activeDocumentId) {
|
||||
return null;
|
||||
}
|
||||
|
||||
|
||||
return (
|
||||
<RedactionSelectionMenuInner
|
||||
<RedactionSelectionMenuInner
|
||||
documentId={activeDocumentId}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function RedactionSelectionMenuInner({
|
||||
function RedactionSelectionMenuInner({
|
||||
documentId,
|
||||
context,
|
||||
selected,
|
||||
selected,
|
||||
menuWrapperProps,
|
||||
}: RedactionSelectionMenuProps & { documentId: string }) {
|
||||
// Extract item and pageIndex from context (EmbedPDF v2.3.0 API)
|
||||
const item = context?.item;
|
||||
const pageIndex = context?.pageIndex;
|
||||
const { t } = useTranslation();
|
||||
@@ -41,14 +39,14 @@ function RedactionSelectionMenuInner({
|
||||
const { setRedactionsApplied } = useRedaction();
|
||||
const wrapperRef = useRef<HTMLDivElement>(null);
|
||||
const [menuPosition, setMenuPosition] = useState<{ top: number; left: number } | null>(null);
|
||||
|
||||
|
||||
// Merge refs - menuWrapperProps.ref is a callback ref
|
||||
const setRef = useCallback((node: HTMLDivElement | null) => {
|
||||
wrapperRef.current = node;
|
||||
// Call the EmbedPDF ref callback
|
||||
menuWrapperProps?.ref?.(node);
|
||||
}, [menuWrapperProps]);
|
||||
|
||||
|
||||
const handleRemove = useCallback(() => {
|
||||
if (provides?.removePending && item && pageIndex !== undefined) {
|
||||
provides.removePending(pageIndex, item.id);
|
||||
@@ -89,17 +87,17 @@ function RedactionSelectionMenuInner({
|
||||
};
|
||||
|
||||
updatePosition();
|
||||
|
||||
|
||||
// Update position on scroll/resize
|
||||
window.addEventListener('scroll', updatePosition, true);
|
||||
window.addEventListener('resize', updatePosition);
|
||||
|
||||
|
||||
return () => {
|
||||
window.removeEventListener('scroll', updatePosition, true);
|
||||
window.removeEventListener('resize', updatePosition);
|
||||
};
|
||||
}, [selected, item]);
|
||||
|
||||
|
||||
// Early return AFTER all hooks have been called
|
||||
if (!selected || !item) return null;
|
||||
|
||||
@@ -146,8 +144,8 @@ function RedactionSelectionMenuInner({
|
||||
<DeleteIcon style={{ fontSize: 18 }} />
|
||||
</ActionIcon>
|
||||
</Tooltip>
|
||||
|
||||
<Tooltip
|
||||
|
||||
<Tooltip
|
||||
label={t('redact.manual.applyWarning', '⚠️ Permanent application, cannot be undone and the data underneath will be deleted')}
|
||||
withArrow
|
||||
position="top"
|
||||
@@ -172,15 +170,15 @@ function RedactionSelectionMenuInner({
|
||||
return (
|
||||
<>
|
||||
{/* Invisible wrapper that provides positioning - uses EmbedPDF's menuWrapperProps */}
|
||||
<div
|
||||
ref={setRef}
|
||||
style={{
|
||||
<div
|
||||
ref={setRef}
|
||||
style={{
|
||||
// Use EmbedPDF's positioning styles
|
||||
...menuWrapperProps?.style,
|
||||
// Keep the wrapper invisible but still occupying space for positioning
|
||||
opacity: 0,
|
||||
pointerEvents: 'none',
|
||||
}}
|
||||
}}
|
||||
/>
|
||||
{typeof document !== 'undefined' && menuContent
|
||||
? createPortal(menuContent, document.body)
|
||||
|
||||
@@ -25,6 +25,7 @@ export interface AnnotationAPI {
|
||||
deactivateTools: () => void;
|
||||
onAnnotationEvent?: (listener: (event: AnnotationEvent) => void) => void | (() => void);
|
||||
getActiveTool?: () => { id: AnnotationToolId } | null;
|
||||
purgeAnnotation?: (pageIndex: number, annotationId: string) => void;
|
||||
}
|
||||
|
||||
export interface HistoryAPI {
|
||||
@@ -33,6 +34,15 @@ export interface HistoryAPI {
|
||||
canUndo: () => boolean;
|
||||
canRedo: () => boolean;
|
||||
subscribe?: (listener: () => void) => () => void;
|
||||
/**
|
||||
* Purges history entries that match the given predicate based on command metadata.
|
||||
* Useful for removing commands that are no longer valid (e.g., after a permanent redaction commit).
|
||||
* Added in embedPDF v2.4.0+
|
||||
* @param predicate A function that returns true for commands that should be purged
|
||||
* @param topic If provided, only purges entries for that specific topic
|
||||
* @returns The number of entries that were purged
|
||||
*/
|
||||
purgeByMetadata?: <T>(predicate: (metadata: T | undefined) => boolean, topic?: string) => number;
|
||||
}
|
||||
|
||||
export type AnnotationToolId =
|
||||
|
||||
@@ -1,20 +1,25 @@
|
||||
import React, { createContext, useContext, useState, ReactNode, useCallback, useRef, useEffect } from 'react';
|
||||
import { RedactParameters } from '@app/hooks/tools/redact/useRedactParameters';
|
||||
import { useNavigationGuard } from '@app/contexts/NavigationContext';
|
||||
import { RedactionMode } from '@embedpdf/plugin-redaction';
|
||||
|
||||
/**
|
||||
* API interface that the EmbedPDF bridge will implement
|
||||
*/
|
||||
export interface RedactionAPI {
|
||||
toggleRedactSelection: () => void;
|
||||
toggleMarqueeRedact: () => void;
|
||||
toggleRedact: () => void;
|
||||
enableRedact: () => void;
|
||||
isRedactActive: () => boolean;
|
||||
endRedact: () => void;
|
||||
// Common methods
|
||||
commitAllPending: () => void;
|
||||
getActiveType: () => 'redactSelection' | 'marqueeRedact' | null;
|
||||
getActiveType: () => RedactionMode | null;
|
||||
getPendingCount: () => number;
|
||||
}
|
||||
|
||||
/**
|
||||
* State interface for redaction operations
|
||||
* Uses embedPDF v2.5.0 unified redaction mode
|
||||
*/
|
||||
interface RedactionState {
|
||||
// Current redaction configuration from the tool
|
||||
@@ -25,7 +30,8 @@ interface RedactionState {
|
||||
redactionsApplied: boolean;
|
||||
// Synced state from EmbedPDF
|
||||
pendingCount: number;
|
||||
activeType: 'redactSelection' | 'marqueeRedact' | null;
|
||||
// Uses RedactionMode enum from v2.5.0
|
||||
activeType: RedactionMode | null;
|
||||
isRedacting: boolean;
|
||||
// Whether the redaction API bridge is ready (API ref is populated)
|
||||
isBridgeReady: boolean;
|
||||
@@ -33,6 +39,7 @@ interface RedactionState {
|
||||
|
||||
/**
|
||||
* Actions interface for redaction operations
|
||||
* Uses embedPDF v2.5.0 unified redaction mode
|
||||
*/
|
||||
interface RedactionActions {
|
||||
setRedactionConfig: (config: RedactParameters | null) => void;
|
||||
@@ -40,13 +47,16 @@ interface RedactionActions {
|
||||
setRedactionsApplied: (applied: boolean) => void;
|
||||
// Synced state setters (called from inside EmbedPDF)
|
||||
setPendingCount: (count: number) => void;
|
||||
setActiveType: (type: 'redactSelection' | 'marqueeRedact' | null) => void;
|
||||
setActiveType: (type: RedactionMode | null) => void;
|
||||
setIsRedacting: (isRedacting: boolean) => void;
|
||||
setBridgeReady: (ready: boolean) => void;
|
||||
// Actions that call through to EmbedPDF API
|
||||
// Unified redaction actions (v2.5.0)
|
||||
activateRedact: () => void;
|
||||
deactivateRedact: () => void;
|
||||
commitAllPending: () => void;
|
||||
// Legacy UI actions (for backwards compatibility with UI)
|
||||
activateTextSelection: () => void;
|
||||
activateMarquee: () => void;
|
||||
commitAllPending: () => void;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -110,7 +120,7 @@ export const RedactionProvider: React.FC<{ children: ReactNode }> = ({ children
|
||||
}));
|
||||
}, []);
|
||||
|
||||
const setActiveType = useCallback((type: 'redactSelection' | 'marqueeRedact' | null) => {
|
||||
const setActiveType = useCallback((type: RedactionMode | null) => {
|
||||
setState(prev => ({
|
||||
...prev,
|
||||
activeType: type,
|
||||
@@ -143,16 +153,16 @@ export const RedactionProvider: React.FC<{ children: ReactNode }> = ({ children
|
||||
}
|
||||
}, [state.pendingCount, state.redactionsApplied, state.isRedactionMode, setHasUnsavedChanges]);
|
||||
|
||||
// Actions that call through to EmbedPDF API
|
||||
const activateTextSelection = useCallback(() => {
|
||||
// Unified redaction actions (v2.5.0)
|
||||
const activateRedact = useCallback(() => {
|
||||
if (redactionApiRef.current) {
|
||||
redactionApiRef.current.toggleRedactSelection();
|
||||
redactionApiRef.current.enableRedact();
|
||||
}
|
||||
}, []);
|
||||
|
||||
const activateMarquee = useCallback(() => {
|
||||
const deactivateRedact = useCallback(() => {
|
||||
if (redactionApiRef.current) {
|
||||
redactionApiRef.current.toggleMarqueeRedact();
|
||||
redactionApiRef.current.endRedact();
|
||||
}
|
||||
}, []);
|
||||
|
||||
@@ -165,6 +175,23 @@ export const RedactionProvider: React.FC<{ children: ReactNode }> = ({ children
|
||||
}
|
||||
}, [setRedactionsApplied]);
|
||||
|
||||
// Legacy UI actions for backwards compatibility
|
||||
// In v2.5.0, both text selection and marquee use the same unified mode
|
||||
// These just activate the unified redact mode and set the active type for UI state
|
||||
const activateTextSelection = useCallback(() => {
|
||||
if (redactionApiRef.current) {
|
||||
redactionApiRef.current.enableRedact();
|
||||
setActiveType('redactSelection' as RedactionMode);
|
||||
}
|
||||
}, [setActiveType]);
|
||||
|
||||
const activateMarquee = useCallback(() => {
|
||||
if (redactionApiRef.current) {
|
||||
redactionApiRef.current.enableRedact();
|
||||
setActiveType('marqueeRedact' as RedactionMode);
|
||||
}
|
||||
}, [setActiveType]);
|
||||
|
||||
const contextValue: RedactionContextValue = {
|
||||
...state,
|
||||
redactionApiRef,
|
||||
@@ -175,9 +202,11 @@ export const RedactionProvider: React.FC<{ children: ReactNode }> = ({ children
|
||||
setActiveType,
|
||||
setIsRedacting,
|
||||
setBridgeReady,
|
||||
activateRedact,
|
||||
deactivateRedact,
|
||||
commitAllPending,
|
||||
activateTextSelection,
|
||||
activateMarquee,
|
||||
commitAllPending,
|
||||
};
|
||||
|
||||
return (
|
||||
|
||||
Reference in New Issue
Block a user