pdf-oxide-fips 0.3.47

package/lib/form-field-manager.d.ts

@@ -0,0 +1,299 @@
+/**
+ * FormFieldManager for form field operations
+ *
+ * Manages form fields in PDF documents including retrieval, modification, and flattening.
+ * API is consistent with Python, Java, C#, Go, and Swift implementations.
+ */
+import { EventEmitter } from 'events';
+/**
+ * Types of form fields
+ */
+export declare enum FormFieldType {
+    Text = "Text",
+    CheckBox = "CheckBox",
+    RadioButton = "RadioButton",
+    ComboBox = "ComboBox",
+    ListBox = "ListBox",
+    Button = "Button",
+    Signature = "Signature",
+    TextArea = "TextArea"
+}
+/**
+ * Field visibility options
+ */
+export declare enum FieldVisibility {
+    Visible = "Visible",
+    Hidden = "Hidden",
+    PrintOnly = "PrintOnly",
+    NoView = "NoView"
+}
+/**
+ * Form field information
+ */
+export interface FormField {
+    fieldName: string;
+    fieldType: FormFieldType;
+    pageIndex?: number;
+    isRequired: boolean;
+    isReadOnly: boolean;
+    visibility: FieldVisibility;
+    defaultValue?: string;
+    currentValue?: string;
+    toolTip?: string;
+}
+/**
+ * Configuration for form field creation
+ */
+export interface FormFieldConfig {
+    fieldName: string;
+    fieldType?: FormFieldType;
+    pageIndex?: number;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    isRequired?: boolean;
+    defaultValue?: string;
+}
+/**
+ * Form Field Manager for form operations
+ *
+ * Provides methods to:
+ * - Retrieve form field information
+ * - Get and set field values
+ * - Create new form fields
+ * - Manage field properties
+ * - Flatten forms
+ */
+export declare class FormFieldManager extends EventEmitter {
+    private document;
+    private resultCache;
+    private maxCacheSize;
+    constructor(document: any);
+    /**
+     * Gets all form fields in the document
+     * Matches: Python getAllFields(), Java getAllFields(), C# GetAllFields()
+     */
+    getAllFields(): Promise<FormField[]>;
+    /**
+     * Gets a specific form field by name
+     * Matches: Python getField(), Java getField(), C# GetField()
+     */
+    getField(fieldName: string): Promise<FormField | undefined>;
+    /**
+     * Gets fields of a specific type
+     * Matches: Python getFieldsOfType(), Java getFieldsOfType(), C# GetFieldsOfType()
+     */
+    getFieldsOfType(fieldType: FormFieldType): Promise<FormField[]>;
+    /**
+     * Gets the value of a form field
+     * Matches: Python getFieldValue(), Java getFieldValue(), C# GetFieldValue()
+     */
+    getFieldValue(fieldName: string): Promise<string | undefined>;
+    /**
+     * Sets the value of a form field
+     * Matches: Python setFieldValue(), Java setFieldValue(), C# SetFieldValue()
+     */
+    setFieldValue(fieldName: string, value: string): Promise<void>;
+    /**
+     * Gets field count
+     * Matches: Python getFieldCount(), Java getFieldCount(), C# GetFieldCount()
+     */
+    getFieldCount(): Promise<number>;
+    /**
+     * Checks if form has fields
+     * Matches: Python hasForm(), Java hasForm(), C# HasForm()
+     */
+    hasForm(): Promise<boolean>;
+    /**
+     * Creates a new form field
+     * Matches: Python createField(), Java createField(), C# CreateField()
+     */
+    createField(config: FormFieldConfig): Promise<void>;
+    /**
+     * Removes a form field
+     * Matches: Python removeField(), Java removeField(), C# RemoveField()
+     */
+    removeField(fieldName: string): Promise<void>;
+    /**
+     * Flattens form fields (convert to content)
+     * Matches: Python flattenForm(), Java flattenForm(), C# FlattenForm()
+     */
+    flattenForm(): Promise<void>;
+    /**
+     * Resets all form fields to defaults
+     * Matches: Python resetForm(), Java resetForm(), C# ResetForm()
+     */
+    resetForm(): Promise<void>;
+    /**
+     * Clears the result cache
+     * Matches: Python clearCache(), Java clearCache(), C# ClearCache()
+     */
+    clearCache(): void;
+    /**
+     * Gets cache statistics
+     * Matches: Python getCacheStats(), Java getCacheStats(), C# GetCacheStats()
+     */
+    getCacheStats(): Record<string, any>;
+    /**
+     * Gets the AcroForm handle from the document
+     * Provides access to lower-level form operations
+     * @returns AcroForm handle
+     */
+    getFormAcroform(): Promise<any>;
+    /**
+     * Exports form data to a file
+     * Supports FDF (0), XFDF (1), and JSON (2) formats
+     * @param filename Path to output file
+     * @param format Format type (0=FDF, 1=XFDF, 2=JSON)
+     * @returns Number of fields exported
+     */
+    exportFormData(filename: string, format?: number): Promise<number>;
+    /**
+     * Exports form data to bytes in memory
+     * Supports FDF (0), XFDF (1), and JSON (2) formats
+     * @param format Format type (0=FDF, 1=XFDF, 2=JSON)
+     * @returns Form data as byte array
+     */
+    exportFormDataBytes(format?: number): Promise<Uint8Array>;
+    /**
+     * Imports form data from a file
+     * Supports FDF, XFDF, and JSON formats (auto-detected)
+     * @param filename Path to form data file
+     * @returns Number of fields updated
+     */
+    importFormData(filename: string): Promise<number>;
+    /**
+     * Resets all form fields to their default values
+     * @returns Number of fields reset
+     */
+    resetAllFields(): Promise<number>;
+    /**
+     * Gets the default value of a form field
+     * @param fieldName Name of the field
+     * @returns Default value or empty string
+     */
+    getFieldDefaultValue(fieldName: string): Promise<string>;
+    /**
+     * Sets the default value of a form field
+     * @param fieldName Name of the field
+     * @param value New default value
+     */
+    setFieldDefaultValue(fieldName: string, value: string): Promise<void>;
+    /**
+     * Gets the flags of a form field (combination of bit flags)
+     * @param fieldName Name of the field
+     * @returns Field flags as integer
+     */
+    getFieldFlags(fieldName: string): Promise<number>;
+    /**
+     * Sets the flags of a form field
+     * Flags control field properties like readonly, required, etc.
+     * @param fieldName Name of the field
+     * @param flags New flags value
+     */
+    setFieldFlags(fieldName: string, flags: number): Promise<void>;
+    /**
+     * Gets the tooltip text for a form field
+     * @param fieldName Name of the field
+     * @returns Tooltip text or empty string
+     */
+    getFieldTooltip(fieldName: string): Promise<string>;
+    /**
+     * Sets the tooltip text for a form field
+     * @param fieldName Name of the field
+     * @param tooltip New tooltip text
+     */
+    setFieldTooltip(fieldName: string, tooltip: string): Promise<void>;
+    /**
+     * Gets the alternate name (UI name) for a form field
+     * @param fieldName Name of the field
+     * @returns Alternate name or empty string
+     */
+    getFieldAlternateName(fieldName: string): Promise<string>;
+    /**
+     * Sets the alternate name (UI name) for a form field
+     * @param fieldName Name of the field
+     * @param alternateName New alternate name
+     */
+    setFieldAlternateName(fieldName: string, alternateName: string): Promise<void>;
+    /**
+     * Checks if a form field is read-only
+     * @param fieldName Name of the field
+     * @returns True if field is read-only
+     */
+    isFieldReadonly(fieldName: string): Promise<boolean>;
+    /**
+     * Sets the read-only status of a form field
+     * @param fieldName Name of the field
+     * @param readonly True to make field read-only
+     */
+    setFieldReadonly(fieldName: string, readonly: boolean): Promise<void>;
+    /**
+     * Checks if a form field is required
+     * @param fieldName Name of the field
+     * @returns True if field is required
+     */
+    isFieldRequired(fieldName: string): Promise<boolean>;
+    /**
+     * Sets the required status of a form field
+     * @param fieldName Name of the field
+     * @param required True to make field required
+     */
+    setFieldRequired(fieldName: string, required: boolean): Promise<void>;
+    /**
+     * Gets the background color of a form field
+     * @param fieldName Name of the field
+     * @returns Color as [R, G, B] array (0-255) or null if no color
+     */
+    getFieldBackgroundColor(fieldName: string): Promise<[number, number, number] | null>;
+    /**
+     * Sets the background color of a form field
+     * @param fieldName Name of the field
+     * @param red Red component (0-255)
+     * @param green Green component (0-255)
+     * @param blue Blue component (0-255)
+     */
+    setFieldBackgroundColor(fieldName: string, red: number, green: number, blue: number): Promise<void>;
+    /**
+     * Gets the text color of a form field
+     * @param fieldName Name of the field
+     * @returns Color as [R, G, B] array (0-255) or null if no color
+     */
+    getFieldTextColor(fieldName: string): Promise<[number, number, number] | null>;
+    /**
+     * Sets the text color of a form field
+     * @param fieldName Name of the field
+     * @param red Red component (0-255)
+     * @param green Green component (0-255)
+     * @param blue Blue component (0-255)
+     */
+    setFieldTextColor(fieldName: string, red: number, green: number, blue: number): Promise<void>;
+    /**
+     * Validates a form field
+     * Checks field consistency and compliance
+     * @param fieldName Name of the field
+     * @returns True if field is valid
+     */
+    validateField(fieldName: string): Promise<boolean>;
+    /**
+     * Gets form statistics
+     * @returns Object with form statistics
+     */
+    getFormStatistics(): Promise<Record<string, number>>;
+    /**
+     * Batch sets multiple field values
+     * @param values Map of field names to values
+     * @returns Number of fields updated
+     */
+    batchSetValues(values: Record<string, string>): Promise<number>;
+    /**
+     * Batch gets multiple field values
+     * @param fieldNames Array of field names
+     * @returns Map of field names to values
+     */
+    getBatchValues(fieldNames: string[]): Promise<Record<string, string>>;
+    private setCached;
+    private clearCachePattern;
+}
+export default FormFieldManager;