pdf-oxide-fips 0.3.47

package/lib/managers/index.d.ts

@@ -0,0 +1,64 @@
+/**
+ * PDF Oxide Managers - Specialized facades for domain-specific operations
+ *
+ * This module provides manager classes that encapsulate domain-specific
+ * operations on PDF documents, offering a cleaner and more organized API
+ * compared to working directly with documents and pages.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   OutlineManager,
+ *   MetadataManager,
+ *   ExtractionManager,
+ *   SearchManager,
+ *   SecurityManager,
+ *   AnnotationManager,
+ *   LayerManager,
+ *   RenderingManager,
+ * } from 'pdf_oxide';
+ *
+ * const doc = PdfDocument.open('document.pdf');
+ *
+ * // Metadata operations
+ * const metadataManager = new MetadataManager(doc);
+ * console.log(metadataManager.getTitle());
+ *
+ * // Text extraction
+ * const extractionManager = new ExtractionManager(doc);
+ * const text = extractionManager.extractAllText();
+ *
+ * // Search operations
+ * const searchManager = new SearchManager(doc);
+ * const results = searchManager.searchAll('keyword');
+ *
+ * // Page annotations
+ * const page = doc.getPage(0);
+ * const annotationManager = new AnnotationManager(page);
+ * const highlights = annotationManager.getHighlights();
+ * ```
+ */
+export { FieldVisibility, type FormField, type FormFieldConfig, FormFieldManager, FormFieldType, } from '../form-field-manager.js';
+export { type AnnotationProperties, type FontProperties, type ImageProperties, ResultAccessorsManager, type SearchResultProperties, } from '../result-accessors-manager.js';
+export { AccessibilityManager, type AutoTagResult, type StructureElement, type StructureTree, } from './accessibility-manager.js';
+export { type Annotation, AnnotationManager, type AnnotationStatistics, type AnnotationValidation, } from './annotation-manager.js';
+export { BarcodeErrorCorrection, BarcodeFormat, type BarcodeGenerationConfig, BarcodeManager, type DetectedBarcode, QrErrorCorrection, } from './barcode-manager.js';
+export { type BatchDocument, BatchManager, type BatchOptions, type BatchProgress, type BatchResult, type BatchStatistics, } from './batch-manager.js';
+export { CacheManager, type CacheStatistics as CacheStats, } from './cache-manager.js';
+export { type ComplianceIssue, ComplianceIssueType, ComplianceManager, type ComplianceValidationResult, IssueSeverity, PdfALevel, PdfUALevel, PdfXLevel, } from './compliance-manager.js';
+export { type ContentAnalysis, ContentManager, } from './content-manager.js';
+export { type ApplyRedactionsOptions, EditingManager, type RedactionRect, type RgbColor, type ScrubMetadataOptions, } from './editing-manager.js';
+export { BatesPosition, type Difference, DifferenceType, type DocumentComparisonResult, EnterpriseManager, type PageComparisonResult, StampAlignment, } from './enterprise-manager.js';
+export { type ContentStatistics, ExtractionManager, type SearchMatch, } from './extraction-manager.js';
+export { type Layer, type LayerHierarchy, LayerManager, type LayerStatistics, type LayerValidation, } from './layer-manager.js';
+export { type MetadataComparison, MetadataManager, type ValidationResult, } from './metadata-manager.js';
+export { OCRManager, type OcrConfig, OcrDetectionMode, OcrManager, type OcrPageAnalysis, type OcrSpan, } from './ocr-manager.js';
+export { OptimizationManager, type OptimizationResult, } from './optimization-manager.js';
+export { type OutlineItem, OutlineManager } from './outline-manager.js';
+export { type PageInfo, PageManager, type PageRange, type PageStatistics, } from './page-manager.js';
+export { type PageBox, type PageDimensions, type PageResources, RenderingManager, type RenderingStatistics, RenderOptions, type RenderOptionsConfig, } from './rendering-manager.js';
+export { type SearchCapabilities, SearchManager, type SearchResult, type SearchStatistics, } from './search-manager.js';
+export { type AccessibilityValidation, type PermissionsSummary, type SecurityLevel, SecurityManager, } from './security-manager.js';
+export { type Certificate, type CertificateChain, CertificateFormat, type CertificateInfo, CertificationPermission, DigestAlgorithm, type DigitalSignature, FfiDigestAlgorithm, FfiSignatureSubFilter, type LoadedCertificate, type Signature, SignatureAlgorithm, type SignatureAppearance, type SignatureConfig, type SignatureField, type SignatureFieldConfig, SignatureManager, SignatureType, type SignatureValidationResult, type SigningCredentials, type SigningOptions, type SigningResult, type SignOptions, type TimestampConfig, type TimestampResult, TimestampStatus, } from './signature-manager.js';
+export { createExtractionStream, createMetadataStream, createSearchStream, type ExtractionProgressData, ExtractionStream, MetadataStream, type PageMetadataData, type SearchResultData, SearchStream, } from './streams.js';
+export { XFAManager, XfaBindingType, type XfaCreationResult, type XfaDataOptions, type XfaDataset, type XfaField, type XfaFieldConfig, type XfaFieldHandle, XfaFieldType, XfaFormType, XfaManager, type XfaScriptConfig, type XfaSubformConfig, type XfaTemplateConfig, XfaValidationType, } from './xfa-manager.js';

