kviewer 0.1.0 → 0.1.2

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

@@ -0,0 +1,105 @@
+import type { ExportPdfOptions } from '../annotation/pdf-export/export.js';
+import type { AddFormFieldPayload, FormFieldDefinition, FormFieldValue, IAnnotationStore } from '../annotation/engine/types.js';
+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";
+export type ImportAnnotationsMode = 'replace' | 'merge';
+export interface MethodSignatures {
+    getAnnotations: {
+        args: [];
+        result: IAnnotationStore[];
+    };
+    importAnnotations: {
+        args: [annotations: IAnnotationStore[], options?: {
+            mode?: ImportAnnotationsMode;
+        }];
+        result: {
+            loaded: number;
+            skipped: number;
+        };
+    };
+    exportPdf: {
+        args: [options?: ExportPdfOptions];
+        result: Uint8Array;
+    };
+    getFormFieldValues: {
+        args: [];
+        result: FormFieldValue[];
+    };
+    setFormFieldValue: {
+        args: [fieldName: string, value: string | boolean | string[]];
+        result: undefined;
+    };
+    addFormField: {
+        args: [payload: AddFormFieldPayload];
+        result: FormFieldDefinition;
+    };
+    updateFormField: {
+        args: [id: string, patch: Partial<FormFieldDefinition>];
+        result: undefined;
+    };
+    removeFormField: {
+        args: [id: string];
+        result: undefined;
+    };
+    getFormFields: {
+        args: [];
+        result: FormFieldDefinition[];
+    };
+    getFormEditMode: {
+        args: [];
+        result: boolean;
+    };
+    setFormEditMode: {
+        args: [enabled: boolean];
+        result: undefined;
+    };
+    toggleFormEditMode: {
+        args: [];
+        result: boolean;
+    };
+}
+export type MethodName = keyof MethodSignatures;
+export interface RequestMessage<M extends MethodName = MethodName> {
+    kind: typeof REQUEST_KIND;
+    v: typeof KVIEWER_EMBED_PROTOCOL_VERSION;
+    id: string;
+    method: M;
+    args: MethodSignatures[M]['args'];
+}
+export type ResponseMessage<M extends MethodName = MethodName> = {
+    kind: typeof RESPONSE_KIND;
+    v: typeof KVIEWER_EMBED_PROTOCOL_VERSION;
+    id: string;
+    ok: true;
+    result: MethodSignatures[M]['result'];
+} | {
+    kind: typeof RESPONSE_KIND;
+    v: typeof KVIEWER_EMBED_PROTOCOL_VERSION;
+    id: string;
+    ok: false;
+    error: {
+        message: string;
+        name?: string;
+    };
+};
+export interface EventPayloads {
+    ready: {
+        protocolVersion: number;
+    };
+    'formEditMode-changed': {
+        enabled: boolean;
+    };
+}
+export type EventName = keyof EventPayloads;
+export interface EventMessage<E extends EventName = EventName> {
+    kind: typeof EVENT_KIND;
+    v: typeof KVIEWER_EMBED_PROTOCOL_VERSION;
+    name: E;
+    payload: EventPayloads[E];
+}
+export type AnyMessage = RequestMessage | ResponseMessage | EventMessage;
+export declare function isRequest(msg: unknown): msg is RequestMessage;
+export declare function isResponse(msg: unknown): msg is ResponseMessage;
+export declare function isEvent(msg: unknown): msg is EventMessage;

package/dist/runtime/embed/protocol.js

@@ -0,0 +1,13 @@
+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 function isRequest(msg) {
+  return !!msg && typeof msg === "object" && msg.kind === REQUEST_KIND && msg.v === KVIEWER_EMBED_PROTOCOL_VERSION;
+}
+export function isResponse(msg) {
+  return !!msg && typeof msg === "object" && msg.kind === RESPONSE_KIND && msg.v === KVIEWER_EMBED_PROTOCOL_VERSION;
+}
+export function isEvent(msg) {
+  return !!msg && typeof msg === "object" && msg.kind === EVENT_KIND && msg.v === KVIEWER_EMBED_PROTOCOL_VERSION;
+}

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

