@embedpdf/plugin-form 3.0.0-next.14 → 3.0.0-next.16

package/dist/index.d.cts

@@ -1,24 +1,53 @@
-import { _ as FillItem, a as FormHostCapability, b as WidgetHit, d as PlacedField, f as WidgetActivationResult, g as FormToolDef, h as FORM_TOOL_BY_ID, i as FormCommitStatus, l as FormUiEffect, m as FORM_TOOLS, n as FormCapability, o as FormPluginOptions, p as AuthorableFormFamily, r as FormCommitResult, s as FormState, t as FormAction, u as PlaceFieldInput, v as Box, x as fieldKeyOf, y as FieldKey } from "./types-Bpc32Qmx.cjs";
-import { FormFieldDTO, FormFieldPatch, FormFieldRef, FormToken, WidgetAppearance } from "./contract.cjs";
+import { A as FormRepairResult, B as FormValidationRejectedEvent, C as FormImportDrop, D as FormKind, E as FormImportResult, F as FormSettings, G as WidgetAnnotation, H as FormWidgetAddResult, I as FormSnapshot, J as FormWidgetItem, K as toFieldRef, L as FormTransfer, M as FormResyncedEvent, N as FormSetValueResult, O as FormPlainValue, P as FormSetValueStatus, Q as WidgetHit, R as FormUiEffect, S as FormFilter, T as FormImportOptions, U as WidgetActivationResult, V as FormValueChangedEvent, W as WidgetAddress, X as FormWidgetLook, Y as Box, _ as FormFieldResult, a as FormCommitResult, b as FormFieldUpdatedEvent, c as FormExportSelection, d as FormFieldDeletedEvent, f as FormFieldDraft, g as FormFieldRef, h as FormFieldPatch, i as FormCapability, j as FormResetResult, k as FormRepairOptions, l as FormFieldCreatedEvent, m as FormFieldFlagSetting, n as FillableFields, o as FormCommitStatus, p as FormFieldFamily, q as FormToken, r as FormBundle, s as FormConfig, t as FORM_DEFAULTS, u as FormFieldDTO, v as FormFieldSetting, w as FormImportDropReason, x as FormFieldValue, y as FormFieldSettings, z as FormValidation } from "./contract-D-yQxw3H.cjs";
+import { t as FormHostCapability } from "./host-contract-1epLfK1S.cjs";
 import { FormScriptingController, createFormScriptingController } from "./scripting.cjs";
-import { createSerialQueue } from "@embedpdf/core";
+import { FormFieldDTO as FormFieldDTO$1, FormFieldFamily as FormFieldFamily$1, WidgetAppearance } from "@embedpdf/engine-core/runtime";
+import { ClickCreate } from "@embedpdf/plugin-annotation/contract";
 //#region src/form.plugin.d.ts
 /**
- * The form plugin: the FIELD plane. Document-scoped; requires the
- * interaction hub. Fill mode works with no annotation plugin at all —
- * geometry is read from the engine's widget DTOs. When the annotation
- * plugin IS present, a Behavior keeps widgets geometry-inert while the
- * active tool carries 'form-fill' (the built-in pointer/pan tools do, so
- * filling is the resting state) and stands the fill controls down under
- * every other tool — the single-active-tool hub IS the mode switch.
- * Design mode = the 'form-edit' / palette tools: no 'form-fill' tag, so
- * widgets become ordinary editable annotations.
+ * The form plugin: the field plane. Document-scoped; requires the
+ * interaction hub. Filling works without the annotation plugin, because
+ * widget geometry is read from the engine's widget records. The active tool
+ * is the mode switch: while it carries 'form-fill' (the built-in pointer and
+ * pan tools do, so filling is the resting state), the form layer draws and
+ * fills every widget. Design mode is the 'form-edit' and palette tools: with
+ * the annotation plugin present, the form lends it the widgets, which its
+ * tools then select, move, restyle and delete. The render plugin draws the
+ * widgets' pictures in both modes. `config` is the settings the app
+ * registers, over {@link FORM_DEFAULTS}.
  */