package/lib/managers/index.js

@@ -0,0 +1,69 @@
+/**
+ * PDF Oxide Managers - Specialized facades for domain-specific operations
+ *
+ * This module provides manager classes that encapsulate domain-specific
+ * operations on PDF documents, offering a cleaner and more organized API
+ * compared to working directly with documents and pages.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   OutlineManager,
+ *   MetadataManager,
+ *   ExtractionManager,
+ *   SearchManager,
+ *   SecurityManager,
+ *   AnnotationManager,
+ *   LayerManager,
+ *   RenderingManager,
+ * } from 'pdf_oxide';
+ *
+ * const doc = PdfDocument.open('document.pdf');
+ *
+ * // Metadata operations
+ * const metadataManager = new MetadataManager(doc);
+ * console.log(metadataManager.getTitle());
+ *
+ * // Text extraction
+ * const extractionManager = new ExtractionManager(doc);
+ * const text = extractionManager.extractAllText();
+ *
+ * // Search operations
+ * const searchManager = new SearchManager(doc);
+ * const results = searchManager.searchAll('keyword');
+ *
+ * // Page annotations
+ * const page = doc.getPage(0);
+ * const annotationManager = new AnnotationManager(page);
+ * const highlights = annotationManager.getHighlights();
+ * ```
+ */
+export { FieldVisibility, FormFieldManager, FormFieldType, } from '../form-field-manager.js';
+// Phase 1 Expansion: Result Accessors and Forms
+export { ResultAccessorsManager, } from '../result-accessors-manager.js';
+export { AccessibilityManager, } from './accessibility-manager.js';
+export { AnnotationManager, } from './annotation-manager.js';
+export { BarcodeErrorCorrection, BarcodeFormat, BarcodeManager, QrErrorCorrection, } from './barcode-manager.js';
+// Phase 2.5: Batch Processing API
+export { BatchManager, } from './batch-manager.js';
+export { CacheManager, } from './cache-manager.js';
+export { ComplianceIssueType, ComplianceManager, IssueSeverity, PdfALevel, PdfUALevel, PdfXLevel, } from './compliance-manager.js';
+export { ContentManager, } from './content-manager.js';
+export { EditingManager, } from './editing-manager.js';
+export { BatesPosition, DifferenceType, EnterpriseManager, StampAlignment, } from './enterprise-manager.js';
+export { ExtractionManager, } from './extraction-manager.js';
+export { LayerManager, } from './layer-manager.js';
+export { MetadataManager, } from './metadata-manager.js';
+// Canonical Managers (Phase 9 consolidation)
+export { OCRManager, OcrDetectionMode, OcrManager, } from './ocr-manager.js';
+export { OptimizationManager, } from './optimization-manager.js';
+// Core Managers
+export { OutlineManager } from './outline-manager.js';
+export { PageManager, } from './page-manager.js';
+export { RenderingManager, RenderOptions, } from './rendering-manager.js';
+export { SearchManager, } from './search-manager.js';
+export { SecurityManager, } from './security-manager.js';
+export { CertificateFormat, CertificationPermission, DigestAlgorithm, FfiDigestAlgorithm, FfiSignatureSubFilter, SignatureAlgorithm, SignatureManager, SignatureType, TimestampStatus, } from './signature-manager.js';
+// Phase 2.4: Stream API support
+export { createExtractionStream, createMetadataStream, createSearchStream, ExtractionStream, MetadataStream, SearchStream, } from './streams.js';
+export { XFAManager, XfaBindingType, XfaFieldType, XfaFormType, XfaManager, XfaValidationType, } from './xfa-manager.js';

package/lib/managers/layer-manager.d.ts

