@embedpdf/react 3.0.0-next.1 → 3.0.0-next.10

package/dist/AnnotationListSnapshot-DDxHpJQU-BG32YXxG.d.cts

@@ -0,0 +1,347 @@
+//#region ../../engine/core/dist/AnnotationListSnapshot-DDxHpJQU.d.ts
+//#endregion
+//#region src/dto/PdfAction.d.ts
+/** Normalized values of an action dictionary's `/S` name. */
+type PdfActionType = 'unknown' | 'goto' | 'goto-remote' | 'goto-embedded' | 'launch' | 'thread' | 'uri' | 'sound' | 'movie' | 'hide' | 'named' | 'submit-form' | 'reset-form' | 'import-data' | 'javascript' | 'set-ocg-state' | 'rendition' | 'transition' | 'goto-3d-view';
+/** One detached node in a normalized PDF action tree. */
+interface PdfActionNode {
+  type: PdfActionType;
+  /** Raw `/S` name, retained for unknown and future action types. */
+  subtype: string;
+  /** Decoded `/JS` source for JavaScript and Rendition actions. */
+  script?: string;
+  /** Normalized `/Next` children in PDF order. */
+  next: PdfActionNode[];
+}
+type PdfActionWarning = 'cycle-dropped' | 'malformed-next' | 'incomplete';
+/**
+ * One extracted action root plus the native reader's safety verdict.
+ * Consumers must never execute a tree whose `incomplete` flag is true.
+ */
+interface PdfActionTree {
+  /** Null when the model was valid but its root exceeded a safety bound. */
+  root: PdfActionNode | null;
+  incomplete: boolean;
+  /** Raw native bits, retained so newer warnings survive older SDKs. */
+  warningFlags: number;
+  warnings: PdfActionWarning[];
+}
+interface PdfFieldActions {
+  keystroke?: PdfActionTree;
+  format?: PdfActionTree;
+  validate?: PdfActionTree;
+  calculate?: PdfActionTree;
+}
+//#endregion
+//#region src/identity/PageObjectNumber.d.ts
+/**
+ * PDF indirect object number for a page.
+ *
+ * Resolved via the PDFium runtime helper `EPDFPage_GetObjectNumber(pagePtr)`.
+ * Always > 0 for well-formed PDFs. This replaces the v2 page index as the
+ * primary addressing key. The page index is kept on `PageHandle` as display
+ * metadata only, because it can shift when pages are inserted, deleted, or
+ * reordered while a session is open.
+ */
+type PageObjectNumber = number;
+//#endregion
+//#region src/identity/FormFieldRef.d.ts
+/**
+ * How callers address a logical form field.
+ *
+ * - `objectNumber` — the indirect object number of the field dictionary.
+ *   ISO 32000 guarantees every real AcroForm field dictionary is an
+ *   indirect object, and the layer runtime never renumbers (frozen base +
+ *   incremental deltas), so this is the durable identity for the lifetime
+ *   of a document. Preferred for all engine calls.
+ * - `fqn` — the fully qualified field name ("billing.name"). The portable,
+ *   semantic identity used by interchange formats (FDF/XFDF) and analytics;
+ *   survives document rewrites but is only as unique as the producer made
+ *   it. The engine resolves it against the reconciled field tree.
+ */
+type FormFieldRef = {
+  kind: 'objectNumber';
+  fieldObjectNumber: number;
+} | {
+  kind: 'fqn';
+  name: string;
+};
+/** A widget annotation of a field, as the forms subsystem sees it. */
+interface FormWidgetRef {
+  /**
+   * Indirect object number of the widget annotation — the join key to the
+   * annotation subsystem's `objectNumber` refs. `0` when the widget is
+   * stored as a direct object (spec-violating; cannot be addressed).
+   */
+  annotObjectNumber: number;
+  /**
+   * Object number of the page whose /Annots array references the widget.
+   * `0` when the widget is not reachable from any page ("unplaced").
+   */
+  pageObjectNumber: PageObjectNumber;
+}
+//#endregion
+//#region src/forms/value-entry.d.ts
+/** Lossless shape of a field's effective PDF `/V` or `/DV` object. */
+type FormValueEntry = {
+  kind: 'none';
+} | {
+  kind: 'scalar';
+  value: string;
+} | {
+  kind: 'array';
+  values: string[];
+} | {
+  kind: 'unsupported';
+};
+//#endregion
+//#region src/forms/field.d.ts
+/**
+ * The field family — the discriminant of {@link FormFieldDTO}. Narrowing on
+ * it reveals exactly the members that are meaningful for that family, the
+ * same way annotation DTOs narrow on `subtype`.
+ */
+type FormFieldFamily = 'text' | 'checkbox' | 'radio' | 'combobox' | 'listbox' | 'pushbutton' | 'signature' | 'unknown';
+/**
+ * Where the field was found.
+ *
+ * - `acroform` — reachable from the /AcroForm /Fields tree, as the spec
+ *   requires.
+ * - `recovered` — only reachable through a page's /Annots array (a common
+ *   producer bug). The engine reconciles these on every read so they work
+ *   like any other field, but other PDF processors will not see them until
+ *   {@link DocumentFormsService.repair} makes the fix durable.
+ */
+type FormFieldOrigin = 'acroform' | 'recovered';
+/**
+ * The /Ff flags every field family shares. Family-specific flags (comb,
+ * multi-select, radios-in-unison, ...) live as plain booleans on the
+ * family DTOs where they are always meaningful.
+ */
+interface FormFieldFlags {
+  /**
+   * The user must not change the value. The engine's write transactions
+   * still accept programmatic writes to read-only fields (calculated
+   * fields are read-only yet script-written); enforcing fill policy is
+   * the application's job.
+   */
+  readOnly: boolean;
+  required: boolean;
+  noExport: boolean;
+  /** The raw /Ff integer, for anything not surfaced. */
+  raw: number;
+}
+/**
+ * A widget of a toggle (checkbox/radio) field. Toggle widgets always carry
+ * their appearance-state machinery — no nullable fields to probe.
+ */
+interface ToggleFieldWidget extends FormWidgetRef {
+  /**
+   * The widget's appearance state name (the non-"Off" key of its /AP /N
+   * dictionary) — the token toggle writes address widgets by.
+   */
+  onState: string;
+  /**
+   * The widget's export value (/Opt entry when present, else the
+   * on-state). The identity FDF/XFDF carry.
+   */
+  exportValue: string;
+  /** Whether this widget is currently checked. */
+  checked: boolean;
+}
+/** One option of a choice (combo/list box) field. */
+interface FormFieldOption {
+  /** Display label shown to the user. */
+  label: string;
+  /** Export value used by /V, interchange, and `FormFieldValue.choice`. */
+  value: string;
+  /** Whether the option is currently selected. */
+  selected: boolean;
+}
+/**
+ * The trunk every field family shares: identity, provenance, universal
+ * flags, and widget placement. A logical field is the document-scoped
+ * record that holds the value; its widgets are page-scoped views — join
+ * them to the annotation subsystem via `annotObjectNumber`.
+ */
+interface FormFieldBase {
+  /** Durable ref (`objectNumber` whenever the field dictionary is indirect). */
+  ref: FormFieldRef;
+  /** Field dictionary object number; `0` for direct (spec-violating) dicts. */
+  fieldObjectNumber: number;
+  /** Fully qualified name, e.g. `"billing.name"`. */
+  name: string;
+  family: FormFieldFamily;
+  origin: FormFieldOrigin;
+  flags: FormFieldFlags;
+  /** /TU — the accessible tooltip / alternate name. */
+  alternateName: string | null;
+  /** /TM — the export mapping name. */
+  mappingName: string | null;
+  /** Exact effective `/V` object shape; family conveniences below are derived. */
+  valueEntry: FormValueEntry;
+  /** Exact effective `/DV` object shape, including absent and malformed values. */
+  defaultValueEntry: FormValueEntry;
+  /** Effective inherited field `/AA` actions. */
+  actions?: PdfFieldActions;
+  /** The field's widget annotations, in control order. May be empty ("unplaced"). */
+  widgets: FormWidgetRef[];
+}
+/** A text field. Write with `{ type: 'text', value }`. */
+interface TextFieldDTO extends FormFieldBase {
+  family: 'text';
+  value: string;
+  /** /DV — restored by `reset()`. */
+  defaultValue: string;
+  /** /MaxLen; `null` when unlimited. Longer writes are truncated to this length. */
+  maxLength: number | null;
+  multiline: boolean;
+  password: boolean;
+  /** Fixed character cells; meaningful with `maxLength`. */
+  comb: boolean;
+}
+/** A checkbox. Write with `{ type: 'toggle', state: onState | null }`. */
+interface CheckboxFieldDTO extends FormFieldBase {
+  family: 'checkbox';
+  checked: boolean;
+  /** The export value reported while checked ("Off" is never exported). */
+  exportValue: string;
+  widgets: ToggleFieldWidget[];
+}
+/** A radio group: ONE field, N widgets. Write with `{ type: 'toggle', state }`. */
+interface RadioFieldDTO extends FormFieldBase {
+  family: 'radio';
+  /** The checked widget's export value, or `"Off"` when the group is clear. */
+  value: string;
+  /** Widgets sharing an export value check together. */
+  radiosInUnison: boolean;
+  /** The group cannot be cleared once a choice is made. */
+  noToggleToOff: boolean;
+  widgets: ToggleFieldWidget[];
+}
+/** A combo box (dropdown). Write with `{ type: 'choice', values: [v] }`. */
+interface ComboBoxFieldDTO extends FormFieldBase {
+  family: 'combobox';
+  /** An option export value — or free text when `edit` is set. */
+  value: string;
+  /** /DV — restored by `reset()`. */
+  defaultValue: string;
+  /** Free text is allowed in addition to the options. */
+  edit: boolean;
+  options: FormFieldOption[];
+}
+/** A list box. Write with `{ type: 'choice', values }`. */
+interface ListBoxFieldDTO extends FormFieldBase {
+  family: 'listbox';
+  /** Selected option export values, in option order. */
+  selectedValues: string[];
+  /** Whether several options may be selected at once. */
+  multiSelect: boolean;
+  options: FormFieldOption[];
+}
+/** A push button: pure trigger, holds no value. Never written or exported. */
+interface PushButtonFieldDTO extends FormFieldBase {
+  family: 'pushbutton';
+}
+/**
+ * A signature field. Identity and placement only for now — the engine
+ * never writes signature values; signing is a future capability.
+ */
+interface SignatureFieldDTO extends FormFieldBase {
+  family: 'signature';
+}
+/**
+ * Forward-compat placeholder for field types the engine does not model,
+ * mirroring the `unsupported` annotation kind. Round-trips safely.
+ */
+interface UnknownFieldDTO extends FormFieldBase {
+  family: 'unknown';
+  /** The raw /V value as text, for diagnostics. */
+  rawValue: string;
+}
+/**
+ * A logical form field. Discriminated on `family`:
+ *
+ * ```ts
+ * if (field.family === 'listbox') {
+ *   field.selectedValues; // string[]
+ * }
+ * ```
+ */
+type FormFieldDTO = TextFieldDTO | CheckboxFieldDTO | RadioFieldDTO | ComboBoxFieldDTO | ListBoxFieldDTO | PushButtonFieldDTO | SignatureFieldDTO | UnknownFieldDTO;
+//#endregion
+//#region src/forms/snapshot.d.ts
+/**
+ * What kind of interactive form the document declares.
+ *
+ * - `none` — no /AcroForm dictionary. Recovered fields may still exist
+ *   (see {@link FormFieldOrigin}); `repair()` can bootstrap the dictionary.
+ * - `acroform` — a standard AcroForm.
+ * - `xfa` — the /AcroForm carries an /XFA entry. The engine serves the
+ *   AcroForm shell read-only and never executes XFA.
+ */
+type FormKind = 'none' | 'acroform' | 'xfa';
+/**
+ * The document's complete form state at one instant: the reconciled field
+ * tree flattened to terminal fields with fully qualified names.
+ *
+ * Snapshots are detached and immutable — any mutation (a value write, an
+ * annotation edit, a page operation) makes previously returned snapshots
+ * stale. Re-read after mutating; the engine caches the underlying model
+ * per document version, so repeated reads between mutations are cheap.
+ */
+interface FormSnapshot {
+  formKind: FormKind;
+  /**
+   * Whether the /AcroForm sets /NeedAppearances (viewer-generated widget
+   * appearances). The engine bakes appearances on every write regardless;
+   * `repair({ bakeAppearances: true })` can clear the flag document-wide.
+   */
+  needsAppearances: boolean;
+  fields: FormFieldDTO[];
+  /** `/AcroForm /CO` order; null preserves each malformed/unresolved slot. */
+  calculationOrder: Array<FormFieldRef | null>;
+}
+//#endregion
+//#region src/search/types.d.ts
+/**
+ * What to search for — THE one shape, engine → wire → plugin state →
+ * search box. One flat object; the flags define behavior per mode instead
+ * of the mode changing the shape:
+ *
+ * | flag              | literal          | regex                          |
+ * |-------------------|------------------|--------------------------------|
+ * | `matchCase`       | fold case        | `i` flag                       |
+ * | `wholeWord`       | boundary check   | pattern is `\b(?:…)\b`-wrapped |
+ * | `matchDiacritics` | mark fold        | REJECTED (`InvalidArg`)        |
+ *
+ * Literal queries match over FOLDED text; regex queries run the portable
+ * dialect against the RAW page text — which is why `matchDiacritics`
+ * cannot apply to them (diacritic folding is a property of the folded
+ * text plane). Validate with `validateSearchQuery` for early UI feedback;
+ * engines re-validate and reject with `EngineErrorCode.InvalidArg`.
+ */
+interface SearchQuery {
+  /**
+   * The literal text — or, when `regex`, a pattern in the portable
+   * search-regex dialect: JavaScript `u`-mode syntax MINUS backreferences
+   * and lookaround, so every valid pattern also runs on RE2 (the
+   * server-side engine).
+   */
+  text: string;
+  /** Interpret `text` as a regex pattern. Default false (literal). */
+  regex?: boolean;
+  /** Exact-case matching. Default false (case-folded / `i` semantics). */
+  matchCase?: boolean;
+  /** Only match at word boundaries (letters/digits end the word). */
+  wholeWord?: boolean;
+  /**
+   * Treat diacritics as significant ("café" ≠ "cafe"). Default false —
+   * marks are stripped on both sides, which is what viewers ship.
+   * LITERAL ONLY: combined with `regex` the query is rejected.
+   */
+  matchDiacritics?: boolean;
+}
+//#endregion
+export { SearchQuery as n, FormSnapshot as t };
+//# sourceMappingURL=AnnotationListSnapshot-DDxHpJQU-BG32YXxG.d.cts.map

