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

package/dist/contract/host.cjs

@@ -1,3 +1,30 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_types = require("../types-C1uIIYfn.cjs");
-exports.FormToken = require_types.FormToken;
+const require_contract = require("../contract-CU0jrI_D.cjs");
+let _embedpdf_core = require("@embedpdf/core");
+let _embedpdf_engine_core_public = require("@embedpdf/engine-core/public");
+let _embedpdf_engine_core_runtime = require("@embedpdf/engine-core/runtime");
+//#region src/host-contract.ts
+/**
+* @embedpdf/plugin-form/contract/host: the host lens, for the framework
+* layers and the actions plugin: loading a page's widgets, the widget event
+* feed, the text being typed, and the actions plugin's executors and sinks.
+* Same runtime token as the public one, typed wider.
+*/
+const FormToken = (0, _embedpdf_core.createHostToken)(require_contract.FormToken);
+//#endregion
+exports.FORM_DEFAULTS = require_contract.FORM_DEFAULTS;
+exports.FormToken = FormToken;
+Object.defineProperty(exports, "FormTransfer", {
+	enumerable: true,
+	get: function() {
+		return _embedpdf_engine_core_public.FormTransfer;
+	}
+});
+Object.defineProperty(exports, "toFieldRef", {
+	enumerable: true,
+	get: function() {
+		return _embedpdf_engine_core_runtime.toFieldRef;
+	}
+});
+
+//# sourceMappingURL=host.cjs.map

