pdf-lite 1.6.1 → 1.6.3

package/dist/acroform/fields/pdf-form-field.d.ts

@@ -10,6 +10,8 @@ import type { PdfFieldType } from './types.js';
 import { PdfFormFieldFlags } from './pdf-form-field-flags.js';
 import { PdfDefaultResourcesDictionary } from '../../annotations/pdf-default-resources.js';
 import type { PdfAcroForm } from '../pdf-acro-form.js';
+import { PdfFieldActions } from '../js/pdf-field-actions.js';
+import { PdfJavaScriptAction } from '../js/pdf-javascript-action.js';
 /**
  * Abstract base form field class. Extends PdfWidgetAnnotation with form-specific properties:
  * FT, V, DA, Ff, T (name), field hierarchy (parent/children/siblings).
@@ -100,6 +102,9 @@ export declare abstract class PdfFormField extends PdfWidgetAnnotation {
     set maxLen(maxLen: number | null);
     get kids(): PdfArray<PdfObjectReference> | undefined;
     set kids(kids: PdfObjectReference[]);
+    private _resolveActionDict;
+    get actions(): PdfFieldActions | null;
+    get activateAction(): PdfJavaScriptAction | null;
     abstract generateAppearance(options?: {
         makeReadOnly?: boolean;
         textYOffset?: number;
@@ -107,6 +112,11 @@ export declare abstract class PdfFormField extends PdfWidgetAnnotation {
     setAppearanceStream(stream: PdfIndirectObject | {
         [key: string]: PdfIndirectObject;
     }): void;
+    /**
+     * Returns the list of appearance state names from the normal appearance
+     * dictionary (e.g. ["Yes", "Off"] for a checkbox).
+     */
+    get appearanceStates(): string[];
     getAppearanceStream(setting?: string): PdfIndirectObject<PdfStream> | null;
     private static _fallbackCtor?;
     private static _registry;

package/dist/acroform/fields/pdf-form-field.js

@@ -12,6 +12,8 @@ import { PdfWidgetAnnotation } from '../../annotations/pdf-widget-annotation.js'
 import { PdfDefaultAppearance } from './pdf-default-appearance.js';
 import { PdfFieldType as PdfFieldTypeConst } from './types.js';
 import { PdfFormFieldFlags } from './pdf-form-field-flags.js';
