pdf-oxide-fips 0.3.47

package/lib/result-accessors-manager.d.ts

@@ -0,0 +1,346 @@
+/**
+ * ResultAccessorsManager for extracting extended properties from PDF operations
+ *
+ * Provides detailed metadata from search results, fonts, images, and annotations.
+ * Enables advanced features like context extraction, font metrics analysis, and annotation tracking.
+ * API is consistent with Python, Java, C#, Go, and Swift implementations.
+ */
+import { EventEmitter } from 'events';
+/**
+ * Extended properties from a search result
+ */
+export interface SearchResultProperties {
+    context: string;
+    lineNumber: number;
+    paragraphNumber: number;
+    confidence: number;
+    isHighlighted: boolean;
+    fontInfo: string;
+    color: [number, number, number];
+    rotation: number;
+    objectId: number;
+    streamIndex: number;
+}
+/**
+ * Extended font metric information
+ */
+export interface FontProperties {
+    baseFontName: string;
+    descriptor: string;
+    descendantFont: string;
+    toUnicodeCmap: string;
+    isVertical: boolean;
+    widths: Float32Array;
+    ascender: number;
+    descender: number;
+}
+/**
+ * Extended image metadata
+ */
+export interface ImageProperties {
+    hasAlphaChannel: boolean;
+    iccProfile: Uint8Array;
+    filterChain: string;
+    decodedData: Uint8Array;
+    width: number;
+    height: number;
+    colorSpace: string;
+}
+/**
+ * Extended annotation properties
+ */
+export interface AnnotationProperties {
+    modifiedDate: number;
+    subject: string;
+    replyToIndex: number;
+    pageNumber: number;
+    iconName: string;
+    author: string;
+}
+/**
+ * Result Accessors Manager for extracting extended properties
+ *
+ * Provides methods to:
+ * - Extract context from search results
+ * - Get detailed font metrics
+ * - Inspect image metadata and ICC profiles
+ * - Track annotation relationships and metadata
+ * - Filter and analyze results by properties
+ *
+ * Matches: Python ResultAccessorsManager, Java ResultAccessorsManager, etc.
+ */
+export declare class ResultAccessorsManager extends EventEmitter {
+    private document;
+    private resultCache;
+    private maxCacheSize;
+    private native;
+    constructor(document: any);
+    private setCached;
+    /**
+     * Gets context text around a search result
+     * Includes words before and after the match
+     * @param results Search results handle
+     * @param index Index of the result
+     * @param contextWidth Number of characters for context
+     * @returns Context text with highlighted match
+     */
+    getSearchResultContext(results: any, index: number, contextWidth?: number): Promise<string>;
+    /**
+     * Gets the line number of a search result
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns Line number (0-based)
+     */
+    getSearchResultLineNumber(results: any, index: number): Promise<number>;
+    /**
+     * Gets the paragraph number of a search result
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns Paragraph number (0-based)
+     */
+    getSearchResultParagraphNumber(results: any, index: number): Promise<number>;
+    /**
+     * Gets the confidence score of a search result
+     * Useful for OCR results where confidence varies
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns Confidence score (0.0 to 1.0)
+     */
+    getSearchResultConfidence(results: any, index: number): Promise<number>;
+    /**
+     * Checks if a search result is highlighted in the document
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns True if the result is highlighted
+     */
+    isSearchResultHighlighted(results: any, index: number): Promise<boolean>;
+    /**
+     * Gets font information for a search result
+     * Returns JSON with font name, size, family, etc.
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns Font info as JSON string
+     */
+    getSearchResultFontInfo(results: any, index: number): Promise<string>;
+    /**
+     * Gets RGB color of a search result
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns Color as [R, G, B] array (0-255)
+     */
+    getSearchResultColor(results: any, index: number): Promise<[number, number, number]>;
+    /**
+     * Gets the rotation angle of a search result
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns Rotation in degrees (0, 90, 180, 270)
+     */
+    getSearchResultRotation(results: any, index: number): Promise<number>;
+    /**
+     * Gets the object ID of a search result
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns PDF object ID
+     */
+    getSearchResultObjectId(results: any, index: number): Promise<number>;
+    /**
+     * Gets the stream index of a search result
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns Stream index in the content
+     */
+    getSearchResultStreamIndex(results: any, index: number): Promise<number>;
+    /**
+     * Gets all properties of a search result at once
+     * More efficient than individual property calls
+     * @param results Search results handle
+     * @param index Index of the result
+     * @returns Object with all properties
+     */
+    getSearchResultAllProperties(results: any, index: number): Promise<SearchResultProperties>;
+    /**
+     * Gets the base font name
+     * @param fonts Font handle
+     * @param index Index of the font
+     * @returns Font name (e.g., "Helvetica", "Arial")
+     */
+    getFontBaseFontName(fonts: any, index: number): Promise<string>;
+    /**
+     * Gets the font descriptor JSON
+     * Contains details about font metrics and characteristics
+     * @param fonts Font handle
+     * @param index Index of the font
+     * @returns Font descriptor as JSON string
+     */
+    getFontDescriptor(fonts: any, index: number): Promise<string>;
+    /**
+     * Gets the descendant font name (for composite fonts)
+     * @param fonts Font handle
+     * @param index Index of the font
+     * @returns Descendant font name or empty string
+     */
+    getFontDescendantFont(fonts: any, index: number): Promise<string>;
+    /**
+     * Gets the ToUnicode CMap for character to Unicode mapping
+     * @param fonts Font handle
+     * @param index Index of the font
+     * @returns ToUnicode CMap as string
+     */
+    getFontToUnicodeCmap(fonts: any, index: number): Promise<string>;
+    /**
+     * Checks if font is vertical (top-to-bottom layout)
+     * @param fonts Font handle
+     * @param index Index of the font
+     * @returns True if font is vertical
+     */
+    isFontVertical(fonts: any, index: number): Promise<boolean>;
+    /**
+     * Gets character widths for the font
+     * @param fonts Font handle
+     * @param index Index of the font
+     * @returns Array of character widths
+     */
+    getFontWidths(fonts: any, index: number): Promise<Float32Array>;
+    /**
+     * Gets the ascender metric (height above baseline)
+     * @param fonts Font handle
+     * @param index Index of the font
+     * @returns Ascender value in font units
+     */
+    getFontAscender(fonts: any, index: number): Promise<number>;
+    /**
+     * Gets the descender metric (depth below baseline)
+     * @param fonts Font handle
+     * @param index Index of the font
+     * @returns Descender value in font units (usually negative)
+     */
+    getFontDescender(fonts: any, index: number): Promise<number>;
+    /**
+     * Gets all font properties at once
+     * More efficient than individual property calls
+     * @param fonts Font handle
+     * @param index Index of the font
+     * @returns Object with all font properties
+     */
+    getFontAllProperties(fonts: any, index: number): Promise<FontProperties>;
+    /**
+     * Checks if image has an alpha channel
+     * @param images Image handle
+     * @param index Index of the image
+     * @returns True if alpha channel is present
+     */
+    hasImageAlphaChannel(images: any, index: number): Promise<boolean>;
+    /**
+     * Gets the ICC color profile
+     * @param images Image handle
+     * @param index Index of the image
+     * @returns ICC profile as binary data
+     */
+    getImageIccProfile(images: any, index: number): Promise<Uint8Array>;
+    /**
+     * Gets the filter chain applied to the image
+     * (e.g., ["FlateDecode", "DCTDecode"])
+     * @param images Image handle
+     * @param index Index of the image
+     * @returns Filter chain as JSON string
+     */
+    getImageFilterChain(images: any, index: number): Promise<string>;
+    /**
+     * Gets the decoded image data
+     * @param images Image handle
+     * @param index Index of the image
+     * @returns Decoded image data as binary
+     */
+    getImageDecodedData(images: any, index: number): Promise<Uint8Array>;
+    /**
+     * Gets the image width in pixels
+     * @param images Image handle
+     * @param index Index of the image
+     * @returns Width in pixels
+     */
+    getImageWidth(images: any, index: number): Promise<number>;
+    /**
+     * Gets the image height in pixels
+     * @param images Image handle
+     * @param index Index of the image
+     * @returns Height in pixels
+     */
+    getImageHeight(images: any, index: number): Promise<number>;
+    /**
+     * Gets the color space of the image
+     * @param images Image handle
+     * @param index Index of the image
+     * @returns Color space name (e.g., "RGB", "CMYK", "Gray")
+     */
+    getImageColorSpace(images: any, index: number): Promise<string>;
+    /**
+     * Gets all image properties at once
+     * More efficient than individual property calls
+     * @param images Image handle
+     * @param index Index of the image
+     * @returns Object with all image properties
+     */
+    getImageAllProperties(images: any, index: number): Promise<ImageProperties>;
+    /**
+     * Gets the modified date of an annotation
+     * @param annotations Annotation handle
+     * @param index Index of the annotation
+     * @returns Timestamp in milliseconds
+     */
+    getAnnotationModifiedDate(annotations: any, index: number): Promise<number>;
+    /**
+     * Gets the subject/title of an annotation
+     * @param annotations Annotation handle
+     * @param index Index of the annotation
+     * @returns Subject text
+     */
+    getAnnotationSubject(annotations: any, index: number): Promise<string>;
+    /**
+     * Gets the index of the annotation this is replying to
+     * @param annotations Annotation handle
+     * @param index Index of the annotation
+     * @returns Index of parent annotation, or -1 if not a reply
+     */
+    getAnnotationReplyToIndex(annotations: any, index: number): Promise<number>;
+    /**
+     * Gets the page number where annotation appears
+     * @param annotations Annotation handle
+     * @param index Index of the annotation
+     * @returns Page number (0-based)
+     */
+    getAnnotationPageNumber(annotations: any, index: number): Promise<number>;
+    /**
+     * Gets the icon name for the annotation
+     * (e.g., "Comment", "Note", "Help")
+     * @param annotations Annotation handle
+     * @param index Index of the annotation
+     * @returns Icon name
+     */
+    getAnnotationIconName(annotations: any, index: number): Promise<string>;
+    /**
+     * Gets the author/creator of the annotation
+     * @param annotations Annotation handle
+     * @param index Index of the annotation
+     * @returns Author name
+     */
+    getAnnotationAuthor(annotations: any, index: number): Promise<string>;
+    /**
+     * Gets all annotation properties at once
+     * More efficient than individual property calls
+     * @param annotations Annotation handle
+     * @param index Index of the annotation
+     * @returns Object with all annotation properties
+     */
+    getAnnotationAllProperties(annotations: any, index: number): Promise<AnnotationProperties>;
+    /**
+     * Clears the result cache
+     */
+    clearCache(): void;
+    /**
+     * Gets cache statistics
+     * @returns Object with cache information
+     */
+    getCacheStats(): Record<string, any>;
+    private clearCachePattern;
+}
+export default ResultAccessorsManager;