@@ -0,0 +1,34 @@
+/** A custom item appended to the viewer's burger menu. Pass an array of
+ *  these to `<KViewer :menu-items="...">` (or `<KViewerTabs>`) to extend
+ *  the menu without replacing the built-in entries.
+ *
+ *  Inspired by Nuxt UI's `UNavigationMenu` items pattern, but scoped to
+ *  the small set of controls a viewer menu needs in practice. */
+export type ViewerMenuItem = ViewerMenuButtonItem | ViewerMenuCheckboxItem | ViewerMenuSeparatorItem;
+export interface ViewerMenuButtonItem {
+    type: 'button';
+    /** Stable key for Vue list rendering. Keep unique within the array. */
+    key: string;
+    label: string;
+    /** Lucide-style icon name passed through to the underlying UButton. */
+    icon?: string;
+    /** Fired on click. */
+    onSelect: () => void;
+    /** Disables the item without removing it. */
+    disabled?: boolean;
+}
+export interface ViewerMenuCheckboxItem {
+    type: 'checkbox';
+    key: string;
+    label: string;
+    icon?: string;
+    /** Current checked state — keep this reactive (Vue will re-render). */
+    checked: boolean;
+    /** Fired with the new state when the user toggles the item. */
+    onUpdate: (checked: boolean) => void;
+    disabled?: boolean;
+}
+export interface ViewerMenuSeparatorItem {
+    type: 'separator';
+    key: string;
+}

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

@@ -2,3 +2,10 @@ 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, SignatureData, SignatureHandlers, } from './annotation/engine/types.js';
 export type { ViewMode } from './composables/viewMode.js';
+export type { KViewerApi, 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 type { ViewerMenuItem, ViewerMenuButtonItem, ViewerMenuCheckboxItem, ViewerMenuSeparatorItem, } from './menu-items.js';

package/dist/runtime/public-types.js

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

package/dist/runtime/style.css

@@ -0,0 +1 @@
+@source "./components/**/*.vue";

package/dist/types.d.mts

@@ -1,4 +1,4 @@
-export { type AddFormFieldPayload, type CheckboxStyle, type ExportPdfOptions, type FormFieldDefinition, type FormFieldOrigin, type FormFieldType, type FormFieldValue, type SignatureData, type SignatureHandlers, type ViewMode } from '../dist/runtime/public-types.js'
+export { 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 SignatureData, type SignatureHandlers, type ViewMode, type ViewerMenuButtonItem, type ViewerMenuCheckboxItem, type ViewerMenuItem, type ViewerMenuSeparatorItem, type useKViewerEmbedBridge } from '../dist/runtime/public-types.js'
 
 export { default } from './module.mjs'
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kviewer",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Kabema PDF Editor",
   "repository": "kabema/kviewer",
   "license": "MIT",
@@ -8,10 +8,12 @@
   "exports": {
     ".": {
       "types": "./dist/types.d.mts",
+      "style": "./dist/runtime/style.css",
       "import": "./dist/module.mjs"
     }
   },
   "main": "./dist/module.mjs",
+  "style": "./dist/runtime/style.css",
   "typesVersions": {
     "*": {
       ".": [
@@ -40,21 +42,21 @@
     "test:e2e:ui": "playwright test --ui"
   },
   "dependencies": {
+    "@iconify-json/lucide": "^1.2.101",
     "@nuxt/kit": "^4.4.2",
+    "@nuxt/ui": "^4.6.0",
     "konva": "^10.2.3",
     "pdf-lib": "^1.17.1",
     "pdfjs-dist": "^5.6.205",
     "tailwindcss": "^4.2.2"
   },
   "devDependencies": {
-    "@iconify-json/lucide": "^1.2.101",
     "@nuxt/devtools": "^3.2.4",
     "@nuxt/eslint": "1.15.2",
     "@nuxt/eslint-config": "^1.15.2",
     "@nuxt/module-builder": "^1.0.2",
     "@nuxt/schema": "^4.4.2",
     "@nuxt/test-utils": "^4.0.0",
-    "@nuxt/ui": "4.6.0",
     "@playwright/test": "^1.59.1",
     "@types/node": "latest",
     "canvas": "^3.2.3",