package/dist/contract/host.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.cjs","names":["PublicFormToken"],"sources":["../../src/host-contract.ts"],"sourcesContent":["/**\n * @embedpdf/plugin-form/contract/host: the host lens, for the framework\n * layers and the actions plugin: loading a page's widgets, the widget event\n * feed, the text being typed, and the actions plugin's executors and sinks.\n * Same runtime token as the public one, typed wider.\n */\nimport { createHostToken } from '@embedpdf/core';\nimport type { TextEditorLayout } from '@embedpdf/core-form';\nimport type {\n  AnnotationRef,\n  FormEffect,\n  FormFieldRef,\n  PageRef,\n  PdfActionTargetRef,\n} from '@embedpdf/engine-core/runtime';\nimport type {\n  ActionContext,\n  ActionDiagnostic,\n  ActionOrigin,\n  ActionSubmitRequest,\n  PdfAnnotationEventKind,\n  SubmitIntent,\n} from '@embedpdf/plugin-actions/contract';\nimport type { FormCommitSinkResult } from '@embedpdf/plugin-actions/contract/host';\nimport type { AppearancePicture } from '@embedpdf/plugin-render/contract/host';\n\nimport type { FormCapability, FormCommitResult, FormSetValueResult } from './contract';\nimport type { Box, ShownWidget } from './model';\nimport type { WidgetPainting } from './services/looks';\nimport { FormToken as PublicFormToken } from './token';\n\nexport * from './contract';\nexport type { ShownWidget } from './model';\nexport type { WidgetPainting } from './services/looks';\nexport type { TextEditorLayout } from '@embedpdf/core-form';\n\n/**\n * The host lens: members for the framework layers and sibling plugins (the\n * widget event feed, the text being typed, and the actions plugin's\n * executors and sinks). Application code uses the public capability.\n */\nexport interface FormHostCapability extends FormCapability {\n  /** Load a page's widgets (one annotation read per page), so `listWidgets(page)` has them. */\n  ensureLoaded(page: PageRef): Promise<void>;\n  /**\n   * The widgets a page shows, in the order the page draws them, each with the appearance state it\n   * shows and whether its look is `pending` (the view's isn't the confirmed one yet); hidden ones\n   * are left out. The form layer paints their pictures from it, and the painter's drawing\n   * (`getWidgetPainting`) for a pending one or one whose picture is older than its look. In design\n   * mode, while the widgets are lent to the annotation plugin, none: the annotation layer draws\n   * them.\n   */\n  listShownWidgets(page: PageRef): readonly ShownWidget[];\n  /**\n   * What a page's widget pictures depend on: its widgets at their picture\n   * versions (`5@2|6@7`). Load the pictures again when it changes, or when\n   * the appearance scale does. A checkbox that only switches its state\n   * doesn't move it.\n   */\n  getAppearanceEpoch(page: PageRef): string;\n  /**\n   * Every picture of a page's widgets, at rest, in every state, each with the\n   * picture version of its widget (`ShownWidget.pictureVersion`), through the\n   * render plugin; none without it. The form layer and design mode share them.\n   */\n  renderAppearances(\n    page: PageRef,\n    scale: number,\n    signal?: AbortSignal,\n  ): Promise<readonly AppearancePicture[]>;\n  /**\n   * What the widget looks like as the view has it, drawn by the painter (`@embedpdf/core-form`): its\n   * scene in page space, its text in the engine's own faces (each glyphs node carries the program\n   * to mount). The same object while nothing it shows changes; `null` for a widget the painter\n   * doesn't draw (a signature).\n   */\n  getWidgetPainting(widget: AnnotationRef): WidgetPainting | null;\n  /**\n   * Where a text field's editor shows `text` (what is typed in it), so it sits where the engine\n   * will draw it: the face, the size the engine draws at (a fitted size resolved for `text`),\n   * the text's box inside the widget's, one line's height and a comb's spacing, in page points.\n   * `null` for a widget that isn't a text field's.\n   */\n  getTextEditorLayout(widget: AnnotationRef, text: string): TextEditorLayout | null;\n  /** The page box in page space, for keeping a placement on the page; `null` for a page that isn't there. */\n  getPageBox(page: PageRef): Box | null;\n  /** Send a widget's pointer or focus event to the actions plugin, which runs its `/AA` actions. */\n  notifyWidgetEvent(\n    field: FormFieldRef,\n    widget: AnnotationRef,\n    event: PdfAnnotationEventKind,\n  ): void;\n  /** Run a ResetForm action: reset the fields it names (or all but them), then recalculate. */\n  resetFormAction(\n    fields: PdfActionTargetRef[] | null,\n    exclude: boolean,\n    origin?: ActionOrigin,\n  ): Promise<FormCommitResult>;\n  /** The fields a SubmitForm action sends: the form as the user sees it, once every fill on its way is answered. */\n  resolveSubmitDataset(\n    intent: SubmitIntent,\n    actionContext: ActionContext,\n    diagnose: (diagnostic: ActionDiagnostic) => void,\n  ): Promise<ActionSubmitRequest>;\n  /**\n   * Write what a document script changed in the fields, with the calculations a value causes,\n   * as one change: shown at once, sent once the script's transaction ends. Never rejects; a\n   * change it can't stage reports why, and the engine's refusal comes through the change queue.\n   */\n  commitScriptFormEffects(effects: FormEffect[]): Promise<FormCommitSinkResult>;\n  /**\n   * The text someone is typing in a field, before it's written (write/typing.ts): a keystroke\n   * calls `draftText`, blur or Enter `commitDraftText` (the field's scripts run then), Escape\n   * `discardDraftText`. A download writes a draft first, like Acrobat commits the field being\n   * edited before it saves. `commitDraftText` resolves `null` when there's nothing to write.\n   */\n  draftText(field: FormFieldRef, text: string): void;\n  commitDraftText(field: FormFieldRef): Promise<FormSetValueResult | null>;\n  discardDraftText(field: FormFieldRef): void;\n}\n\nexport const FormToken = createHostToken<FormHostCapability>(PublicFormToken);\n"],"mappings":";;;;;;;;;;;;AAyHA,MAAa,aAAA,GAAA,eAAA,gBAAA,CAAgDA,iBAAAA,SAAe"}

package/dist/contract/host.d.cts

@@ -1,2 +1,3 @@
-import { a as FormHostCapability, c as FormToken } from "../types-Bpc32Qmx.cjs";
-export { type FormHostCapability, FormToken };
+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, Z as ShownWidget, _ 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, 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 { i as WidgetPainting, n as FormToken, r as TextEditorLayout, t as FormHostCapability } from "../host-contract-1epLfK1S.cjs";
+export { type Box, FORM_DEFAULTS, 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, FormHostCapability, type FormImportDrop, type FormImportDropReason, type FormImportOptions, FormImportResult, type FormKind, FormPlainValue, type FormRepairOptions, type FormRepairResult, FormResetResult, FormResyncedEvent, FormSetValueResult, FormSetValueStatus, FormSettings, type FormSnapshot, FormToken, FormTransfer, FormUiEffect, FormValidation, FormValidationRejectedEvent, FormValueChangedEvent, FormWidgetAddResult, type FormWidgetItem, type FormWidgetLook, type ShownWidget, type TextEditorLayout, WidgetActivationResult, WidgetAddress, type WidgetAnnotation, type WidgetHit, type WidgetPainting, toFieldRef };

