@kopjra/pdf-sentinel 1.11.3 → 1.11.4

package/dist/preact/src/__tests__/annotationUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/annotations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/frameworkExports.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/readAnnotationFields.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/renderers.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/renderersRender.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/shared.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/signatureColors.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/textRendererReadonly.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/toolbar.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/tools.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/toolsAdvanced.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/translations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/useDeepMemo.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/__tests__/usePdfSentinel.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/preact/src/framework/index.d.ts

@@ -37,3 +37,5 @@ export { HistoryPluginPackage, useHistoryCapability } from '@embedpdf/plugin-his
 export type { HistoryCapability } from '@embedpdf/plugin-history/react';
 export { AnnotationPluginPackage, AnnotationLayer, useAnnotation, AnnotationPlugin, useAnnotationCapability, } from '@embedpdf/plugin-annotation/react';
 export type { CustomAnnotationRenderer, CustomAnnotationRendererProps, AnnotationCapability, AnnotationSelectionMenuProps } from '@embedpdf/plugin-annotation/react';
+export { FormPluginPackage, useFormCapability } from '@embedpdf/plugin-form/react';
+export type { FormCapability, FormScope, FormFieldInfo } from '@embedpdf/plugin-form/react';

package/dist/preact/src/framework/preact.d.ts

@@ -38,3 +38,5 @@ export { HistoryPluginPackage, useHistoryCapability } from '@embedpdf/plugin-his
 export type { HistoryCapability } from '@embedpdf/plugin-history/preact';
 export { AnnotationPluginPackage, AnnotationLayer, useAnnotation, AnnotationPlugin, useAnnotationCapability } from '@embedpdf/plugin-annotation/preact';
 export type { CustomAnnotationRenderer, CustomAnnotationRendererProps, AnnotationCapability, AnnotationSelectionMenuProps } from '@embedpdf/plugin-annotation/preact';
+export { FormPluginPackage, useFormCapability } from '@embedpdf/plugin-form/preact';
+export type { FormCapability, FormScope, FormFieldInfo } from '@embedpdf/plugin-form/preact';

package/dist/preact/src/plugins/forms/hooks/usePdfForms.d.ts

@@ -1,6 +1,5 @@
 import { Field as SharedField } from '../shared.ts';
-import { DocumentManagerCapability, ScrollCapability, ViewportCapability } from '../../../framework/preact.ts';
-import { PdfEngine } from '@embedpdf/models';
+import { DocumentManagerCapability, FormCapability, ScrollCapability, ViewportCapability } from '../../../framework/preact.ts';
 import { ConditionalSignature, InitialValuesType } from '../../../hooks/usePdfSentinel.tsx';
 type Field = SharedField;
 export type UsePdfFormsResult = {
@@ -16,5 +15,5 @@ export type UsePdfFormsResult = {
     showErrors: boolean;
     scrollToConditionalSignature: (index: string) => Generator;
 };
-export declare function usePdfForms(documentId: string, initialValues: InitialValuesType, conditionalSignatures: ConditionalSignature[] | undefined, signatureFieldNames: string[] | undefined, engine: PdfEngine<Blob> | null, loader: DocumentManagerCapability | null, scrollCapability: ScrollCapability | null, viewportCapability: ViewportCapability | null): UsePdfFormsResult;
+export declare function usePdfForms(documentId: string, initialValues: InitialValuesType, conditionalSignatures: ConditionalSignature[] | undefined, signatureFieldNames: string[] | undefined, formCapability: FormCapability | null, loader: DocumentManagerCapability | null, scrollCapability: ScrollCapability | null, viewportCapability: ViewportCapability | null): UsePdfFormsResult;
 export {};

package/dist/preact/src/plugins/forms/shared.d.ts

@@ -1,5 +1,5 @@
 import { PdfAnnotationObject, PdfDocumentObject, PdfEngine } from '@embedpdf/models';
-import { DocumentManagerCapability } from '../../framework/preact.ts';
+import { DocumentManagerCapability, FormCapability } from '../../framework/preact.ts';
 import { ConditionalSignature, InitialValuesType } from '../../hooks/usePdfSentinel.tsx';
 export type Field = {
     name: string;
@@ -16,13 +16,28 @@ export type Field = {
     required?: boolean;
     conditionalIndex?: string;
 };
+/**
+ * Extracts form fields from a PDF document using the raw engine API.
+ *
+ * Kept for use-cases that operate outside the EmbedPDF component tree
+ * (e.g. readAnnotationFieldsAndClean in tools.ts).
+ */
 export declare function getFormFieldsFromDocument(document: PdfDocumentObject, engine: PdfEngine<Blob>, initialValues?: InitialValuesType, conditionalSignatures?: ConditionalSignature[], signatureFieldNames?: string[], readAllFields?: boolean): AsyncGenerator<{
     field: Field;
     annotation: PdfAnnotationObject;
 }>;
+/**
+ * Checks whether a PDF annotation (widget) currently holds a value.
+ * Uses native `isWidgetChecked` for toggle fields (2.14.0+).
+ */
 export declare function hasValue(annotation: PdfAnnotationObject): boolean;
 export declare function makeReadOnlyAndNotRequired(annotation: PdfAnnotationObject): PdfAnnotationObject;
-export declare function getFormFields(documentId: string, initialValues: InitialValuesType, conditionalSignatures: ConditionalSignature[], signatureFieldNames: string[] | undefined, engine: PdfEngine<Blob> | null, loader: DocumentManagerCapability | null): Promise<{
+/**
+ * Collects form fields and their values using the `@embedpdf/plugin-form`
+ * capability.  This replaces the old engine-level annotation scanning for the
+ * interactive form-usage path.
+ */
+export declare function getFormFieldsViaCapability(documentId: string, initialValues: InitialValuesType, conditionalSignatures: ConditionalSignature[], signatureFieldNames: string[] | undefined, formCapability: FormCapability | null, loader: DocumentManagerCapability | null): Promise<{
     fields: Field[];
     values: Record<string, string | boolean>;
 }>;