-declare const formPlugin: (options?: FormPluginOptions) => import("@embedpdf/core").PluginDef<FormState, FormAction, FormHostCapability>;
+declare const formPlugin: (config?: FormConfig) => import("@embedpdf/core").PluginDef<Readonly<Record<string, never>>, FormHostCapability, FormSettings>;
 //#endregion
-//#region src/mutationQueue.d.ts
-/** The core serial queue under its historical form-plugin name. */
-declare const createSerialMutationQueue: typeof createSerialQueue;
+//#region src/state.d.ts
+declare const formState: import("@embedpdf/core").StateDeclaration<FormCapability, {
+  fields: readonly FormFieldDTO$1[];
+  status: import("@embedpdf/core").ResourceStatus;
+  formKind: import("@embedpdf/engine-core/runtime").FormKind;
+  selectedField: FormFieldDTO$1 | null;
+}>;
 //#endregion
-export { type AuthorableFormFamily, type Box, FORM_TOOLS, FORM_TOOL_BY_ID, type FieldKey, type FillItem, type FormAction, type FormCapability, type FormCommitResult, type FormCommitStatus, type FormFieldDTO, type FormFieldPatch, type FormFieldRef, type FormPluginOptions, FormScriptingController, type FormState, FormToken, type FormToolDef, type FormUiEffect, type PlaceFieldInput, type PlacedField, type WidgetActivationResult, type WidgetAppearance, type WidgetHit, createFormScriptingController, createSerialMutationQueue, fieldKeyOf, formPlugin };
+//#region src/tools/definitions.d.ts
+/** The families the palette places. */
+type AuthorableFormFamily = Exclude<FormFieldFamily$1, 'unknown'>;
+interface FormToolDef {
+  id: string;
+  /** The field family the tool places (the form plane's vocabulary). */
+  family: AuthorableFormFamily;
+  /** The client kind the annotation registry routes on (props panel).
+   *  Not a PDF subtype — every widget is PDF `widget`; this is the view. */
+  visualKind: 'widget-text' | 'widget-choice' | 'widget-button' | 'widget-toggle' | 'widget-radio' | 'widget-box';
+  /** What a bare click places (box policies only — fields are boxes). */
+  clickCreate: Extract<ClickCreate, {
+    width: number;
+  }>;
+  /** Seed drawing defaults, the widget's appearance fields: a placed field is
+   *  visible (white box, gray border) and restylable per tool through the
+   *  shared style panel. */
+  defaults: WidgetAppearance;
+  cursor: string;
+}
+declare const FORM_TOOLS: readonly FormToolDef[];
+declare const FORM_TOOL_BY_ID: ReadonlyMap<string, FormToolDef>;
+//#endregion
+export { type AuthorableFormFamily, type Box, FORM_DEFAULTS, FORM_TOOLS, FORM_TOOL_BY_ID, FillableFields, type FormBundle, FormCapability, FormCommitResult, FormCommitStatus, FormConfig, FormExportSelection, FormFieldCreatedEvent, type FormFieldDTO, FormFieldDeletedEvent, type FormFieldDraft, type FormFieldFamily, FormFieldFlagSetting, type FormFieldPatch, type FormFieldRef, FormFieldResult, FormFieldSetting, FormFieldSettings, FormFieldUpdatedEvent, type FormFieldValue, FormFilter, type FormImportDrop, type FormImportDropReason, type FormImportOptions, FormImportResult, type FormKind, FormPlainValue, type FormRepairOptions, type FormRepairResult, FormResetResult, FormResyncedEvent, FormScriptingController, FormSetValueResult, FormSetValueStatus, FormSettings, type FormSnapshot, FormToken, type FormToolDef, FormTransfer, FormUiEffect, FormValidation, FormValidationRejectedEvent, FormValueChangedEvent, FormWidgetAddResult, type FormWidgetItem, type FormWidgetLook, WidgetActivationResult, WidgetAddress, type WidgetAnnotation, type WidgetHit, createFormScriptingController, formPlugin, formState, toFieldRef };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,24 +1,53 @@
-import { _ as FillItem, a as FormHostCapability, b as WidgetHit, d as PlacedField, f as WidgetActivationResult, g as FormToolDef, h as FORM_TOOL_BY_ID, i as FormCommitStatus, l as FormUiEffect, m as FORM_TOOLS, n as FormCapability, o as FormPluginOptions, p as AuthorableFormFamily, r as FormCommitResult, s as FormState, t as FormAction, u as PlaceFieldInput, v as Box, x as fieldKeyOf, y as FieldKey } from "./types-DRirhZKr.js";
-import { FormFieldDTO, FormFieldPatch, FormFieldRef, FormToken, WidgetAppearance } from "./contract.js";
+import { A as FormRepairResult, B as FormValidationRejectedEvent, C as FormImportDrop, D as FormKind, E as FormImportResult, F as FormSettings, G as WidgetAnnotation, H as FormWidgetAddResult, I as FormSnapshot, J as FormWidgetItem, K as toFieldRef, L as FormTransfer, M as FormResyncedEvent, N as FormSetValueResult, O as FormPlainValue, P as FormSetValueStatus, Q as WidgetHit, R as FormUiEffect, S as FormFilter, T as FormImportOptions, U as WidgetActivationResult, V as FormValueChangedEvent, W as WidgetAddress, X as FormWidgetLook, Y as Box, _ as FormFieldResult, a as FormCommitResult, b as FormFieldUpdatedEvent, c as FormExportSelection, d as FormFieldDeletedEvent, f as FormFieldDraft, g as FormFieldRef, h as FormFieldPatch, i as FormCapability, j as FormResetResult, k as FormRepairOptions, l as FormFieldCreatedEvent, m as FormFieldFlagSetting, n as FillableFields, o as FormCommitStatus, p as FormFieldFamily, q as FormToken, r as FormBundle, s as FormConfig, t as FORM_DEFAULTS, u as FormFieldDTO, v as FormFieldSetting, w as FormImportDropReason, x as FormFieldValue, y as FormFieldSettings, z as FormValidation } from "./contract-BwcgtCOD.js";
+import { t as FormHostCapability } from "./host-contract-BRYUbpT_.js";
 import { FormScriptingController, createFormScriptingController } from "./scripting.js";