package/dist/contract/host.d.ts

@@ -1,2 +1,3 @@
-import { a as FormHostCapability, c as FormToken } from "../types-DRirhZKr.js";
-export { type FormHostCapability, FormToken };
+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, Z as ShownWidget, _ 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, 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 { i as WidgetPainting, n as FormToken, r as TextEditorLayout, t as FormHostCapability } from "../host-contract-BRYUbpT_.js";
+export { type Box, FORM_DEFAULTS, 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, FormHostCapability, type FormImportDrop, type FormImportDropReason, type FormImportOptions, FormImportResult, type FormKind, FormPlainValue, type FormRepairOptions, type FormRepairResult, FormResetResult, FormResyncedEvent, FormSetValueResult, FormSetValueStatus, FormSettings, type FormSnapshot, FormToken, FormTransfer, FormUiEffect, FormValidation, FormValidationRejectedEvent, FormValueChangedEvent, FormWidgetAddResult, type FormWidgetItem, type FormWidgetLook, type ShownWidget, type TextEditorLayout, WidgetActivationResult, WidgetAddress, type WidgetAnnotation, type WidgetHit, type WidgetPainting, toFieldRef };

package/dist/contract/host.js

@@ -1,2 +1,14 @@
-import { t as FormToken } from "../types-DkQmmcTG.js";
-export { FormToken };
+import { i as FormToken$1, n as FormTransfer, r as toFieldRef, t as FORM_DEFAULTS } from "../contract-DcncvPcF.js";
+import { createHostToken } from "@embedpdf/core";
+//#region src/host-contract.ts
+/**
+* @embedpdf/plugin-form/contract/host: the host lens, for the framework
+* layers and the actions plugin: loading a page's widgets, the widget event
+* feed, the text being typed, and the actions plugin's executors and sinks.
+* Same runtime token as the public one, typed wider.
+*/
+const FormToken = createHostToken(FormToken$1);
+//#endregion
+export { FORM_DEFAULTS, FormToken, FormTransfer, toFieldRef };
+
+//# sourceMappingURL=host.js.map

