@kopjra/pdf-sentinel 1.11.2 → 1.11.4

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/react/src/components/PdfSToolbar.d.ts

@@ -13,5 +13,6 @@ export interface PdfSToolbarProps {
     totalPages?: number | null;
     historyCapability?: HistoryCapability | null;
     annotationsApi?: AnnotationsApi | null;
+    usageType: "form" | "annotation" | "plain";
 }
-export declare function PdfSToolbar({ buttons, currentPage, zoomCapability, scrollCapability, exportCapability, totalPages, removeButtons, historyCapability, annotationsApi }: PdfSToolbarProps): import("react/jsx-runtime").JSX.Element;
+export declare function PdfSToolbar({ buttons, currentPage, zoomCapability, scrollCapability, exportCapability, totalPages, removeButtons, historyCapability, annotationsApi, usageType, }: PdfSToolbarProps): import("react/jsx-runtime").JSX.Element;

package/dist/react/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/react/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/react/src/plugins/forms/hooks/usePdfForms.d.ts

@@ -1,6 +1,5 @@
 import { Field as SharedField } from '../shared.ts';
-import { DocumentManagerCapability, ScrollCapability, ViewportCapability } from '../../../framework/index.ts';
-import { PdfEngine } from '@embedpdf/models';
+import { DocumentManagerCapability, FormCapability, ScrollCapability, ViewportCapability } from '../../../framework/index.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/react/src/plugins/forms/shared.d.ts

@@ -1,5 +1,5 @@
 import { PdfAnnotationObject, PdfDocumentObject, PdfEngine } from '@embedpdf/models';
-import { DocumentManagerCapability } from '../../framework/index.ts';
+import { DocumentManagerCapability, FormCapability } from '../../framework/index.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>;
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kopjra/pdf-sentinel",
-  "version": "1.11.2",
+  "version": "1.11.4",
   "description": "A React and Preact component library for embedding and interacting with PDF documents using EmbedPDF.",
   "keywords": [
     "react",
@@ -35,7 +35,7 @@
     "dist"
   ],
   "config": {
-    "embedpdf": "2.9.0"
+    "embedpdf": "2.14.0"
   },
   "author": "",
   "license": "ISC",
@@ -46,14 +46,18 @@
   },
   "devDependencies": {
     "@preact/preset-vite": "^2.10.2",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
     "@types/jquery": "^3.5.33",
     "@types/lodash": "^4.17.21",
     "@types/node": "^24.10.4",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.2",
     "@vitejs/plugin-react": "^4.3.4",
+    "@vitest/coverage-v8": "4.0.18",
     "cross-env": "^7.0.3",
     "jquery": "^3.7.1",
+    "jsdom": "^29.0.2",
     "preact": "^10.28.3",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
@@ -61,25 +65,27 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3",
     "vite": "^5.4.9",
-    "vite-plugin-dts": "^4.2.1"
+    "vite-plugin-dts": "^4.2.1",
+    "vitest": "^4.0.18"
   },
   "dependencies": {
-    "@embedpdf/core": "2.9.0",
-    "@embedpdf/engines": "2.9.0",
-    "@embedpdf/models": "2.9.0",
-    "@embedpdf/pdfium": "2.9.0",
-    "@embedpdf/plugin-annotation": "2.9.0",
-    "@embedpdf/plugin-document-manager": "2.9.0",
-    "@embedpdf/plugin-export": "2.9.0",
-    "@embedpdf/plugin-history": "2.9.0",
-    "@embedpdf/plugin-interaction-manager": "2.9.0",
-    "@embedpdf/plugin-pan": "2.9.0",
-    "@embedpdf/plugin-render": "2.9.0",
-    "@embedpdf/plugin-scroll": "2.9.0",
-    "@embedpdf/plugin-selection": "2.9.0",
-    "@embedpdf/plugin-spread": "2.9.0",
-    "@embedpdf/plugin-viewport": "2.9.0",
-    "@embedpdf/plugin-zoom": "2.9.0",
+    "@embedpdf/core": "2.14.0",
+    "@embedpdf/engines": "2.14.0",
+    "@embedpdf/models": "2.14.0",
+    "@embedpdf/pdfium": "2.14.0",
+    "@embedpdf/plugin-annotation": "2.14.0",
+    "@embedpdf/plugin-document-manager": "2.14.0",
+    "@embedpdf/plugin-export": "2.14.0",
+    "@embedpdf/plugin-form": "2.14.0",
+    "@embedpdf/plugin-history": "2.14.0",
+    "@embedpdf/plugin-interaction-manager": "2.14.0",
+    "@embedpdf/plugin-pan": "2.14.0",
+    "@embedpdf/plugin-render": "2.14.0",
+    "@embedpdf/plugin-scroll": "2.14.0",
+    "@embedpdf/plugin-selection": "2.14.0",
+    "@embedpdf/plugin-spread": "2.14.0",
+    "@embedpdf/plugin-viewport": "2.14.0",
+    "@embedpdf/plugin-zoom": "2.14.0",
     "lodash": "^4.17.21"
   },
   "scripts": {
@@ -89,7 +95,9 @@
     "build:react": "cross-env FRAMEWORK_VARIANT=react vite build",
     "build:preact": "cross-env FRAMEWORK_VARIANT=preact vite build",
     "typecheck": "tsc --noEmit",
-    "test": "echo \"No tests configured yet\"",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
     "copy-wasm-s3": "aws s3 cp ./node_modules/@embedpdf/pdfium/dist/pdfium.wasm s3://kopjra-public/wias/pdfium/pdfium-$npm_package_config_embedpdf.wasm --acl public-read --cache-control max-age=31536000",
     "wasm-hash": "shasum -a 256 ./node_modules/@embedpdf/pdfium/dist/pdfium.wasm | awk '{ print $1 }' > ./pdfium-$npm_package_config_embedpdf.wasm.hash.txt",
     "sign-wasm-hash": "curl -k -X POST -H \"Content-Type: application/octet-stream\" -H \"Authorization: Basic ${WEBTRUST_API_KEY}\" --data-binary \"@./pdfium-$npm_package_config_embedpdf.wasm.hash.txt\" \"https://api.webtrust.kopjra.com/v1/timestamps?sync=true&trusted=true&fileName=pdfium-$npm_package_config_embedpdf.wasm.hash.txt\" > ./pdfium-$npm_package_config_embedpdf.wasm.hash.txt.tsd",

package/dist/preact/src/utils/raper.d.ts

@@ -1,8 +0,0 @@
-import { PdfEngine, PdfWidgetAnnoField as OriginalPdfWidgetAnnoField } from '@embedpdf/models';
-declare module "@embedpdf/models" {
-    interface PdfWidgetAnnoField extends OriginalPdfWidgetAnnoField {
-        exportValue?: string;
-        signed?: boolean;
-    }
-}
-export declare function rapeEngine(engine: PdfEngine | null): void;

package/dist/react/src/utils/raper.d.ts

@@ -1,8 +0,0 @@
-import { PdfEngine, PdfWidgetAnnoField as OriginalPdfWidgetAnnoField } from '@embedpdf/models';
-declare module "@embedpdf/models" {
-    interface PdfWidgetAnnoField extends OriginalPdfWidgetAnnoField {
-        exportValue?: string;
-        signed?: boolean;
-    }
-}
-export declare function rapeEngine(engine: PdfEngine | null): void;