@@ -0,0 +1,203 @@
+/**
+ * Manager for PDF layers (Optional Content Groups - OCG)
+ *
+ * Provides methods to manage and interact with PDF layers which are used
+ * for optional content groups in PDF documents.
+ *
+ * @example
+ * ```typescript
+ * import { LayerManager } from 'pdf_oxide';
+ *
+ * const doc = PdfDocument.open('document.pdf');
+ * const layerManager = new LayerManager(doc);
+ *
+ * // Check if document has layers
+ * if (layerManager.hasLayers()) {
+ *   const layers = layerManager.getLayers();
+ *   console.log(`Document has ${layers.length} layers`);
+ * }
+ * ```
+ */
+export interface Layer {
+    id: string;
+    name: string;
+    visible: boolean;
+    index: number;
+    parentId: string | null;
+    printable: boolean;
+    export: boolean;
+    description?: string;
+    dependsOn?: string[];
+}
+export interface LayerNode extends Layer {
+    children: LayerNode[];
+}
+export interface LayerHierarchy {
+    root: LayerNode[];
+}
+export interface LayerStatistics {
+    count: number;
+    rootCount: number;
+    maxDepth: number;
+    visible: number;
+    hidden: number;
+    printable: number;
+    exportable: number;
+    hasConflicts: boolean;
+}
+export interface LayerValidation {
+    isValid: boolean;
+    issues: string[];
+}
+export declare class LayerManager {
+    private _document;
+    private _layerCache;
+    private _hierarchyCache;
+    private _statisticsCache;
+    /**
+     * Creates a new LayerManager for the given document
+     * @param document - The PDF document
+     * @throws Error if document is null or undefined
+     */
+    constructor(document: any);
+    /**
+     * Clears the layer cache
+     * Useful when document content might have changed
+     */
+    clearCache(): void;
+    /**
+     * Checks if document has layers
+     * @returns True if document contains layers
+     */
+    hasLayers(): boolean;
+    /**
+     * Gets number of layers in document
+     * @returns Number of layers
+     */
+    getLayerCount(): number;
+    /**
+     * Gets all layers in document
+     * @returns Array of layer objects with id, name, visible, etc.
+     *
+     * @example
+     * ```typescript
+     * const layers = manager.getLayers();
+     * layers.forEach(layer => {
+     *   console.log(`Layer: ${layer.name} (visible: ${layer.visible})`);
+     * });
+     * ```
+     */
+    getLayers(): Layer[];
+    /**
+     * Gets layer by name
+     * @param name - Layer name to find
+     * @returns Layer object or null if not found
+     *
+     * @example
+     * ```typescript
+     * const layer = manager.getLayerByName('Background');
+     * if (layer) {
+     *   console.log(`Found layer: ${layer.name}`);
+     * }
+     * ```
+     */
+    getLayerByName(name: string): Layer | null;
+    /**
+     * Gets layer by ID
+     * @param id - Layer ID to find
+     * @returns Layer object or null if not found
+     */
+    getLayerById(id: string): Layer | null;
+    /**
+     * Gets root-level layers (not nested under other layers)
+     * @returns Array of root-level layers
+     */
+    getRootLayers(): Layer[];
+    /**
+     * Gets the full layer hierarchy as a tree structure
+     * @returns Layer hierarchy tree
+     *
+     * @example
+     * ```typescript
+     * const hierarchy = manager.getLayerHierarchy();
+     * // { root: [{ name: 'Layer1', children: [...] }, ...] }
+     * ```
+     */
+    getLayerHierarchy(): LayerHierarchy;
+    /**
+     * Gets child layers of a parent layer
+     * @param parentId - Parent layer ID
+     * @returns Array of child layers
+     */
+    getChildLayers(parentId: string): Layer[];
+    /**
+     * Gets parent layer of a layer
+     * @param layerId - Layer ID
+     * @returns Parent layer object or null if no parent
+     */
+    getParentLayer(layerId: string): Layer | null;
+    /**
+     * Checks if a layer is visible
+     * @param layerId - Layer ID
+     * @returns True if layer is visible
+     */
+    isLayerVisible(layerId: string): boolean;
+    /**
+     * Gets visibility chain from root to layer
+     * Shows visibility state of all parent layers
+     * @param layerId - Layer ID
+     * @returns Array of layers from root to target
+     */
+    getVisibilityChain(layerId: string): Layer[];
+    /**
+     * Gets layer usage information
+     * @returns Layer usage { view, print, export }
+     */
+    getLayerUsages(): Record<string, number>;
+    /**
+     * Gets statistics about layers
+     * @returns Layer statistics
+     *
+     * @example
+     * ```typescript
+     * const stats = manager.getLayerStatistics();
+     * console.log(`Total layers: ${stats.count}`);
+     * console.log(`Max depth: ${stats.maxDepth}`);
+     * ```
+     */
+    getLayerStatistics(): LayerStatistics;
+    /**
+     * Gets layer dependencies
+     * @returns Layer dependencies map
+     * @private
+     */
+    private getLayerDependencies;
+    /**
+     * Finds layers by pattern
+     * @param pattern - Pattern to match
+     * @returns Matching layers
+     *
+     * @example
+     * ```typescript
+     * const backgroundLayers = manager.findLayersByPattern(/background/i);
+     * ```
+     */
+    findLayersByPattern(pattern: RegExp | string): Layer[];
+    /**
+     * Validates layer state for conflicts and issues
+     * @returns Validation result { isValid, issues }
+     */
+    validateLayerState(): LayerValidation;
+    /**
+     * Detects layer conflicts
+     * @returns Array of conflict descriptions
+     * @private
+     */
+    private _detectLayerConflicts;
+    /**
+     * Detects cycles in layer hierarchy
+     * @returns Array of cycle descriptions
+     * @private
+     */
+    private _detectLayerCycles;
+}