kviewer 0.3.2 → 0.3.4

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

@@ -3,8 +3,42 @@ import {
   EVENT_KIND,
   KVIEWER_EMBED_PROTOCOL_VERSION,
   RESPONSE_KIND,
+  UNSUPPORTED_METHOD_ERROR_NAME,
   isRequest
 } from "./protocol.js";
+const METHOD_REQUIREMENT = {
+  getAnnotations: "getAnnotations",
+  importAnnotations: "importAnnotations",
+  exportPdf: "exportPdf",
+  printPdf: "printPdf",
+  getFormFieldValues: "getFormFieldValues",
+  setFormFieldValue: "setFormFieldValue",
+  addFormField: "addFormField",
+  updateFormField: "updateFormField",
+  removeFormField: "removeFormField",
+  getFormFields: "getFormFields",
+  setFieldDefaults: "setFieldDefaults",
+  setClickToSign: "setClickToSign",
+  getSignedStatus: "getSignedStatus",
+  getSignatureFieldStatus: "getSignatureFieldStatus",
+  getFormEditMode: "formEditMode",
+  setFormEditMode: "setFormEditMode",
+  toggleFormEditMode: "toggleFormEditMode",
+  allPagesRead: "allPagesRead",
+  getViewedPages: "getViewedPages",
+  resetViewedPages: "resetViewedPages"
+};
+const ALL_METHODS = Object.keys(METHOD_REQUIREMENT);
+function supportsMethod(viewer, method) {
+  const member = METHOD_REQUIREMENT[method];
+  if (!member) return false;
+  return member === "formEditMode" ? viewer.formEditMode !== void 0 : typeof viewer[member] === "function";
+}
+function unsupportedMethodError(method) {
+  const err = new Error(`KViewer embed host does not implement "${method}"`);
+  err.name = UNSUPPORTED_METHOD_ERROR_NAME;
+  return err;
+}
 export function useKViewerEmbedBridge(viewerRef, options) {
   const allowAny = options.parentOrigin === "*";
   const winMaybe = options.windowRef ?? (typeof window !== "undefined" ? window : void 0);
@@ -28,10 +62,17 @@ export function useKViewerEmbedBridge(viewerRef, options) {
     parent.postMessage(message, options.parentOrigin);
   }
   async function dispatch(req) {
-    const viewer = viewerRef.value;
-    if (!viewer) {
+    const host = viewerRef.value;
+    if (!host) {
       throw new Error("KViewer ref is not yet available");
     }
+    if (!(req.method in METHOD_REQUIREMENT)) {
+      throw new Error(`Unknown KViewer embed method: ${req.method}`);
+    }
+    if (!supportsMethod(host, req.method)) {
+      throw unsupportedMethodError(req.method);
+    }
+    const viewer = host;
     switch (req.method) {
       case "getAnnotations":
         return viewer.getAnnotations();
@@ -43,6 +84,11 @@ export function useKViewerEmbedBridge(viewerRef, options) {
         const [opts] = req.args;
         return viewer.exportPdf(opts);
       }
+      case "printPdf": {
+        const [opts] = req.args;
+        await viewer.printPdf(opts);
+        return void 0;
+      }
       case "getFormFieldValues":
         return viewer.getFormFieldValues();
       case "setFormFieldValue": {
@@ -138,32 +184,60 @@ export function useKViewerEmbedBridge(viewerRef, options) {
       for (const stop of stopViewerStateWatches) stop();
       stopViewerStateWatches = [];
       if (!viewer) return;
-      postEvent("ready", { protocolVersion: KVIEWER_EMBED_PROTOCOL_VERSION });
-      stopViewerStateWatches.push(
-        watch(
-          () => unref(viewer.formEditMode),
-          (enabled) => postEvent("formEditMode-changed", { enabled })
-        ),
-        viewer.onFieldPlaced(
-          (field) => postEvent("field-placed", { field })
-        ),
-        viewer.onSignedStatusChanged(
-          (payload) => postEvent("signedStatus-changed", payload)
-        ),
-        // 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() })
-        )
-      );
+      const events = ["ready"];
+      if (viewer.formEditMode !== void 0) {
+        events.push("formEditMode-changed");
+        stopViewerStateWatches.push(
+          watch(
+            () => unref(viewer.formEditMode),
+            (enabled) => postEvent("formEditMode-changed", { enabled: enabled ?? false })
+          )
+        );
+      }
+      if (typeof viewer.onFieldPlaced === "function") {
+        events.push("field-placed");
+        stopViewerStateWatches.push(
+          viewer.onFieldPlaced(
+            (field) => postEvent("field-placed", { field })
+          )
+        );
+      }
+      if (typeof viewer.onSignedStatusChanged === "function") {
+        events.push("signedStatus-changed");
+        stopViewerStateWatches.push(
+          viewer.onSignedStatusChanged(
+            (payload) => postEvent("signedStatus-changed", payload)
+          )
+        );
+      }
+      if (typeof viewer.allPagesRead === "function") {
+        events.push("all-pages-read");
+        stopViewerStateWatches.push(
+          watch(
+            () => viewer.allPagesRead?.() ?? false,
+            (read, prev) => {
+              if (read && !prev) postEvent("all-pages-read", {});
+            }
+          )
+        );
+      }
+      if (typeof viewer.getViewedPages === "function") {
+        events.push("viewedPages-changed");
+        stopViewerStateWatches.push(
+          watch(
+            () => viewer.getViewedPages?.() ?? [],
+            (pages) => postEvent("viewedPages-changed", {
+              pages,
+              allRead: viewer.allPagesRead?.() ?? false
+            })
+          )
+        );
+      }
+      postEvent("ready", {
+        protocolVersion: KVIEWER_EMBED_PROTOCOL_VERSION,
+        methods: ALL_METHODS.filter((method) => supportsMethod(viewer, method)),
+        events
+      });
     },
     { immediate: true }
   );

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

@@ -4,6 +4,12 @@ export declare const KVIEWER_EMBED_PROTOCOL_VERSION = 1;
 export declare const REQUEST_KIND: "kviewer:request";
 export declare const RESPONSE_KIND: "kviewer:response";
 export declare const EVENT_KIND: "kviewer:event";
+/**
+ * `error.name` on a response rejected because the embedding host's viewer
+ * adapter does not implement the requested method. Lets a parent tell a
+ * missing capability apart from a genuine failure inside the viewer.
+ */
+export declare const UNSUPPORTED_METHOD_ERROR_NAME = "KViewerUnsupportedMethodError";
 export type ImportAnnotationsMode = 'replace' | 'merge';
 export interface MethodSignatures {
     getAnnotations: {
@@ -23,6 +29,10 @@ export interface MethodSignatures {
         args: [options?: ExportPdfOptions];
         result: Uint8Array;
     };
+    printPdf: {
+        args: [options?: Omit<ExportPdfOptions, 'download' | 'fileName'>];
+        result: undefined;
+    };
     getFormFieldValues: {
         args: [];
         result: FormFieldValue[];
@@ -115,6 +125,13 @@ export type ResponseMessage<M extends MethodName = MethodName> = {
 export interface EventPayloads {
     ready: {
         protocolVersion: number;
+        /** Methods the host's viewer adapter implements. Absent on hosts
+         *  predating capability discovery, where the full API was mandatory —
+         *  treat `undefined` as "assume everything". */
+        methods?: MethodName[];
+        /** Events the host actually subscribed to. Same `undefined` caveat as
+         *  `methods`. */
+        events?: EventName[];
     };
     'formEditMode-changed': {
         enabled: boolean;

package/dist/runtime/embed/protocol.js

@@ -2,6 +2,7 @@ export const KVIEWER_EMBED_PROTOCOL_VERSION = 1;
 export const REQUEST_KIND = "kviewer:request";
 export const RESPONSE_KIND = "kviewer:response";
 export const EVENT_KIND = "kviewer:event";
+export const UNSUPPORTED_METHOD_ERROR_NAME = "KViewerUnsupportedMethodError";
 export function isRequest(msg) {
   return !!msg && typeof msg === "object" && msg.kind === REQUEST_KIND && msg.v === KVIEWER_EMBED_PROTOCOL_VERSION;
 }

package/dist/runtime/i18n/messages.d.ts

@@ -15,6 +15,7 @@ export declare const messages: {
         readonly clear: "Clear";
         readonly delete: "Delete";
         readonly download: "Download";
+        readonly print: "Print";
         readonly search: "Search";
         readonly marqueeSelect: "Marquee select";
         readonly eraser: "Eraser";
@@ -141,6 +142,7 @@ export declare const messages: {
         readonly clear: "Leeren";
         readonly delete: "Löschen";
         readonly download: "Herunterladen";
+        readonly print: "Drucken";
         readonly search: "Suchen";
         readonly marqueeSelect: "Mehrfachauswahl";
         readonly eraser: "Radierer";

package/dist/runtime/i18n/messages.js

@@ -7,6 +7,7 @@ export const messages = {
     clear: "Clear",
     delete: "Delete",
     download: "Download",
+    print: "Print",
     // Toolbar
     search: "Search",
     marqueeSelect: "Marquee select",
@@ -140,6 +141,7 @@ export const messages = {
     clear: "Leeren",
     delete: "L\xF6schen",
     download: "Herunterladen",
+    print: "Drucken",
     search: "Suchen",
     marqueeSelect: "Mehrfachauswahl",
     eraser: "Radierer",

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

@@ -1,13 +1,14 @@
 export type { ExportPdfOptions } from './annotation/pdf-export/export.js';
 export type { ViewerTabItem, AddTabOptions } from './components/ViewerTabs.vue.js';
-export type { AddFormFieldPayload, CheckboxStyle, FormFieldDefinition, FormFieldOrigin, FormFieldType, FormFieldValue, PlacedFieldDefaultProps, PlacedFieldDefaults, SignatureData, SignatureFieldStatus, SignatureHandlers, } from './annotation/engine/types.js';
+export type { AddFormFieldPayload, CheckboxStyle, FormFieldDefinition, FormFieldOrigin, FormFieldType, FormFieldValue, IAnnotationStore, PlacedFieldDefaultProps, PlacedFieldDefaults, SignatureData, SignatureFieldStatus, SignatureHandlers, } from './annotation/engine/types.js';
 export type { ViewMode } from './composables/viewMode.js';
 export type { ViewerState, ActiveTool } from './composables/useViewerState.js';
-export type { KViewerApi, KViewerEmbedBridgeOptions, } from './embed/bridge-host.js';
+export type { KViewerApi, KViewerHostApi, KViewerEmbedBridgeOptions, } from './embed/bridge-host.js';
 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 { KVIEWER_EMBED_PROTOCOL_VERSION } 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';
 export type { ViewerToolId, ViewerTopToolId, ViewerBottomToolId, ViewerLayoutToolId, ViewerToolEntry, ViewerToolSlot, } from './toolbar-tools.js';

package/dist/runtime/public-types.js

@@ -1,3 +1,6 @@
 export { useKViewerEmbedBridge } from "./embed/bridge-host.js";
 export { KViewerEmbedClient } from "./embed/bridge-client.js";
-export { KVIEWER_EMBED_PROTOCOL_VERSION } from "./embed/protocol.js";
+export {
+  KVIEWER_EMBED_PROTOCOL_VERSION,
+  UNSUPPORTED_METHOD_ERROR_NAME as KVIEWER_EMBED_UNSUPPORTED_METHOD_ERROR_NAME
+} from "./embed/protocol.js";

package/dist/runtime/selection-items.d.ts

@@ -0,0 +1,61 @@
+import type { InjectionKey, Ref } from 'vue';
+import type { FormFieldDefinition, IAnnotationStore } from './annotation/engine/types.js';
+/** What the floating selection popover is currently attached to. Passed to
+ *  every custom-item callback so a single item list can serve both the
+ *  Konva annotation selection and the HTML placed-field selection. */
+export interface ViewerSelectionContext {
+    /** `'annotation'` = Konva-drawn annotation(s); `'field'` = a user-placed
+     *  HTML form field (e.g. a signature field). */
+    kind: 'annotation' | 'field';
+    /** The selected annotation(s): one entry for a single selection, several
+     *  for a marquee multi-select, empty when `kind` is `'field'`. */
+    annotations: IAnnotationStore[];
+    /** The selected placed form field. Null when `kind` is `'annotation'`. */
+    field: FormFieldDefinition | null;
+}
+/** A custom control appended to the floating selection popover shown when
+ *  an annotation or a placed form field is selected. Pass an array of
+ *  these to `<KViewer :selection-items="...">` (or `<KViewerTabs>`).
+ *
+ *  Mirrors the `menuItems` discriminated-union pattern; scoped to the
+ *  controls a compact floating toolbar can carry. */
+export type ViewerSelectionItem = ViewerSelectionButtonItem | ViewerSelectionSelectItem;
+export interface ViewerSelectionButtonItem {
+    type: 'button';
+    /** Stable key for Vue list rendering. Keep unique within the array. */
+    key: string;
+    /** Tooltip / accessible label. Rendered as text when no icon is set. */
+    label: string;
+    /** Lucide-style icon name. When set, the button is icon-only. */
+    icon?: string;
+    /** Fired on click with the current selection. */
+    onSelect: (ctx: ViewerSelectionContext) => void;
+    /** Disables the item without removing it. */
+    disabled?: boolean;
+    /** Show the item only for selections this predicate accepts. Omit to
+     *  show it for both annotation and field selections. */
+    visible?: (ctx: ViewerSelectionContext) => boolean;
+}
+export interface ViewerSelectionSelectItem {
+    type: 'select';
+    key: string;
+    /** Accessible label / tooltip for the select. */
+    label?: string;
+    /** Options shown in the dropdown. */
+    items: {
+        label: string;
+        value: string;
+    }[];
+    /** Current value — a plain (reactive) string, or a getter deriving it
+     *  from the current selection. */
+    value?: string | ((ctx: ViewerSelectionContext) => string | undefined);
+    placeholder?: string;
+    /** Fired with the chosen option value and the current selection. */
+    onUpdate: (value: string, ctx: ViewerSelectionContext) => void;
+    disabled?: boolean;
+    visible?: (ctx: ViewerSelectionContext) => boolean;
+}
+/** Provided by KViewer so both selection popovers (the Konva annotation
+ *  toolbar and the placed-field toolbar, which lives deep inside the page
+ *  DOM layer) can read the host's items without prop-drilling. */
+export declare const SELECTION_ITEMS_KEY: InjectionKey<Ref<ViewerSelectionItem[] | undefined>>;

package/dist/runtime/selection-items.js

@@ -0,0 +1 @@
+export const SELECTION_ITEMS_KEY = Symbol("kviewer-selection-items");

package/dist/runtime/toolbar-tools.d.ts

@@ -1,7 +1,10 @@
 import type { InjectionKey, Ref } from 'vue';
 import { AnnotationType } from './annotation/engine/types.js';
 /** Built-in tools that live in the top navigation row. Each maps to a
- *  whole self-contained sub-component. `hand` / `marquee` are readonly-gated. */
+ *  whole self-contained sub-component. `hand` / `marquee` are readonly-gated.
+ *  `marquee` has no button in the default toolbar — hand mode rubber-band
+ *  selects on empty-space mouse drags; the dedicated mode remains for hosts
+ *  that want touch-capable multi-select via the `tools` prop. */
 export type ViewerTopToolId = 'menu' | 'pageSettings' | 'zoom' | 'hand' | 'marquee' | 'pageInfo' | 'search';
 /** Built-in tools that live in the second (annotation) row, controlled
  *  per individual button. IDs match the annotation `name` in

package/dist/types.d.mts

@@ -1,4 +1,4 @@
-export { type ActiveTool, type AddFormFieldPayload, type CheckboxStyle, type ExportPdfOptions, type FormFieldDefinition, type FormFieldOrigin, type FormFieldType, type FormFieldValue, type KVIEWER_EMBED_PROTOCOL_VERSION, type KViewerApi, type KViewerEmbedBridgeOptions, type KViewerEmbedClient, type KViewerEmbedClientOptions, type KViewerEmbedEventName, type KViewerEmbedEventPayloads, type KViewerEmbedMethodName, type PlacedFieldDefaults, type SignatureData, type SignatureFieldStatus, type SignatureHandlers, type ViewMode, type ViewerBottomToolId, type ViewerLayoutToolId, type ViewerMenuButtonItem, type ViewerMenuCheckboxItem, type ViewerMenuItem, type ViewerMenuSeparatorItem, type ViewerState, type ViewerToolEntry, type ViewerToolId, type ViewerToolSlot, type ViewerTopToolId, type useKViewerEmbedBridge } from '../dist/runtime/public-types.js'
+export { type ActiveTool, type AddFormFieldPayload, type CheckboxStyle, type ExportPdfOptions, type FormFieldDefinition, type FormFieldOrigin, type FormFieldType, type FormFieldValue, type IAnnotationStore, type KVIEWER_EMBED_PROTOCOL_VERSION, type KVIEWER_EMBED_UNSUPPORTED_METHOD_ERROR_NAME, type KViewerApi, type KViewerEmbedBridgeOptions, type KViewerEmbedClient, type KViewerEmbedClientOptions, type KViewerEmbedEventName, type KViewerEmbedEventPayloads, type KViewerEmbedMethodName, type KViewerHostApi, type PlacedFieldDefaults, type SignatureData, type SignatureFieldStatus, type SignatureHandlers, type ViewMode, type ViewerBottomToolId, type ViewerLayoutToolId, type ViewerMenuButtonItem, type ViewerMenuCheckboxItem, type ViewerMenuItem, type ViewerMenuSeparatorItem, type ViewerSelectionButtonItem, type ViewerSelectionContext, type ViewerSelectionItem, type ViewerSelectionSelectItem, type ViewerState, type ViewerToolEntry, type ViewerToolId, type ViewerToolSlot, type ViewerTopToolId, type useKViewerEmbedBridge } from '../dist/runtime/public-types.js'
 
 export { default } from './module.mjs'
 

package/package.json

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