+import { PdfFieldActions } from '../js/pdf-field-actions.js';
+import { PdfJavaScriptAction } from '../js/pdf-javascript-action.js';
 /**
  * Abstract base form field class. Extends PdfWidgetAnnotation with form-specific properties:
  * FT, V, DA, Ff, T (name), field hierarchy (parent/children/siblings).
@@ -467,6 +469,36 @@ export class PdfFormField extends PdfWidgetAnnotation {
         const kidsArray = new PdfArray(kids);
         this.content.set('Kids', kidsArray);
     }
+    _resolveActionDict(key) {
+        const entry = this.content.get(key);
+        if (entry instanceof PdfObjectReference) {
+            const resolved = entry.resolve();
+            if (resolved?.content instanceof PdfDictionary) {
+                return resolved.content;
+            }
+        }
+        else if (entry instanceof PdfDictionary) {
+            return entry;
+        }
+        return undefined;
+    }
+    get actions() {
+        const aaDict = this._resolveActionDict('AA');
+        if (!aaDict)
+            return null;
+        return aaDict.becomes(PdfFieldActions, {
+            activateDict: this._resolveActionDict('A'),
+            engine: this._form?.jsEngine,
+        });
+    }
+    get activateAction() {
+        const aDict = this._resolveActionDict('A');
+        if (!aDict)
+            return null;
+        return aDict.becomes(PdfJavaScriptAction, {
+            engine: this._form?.jsEngine,
+        });
+    }
     setAppearanceStream(stream) {
         this.appearanceStreamDict ||= new PdfDictionary();
         if (stream instanceof PdfIndirectObject) {
@@ -480,6 +512,17 @@ export class PdfFormField extends PdfWidgetAnnotation {
             this.appearanceStreamDict.set('N', dict);
         }
     }
+    /**
+     * Returns the list of appearance state names from the normal appearance
+     * dictionary (e.g. ["Yes", "Off"] for a checkbox).
+     */
+    get appearanceStates() {
+        const n = this.appearanceStreamDict?.get('N');
+        if (n instanceof PdfDictionary) {
+            return Array.from(n.entries(), ([key]) => key);
+        }
+        return [];
+    }
     getAppearanceStream(setting) {
         const n = this.appearanceStreamDict?.get('N');
         if (!n)

package/dist/acroform/index.d.ts

@@ -2,3 +2,4 @@ export * from './pdf-acro-form.js';
 export * from './fields/index.js';
 export * from './appearance/index.js';
 export * from './xfa/index.js';
+export * from './js/index.js';

package/dist/acroform/index.js

@@ -2,3 +2,4 @@ export * from './pdf-acro-form.js';
 export * from './fields/index.js';
 export * from './appearance/index.js';
 export * from './xfa/index.js';
+export * from './js/index.js';

package/dist/acroform/js/index.d.ts

@@ -0,0 +1,5 @@
+export * from './pdf-js-engine.js';
+export * from './pdf-js-engine-impl.js';
+export * from './pdf-js-builtins.js';
+export * from './pdf-javascript-action.js';
+export * from './pdf-field-actions.js';

package/dist/acroform/js/index.js

@@ -0,0 +1,5 @@
+export * from './pdf-js-engine.js';
+export * from './pdf-js-engine-impl.js';
+export * from './pdf-js-builtins.js';
+export * from './pdf-javascript-action.js';
+export * from './pdf-field-actions.js';

package/dist/acroform/js/pdf-field-actions.d.ts

@@ -0,0 +1,17 @@
+import { PdfDictionary } from '../../core/objects/pdf-dictionary.js';
+import { PdfJavaScriptAction } from './pdf-javascript-action.js';
+import type { PdfJsEngine } from './pdf-js-engine.js';
+export declare class PdfFieldActions extends PdfDictionary {
+    private readonly activateDict?;
+    readonly engine?: PdfJsEngine;
+    constructor(dict: PdfDictionary, options?: {
+        activateDict?: PdfDictionary;
+        engine?: PdfJsEngine;
+    });
+    private _resolve;
+    get keystroke(): PdfJavaScriptAction | null;
+    get validate(): PdfJavaScriptAction | null;
+    get calculate(): PdfJavaScriptAction | null;
+    get format(): PdfJavaScriptAction | null;
+    get activate(): PdfJavaScriptAction | null;
+}

package/dist/acroform/js/pdf-field-actions.js

@@ -0,0 +1,52 @@
+import { PdfDictionary } from '../../core/objects/pdf-dictionary.js';
+import { PdfObjectReference } from '../../core/objects/pdf-object-reference.js';
+import { PdfJavaScriptAction } from './pdf-javascript-action.js';
+export class PdfFieldActions extends PdfDictionary {
+    activateDict;
+    engine;
+    constructor(dict, options) {
+        super();
+        this.copyFrom(dict);
+        this.activateDict = options?.activateDict;
+        this.engine = options?.engine;
+    }
+    _resolve(key) {
+        const entry = this.get(key);
+        if (!entry)
+            return null;
+        let actionDict;
+        if (entry instanceof PdfObjectReference) {
+            const resolved = entry.resolve();
+            if (resolved?.content instanceof PdfDictionary) {
+                actionDict = resolved.content;
+            }
+        }
+        else if (entry instanceof PdfDictionary) {
+            actionDict = entry;
+        }
+        if (!actionDict)
+            return null;
+        return actionDict.becomes(PdfJavaScriptAction, {
+            engine: this.engine,
+        });
+    }
+    get keystroke() {
+        return this._resolve('K');
+    }
+    get validate() {
+        return this._resolve('V');
+    }
+    get calculate() {
+        return this._resolve('C');
+    }
+    get format() {
+        return this._resolve('F');
+    }
+    get activate() {
+        if (!this.activateDict)
+            return null;
+        return this.activateDict.becomes(PdfJavaScriptAction, {
+            engine: this.engine,
+        });
+    }
+}

package/dist/acroform/js/pdf-javascript-action.d.ts

@@ -0,0 +1,17 @@
+import { PdfDictionary } from '../../core/objects/pdf-dictionary.js';
+import { PdfString } from '../../core/objects/pdf-string.js';
+import { PdfStream } from '../../core/objects/pdf-stream.js';
+import { PdfObjectReference } from '../../core/objects/pdf-object-reference.js';
+import { PdfName } from '../../core/objects/pdf-name.js';
+import type { PdfJsEngine, PdfJsEvent } from './pdf-js-engine.js';
+export declare class PdfJavaScriptAction extends PdfDictionary<{
+    S?: PdfName;
+    JS?: PdfString | PdfStream | PdfObjectReference;
+}> {
+    engine?: PdfJsEngine;
+    constructor(dict: PdfDictionary, options?: {
+        engine?: PdfJsEngine;
+    });
+    get code(): string | null;
+    execute(event: PdfJsEvent): void;
+}

package/dist/acroform/js/pdf-javascript-action.js

@@ -0,0 +1,38 @@
+import { PdfDictionary } from '../../core/objects/pdf-dictionary.js';
+import { PdfString } from '../../core/objects/pdf-string.js';
+import { PdfStream } from '../../core/objects/pdf-stream.js';
+import { PdfObjectReference } from '../../core/objects/pdf-object-reference.js';
+import { bytesToString } from '../../utils/bytesToString.js';
+export class PdfJavaScriptAction extends PdfDictionary {
+    engine;
+    constructor(dict, options) {
+        super();
+        this.copyFrom(dict);
+        this.engine = options?.engine;
+    }
+    get code() {
+        const js = this.get('JS');
+        if (js instanceof PdfString) {
+            return js.value;
+        }
+        if (js instanceof PdfObjectReference) {
+            const resolved = js.resolve();
+            if (resolved?.content instanceof PdfStream) {
+                return bytesToString(resolved.content.data);
+            }
+            if (resolved?.content instanceof PdfString) {
+                return resolved.content.value;
+            }
+        }
+        if (js instanceof PdfStream) {
+            return bytesToString(js.data);
+        }
+        return null;
+    }
+    execute(event) {
+        const code = this.code;
+        if (code && this.engine) {
+            this.engine.execute(code, event);
+        }
+    }
+}

package/dist/acroform/js/pdf-js-builtins.d.ts

@@ -0,0 +1,12 @@
+import type { PdfJsEvent } from './pdf-js-engine.js';
+export declare function printd(fmt: string, date: Date): string;
+export declare function scand(fmt: string, str: string): Date | null;
+export declare function printf(fmt: string, ...args: unknown[]): string;
+export declare const util: {
+    printd: typeof printd;
+    scand: typeof scand;
+    printf: typeof printf;
+};
+type GetFieldValue = (name: string) => string;
+export declare function createBuiltins(event: PdfJsEvent, getFieldValue?: GetFieldValue): Record<string, unknown>;
+export {};