kviewer 0.3.4 → 0.3.6

package/dist/runtime/embed/bridge-client.d.ts

@@ -21,7 +21,8 @@ type EventHandler<E extends EventName> = (payload: EventPayloads[E]) => void;
  * an iframe. Wraps `postMessage` into a Promise-based RPC mirroring the
  * viewer's exposed methods, and surfaces iframe-emitted events
  * (`ready`, `formEditMode-changed`, `viewedPages-changed`, `all-pages-read`,
- * `field-placed`, `signedStatus-changed`) via `on()`.
+ * `field-placed`, `field-updated`, `field-removed`, `signedStatus-changed`)
+ * and `scroll-boundary`) via `on()`.
  */
 export declare class KViewerEmbedClient {
     private readonly iframe;
@@ -68,7 +69,8 @@ export declare class KViewerEmbedClient {
      *  a push-style signal subscribe via `on('signedStatus-changed', …)`. */
     getSignedStatus(): Promise<boolean>;
     /** Per-widget signed-state snapshot (id, fieldName, pageNumber,
-     *  signed, roleId). */
+     *  signed). Correlate to host data by `id` (see the `meta` bag on
+     *  `getFormFields()` for grouping, e.g. by signer). */
     getSignatureFieldStatus(): Promise<SignatureFieldStatus[]>;
     getFormEditMode(): Promise<boolean>;
     setFormEditMode(enabled: boolean): Promise<void>;

package/dist/runtime/embed/bridge-client.js

@@ -104,7 +104,8 @@ export class KViewerEmbedClient {
     return this.call("getSignedStatus");
   }
   /** Per-widget signed-state snapshot (id, fieldName, pageNumber,
-   *  signed, roleId). */
+   *  signed). Correlate to host data by `id` (see the `meta` bag on
+   *  `getFormFields()` for grouping, e.g. by signer). */
   getSignatureFieldStatus() {
     return this.call("getSignatureFieldStatus");
   }

package/dist/runtime/embed/bridge-host.d.ts

@@ -1,7 +1,7 @@
 import { type Ref } from 'vue';
 import type { ExportPdfOptions } from '../annotation/pdf-export/export.js';
 import type { AddFormFieldPayload, FormFieldDefinition, FormFieldValue, IAnnotationStore, PlacedFieldDefaults, SignatureFieldStatus } from '../annotation/engine/types.js';
-import { type MethodName } from './protocol.js';
+import { type MethodName, type ScrollBoundaryPayload } from './protocol.js';
 /**
  * Surface the bridge calls on the KViewer template ref. Mirrors the
  * methods defined in `defineExpose` inside Viewer.vue. Kept as a
@@ -27,12 +27,15 @@ export interface KViewerApi {
     setFieldDefaults: (defaults: PlacedFieldDefaults) => void;
     setClickToSign: (enabled: boolean) => void;
     onFieldPlaced: (cb: (field: FormFieldDefinition) => void) => () => void;
+    onFieldUpdated: (cb: (field: FormFieldDefinition, patch: Partial<FormFieldDefinition>) => void) => () => void;
+    onFieldRemoved: (cb: (field: FormFieldDefinition) => void) => () => void;
     getSignedStatus: () => boolean;
     getSignatureFieldStatus: () => SignatureFieldStatus[];
     onSignedStatusChanged: (cb: (payload: {
         allSigned: boolean;
         fields: SignatureFieldStatus[];
     }) => void) => () => void;
+    onScrollBoundary: (cb: (payload: ScrollBoundaryPayload) => void) => () => void;
     formEditMode: boolean | Ref<boolean>;
     setFormEditMode: (enabled: boolean) => void;
     toggleFormEditMode: () => boolean;

package/dist/runtime/embed/bridge-host.js

@@ -202,6 +202,22 @@ export function useKViewerEmbedBridge(viewerRef, options) {
           )
         );
       }
+      if (typeof viewer.onFieldUpdated === "function") {
+        events.push("field-updated");
+        stopViewerStateWatches.push(
+          viewer.onFieldUpdated(
+            (field, patch) => postEvent("field-updated", { field, patch })
+          )
+        );
+      }
+      if (typeof viewer.onFieldRemoved === "function") {
+        events.push("field-removed");
+        stopViewerStateWatches.push(
+          viewer.onFieldRemoved(
+            (field) => postEvent("field-removed", { field })
+          )
+        );
+      }
       if (typeof viewer.onSignedStatusChanged === "function") {
         events.push("signedStatus-changed");
         stopViewerStateWatches.push(
@@ -210,6 +226,14 @@ export function useKViewerEmbedBridge(viewerRef, options) {
           )
         );
       }
+      if (typeof viewer.onScrollBoundary === "function") {
+        events.push("scroll-boundary");
+        stopViewerStateWatches.push(
+          viewer.onScrollBoundary(
+            (payload) => postEvent("scroll-boundary", payload)
+          )
+        );
+      }
       if (typeof viewer.allPagesRead === "function") {
         events.push("all-pages-read");
         stopViewerStateWatches.push(

package/dist/runtime/embed/protocol.d.ts

@@ -11,6 +11,10 @@ export declare const EVENT_KIND: "kviewer:event";
  */
 export declare const UNSUPPORTED_METHOD_ERROR_NAME = "KViewerUnsupportedMethodError";
 export type ImportAnnotationsMode = 'replace' | 'merge';
