@peculiar/pdf-form-json 1.17.2 → 2.0.0

package/README.md

@@ -1,20 +1,31 @@
-# `@peculiar/pdf-form-json`
+<h1 align="center">
+  @peculiar/pdf-form-json
+</h1>
+
+<div align="center">
+
+![GitHub License](https://img.shields.io/github/license/PeculiarVentures/pdf)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/PeculiarVentures/pdf/release.yml?branch=main&label=release)
+[![npm version](https://img.shields.io/npm/v/@peculiar/pdf-form-json.svg)](https://www.npmjs.com/package/@peculiar/pdf-form-json)
+[![npm downloads](https://img.shields.io/npm/dm/@peculiar/pdf-form-json.svg)](https://www.npmjs.com/package/@peculiar/pdf-form-json)
+
+</div>
 
 `@peculiar/pdf-form-json` is a library for working with PDF form data in JSON format. This library provides a FormConverter class that can convert a PDF document with form data into a JSON representation of that data, and also set values on form components based on a JSON payload.
 
 ## Installation
 
-Using npm:
-
 ```bash
 npm install @peculiar/pdf-form-json
 ```
 
-Using yarn:
+## Breaking Changes In v2
 
-```bash
-yarn add @peculiar/pdf-form-json
-```
+v2 is ESM-only and requires Node.js `^20.19.0 || >=22.12.0` (1.x declared no `engines`). CommonJS code can still `require("@peculiar/pdf-form-json")` on these versions; Node.js 22.0–22.11 can't. See the [full notes](https://github.com/PeculiarVentures/pdf#breaking-changes-in-v2).
+
+- **TypeScript compiling to CommonJS:** use `"module": "node20"` or `"nodenext"` (`node16` fails with TS1479). ESM and bundler setups need no changes.
+- **Jest in CommonJS mode:** switch to ESM mode or Vitest, or configure an ESM-to-CommonJS transformer and make sure `transformIgnorePatterns` doesn't exclude the `@peculiar/*` packages.
+- **Deep imports** (`@peculiar/pdf-form-json/build/...`) are blocked by `exports`; import from `@peculiar/pdf-form-json`.
 
 ## Usage
 

package/build/index.d.ts

@@ -1,96 +1,93 @@
-import * as pdfDoc from '@peculiar/pdf-doc';
-import { FormComponentType } from '@peculiar/pdf-doc';
-
+import * as pdfDoc from "@peculiar/pdf-doc";
+import { FormComponentType } from "@peculiar/pdf-doc";
 /**
  * Type representing a constructor for an IComponent instance.
  */
-type IComponentConstructor<T extends pdfDoc.IComponent> = new (target: any, doc: pdfDoc.PDFDocument) => T;
+export type IComponentConstructor<T extends pdfDoc.IComponent> = new (target: any, doc: pdfDoc.PDFDocument) => T;
 /**
  * Interface representing the JSON object for a form component.
  */
-interface JsonComponent {
-    name: string;
+export interface JsonComponent {
+  name: string;
 }
 /**
  * Interface representing the JSON object for a PDF form.
  */
-interface JsonForm {
-    form: Record<string, JsonComponent>;
+export interface JsonForm {
+  form: Record<string, JsonComponent>;
 }
 /**
  * Interface representing the update data for a form component.
  */
-interface JsonComponentUpdate {
-    type: FormComponentType[keyof FormComponentType];
-    name: string;
+export interface JsonComponentUpdate {
+  type: FormComponentType[keyof FormComponentType];
+  name: string;
 }
 /**
  * Interface representing the update data for a check box form component.
  */
-interface JsonCheckBoxUpdate extends JsonComponentUpdate {
-    type: "check_box";
-    checked: boolean;
+export interface JsonCheckBoxUpdate extends JsonComponentUpdate {
+  type: "check_box";
+  checked: boolean;
 }
 /**
  * Interface representing the update data for a radio button form component.
  */
-interface JsonRadioButtonUpdate extends JsonComponentUpdate {
-    type: "radio_button";
-    checked: boolean;
+export interface JsonRadioButtonUpdate extends JsonComponentUpdate {
+  type: "radio_button";
+  checked: boolean;
 }
 /**
  * Interface representing the update data for a radio button group form component.
  */
-interface JsonRadioButtonGroupUpdate extends JsonComponentUpdate {
-    type: "radio_button_group";
-    selected: string;
+export interface JsonRadioButtonGroupUpdate extends JsonComponentUpdate {
+  type: "radio_button_group";
+  selected: string;
 }
 /**
  * Interface representing the update data for a combo box form component.
  */
-interface JsonComboBoxUpdate extends JsonComponentUpdate {
-    type: "combo_box";
-    selected: string[];
+export interface JsonComboBoxUpdate extends JsonComponentUpdate {
+  type: "combo_box";
+  selected: string[];
 }
 /**
  * Interface representing the update data for a text editor form component.
  */
-interface JsonTextEditorUpdate extends JsonComponentUpdate {
-    type: "text_editor";
-    text: string;
+export interface JsonTextEditorUpdate extends JsonComponentUpdate {
+  type: "text_editor";
+  text: string;
 }
 /**
  * Union type for all possible types of form component updates.
  */
-type JsonUpdateMixed = JsonCheckBoxUpdate | JsonRadioButtonGroupUpdate | JsonRadioButtonUpdate | JsonComboBoxUpdate | JsonTextEditorUpdate;
-
+export type JsonUpdateMixed = JsonCheckBoxUpdate | JsonRadioButtonGroupUpdate | JsonRadioButtonUpdate | JsonComboBoxUpdate | JsonTextEditorUpdate;
 /**
  * Abstract class representing a ComponentConverter for an IComponent type.
  */
-declare abstract class ComponentConverter<T extends pdfDoc.IComponent> {
-    /**
-     * The constructor function for the associated IComponent type.
-     */
-    type: pdfDoc.IComponentConstructor<T>;
-    /**
-     * The string value of the FormComponentType for the associated IComponent type.
-     */
-    abstract typeJSON: string;
-    constructor(type: pdfDoc.IComponentConstructor<T>);
-    /**
-     * Exports a component to a JSON object.
-     * @param component - The component to export.
-     * @returns The JSON object representing the component.
-     */
-    abstract export(component: T): JsonComponent;
-    /**
-     * Sets the value of a component based on update data.
-     * @param component - The component to update.
-     * @param data - The update data for the component.
-     */
-    abstract setValue(component: T, data: JsonComponentUpdate): void;
-}
-
+export declare abstract class ComponentConverter<T extends pdfDoc.IComponent> {
+  /**
+   * The constructor function for the associated IComponent type.
+   */
+  type: pdfDoc.IComponentConstructor<T>;
+  /**
+   * The string value of the FormComponentType for the associated IComponent type.
+   */
+  abstract typeJSON: string;
+  constructor(type: pdfDoc.IComponentConstructor<T>);
+  /**
+   * Exports a component to a JSON object.
+   * @param component - The component to export.
+   * @returns The JSON object representing the component.
+   */
+  abstract export(component: T): JsonComponent;
+  /**
+   * Sets the value of a component based on update data.
+   * @param component - The component to update.
+   * @param data - The update data for the component.
+   */
+  abstract setValue(component: T, data: JsonComponentUpdate): void;
+}
 /**
  * The ComponentConverterFactory is a factory that creates ComponentConverter instances for IComponent types.
  * It contains a map of ComponentConverter instances, keyed by their associated IComponent type.
@@ -98,153 +95,142 @@ declare abstract class ComponentConverter<T extends pdfDoc.IComponent> {
  * @remarks
  * To create a new ComponentConverter instance, call the register method with a new instance of the converter.
  */
-declare class ComponentConverterFactory {
-    /**
-     * A map of ComponentConverter instances, keyed by their associated IComponent type.
-     */
-    protected items: Map<IComponentConstructor<pdfDoc.IComponent>, ComponentConverter<pdfDoc.IComponent>>;
-    constructor(...converters: ComponentConverter<pdfDoc.IComponent>[]);
-    /**
-     * Registers a new ComponentConverter instance for a given IComponent type.
-     *
-     * @param converter - The ComponentConverter instance to register.
-     */
-    register(converter: ComponentConverter<pdfDoc.IComponent>): void;
-    /**
-     * Finds a ComponentConverter instance for a given IComponent type.
-     *
-     * @typeparam T - The IComponent type to find a converter for.
-     * @param type - The constructor function for the IComponent type to find a converter for.
-     * @returns The ComponentConverter instance for the given IComponent type, or null if not found.
-     */
-    find<T extends pdfDoc.IComponent>(type: IComponentConstructor<T>): ComponentConverter<T> | null;
-    /**
-     * Gets a ComponentConverter instance for a given IComponent type.
-     *
-     * @typeparam T - The IComponent type to get a converter for.
-     * @param type - The constructor function for the IComponent type to get a converter for.
-     * @returns The ComponentConverter instance for the given IComponent type.
-     * @throws If no converter is found for the given IComponent type.
-     */
-    get<T extends pdfDoc.IComponent>(type: IComponentConstructor<T>): ComponentConverter<T>;
-}
-
+export declare class ComponentConverterFactory {
+  /**
+   * A map of ComponentConverter instances, keyed by their associated IComponent type.
+   */
+  protected items: Map<IComponentConstructor<pdfDoc.IComponent>, ComponentConverter<pdfDoc.IComponent>>;
+  constructor(...converters: ComponentConverter<pdfDoc.IComponent>[]);
+  /**
+   * Registers a new ComponentConverter instance for a given IComponent type.
+   *
+   * @param converter - The ComponentConverter instance to register.
+   */
+  register(converter: ComponentConverter<pdfDoc.IComponent>): void;
+  /**
+   * Finds a ComponentConverter instance for a given IComponent type.
+   *
+   * @typeparam T - The IComponent type to find a converter for.
+   * @param type - The constructor function for the IComponent type to find a converter for.
+   * @returns The ComponentConverter instance for the given IComponent type, or null if not found.
+   */
+  find<T extends pdfDoc.IComponent>(type: IComponentConstructor<T>): ComponentConverter<T> | null;
+  /**
+   * Gets a ComponentConverter instance for a given IComponent type.
+   *
+   * @typeparam T - The IComponent type to get a converter for.
+   * @param type - The constructor function for the IComponent type to get a converter for.
+   * @returns The ComponentConverter instance for the given IComponent type.
+   * @throws If no converter is found for the given IComponent type.
+   */
+  get<T extends pdfDoc.IComponent>(type: IComponentConstructor<T>): ComponentConverter<T>;
+}
 /**
  * Abstract class representing a ComponentConverter for a FormComponentGroup type.
  * @typeparam T - The FormComponentGroup type to convert.
  */
-declare abstract class FieldConverter<T extends pdfDoc.FormComponentGroup> extends ComponentConverter<T> {
-    export(component: T): JsonComponent;
-    /**
-     *
-     * @param component Called to add additional data to the JSON object representing the form component.
-     * @param component - The form component to export.
-     * @param json - The JSON object representing the form component.
-     */
-    protected abstract onExport(component: T, json: Record<string, unknown>): void;
+export declare abstract class FieldConverter<T extends pdfDoc.FormComponentGroup> extends ComponentConverter<T> {
+  export(component: T): JsonComponent;
+  /**
+   *
+   * @param component Called to add additional data to the JSON object representing the form component.
+   * @param component - The form component to export.
+   * @param json - The JSON object representing the form component.
+   */
+  protected abstract onExport(component: T, json: Record<string, unknown>): void;
 }
-
 /**
  * Abstract class representing a ComponentConverter for a FormComponent type.
  * @typeparam T - The FormComponent type to convert.
  */
-declare abstract class WidgetConverter<T extends pdfDoc.FormComponent> extends ComponentConverter<T> {
-    export(component: T): JsonComponent;
-    /**
-     * Called to add additional data to the JSON object representing the form component.
-     * @param component - The form component to export.
-     * @param json - The JSON object representing the form component.
-     */
-    protected abstract onExport(component: T, json: Record<string, unknown>): void;
+export declare abstract class WidgetConverter<T extends pdfDoc.FormComponent> extends ComponentConverter<T> {
+  export(component: T): JsonComponent;
+  /**
+   * Called to add additional data to the JSON object representing the form component.
+   * @param component - The form component to export.
+   * @param json - The JSON object representing the form component.
+   */
+  protected abstract onExport(component: T, json: Record<string, unknown>): void;
 }
-
 /**
  * A ComponentConverter for CheckBox form components.
  */
-declare class CheckBoxConverter extends WidgetConverter<pdfDoc.CheckBox> {
-    typeJSON: pdfDoc.FormComponentType.checkBox;
-    constructor();
-    protected onExport(component: pdfDoc.CheckBox, json: Record<string, unknown>): void;
-    setValue(component: pdfDoc.CheckBox, data: JsonCheckBoxUpdate): void;
+export declare class CheckBoxConverter extends WidgetConverter<pdfDoc.CheckBox> {
+  typeJSON: pdfDoc.FormComponentType.checkBox;
+  constructor();
+  protected onExport(component: pdfDoc.CheckBox, json: Record<string, unknown>): void;
+  setValue(component: pdfDoc.CheckBox, data: JsonCheckBoxUpdate): void;
 }
-
 /**
  * A ComponentConverter for ComboBox form components.
  */
-declare class ComboBoxConverter extends WidgetConverter<pdfDoc.ComboBox> {
-    typeJSON: pdfDoc.FormComponentType.comboBox;
-    constructor();
-    protected onExport(component: pdfDoc.ComboBox, json: Record<string, unknown>): void;
-    setValue(component: pdfDoc.ComboBox, data: JsonComboBoxUpdate): void;
+export declare class ComboBoxConverter extends WidgetConverter<pdfDoc.ComboBox> {
+  typeJSON: pdfDoc.FormComponentType.comboBox;
+  constructor();
+  protected onExport(component: pdfDoc.ComboBox, json: Record<string, unknown>): void;
+  setValue(component: pdfDoc.ComboBox, data: JsonComboBoxUpdate): void;
 }
-
 /**
  * A ComponentConverter for RadioButton form components.
  */
-declare class RadioButtonConverter extends WidgetConverter<pdfDoc.RadioButton> {
-    typeJSON: pdfDoc.FormComponentType.radioButton;
-    constructor();
-    protected onExport(component: pdfDoc.RadioButton, json: Record<string, unknown>): void;
-    setValue(component: pdfDoc.RadioButton, data: JsonRadioButtonUpdate): void;
+export declare class RadioButtonConverter extends WidgetConverter<pdfDoc.RadioButton> {
+  typeJSON: pdfDoc.FormComponentType.radioButton;
+  constructor();
+  protected onExport(component: pdfDoc.RadioButton, json: Record<string, unknown>): void;
+  setValue(component: pdfDoc.RadioButton, data: JsonRadioButtonUpdate): void;
 }
-
 /**
  * A ComponentConverter for RadioButtonGroup form components.
  */
-declare class RadioButtonGroupConverter extends FieldConverter<pdfDoc.RadioButtonGroup> {
-    typeJSON: pdfDoc.FormComponentType.radioButtonGroup;
-    constructor();
-    protected onExport(component: pdfDoc.RadioButtonGroup, json: Record<string, unknown>): void;
-    setValue(component: pdfDoc.RadioButtonGroup, data: JsonRadioButtonGroupUpdate): void;
+export declare class RadioButtonGroupConverter extends FieldConverter<pdfDoc.RadioButtonGroup> {
+  typeJSON: pdfDoc.FormComponentType.radioButtonGroup;
+  constructor();
+  protected onExport(component: pdfDoc.RadioButtonGroup, json: Record<string, unknown>): void;
+  setValue(component: pdfDoc.RadioButtonGroup, data: JsonRadioButtonGroupUpdate): void;
 }
-
 /**
  * A ComponentConverter for TextEditor form components.
  */
-declare class TextEditorConverter extends WidgetConverter<pdfDoc.TextEditor> {
-    typeJSON: pdfDoc.FormComponentType.textEditor;
-    constructor();
-    protected onExport(component: pdfDoc.TextEditor, json: Record<string, unknown>): void;
-    setValue(component: pdfDoc.TextEditor, data: JsonTextEditorUpdate): void;
+export declare class TextEditorConverter extends WidgetConverter<pdfDoc.TextEditor> {
+  typeJSON: pdfDoc.FormComponentType.textEditor;
+  constructor();
+  protected onExport(component: pdfDoc.TextEditor, json: Record<string, unknown>): void;
+  setValue(component: pdfDoc.TextEditor, data: JsonTextEditorUpdate): void;
 }
-
 /**
  * A utility class for exporting and updating PDF form components.
  */
-declare class FormConverter {
-    /**
-     * The ComponentConverterFactory instance to use for converting PDF form components to JSON.
-     */
-    registry: ComponentConverterFactory;
-    /**
-     * Creates a FormConverter instance.
-     * @param registry - The ComponentConverterFactory instance to use for converting PDF form components to JSON.
-     */
-    constructor(registry: ComponentConverterFactory);
-    /**
-     * Exports all PDF form components in a document to JSON format.
-     * @param doc - The PDF document to export the form components from.
-     * @returns An object containing JSON representations of all form components in the document.
-     */
-    export(doc: pdfDoc.PDFDocument): JsonForm;
-    /**
-     * Exports a single PDF form component to JSON format.
-     * @param component - The PDF form component to export.
-     * @returns The JSON representation of the specified form component,
-     * or null if the component is not supported by the current converter registry.
-     */
-    protected exportComponent(component: pdfDoc.IComponent): JsonComponent | null;
-    /**
-     * Sets the value of one or more PDF form components based on provided JSON updates.
-     * @param doc - The PDF document containing the form components to update.
-     * @param data - An array of JSON updates to apply to the PDF form components.
-     */
-    setValue(doc: pdfDoc.PDFDocument, data: JsonUpdateMixed[]): void;
-}
-
+export declare class FormConverter {
+  /**
+   * The ComponentConverterFactory instance to use for converting PDF form components to JSON.
+   */
+  registry: ComponentConverterFactory;
+  /**
+   * Creates a FormConverter instance.
+   * @param registry - The ComponentConverterFactory instance to use for converting PDF form components to JSON.
+   */
+  constructor(registry: ComponentConverterFactory);
+  /**
+   * Exports all PDF form components in a document to JSON format.
+   * @param doc - The PDF document to export the form components from.
+   * @returns An object containing JSON representations of all form components in the document.
+   */
+  export(doc: pdfDoc.PDFDocument): JsonForm;
+  /**
+   * Exports a single PDF form component to JSON format.
+   * @param component - The PDF form component to export.
+   * @returns The JSON representation of the specified form component,
+   * or null if the component is not supported by the current converter registry.
+   */
+  protected exportComponent(component: pdfDoc.IComponent): JsonComponent | null;
+  /**
+   * Sets the value of one or more PDF form components based on provided JSON updates.
+   * @param doc - The PDF document containing the form components to update.
+   * @param data - An array of JSON updates to apply to the PDF form components.
+   */
+  setValue(doc: pdfDoc.PDFDocument, data: JsonUpdateMixed[]): void;
+}
 /**
  * A global instance of FormConverter that uses the ComponentConverter registry.
  */
-declare const globalFormConverter: FormConverter;
-
-export { CheckBoxConverter, ComboBoxConverter, ComponentConverter, ComponentConverterFactory, FieldConverter, FormConverter, type IComponentConstructor, type JsonCheckBoxUpdate, type JsonComboBoxUpdate, type JsonComponent, type JsonComponentUpdate, type JsonForm, type JsonRadioButtonGroupUpdate, type JsonRadioButtonUpdate, type JsonTextEditorUpdate, type JsonUpdateMixed, RadioButtonConverter, RadioButtonGroupConverter, TextEditorConverter, WidgetConverter, globalFormConverter };
+export declare const globalFormConverter: FormConverter;

package/build/index.js

@@ -0,0 +1,183 @@
+import * as pdfDoc from "@peculiar/pdf-doc";
+// src/converters/ComponentConverter.ts
+var ComponentConverter = class {
+	constructor(type) {
+		this.type = type;
+	}
+};
+// src/converters/ComponentConverter.Factory.ts
+var ComponentConverterFactory = class {
+	constructor(...converters) {
+		this.items = /* @__PURE__ */ new Map();
+		for (const converter of converters) this.register(converter);
+	}
+	register(converter) {
+		this.items.set(converter.type, converter);
+	}
+	find(type) {
+		return this.items.get(type) || null;
+	}
+	get(type) {
+		const converter = this.find(type);
+		if (!converter) throw new Error(`Converter not found for type ${type.name}`);
+		return converter;
+	}
+};
+// src/converters/FieldConverter.ts
+var FieldConverter = class extends ComponentConverter {
+	export(component) {
+		const json = {
+			type: this.typeJSON,
+			id: component.id,
+			name: component.name
+		};
+		this.onExport(component, json);
+		return json;
+	}
+};
+// src/converters/WidgetConverter.ts
+var WidgetConverter = class extends ComponentConverter {
+	export(component) {
+		const json = {
+			type: this.typeJSON,
+			id: component.id,
+			name: component.name,
+			position: {
+				left: component.left,
+				top: component.top,
+				height: component.height,
+				width: component.width
+			},
+			flags: {
+				hidden: component.hidden,
+				invisible: component.invisible,
+				locked: component.locked,
+				lockedContents: component.lockedContents,
+				noExport: component.noExport,
+				noRotate: component.noRotate,
+				noView: component.noView,
+				noZoom: component.noZoom,
+				print: component.print,
+				readOnly: component.readOnly,
+				readOnlyAnnot: component.readOnlyAnnot,
+				required: component.required,
+				toggleNoView: component.toggleNoView
+			}
+		};
+		this.onExport(component, json);
+		return json;
+	}
+};
+// src/converters/CheckBoxConverter.ts
+var CheckBoxConverter = class extends WidgetConverter {
+	constructor() {
+		super(pdfDoc.CheckBox);
+		this.typeJSON = pdfDoc.FormComponentType.checkBox;
+	}
+	onExport(component, json) {
+		json.checked = component.checked;
+		json.value = component.value;
+	}
+	setValue(component, data) {
+		component.checked = data.checked;
+	}
+};
+// src/converters/ComboBoxConverter.ts
+var ComboBoxConverter = class extends WidgetConverter {
+	constructor() {
+		super(pdfDoc.ComboBox);
+		this.typeJSON = pdfDoc.FormComponentType.comboBox;
+	}
+	onExport(component, json) {
+		let flags = {};
+		if (json.flags && typeof json.flags === "object") flags = json.flags;
+		json.flags = {
+			...flags,
+			combo: component.combo,
+			edit: component.edit,
+			sort: component.sort,
+			multiSelect: component.multiSelect,
+			doNotSpellCheck: component.doNotSpellCheck,
+			commitOnSelChange: component.commitOnSelChange
+		};
+		json.options = component.options;
+		json.selected = component.selected;
+	}
+	setValue(component, data) {
+		component.selected = data.selected;
+	}
+};
+// src/converters/RadioButtonConverter.ts
+var RadioButtonConverter = class extends WidgetConverter {
+	constructor() {
+		super(pdfDoc.RadioButton);
+		this.typeJSON = pdfDoc.FormComponentType.radioButton;
+	}
+	onExport(component, json) {
+		json.checked = component.checked;
+		json.value = component.value;
+	}
+	setValue(component, data) {
+		component.checked = data.checked;
+	}
+};
+// src/converters/RadioButtonGroupConverter.ts
+var RadioButtonGroupConverter = class extends FieldConverter {
+	constructor() {
+		super(pdfDoc.RadioButtonGroup);
+		this.typeJSON = pdfDoc.FormComponentType.radioButtonGroup;
+	}
+	onExport(component, json) {
+		json.selected = component.selected;
+	}
+	setValue(component, data) {
+		const button = component.get(data.selected);
+		button.checked = true;
+	}
+};
+// src/converters/TextEditorConverter.ts
+var TextEditorConverter = class extends WidgetConverter {
+	constructor() {
+		super(pdfDoc.TextEditor);
+		this.typeJSON = pdfDoc.FormComponentType.textEditor;
+	}
+	onExport(component, json) {
+		json.maxLen = component.maxLen;
+		json.multiline = component.multiline;
+		json.text = component.text;
+	}
+	setValue(component, data) {
+		component.text = data.text;
+	}
+};
+// src/FormConverter.ts
+var FormConverter = class {
+	constructor(registry) {
+		this.registry = registry;
+	}
+	export(doc) {
+		const res = { form: {} };
+		const components = doc.getComponents();
+		for (const component of components) {
+			const obj = this.exportComponent(component);
+			if (obj) res.form[obj.name] = obj;
+		}
+		return res;
+	}
+	exportComponent(component) {
+		const converter = this.registry.find(component.constructor);
+		if (converter) return converter.export(component);
+		return null;
+	}
+	setValue(doc, data) {
+		for (const item of data) {
+			const component = doc.getComponentByName(item.name);
+			if (!component) continue;
+			const converter = this.registry.find(component.constructor);
+			if (!converter || converter.typeJSON !== item.type) continue;
+			converter.setValue(component, item);
+		}
+	}
+};
+const globalFormConverter = new FormConverter(new ComponentConverterFactory(new CheckBoxConverter(), new RadioButtonConverter(), new TextEditorConverter(), new ComboBoxConverter(), new ComboBoxConverter(), new RadioButtonGroupConverter()));
+export { CheckBoxConverter, ComboBoxConverter, ComponentConverter, ComponentConverterFactory, FieldConverter, FormConverter, RadioButtonConverter, RadioButtonGroupConverter, TextEditorConverter, WidgetConverter, globalFormConverter };

package/package.json

@@ -1,7 +1,27 @@
 {
   "name": "@peculiar/pdf-form-json",
-  "version": "1.17.2",
+  "version": "2.0.0",
   "description": "A PDF module enabling working with form elements through JSON.",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./build/index.js",
+  "module": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "exports": {
+    ".": "./build/index.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "build/",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
   "keywords": [
     "pdf",
     "form",
@@ -9,39 +29,18 @@
     "acroform"
   ],
   "author": "microshine <microshine@mail.ru>",
-  "homepage": "https://github.com/PeculiarVentures/pdf/tree/master/packages/form-json#readme",
   "license": "AGPL",
-  "main": "build/peculiar.pdf.form.js",
-  "module": "build/peculiar.pdf.form.es.js",
-  "types": "build/index.d.ts",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "files": [
-    "build",
-    "LICENSE",
-    "README.md"
-  ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/PeculiarVentures/pdf.git"
-  },
-  "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 1",
-    "clear": "rimraf build/*",
-    "build": "rollup -c",
-    "rebuild": "yarn run clear && yarn run build",
-    "prepack": "npm run rebuild"
+    "url": "https://github.com/PeculiarVentures/pdf",
+    "directory": "packages/form-json"
   },
   "bugs": {
     "url": "https://github.com/PeculiarVentures/pdf/issues"
   },
+  "homepage": "https://github.com/PeculiarVentures/pdf/tree/main/packages/form-json#readme",
   "dependencies": {
-    "@peculiar/pdf-core": "^1.17.1",
-    "@peculiar/pdf-doc": "^1.17.2",
-    "pvtsutils": "^1.3.6",
-    "tslib": "^2.8.1"
-  },
-  "gitHead": "5f19d4933bddeca2579656d9fea7d313e795c67b"
+    "@peculiar/pdf-core": "^2.0.0",
+    "@peculiar/pdf-doc": "^2.0.0"
+  }
 }

package/build/peculiar.pdf.form.es.js

@@ -1,203 +0,0 @@
-import * as pdfDoc from '@peculiar/pdf-doc';
-
-class ComponentConverter {
-    constructor(type) {
-        this.type = type;
-    }
-}
-
-class ComponentConverterFactory {
-    constructor(...converters) {
-        this.items = new Map();
-        for (const converter of converters) {
-            this.register(converter);
-        }
-    }
-    register(converter) {
-        this.items.set(converter.type, converter);
-    }
-    find(type) {
-        const converter = this.items.get(type);
-        return converter || null;
-    }
-    get(type) {
-        const converter = this.find(type);
-        if (!converter) {
-            throw new Error(`Converter not found for type ${type.name}`);
-        }
-        return converter;
-    }
-}
-
-class FieldConverter extends ComponentConverter {
-    export(component) {
-        const json = {
-            type: this.typeJSON,
-            id: component.id,
-            name: component.name
-        };
-        this.onExport(component, json);
-        return json;
-    }
-}
-
-class WidgetConverter extends ComponentConverter {
-    export(component) {
-        const json = {
-            type: this.typeJSON,
-            id: component.id,
-            name: component.name,
-            position: {
-                left: component.left,
-                top: component.top,
-                height: component.height,
-                width: component.width
-            },
-            flags: {
-                hidden: component.hidden,
-                invisible: component.invisible,
-                locked: component.locked,
-                lockedContents: component.lockedContents,
-                noExport: component.noExport,
-                noRotate: component.noRotate,
-                noView: component.noView,
-                noZoom: component.noZoom,
-                print: component.print,
-                readOnly: component.readOnly,
-                readOnlyAnnot: component.readOnlyAnnot,
-                required: component.required,
-                toggleNoView: component.toggleNoView
-            }
-        };
-        this.onExport(component, json);
-        return json;
-    }
-}
-
-class CheckBoxConverter extends WidgetConverter {
-    constructor() {
-        super(pdfDoc.CheckBox);
-        this.typeJSON = pdfDoc.FormComponentType.checkBox;
-    }
-    onExport(component, json) {
-        json.checked = component.checked;
-        json.value = component.value;
-    }
-    setValue(component, data) {
-        component.checked = data.checked;
-    }
-}
-
-class ComboBoxConverter extends WidgetConverter {
-    constructor() {
-        super(pdfDoc.ComboBox);
-        this.typeJSON = pdfDoc.FormComponentType.comboBox;
-    }
-    onExport(component, json) {
-        let flags = {};
-        if (json.flags && typeof json.flags === "object") {
-            flags = json.flags;
-        }
-        json.flags = {
-            ...flags,
-            combo: component.combo,
-            edit: component.edit,
-            sort: component.sort,
-            multiSelect: component.multiSelect,
-            doNotSpellCheck: component.doNotSpellCheck,
-            commitOnSelChange: component.commitOnSelChange
-        };
-        json.options = component.options;
-        json.selected = component.selected;
-    }
-    setValue(component, data) {
-        component.selected = data.selected;
-    }
-}
-
-class RadioButtonConverter extends WidgetConverter {
-    constructor() {
-        super(pdfDoc.RadioButton);
-        this.typeJSON = pdfDoc.FormComponentType.radioButton;
-    }
-    onExport(component, json) {
-        json.checked = component.checked;
-        json.value = component.value;
-    }
-    setValue(component, data) {
-        component.checked = data.checked;
-    }
-}
-
-class RadioButtonGroupConverter extends FieldConverter {
-    constructor() {
-        super(pdfDoc.RadioButtonGroup);
-        this.typeJSON = pdfDoc.FormComponentType.radioButtonGroup;
-    }
-    onExport(component, json) {
-        json.selected = component.selected;
-    }
-    setValue(component, data) {
-        const button = component.get(data.selected);
-        button.checked = true;
-    }
-}
-
-class TextEditorConverter extends WidgetConverter {
-    constructor() {
-        super(pdfDoc.TextEditor);
-        this.typeJSON = pdfDoc.FormComponentType.textEditor;
-    }
-    onExport(component, json) {
-        json.maxLen = component.maxLen;
-        json.multiline = component.multiline;
-        json.text = component.text;
-    }
-    setValue(component, data) {
-        component.text = data.text;
-    }
-}
-
-class FormConverter {
-    constructor(registry) {
-        this.registry = registry;
-    }
-    export(doc) {
-        const res = {
-            form: {}
-        };
-        const components = doc.getComponents();
-        for (const component of components) {
-            const obj = this.exportComponent(component);
-            if (obj) {
-                res.form[obj.name] = obj;
-            }
-        }
-        return res;
-    }
-    exportComponent(component) {
-        const converter = this.registry.find(component.constructor);
-        if (converter) {
-            return converter.export(component);
-        }
-        return null;
-    }
-    setValue(doc, data) {
-        for (const item of data) {
-            const component = doc.getComponentByName(item.name);
-            if (!component) {
-                continue;
-            }
-            const converter = this.registry.find(component.constructor);
-            if (!converter || converter.typeJSON !== item.type) {
-                continue;
-            }
-            converter.setValue(component, item);
-        }
-    }
-}
-
-const registry = new ComponentConverterFactory(new CheckBoxConverter(), new RadioButtonConverter(), new TextEditorConverter(), new ComboBoxConverter(), new ComboBoxConverter(), new RadioButtonGroupConverter());
-const globalFormConverter = new FormConverter(registry);
-
-export { CheckBoxConverter, ComboBoxConverter, ComponentConverter, ComponentConverterFactory, FieldConverter, FormConverter, RadioButtonConverter, RadioButtonGroupConverter, TextEditorConverter, WidgetConverter, globalFormConverter };

package/build/peculiar.pdf.form.js

@@ -1,234 +0,0 @@
-'use strict';
-
-var pdfDoc = require('@peculiar/pdf-doc');
-
-function _interopNamespaceDefault(e) {
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-
-var pdfDoc__namespace = /*#__PURE__*/_interopNamespaceDefault(pdfDoc);
-
-class ComponentConverter {
-    constructor(type) {
-        this.type = type;
-    }
-}
-
-class ComponentConverterFactory {
-    constructor(...converters) {
-        this.items = new Map();
-        for (const converter of converters) {
-            this.register(converter);
-        }
-    }
-    register(converter) {
-        this.items.set(converter.type, converter);
-    }
-    find(type) {
-        const converter = this.items.get(type);
-        return converter || null;
-    }
-    get(type) {
-        const converter = this.find(type);
-        if (!converter) {
-            throw new Error(`Converter not found for type ${type.name}`);
-        }
-        return converter;
-    }
-}
-
-class FieldConverter extends ComponentConverter {
-    export(component) {
-        const json = {
-            type: this.typeJSON,
-            id: component.id,
-            name: component.name
-        };
-        this.onExport(component, json);
-        return json;
-    }
-}
-
-class WidgetConverter extends ComponentConverter {
-    export(component) {
-        const json = {
-            type: this.typeJSON,
-            id: component.id,
-            name: component.name,
-            position: {
-                left: component.left,
-                top: component.top,
-                height: component.height,
-                width: component.width
-            },
-            flags: {
-                hidden: component.hidden,
-                invisible: component.invisible,
-                locked: component.locked,
-                lockedContents: component.lockedContents,
-                noExport: component.noExport,
-                noRotate: component.noRotate,
-                noView: component.noView,
-                noZoom: component.noZoom,
-                print: component.print,
-                readOnly: component.readOnly,
-                readOnlyAnnot: component.readOnlyAnnot,
-                required: component.required,
-                toggleNoView: component.toggleNoView
-            }
-        };
-        this.onExport(component, json);
-        return json;
-    }
-}
-
-class CheckBoxConverter extends WidgetConverter {
-    constructor() {
-        super(pdfDoc__namespace.CheckBox);
-        this.typeJSON = pdfDoc__namespace.FormComponentType.checkBox;
-    }
-    onExport(component, json) {
-        json.checked = component.checked;
-        json.value = component.value;
-    }
-    setValue(component, data) {
-        component.checked = data.checked;
-    }
-}
-
-class ComboBoxConverter extends WidgetConverter {
-    constructor() {
-        super(pdfDoc__namespace.ComboBox);
-        this.typeJSON = pdfDoc__namespace.FormComponentType.comboBox;
-    }
-    onExport(component, json) {
-        let flags = {};
-        if (json.flags && typeof json.flags === "object") {
-            flags = json.flags;
-        }
-        json.flags = {
-            ...flags,
-            combo: component.combo,
-            edit: component.edit,
-            sort: component.sort,
-            multiSelect: component.multiSelect,
-            doNotSpellCheck: component.doNotSpellCheck,
-            commitOnSelChange: component.commitOnSelChange
-        };
-        json.options = component.options;
-        json.selected = component.selected;
-    }
-    setValue(component, data) {
-        component.selected = data.selected;
-    }
-}
-
-class RadioButtonConverter extends WidgetConverter {
-    constructor() {
-        super(pdfDoc__namespace.RadioButton);
-        this.typeJSON = pdfDoc__namespace.FormComponentType.radioButton;
-    }
-    onExport(component, json) {
-        json.checked = component.checked;
-        json.value = component.value;
-    }
-    setValue(component, data) {
-        component.checked = data.checked;
-    }
-}
-
-class RadioButtonGroupConverter extends FieldConverter {
-    constructor() {
-        super(pdfDoc__namespace.RadioButtonGroup);
-        this.typeJSON = pdfDoc__namespace.FormComponentType.radioButtonGroup;
-    }
-    onExport(component, json) {
-        json.selected = component.selected;
-    }
-    setValue(component, data) {
-        const button = component.get(data.selected);
-        button.checked = true;
-    }
-}
-
-class TextEditorConverter extends WidgetConverter {
-    constructor() {
-        super(pdfDoc__namespace.TextEditor);
-        this.typeJSON = pdfDoc__namespace.FormComponentType.textEditor;
-    }
-    onExport(component, json) {
-        json.maxLen = component.maxLen;
-        json.multiline = component.multiline;
-        json.text = component.text;
-    }
-    setValue(component, data) {
-        component.text = data.text;
-    }
-}
-
-class FormConverter {
-    constructor(registry) {
-        this.registry = registry;
-    }
-    export(doc) {
-        const res = {
-            form: {}
-        };
-        const components = doc.getComponents();
-        for (const component of components) {
-            const obj = this.exportComponent(component);
-            if (obj) {
-                res.form[obj.name] = obj;
-            }
-        }
-        return res;
-    }
-    exportComponent(component) {
-        const converter = this.registry.find(component.constructor);
-        if (converter) {
-            return converter.export(component);
-        }
-        return null;
-    }
-    setValue(doc, data) {
-        for (const item of data) {
-            const component = doc.getComponentByName(item.name);
-            if (!component) {
-                continue;
-            }
-            const converter = this.registry.find(component.constructor);
-            if (!converter || converter.typeJSON !== item.type) {
-                continue;
-            }
-            converter.setValue(component, item);
-        }
-    }
-}
-
-const registry = new ComponentConverterFactory(new CheckBoxConverter(), new RadioButtonConverter(), new TextEditorConverter(), new ComboBoxConverter(), new ComboBoxConverter(), new RadioButtonGroupConverter());
-const globalFormConverter = new FormConverter(registry);
-
-exports.CheckBoxConverter = CheckBoxConverter;
-exports.ComboBoxConverter = ComboBoxConverter;
-exports.ComponentConverter = ComponentConverter;
-exports.ComponentConverterFactory = ComponentConverterFactory;
-exports.FieldConverter = FieldConverter;
-exports.FormConverter = FormConverter;
-exports.RadioButtonConverter = RadioButtonConverter;
-exports.RadioButtonGroupConverter = RadioButtonGroupConverter;
-exports.TextEditorConverter = TextEditorConverter;
-exports.WidgetConverter = WidgetConverter;
-exports.globalFormConverter = globalFormConverter;