-import { createSerialQueue } from "@embedpdf/core";
+import { ClickCreate } from "@embedpdf/plugin-annotation/contract";
+import { FormFieldDTO as FormFieldDTO$1, FormFieldFamily as FormFieldFamily$1, WidgetAppearance } from "@embedpdf/engine-core/runtime";
 //#region src/form.plugin.d.ts
 /**
- * The form plugin: the FIELD plane. Document-scoped; requires the
- * interaction hub. Fill mode works with no annotation plugin at all —
- * geometry is read from the engine's widget DTOs. When the annotation
- * plugin IS present, a Behavior keeps widgets geometry-inert while the
- * active tool carries 'form-fill' (the built-in pointer/pan tools do, so
- * filling is the resting state) and stands the fill controls down under
- * every other tool — the single-active-tool hub IS the mode switch.
- * Design mode = the 'form-edit' / palette tools: no 'form-fill' tag, so
- * widgets become ordinary editable annotations.
+ * The form plugin: the field plane. Document-scoped; requires the
+ * interaction hub. Filling works without the annotation plugin, because
+ * widget geometry is read from the engine's widget records. The active tool
+ * is the mode switch: while it carries 'form-fill' (the built-in pointer and
+ * pan tools do, so filling is the resting state), the form layer draws and
+ * fills every widget. Design mode is the 'form-edit' and palette tools: with
+ * the annotation plugin present, the form lends it the widgets, which its
+ * tools then select, move, restyle and delete. The render plugin draws the
+ * widgets' pictures in both modes. `config` is the settings the app
+ * registers, over {@link FORM_DEFAULTS}.
  */