package/dist/AnnotationListSnapshot-DDxHpJQU-BG32YXxG.d.ts

@@ -0,0 +1,347 @@
+//#region ../../engine/core/dist/AnnotationListSnapshot-DDxHpJQU.d.ts
+//#endregion
+//#region src/dto/PdfAction.d.ts
+/** Normalized values of an action dictionary's `/S` name. */
+type PdfActionType = 'unknown' | 'goto' | 'goto-remote' | 'goto-embedded' | 'launch' | 'thread' | 'uri' | 'sound' | 'movie' | 'hide' | 'named' | 'submit-form' | 'reset-form' | 'import-data' | 'javascript' | 'set-ocg-state' | 'rendition' | 'transition' | 'goto-3d-view';
+/** One detached node in a normalized PDF action tree. */
+interface PdfActionNode {
+  type: PdfActionType;
+  /** Raw `/S` name, retained for unknown and future action types. */
+  subtype: string;
+  /** Decoded `/JS` source for JavaScript and Rendition actions. */
+  script?: string;
+  /** Normalized `/Next` children in PDF order. */
+  next: PdfActionNode[];
+}
+type PdfActionWarning = 'cycle-dropped' | 'malformed-next' | 'incomplete';
+/**
+ * One extracted action root plus the native reader's safety verdict.
+ * Consumers must never execute a tree whose `incomplete` flag is true.
+ */
+interface PdfActionTree {
+  /** Null when the model was valid but its root exceeded a safety bound. */
+  root: PdfActionNode | null;
+  incomplete: boolean;
+  /** Raw native bits, retained so newer warnings survive older SDKs. */
+  warningFlags: number;
+  warnings: PdfActionWarning[];
+}
+interface PdfFieldActions {
+  keystroke?: PdfActionTree;
+  format?: PdfActionTree;
+  validate?: PdfActionTree;
+  calculate?: PdfActionTree;
+}
+//#endregion
+//#region src/identity/PageObjectNumber.d.ts
+/**
+ * PDF indirect object number for a page.
+ *
+ * Resolved via the PDFium runtime helper `EPDFPage_GetObjectNumber(pagePtr)`.
+ * Always > 0 for well-formed PDFs. This replaces the v2 page index as the
+ * primary addressing key. The page index is kept on `PageHandle` as display
+ * metadata only, because it can shift when pages are inserted, deleted, or
+ * reordered while a session is open.
+ */
+type PageObjectNumber = number;
+//#endregion
+//#region src/identity/FormFieldRef.d.ts
+/**
+ * How callers address a logical form field.
+ *
+ * - `objectNumber` — the indirect object number of the field dictionary.
+ *   ISO 32000 guarantees every real AcroForm field dictionary is an
+ *   indirect object, and the layer runtime never renumbers (frozen base +
+ *   incremental deltas), so this is the durable identity for the lifetime
+ *   of a document. Preferred for all engine calls.
+ * - `fqn` — the fully qualified field name ("billing.name"). The portable,
+ *   semantic identity used by interchange formats (FDF/XFDF) and analytics;
+ *   survives document rewrites but is only as unique as the producer made
+ *   it. The engine resolves it against the reconciled field tree.
+ */
+type FormFieldRef = {
+  kind: 'objectNumber';
+  fieldObjectNumber: number;
+} | {
+  kind: 'fqn';
+  name: string;
+};
+/** A widget annotation of a field, as the forms subsystem sees it. */
+interface FormWidgetRef {
+  /**
+   * Indirect object number of the widget annotation — the join key to the
+   * annotation subsystem's `objectNumber` refs. `0` when the widget is
+   * stored as a direct object (spec-violating; cannot be addressed).
+   */
+  annotObjectNumber: number;
+  /**
+   * Object number of the page whose /Annots array references the widget.
+   * `0` when the widget is not reachable from any page ("unplaced").
+   */
+  pageObjectNumber: PageObjectNumber;
+}
+//#endregion
+//#region src/forms/value-entry.d.ts
+/** Lossless shape of a field's effective PDF `/V` or `/DV` object. */
+type FormValueEntry = {
+  kind: 'none';
+} | {
+  kind: 'scalar';
+  value: string;
+} | {
+  kind: 'array';
+  values: string[];
+} | {
+  kind: 'unsupported';
+};
+//#endregion
+//#region src/forms/field.d.ts
+/**
+ * The field family — the discriminant of {@link FormFieldDTO}. Narrowing on
+ * it reveals exactly the members that are meaningful for that family, the
+ * same way annotation DTOs narrow on `subtype`.
+ */
+type FormFieldFamily = 'text' | 'checkbox' | 'radio' | 'combobox' | 'listbox' | 'pushbutton' | 'signature' | 'unknown';
+/**
+ * Where the field was found.
+ *
+ * - `acroform` — reachable from the /AcroForm /Fields tree, as the spec
+ *   requires.
+ * - `recovered` — only reachable through a page's /Annots array (a common
+ *   producer bug). The engine reconciles these on every read so they work
+ *   like any other field, but other PDF processors will not see them until
+ *   {@link DocumentFormsService.repair} makes the fix durable.
+ */
+type FormFieldOrigin = 'acroform' | 'recovered';
+/**
+ * The /Ff flags every field family shares. Family-specific flags (comb,
+ * multi-select, radios-in-unison, ...) live as plain booleans on the
+ * family DTOs where they are always meaningful.
+ */
+interface FormFieldFlags {
+  /**
+   * The user must not change the value. The engine's write transactions
+   * still accept programmatic writes to read-only fields (calculated
+   * fields are read-only yet script-written); enforcing fill policy is
+   * the application's job.
+   */
+  readOnly: boolean;
+  required: boolean;
+  noExport: boolean;
+  /** The raw /Ff integer, for anything not surfaced. */
+  raw: number;
+}
+/**
+ * A widget of a toggle (checkbox/radio) field. Toggle widgets always carry
+ * their appearance-state machinery — no nullable fields to probe.
+ */
+interface ToggleFieldWidget extends FormWidgetRef {
+  /**
+   * The widget's appearance state name (the non-"Off" key of its /AP /N
+   * dictionary) — the token toggle writes address widgets by.
+   */
+  onState: string;
+  /**
+   * The widget's export value (/Opt entry when present, else the
+   * on-state). The identity FDF/XFDF carry.
+   */
+  exportValue: string;
+  /** Whether this widget is currently checked. */
+  checked: boolean;
+}
+/** One option of a choice (combo/list box) field. */
+interface FormFieldOption {
+  /** Display label shown to the user. */
+  label: string;
+  /** Export value used by /V, interchange, and `FormFieldValue.choice`. */
+  value: string;
+  /** Whether the option is currently selected. */
+  selected: boolean;
+}
+/**
+ * The trunk every field family shares: identity, provenance, universal
+ * flags, and widget placement. A logical field is the document-scoped
+ * record that holds the value; its widgets are page-scoped views — join
+ * them to the annotation subsystem via `annotObjectNumber`.
+ */
+interface FormFieldBase {
+  /** Durable ref (`objectNumber` whenever the field dictionary is indirect). */
+  ref: FormFieldRef;
+  /** Field dictionary object number; `0` for direct (spec-violating) dicts. */
+  fieldObjectNumber: number;
+  /** Fully qualified name, e.g. `"billing.name"`. */
+  name: string;
+  family: FormFieldFamily;
+  origin: FormFieldOrigin;
+  flags: FormFieldFlags;
+  /** /TU — the accessible tooltip / alternate name. */
+  alternateName: string | null;
+  /** /TM — the export mapping name. */
+  mappingName: string | null;
+  /** Exact effective `/V` object shape; family conveniences below are derived. */
+  valueEntry: FormValueEntry;
+  /** Exact effective `/DV` object shape, including absent and malformed values. */
+  defaultValueEntry: FormValueEntry;
+  /** Effective inherited field `/AA` actions. */
+  actions?: PdfFieldActions;
+  /** The field's widget annotations, in control order. May be empty ("unplaced"). */
+  widgets: FormWidgetRef[];
+}
+/** A text field. Write with `{ type: 'text', value }`. */
+interface TextFieldDTO extends FormFieldBase {
+  family: 'text';
+  value: string;
+  /** /DV — restored by `reset()`. */
+  defaultValue: string;
+  /** /MaxLen; `null` when unlimited. Longer writes are truncated to this length. */
+  maxLength: number | null;
+  multiline: boolean;
+  password: boolean;
+  /** Fixed character cells; meaningful with `maxLength`. */
+  comb: boolean;
+}
+/** A checkbox. Write with `{ type: 'toggle', state: onState | null }`. */
+interface CheckboxFieldDTO extends FormFieldBase {
+  family: 'checkbox';
+  checked: boolean;
+  /** The export value reported while checked ("Off" is never exported). */
+  exportValue: string;
+  widgets: ToggleFieldWidget[];
+}
+/** A radio group: ONE field, N widgets. Write with `{ type: 'toggle', state }`. */
+interface RadioFieldDTO extends FormFieldBase {
+  family: 'radio';
+  /** The checked widget's export value, or `"Off"` when the group is clear. */
+  value: string;
+  /** Widgets sharing an export value check together. */
+  radiosInUnison: boolean;
+  /** The group cannot be cleared once a choice is made. */
+  noToggleToOff: boolean;
+  widgets: ToggleFieldWidget[];
+}
+/** A combo box (dropdown). Write with `{ type: 'choice', values: [v] }`. */
+interface ComboBoxFieldDTO extends FormFieldBase {
+  family: 'combobox';
+  /** An option export value — or free text when `edit` is set. */
+  value: string;
+  /** /DV — restored by `reset()`. */
+  defaultValue: string;
+  /** Free text is allowed in addition to the options. */
+  edit: boolean;
+  options: FormFieldOption[];
+}
+/** A list box. Write with `{ type: 'choice', values }`. */
+interface ListBoxFieldDTO extends FormFieldBase {
+  family: 'listbox';
+  /** Selected option export values, in option order. */
+  selectedValues: string[];
+  /** Whether several options may be selected at once. */
+  multiSelect: boolean;
+  options: FormFieldOption[];
+}
+/** A push button: pure trigger, holds no value. Never written or exported. */
+interface PushButtonFieldDTO extends FormFieldBase {
+  family: 'pushbutton';
+}
+/**
+ * A signature field. Identity and placement only for now — the engine
+ * never writes signature values; signing is a future capability.
+ */
+interface SignatureFieldDTO extends FormFieldBase {
+  family: 'signature';
+}
+/**
+ * Forward-compat placeholder for field types the engine does not model,
+ * mirroring the `unsupported` annotation kind. Round-trips safely.
+ */
+interface UnknownFieldDTO extends FormFieldBase {
+  family: 'unknown';
+  /** The raw /V value as text, for diagnostics. */
+  rawValue: string;
+}
+/**
+ * A logical form field. Discriminated on `family`:
+ *
+ * ```ts
+ * if (field.family === 'listbox') {
+ *   field.selectedValues; // string[]
+ * }
+ * ```
+ */
+type FormFieldDTO = TextFieldDTO | CheckboxFieldDTO | RadioFieldDTO | ComboBoxFieldDTO | ListBoxFieldDTO | PushButtonFieldDTO | SignatureFieldDTO | UnknownFieldDTO;
+//#endregion
+//#region src/forms/snapshot.d.ts
+/**
+ * What kind of interactive form the document declares.
+ *
+ * - `none` — no /AcroForm dictionary. Recovered fields may still exist
+ *   (see {@link FormFieldOrigin}); `repair()` can bootstrap the dictionary.
+ * - `acroform` — a standard AcroForm.
+ * - `xfa` — the /AcroForm carries an /XFA entry. The engine serves the
+ *   AcroForm shell read-only and never executes XFA.
+ */
+type FormKind = 'none' | 'acroform' | 'xfa';
+/**
+ * The document's complete form state at one instant: the reconciled field
+ * tree flattened to terminal fields with fully qualified names.
+ *
+ * Snapshots are detached and immutable — any mutation (a value write, an
+ * annotation edit, a page operation) makes previously returned snapshots
+ * stale. Re-read after mutating; the engine caches the underlying model
+ * per document version, so repeated reads between mutations are cheap.
+ */
+interface FormSnapshot {
+  formKind: FormKind;
+  /**
+   * Whether the /AcroForm sets /NeedAppearances (viewer-generated widget
+   * appearances). The engine bakes appearances on every write regardless;
+   * `repair({ bakeAppearances: true })` can clear the flag document-wide.
+   */
+  needsAppearances: boolean;
+  fields: FormFieldDTO[];
+  /** `/AcroForm /CO` order; null preserves each malformed/unresolved slot. */
+  calculationOrder: Array<FormFieldRef | null>;
+}
+//#endregion
+//#region src/search/types.d.ts
+/**
+ * What to search for — THE one shape, engine → wire → plugin state →
+ * search box. One flat object; the flags define behavior per mode instead
+ * of the mode changing the shape:
+ *
+ * | flag              | literal          | regex                          |
+ * |-------------------|------------------|--------------------------------|
+ * | `matchCase`       | fold case        | `i` flag                       |
+ * | `wholeWord`       | boundary check   | pattern is `\b(?:…)\b`-wrapped |
+ * | `matchDiacritics` | mark fold        | REJECTED (`InvalidArg`)        |
+ *
+ * Literal queries match over FOLDED text; regex queries run the portable
+ * dialect against the RAW page text — which is why `matchDiacritics`
+ * cannot apply to them (diacritic folding is a property of the folded
+ * text plane). Validate with `validateSearchQuery` for early UI feedback;
+ * engines re-validate and reject with `EngineErrorCode.InvalidArg`.
+ */
+interface SearchQuery {
+  /**
+   * The literal text — or, when `regex`, a pattern in the portable
+   * search-regex dialect: JavaScript `u`-mode syntax MINUS backreferences
+   * and lookaround, so every valid pattern also runs on RE2 (the
+   * server-side engine).
+   */
+  text: string;
+  /** Interpret `text` as a regex pattern. Default false (literal). */
+  regex?: boolean;
+  /** Exact-case matching. Default false (case-folded / `i` semantics). */
+  matchCase?: boolean;
+  /** Only match at word boundaries (letters/digits end the word). */
+  wholeWord?: boolean;
+  /**
+   * Treat diacritics as significant ("café" ≠ "cafe"). Default false —
+   * marks are stripped on both sides, which is what viewers ship.
+   * LITERAL ONLY: combined with `regex` the query is rejected.
+   */
+  matchDiacritics?: boolean;
+}
+//#endregion
+export { SearchQuery as n, FormSnapshot as t };
+//# sourceMappingURL=AnnotationListSnapshot-DDxHpJQU-BG32YXxG.d.ts.map