package/dist/contract/host.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.js","names":["PublicFormToken"],"sources":["../../src/host-contract.ts"],"sourcesContent":["/**\n * @embedpdf/plugin-form/contract/host: the host lens, for the framework\n * layers and the actions plugin: loading a page's widgets, the widget event\n * feed, the text being typed, and the actions plugin's executors and sinks.\n * Same runtime token as the public one, typed wider.\n */\nimport { createHostToken } from '@embedpdf/core';\nimport type { TextEditorLayout } from '@embedpdf/core-form';\nimport type {\n  AnnotationRef,\n  FormEffect,\n  FormFieldRef,\n  PageRef,\n  PdfActionTargetRef,\n} from '@embedpdf/engine-core/runtime';\nimport type {\n  ActionContext,\n  ActionDiagnostic,\n  ActionOrigin,\n  ActionSubmitRequest,\n  PdfAnnotationEventKind,\n  SubmitIntent,\n} from '@embedpdf/plugin-actions/contract';\nimport type { FormCommitSinkResult } from '@embedpdf/plugin-actions/contract/host';\nimport type { AppearancePicture } from '@embedpdf/plugin-render/contract/host';\n\nimport type { FormCapability, FormCommitResult, FormSetValueResult } from './contract';\nimport type { Box, ShownWidget } from './model';\nimport type { WidgetPainting } from './services/looks';\nimport { FormToken as PublicFormToken } from './token';\n\nexport * from './contract';\nexport type { ShownWidget } from './model';\nexport type { WidgetPainting } from './services/looks';\nexport type { TextEditorLayout } from '@embedpdf/core-form';\n\n/**\n * The host lens: members for the framework layers and sibling plugins (the\n * widget event feed, the text being typed, and the actions plugin's\n * executors and sinks). Application code uses the public capability.\n */\nexport interface FormHostCapability extends FormCapability {\n  /** Load a page's widgets (one annotation read per page), so `listWidgets(page)` has them. */\n  ensureLoaded(page: PageRef): Promise<void>;\n  /**\n   * The widgets a page shows, in the order the page draws them, each with the appearance state it\n   * shows and whether its look is `pending` (the view's isn't the confirmed one yet); hidden ones\n   * are left out. The form layer paints their pictures from it, and the painter's drawing\n   * (`getWidgetPainting`) for a pending one or one whose picture is older than its look. In design\n   * mode, while the widgets are lent to the annotation plugin, none: the annotation layer draws\n   * them.\n   */\n  listShownWidgets(page: PageRef): readonly ShownWidget[];\n  /**\n   * What a page's widget pictures depend on: its widgets at their picture\n   * versions (`5@2|6@7`). Load the pictures again when it changes, or when\n   * the appearance scale does. A checkbox that only switches its state\n   * doesn't move it.\n   */\n  getAppearanceEpoch(page: PageRef): string;\n  /**\n   * Every picture of a page's widgets, at rest, in every state, each with the\n   * picture version of its widget (`ShownWidget.pictureVersion`), through the\n   * render plugin; none without it. The form layer and design mode share them.\n   */\n  renderAppearances(\n    page: PageRef,\n    scale: number,\n    signal?: AbortSignal,\n  ): Promise<readonly AppearancePicture[]>;\n  /**\n   * What the widget looks like as the view has it, drawn by the painter (`@embedpdf/core-form`): its\n   * scene in page space, its text in the engine's own faces (each glyphs node carries the program\n   * to mount). The same object while nothing it shows changes; `null` for a widget the painter\n   * doesn't draw (a signature).\n   */\n  getWidgetPainting(widget: AnnotationRef): WidgetPainting | null;\n  /**\n   * Where a text field's editor shows `text` (what is typed in it), so it sits where the engine\n   * will draw it: the face, the size the engine draws at (a fitted size resolved for `text`),\n   * the text's box inside the widget's, one line's height and a comb's spacing, in page points.\n   * `null` for a widget that isn't a text field's.\n   */\n  getTextEditorLayout(widget: AnnotationRef, text: string): TextEditorLayout | null;\n  /** The page box in page space, for keeping a placement on the page; `null` for a page that isn't there. */\n  getPageBox(page: PageRef): Box | null;\n  /** Send a widget's pointer or focus event to the actions plugin, which runs its `/AA` actions. */\n  notifyWidgetEvent(\n    field: FormFieldRef,\n    widget: AnnotationRef,\n    event: PdfAnnotationEventKind,\n  ): void;\n  /** Run a ResetForm action: reset the fields it names (or all but them), then recalculate. */\n  resetFormAction(\n    fields: PdfActionTargetRef[] | null,\n    exclude: boolean,\n    origin?: ActionOrigin,\n  ): Promise<FormCommitResult>;\n  /** The fields a SubmitForm action sends: the form as the user sees it, once every fill on its way is answered. */\n  resolveSubmitDataset(\n    intent: SubmitIntent,\n    actionContext: ActionContext,\n    diagnose: (diagnostic: ActionDiagnostic) => void,\n  ): Promise<ActionSubmitRequest>;\n  /**\n   * Write what a document script changed in the fields, with the calculations a value causes,\n   * as one change: shown at once, sent once the script's transaction ends. Never rejects; a\n   * change it can't stage reports why, and the engine's refusal comes through the change queue.\n   */\n  commitScriptFormEffects(effects: FormEffect[]): Promise<FormCommitSinkResult>;\n  /**\n   * The text someone is typing in a field, before it's written (write/typing.ts): a keystroke\n   * calls `draftText`, blur or Enter `commitDraftText` (the field's scripts run then), Escape\n   * `discardDraftText`. A download writes a draft first, like Acrobat commits the field being\n   * edited before it saves. `commitDraftText` resolves `null` when there's nothing to write.\n   */\n  draftText(field: FormFieldRef, text: string): void;\n  commitDraftText(field: FormFieldRef): Promise<FormSetValueResult | null>;\n  discardDraftText(field: FormFieldRef): void;\n}\n\nexport const FormToken = createHostToken<FormHostCapability>(PublicFormToken);\n"],"mappings":";;;;;;;;;AAyHA,MAAa,YAAY,gBAAoCA,WAAe"}