-declare const formPlugin: (options?: FormPluginOptions) => import("@embedpdf/core").PluginDef<FormState, FormAction, FormHostCapability>;
+declare const formPlugin: (config?: FormConfig) => import("@embedpdf/core").PluginDef<Readonly<Record<string, never>>, FormHostCapability, FormSettings>;
 //#endregion
-//#region src/mutationQueue.d.ts
-/** The core serial queue under its historical form-plugin name. */
-declare const createSerialMutationQueue: typeof createSerialQueue;
+//#region src/state.d.ts
+declare const formState: import("@embedpdf/core").StateDeclaration<FormCapability, {
+  fields: readonly FormFieldDTO$1[];
+  status: import("@embedpdf/core").ResourceStatus;
+  formKind: import("@embedpdf/engine-core/runtime").FormKind;
+  selectedField: FormFieldDTO$1 | null;
+}>;
 //#endregion
-export { type AuthorableFormFamily, type Box, FORM_TOOLS, FORM_TOOL_BY_ID, type FieldKey, type FillItem, type FormAction, type FormCapability, type FormCommitResult, type FormCommitStatus, type FormFieldDTO, type FormFieldPatch, type FormFieldRef, type FormPluginOptions, FormScriptingController, type FormState, FormToken, type FormToolDef, type FormUiEffect, type PlaceFieldInput, type PlacedField, type WidgetActivationResult, type WidgetAppearance, type WidgetHit, createFormScriptingController, createSerialMutationQueue, fieldKeyOf, formPlugin };
+//#region src/tools/definitions.d.ts
+/** The families the palette places. */
+type AuthorableFormFamily = Exclude<FormFieldFamily$1, 'unknown'>;
+interface FormToolDef {
+  id: string;
+  /** The field family the tool places (the form plane's vocabulary). */
+  family: AuthorableFormFamily;
+  /** The client kind the annotation registry routes on (props panel).
+   *  Not a PDF subtype — every widget is PDF `widget`; this is the view. */
+  visualKind: 'widget-text' | 'widget-choice' | 'widget-button' | 'widget-toggle' | 'widget-radio' | 'widget-box';
+  /** What a bare click places (box policies only — fields are boxes). */
+  clickCreate: Extract<ClickCreate, {
+    width: number;
+  }>;
+  /** Seed drawing defaults, the widget's appearance fields: a placed field is
+   *  visible (white box, gray border) and restylable per tool through the
+   *  shared style panel. */
+  defaults: WidgetAppearance;
+  cursor: string;
+}
+declare const FORM_TOOLS: readonly FormToolDef[];
+declare const FORM_TOOL_BY_ID: ReadonlyMap<string, FormToolDef>;
+//#endregion
+export { type AuthorableFormFamily, type Box, FORM_DEFAULTS, FORM_TOOLS, FORM_TOOL_BY_ID, FillableFields, type FormBundle, FormCapability, FormCommitResult, FormCommitStatus, FormConfig, FormExportSelection, FormFieldCreatedEvent, type FormFieldDTO, FormFieldDeletedEvent, type FormFieldDraft, type FormFieldFamily, FormFieldFlagSetting, type FormFieldPatch, type FormFieldRef, FormFieldResult, FormFieldSetting, FormFieldSettings, FormFieldUpdatedEvent, type FormFieldValue, FormFilter, type FormImportDrop, type FormImportDropReason, type FormImportOptions, FormImportResult, type FormKind, FormPlainValue, type FormRepairOptions, type FormRepairResult, FormResetResult, FormResyncedEvent, FormScriptingController, FormSetValueResult, FormSetValueStatus, FormSettings, type FormSnapshot, FormToken, type FormToolDef, FormTransfer, FormUiEffect, FormValidation, FormValidationRejectedEvent, FormValueChangedEvent, FormWidgetAddResult, type FormWidgetItem, type FormWidgetLook, WidgetActivationResult, WidgetAddress, type WidgetAnnotation, type WidgetHit, createFormScriptingController, formPlugin, formState, toFieldRef };
 //# sourceMappingURL=index.d.ts.map