kviewer 0.1.2 → 0.2.1

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

@@ -20,7 +20,8 @@ type EventHandler<E extends EventName> = (payload: EventPayloads[E]) => void;
  * Parent-page client that drives a `<KViewer>` instance running inside
  * an iframe. Wraps `postMessage` into a Promise-based RPC mirroring the
  * viewer's exposed methods, and surfaces iframe-emitted events
- * (`ready`, `formEditMode-changed`) via `on()`.
+ * (`ready`, `formEditMode-changed`, `viewedPages-changed`, `all-pages-read`)
+ * via `on()`.
  */
 export declare class KViewerEmbedClient {
     private readonly iframe;
@@ -52,6 +53,13 @@ export declare class KViewerEmbedClient {
     getFormEditMode(): Promise<boolean>;
     setFormEditMode(enabled: boolean): Promise<void>;
     toggleFormEditMode(): Promise<boolean>;
+    /** True once the user has viewed every page. For a push-style signal,
+     *  subscribe via `on('all-pages-read', …)` / `on('viewedPages-changed', …)`. */
+    allPagesRead(): Promise<boolean>;
+    /** Page numbers viewed so far, ascending. */
+    getViewedPages(): Promise<number[]>;
+    /** Clear viewed-page tracking, e.g. to restart a signing session. */
+    resetViewedPages(): Promise<void>;
     private call;
     private handleMessage;
 }

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

@@ -87,6 +87,19 @@ export class KViewerEmbedClient {
   toggleFormEditMode() {
     return this.call("toggleFormEditMode");
   }
+  /** True once the user has viewed every page. For a push-style signal,
+   *  subscribe via `on('all-pages-read', …)` / `on('viewedPages-changed', …)`. */
+  allPagesRead() {
+    return this.call("allPagesRead");
+  }
+  /** Page numbers viewed so far, ascending. */
+  getViewedPages() {
+    return this.call("getViewedPages");
+  }
+  /** Clear viewed-page tracking, e.g. to restart a signing session. */
+  resetViewedPages() {
+    return this.call("resetViewedPages");
+  }
   // ── internals ──────────────────────────────────────────────────────────
   call(method, ...args) {
     if (this.disposed) {

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

@@ -26,6 +26,9 @@ export interface KViewerApi {
     formEditMode: Ref<boolean>;
     setFormEditMode: (enabled: boolean) => void;
     toggleFormEditMode: () => boolean;
+    allPagesRead: () => boolean;
+    getViewedPages: () => number[];
+    resetViewedPages: () => void;
 }
 export interface KViewerEmbedBridgeOptions {
     /**

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

@@ -75,6 +75,13 @@ export function useKViewerEmbedBridge(viewerRef, options) {
       }
       case "toggleFormEditMode":
         return viewer.toggleFormEditMode();
+      case "allPagesRead":
+        return viewer.allPagesRead();
+      case "getViewedPages":
+        return viewer.getViewedPages();
+      case "resetViewedPages":
+        viewer.resetViewedPages();
+        return void 0;
       default:
         throw new Error(`Unknown KViewer embed method: ${req.method}`);
     }
@@ -110,17 +117,32 @@ export function useKViewerEmbedBridge(viewerRef, options) {
     target.postMessage(reply, event.origin === "" ? options.parentOrigin : event.origin);
   }
   win.addEventListener("message", handleMessage);
-  let stopFormEditWatch = null;
+  let stopViewerStateWatches = [];
   const stopViewerWatch = watch(
     viewerRef,
     (viewer) => {
-      stopFormEditWatch?.();
-      stopFormEditWatch = null;
+      for (const stop of stopViewerStateWatches) stop();
+      stopViewerStateWatches = [];
       if (!viewer) return;
       postEvent("ready", { protocolVersion: KVIEWER_EMBED_PROTOCOL_VERSION });
-      stopFormEditWatch = watch(
-        viewer.formEditMode,
-        (enabled) => postEvent("formEditMode-changed", { enabled })
+      stopViewerStateWatches.push(
+        watch(
+          viewer.formEditMode,
+          (enabled) => postEvent("formEditMode-changed", { enabled })
+        ),
+        // Read-tracking. The getters touch the viewer's reactive viewed-pages
+        // state, so watch re-runs them whenever a page is viewed or tracking
+        // is reset.
+        watch(
+          () => viewer.allPagesRead(),
+          (read, prev) => {
+            if (read && !prev) postEvent("all-pages-read", {});
+          }
+        ),
+        watch(
+          () => viewer.getViewedPages(),
+          (pages) => postEvent("viewedPages-changed", { pages, allRead: viewer.allPagesRead() })
+        )
       );
     },
     { immediate: true }
@@ -128,8 +150,8 @@ export function useKViewerEmbedBridge(viewerRef, options) {
   function unmount() {
     win.removeEventListener("message", handleMessage);
     stopViewerWatch();
-    stopFormEditWatch?.();
-    stopFormEditWatch = null;
+    for (const stop of stopViewerStateWatches) stop();
+    stopViewerStateWatches = [];
   }
   onScopeDispose(unmount);
   return { unmount };

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

@@ -59,6 +59,18 @@ export interface MethodSignatures {
         args: [];
         result: boolean;
     };
+    allPagesRead: {
+        args: [];
+        result: boolean;
+    };
+    getViewedPages: {
+        args: [];
+        result: number[];
+    };
+    resetViewedPages: {
+        args: [];
+        result: undefined;
+    };
 }
 export type MethodName = keyof MethodSignatures;
 export interface RequestMessage<M extends MethodName = MethodName> {
@@ -91,6 +103,15 @@ export interface EventPayloads {
     'formEditMode-changed': {
         enabled: boolean;
     };
+    /** The set of viewed pages changed. `allRead` is true once every page has
+     *  been viewed. */
+    'viewedPages-changed': {
+        pages: number[];
+        allRead: boolean;
+    };
+    /** Fires once when the final unseen page is viewed. Re-arms after
+     *  `resetViewedPages()` or a new document. */
+    'all-pages-read': Record<string, never>;
 }
 export type EventName = keyof EventPayloads;
 export interface EventMessage<E extends EventName = EventName> {

package/package.json

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