+export interface ScrollBoundaryPayload {
+    edge: 'start' | 'end';
+    deltaY: number;
+}
 export interface MethodSignatures {
     getAnnotations: {
         args: [];
@@ -145,11 +149,26 @@ export interface EventPayloads {
     /** Fires once when the final unseen page is viewed. Re-arms after
      *  `resetViewedPages()` or a new document. */
     'all-pages-read': Record<string, never>;
+    /** Vertical wheel movement that the embedded viewer could not consume
+     *  because it reached the start or end of the document. */
+    'scroll-boundary': ScrollBoundaryPayload;
     /** The user placed a form field via a placement tool. Patch it with
      *  `updateFormField()` to set host-driven properties. */
     'field-placed': {
         field: FormFieldDefinition;
     };
+    /** The user changed a field through the viewer UI (moved/resized it or
+     *  edited its properties). Not fired for `updateFormField()` calls.
+     *  Continuous edits may fire repeatedly — treat as an upsert. */
+    'field-updated': {
+        field: FormFieldDefinition;
+        patch: Partial<FormFieldDefinition>;
+    };
+    /** The user removed a field through the viewer UI. Not fired for
+     *  `removeFormField()` calls. `field` is the last-known definition. */
+    'field-removed': {
+        field: FormFieldDefinition;
+    };
     /** A signature field's signed state changed (signed, cleared, added,
      *  removed, or renamed). Push-style counterpart to `getSignedStatus()`. */
     'signedStatus-changed': {

package/dist/runtime/public-types.d.ts

@@ -7,7 +7,7 @@ export type { KViewerApi, KViewerHostApi, KViewerEmbedBridgeOptions, } from './e
 export { useKViewerEmbedBridge } from './embed/bridge-host.js';
 export type { KViewerEmbedClientOptions } from './embed/bridge-client.js';
 export { KViewerEmbedClient } from './embed/bridge-client.js';
-export type { EventName as KViewerEmbedEventName, EventPayloads as KViewerEmbedEventPayloads, MethodName as KViewerEmbedMethodName, } from './embed/protocol.js';
+export type { EventName as KViewerEmbedEventName, EventPayloads as KViewerEmbedEventPayloads, MethodName as KViewerEmbedMethodName, ScrollBoundaryPayload, } from './embed/protocol.js';
 export { KVIEWER_EMBED_PROTOCOL_VERSION, UNSUPPORTED_METHOD_ERROR_NAME as KVIEWER_EMBED_UNSUPPORTED_METHOD_ERROR_NAME, } from './embed/protocol.js';
 export type { ViewerMenuItem, ViewerMenuButtonItem, ViewerMenuCheckboxItem, ViewerMenuSeparatorItem, } from './menu-items.js';
 export type { ViewerSelectionItem, ViewerSelectionButtonItem, ViewerSelectionSelectItem, ViewerSelectionContext, } from './selection-items.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kviewer",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "Kabema PDF Editor",
   "repository": "kabema/kviewer",
   "license": "MIT",