content-security-toolkit 1.0.0

package/dist/utils/securityOverlayManager-simple.d.ts

@@ -0,0 +1,197 @@
+import type { MediatorAware, ProtectionMediator } from "../core/mediator/types";
+/**
+ * Options for the security overlay
+ */
+export interface OverlayOptions {
+    /**
+     * Title to display in the overlay
+     */
+    title?: string;
+    /**
+     * Main message to display
+     */
+    message?: string;
+    /**
+     * Secondary message to display
+     */
+    secondaryMessage?: string;
+    /**
+     * Text color for the overlay
+     */
+    textColor?: string;
+    /**
+     * Background color for the overlay
+     */
+    backgroundColor?: string;
+    /**
+     * Z-index for the overlay (default: 2147483647)
+     */
+    zIndex?: string;
+    /**
+     * Whether to show a close button
+     */
+    showCloseButton?: boolean;
+    /**
+     * Text for the close button
+     */
+    closeButtonText?: string;
+    /**
+     * Callback when close button is clicked
+     */
+    onCloseButtonClick?: () => void;
+    /**
+     * Duration in milliseconds to show the overlay (0 for indefinite)
+     */
+    duration?: number;
+    /**
+     * Additional custom styles for the overlay
+     */
+    customStyles?: Record<string, string>;
+    /**
+     * Additional custom styles for the text
+     */
+    textStyles?: Record<string, string>;
+    /**
+     * Font size (ScreenshotStrategy - refactor)
+     */
+    fontSize?: string;
+    /**
+     * Additional HTML content to display in the overlay
+     */
+    additionalContent?: string;
+    /**
+     * Whether to block events (create an event blocker)
+     */
+    blockEvents?: boolean;
+    /**
+     * Whether to automatically restore the overlay if it's removed from the DOM
+     * @default true
+     */
+    autoRestore?: boolean;
+}
+/**
+ * Utility class to manage security overlays
+ */
+export declare class SecurityOverlayManager implements MediatorAware {
+    readonly COMPONENT_NAME = "SecurityOverlayManager";
+    private mediator;
+    private overlayElement;
+    private eventBlocker;
+    private overlayTimeout;
+    private debugMode;
+    private domObserver;
+    private currentOptions;
+    private autoRestoreEnabled;
+    private isActive;
+    private documentWheelHandler;
+    private windowWheelHandler;
+    private documentTouchMoveHandler;
+    private windowTouchMoveHandler;
+    private onElementsRemovedCallbacks;
+    /**
+     * Create a new SecurityOverlayManager
+     * @param debugMode Enable debug mode for troubleshooting
+     */
+    constructor(debugMode?: boolean);
+    /**
+     * Set the mediator
+     * to communicate with the other components
+     */
+    setMediator(mediator: ProtectionMediator): void;
+    /**
+     * Handle overlay shown event
+     */
+    private handleOverlayShown;
+    /**
+     * Handle overlay removed event
+     */
+    private handleOverlayRemoved;
+    /**
+   * Handle overlay restored event
+   */
+    private handleOverlayRestored;
+    /**
+     * Show a security overlay
+     * @param options Options for the overlay
+     * @returns Object containing the created overlay and event blocker elements
+     */
+    showOverlay(options: OverlayOptions): {
+        overlay: HTMLElement | null;
+        blocker: HTMLElement | null;
+    };
+    /**
+     * Remove the security overlay and clean up all event listeners
+     * @param disableAutoRestore Whether to disable auto-restoration when removing
+     */
+    removeOverlay(disableAutoRestore?: boolean): void;
+    /**
+     * Disable auto-restoration of the overlay
+     * This should be called when the condition that triggered the overlay is no longer true
+     */
+    disableAutoRestore(): void;
+    /**
+     * Check if the manager is active
+     * This returns true if the overlay is supposed to be shown, regardless of whether it's currently
+     * in the DOM or has been removed by external forces
+     */
+    isOverlayActive(): boolean;
+    /**
+     * Ensure the overlay is restored if it should be active but isn't displayed
+     * This is useful for external components to check if the overlay should be restored
+     */
+    checkAndRestoreOverlay(): void;
+    /**
+     * Remove global event listeners that were added to document and window
+     */
+    private removeGlobalEventListeners;
+    /**
+     * Create an overlay element
+     * @param options Options for the overlay
+     * @returns The created overlay element
+     */
+    private createOverlay;
+    /**
+     * Create an event blocker that prevents interaction with the page
+     * @returns The created event blocker element
+     */
+    private createEventBlocker;
+    /**
+     * Set up DOM observer to detect when overlay elements are removed
+     */
+    private setupObserver;
+    /**
+     * Notify all callbacks when elements are removed
+     */
+    private notifyElementsRemovedCallbacks;
+    /**
+     * Add a callback to be called when overlay elements are removed
+     * @param callback Callback function
+     */
+    addElementsRemovedCallback(callback: (removedElements: HTMLElement[]) => void): void;
+    /**
+     * Remove a callback
+     * @param callback Callback function to remove
+     */
+    removeElementsRemovedCallback(callback: (removedElements: HTMLElement[]) => void): void;
+    /**
+     * Check if an overlay is currently displayed
+     * @returns True if an overlay is displayed, false otherwise
+     */
+    isOverlayDisplayed(): boolean;
+    /**
+     * Get the current overlay element
+     * @returns The current overlay element or null if none exists
+     */
+    getOverlayElement(): HTMLElement | null;
+    /**
+     * Get the current event blocker element
+     * @returns The current event blocker element or null if none exists
+     */
+    getEventBlocker(): HTMLElement | null;
+    /**
+     * Check if the overlay exists in the DOM
+     * This is different from isOverlayDisplayed() which checks if the manager has a reference
+     * @returns True if the overlay exists in the DOM, false otherwise
+     */
+    doesOverlayExistInDOM(): boolean;
+}