flipbookengine 1.0.0 → 1.0.2

package/dist/components/AnnotationPlacement.d.ts

@@ -0,0 +1,5 @@
+import { FlipbookStore } from '../state/store';
+
+export declare function AnnotationPlacement(props: {
+    store: FlipbookStore;
+}): import('@serenity-is/domwise').JSXElement;

package/dist/components/AnnotationPopover.d.ts

@@ -0,0 +1,10 @@
+import { FlipbookAnnotation } from '../model/annotations';
+import { FlipbookStore } from '../state/store';
+
+export declare function AnnotationPopover(props: {
+    store: FlipbookStore;
+    signal: AbortSignal;
+    onSave: (note: FlipbookAnnotation) => Promise<boolean>;
+    onDelete: (note: FlipbookAnnotation) => Promise<boolean>;
+    onClose: () => void;
+}): import('@serenity-is/domwise').JSXElement;

package/dist/components/App.d.ts

@@ -1,3 +1,4 @@
+import { FlipbookNoteDocument } from '../model/note-editor';
 import { FlipbookSearchOptions } from '../model/search';
 import { FlipbookHotspot } from '../model/hotspots';
 import { FlipbookAnnotation } from '../model/annotations';
@@ -21,8 +22,13 @@ interface AppProps {
     onShare: () => void;
     onToggleBookmark: () => void;
     onToggleNotes: () => void;
-    onSaveNote: (note: string) => void;
-    onClearNote: () => void;
+    onSelectNote: (pageIndex: number) => void;
+    onBeginAnnotation: () => void;
+    onPlaceAnnotation: (pageIndex: number, x: number, y: number) => void;
+    onSaveAnnotation: (annotation: FlipbookAnnotation) => Promise<boolean>;
+    onDeleteAnnotation: (annotation: FlipbookAnnotation) => Promise<boolean>;
+    onSaveNote: (note: string, document?: FlipbookNoteDocument) => Promise<boolean>;
+    onClearNote: () => Promise<boolean>;
     onCloseNotes: () => void;
     onSearch: (query: string, options?: FlipbookSearchOptions) => void;
     onClearSearch: () => void;
@@ -35,6 +41,7 @@ interface AppProps {
     onToggleFullscreen: () => void;
     store: FlipbookStore;
     pluginRegistry?: FlipbookPluginRegistry;
+    signal: AbortSignal;
 }
 export declare function App(props: AppProps): import('@serenity-is/domwise').JSXElement;
 export {};

package/dist/components/NoteEditor.d.ts

@@ -0,0 +1,13 @@
+import { FlipbookNoteEditor, FlipbookNoteEditorFactory, FlipbookNoteValue } from '../model/note-editor';
+
+export declare function NoteEditor(props: {
+    value: FlipbookNoteValue;
+    factory?: FlipbookNoteEditorFactory;
+    signal: AbortSignal;
+    label: string;
+    view: {
+        current: FlipbookNoteEditor | null;
+    };
+    onReady: (ready: boolean) => void;
+    onDraft?: (value: FlipbookNoteValue) => void;
+}): HTMLDivElement;

package/dist/components/NotePlacementLayer.d.ts

@@ -0,0 +1,11 @@
+import { FlipbookStore } from '../state/store';
+
+type Place = (page: number, x: number, y: number) => void;
+export declare function NotePlacementLayer(props: {
+    store: FlipbookStore;
+    pageIndex: number;
+    onPlace: Place;
+}): import('@serenity-is/domwise').JSXElement;
+/** Long press tolerates small finger movement; dragging/pinching always cancels it. */
+export declare function bindNoteGestures(element: HTMLElement, store: FlipbookStore, place: Place, signal: AbortSignal): void;
+export {};

package/dist/components/NotesPanel.d.ts

@@ -1,14 +1,17 @@
 import { FlipbookStore } from '../state/store';
+import { FlipbookAnnotation } from '../model/annotations';
+import { FlipbookNoteDocument } from '../model/note-editor';
 
 interface NotesPanelProps {
     store: FlipbookStore;
-    onSave: (note: string) => void;
-    onClear: () => void;
+    onSave: (note: string, document?: FlipbookNoteDocument) => Promise<boolean>;
+    onClear: () => Promise<boolean>;
     onClose: () => void;
+    onSelect: (pageIndex: number) => void;
+    onAnnotation: (annotation: FlipbookAnnotation) => void;
+    onAdd: () => void;
+    signal: AbortSignal;
 }
-/**
- * Page-level note UI. Persistence remains host-owned through the engine API and
- * noteChange event; the panel intentionally does not know about a backend.
- */
+/** The editor keeps its draft until the host confirms persistence. */
 export declare function NotesPanel(props: NotesPanelProps): import('@serenity-is/domwise').JSXElement;
 export {};

package/dist/components/ReaderHelp.d.ts

@@ -0,0 +1,3 @@
+import { FlipbookStore } from '../state/store';
+
+export declare function showReaderHelp(root: HTMLElement, store: FlipbookStore): void;

package/dist/components/ReaderShortcuts.d.ts

@@ -0,0 +1,16 @@
+import { FlipbookStore } from '../state/store';
+import { InteractionManager } from '../core/InteractionManager';
+import { PageFlipAdapter } from '../adapters/PageFlipAdapter';
+
+export declare function ReaderShortcuts(root: HTMLElement, store: FlipbookStore, commands: {
+    pageFlipAdapterRef: {
+        current: PageFlipAdapter | null;
+    };
+    interactionManagerRef: {
+        current: InteractionManager | null;
+    };
+    onBeginAnnotation: () => void;
+    onToggleNotes: () => void;
+    onToggleFullscreen: () => void;
+    onAnnotationClose: () => void;
+}, signal: AbortSignal): void;

package/dist/components/TableOfContents.d.ts

@@ -1,6 +1,7 @@
 import { FlipbookStore } from '../state/store';
 
 interface TableOfContentsProps {
+    onClose?: () => void;
     store: FlipbookStore;
     onEntryClick: (pageIndex: number) => void;
 }

package/dist/components/TextLayer.d.ts

@@ -0,0 +1,8 @@
+import { FlipbookStore } from '../state/store';
+
+/** Transparent text is loaded independently of the PDF and page image resolution. */
+export declare function TextLayer(props: {
+    store: FlipbookStore;
+    pageIndex: number;
+    signal: AbortSignal;
+}): import('@serenity-is/domwise').JSXElement;

package/dist/components/Toolbar.d.ts

@@ -20,5 +20,5 @@ interface ToolbarProps {
     onToggleFullscreen: () => void;
     pluginRegistry?: FlipbookPluginRegistry;
 }
-export declare function Toolbar(props: ToolbarProps): import('@serenity-is/domwise').JSXElement;
+export declare function Toolbar(props: ToolbarProps): HTMLElement;
 export {};

package/dist/components/ToolbarMore.d.ts

@@ -0,0 +1,6 @@
+import { ReadonlySignal } from '@preact/signals-core';
+import { FlipbookMessages } from '../i18n/service';
+import { FlipbookStore } from '../state/store';
+
+/** Secondary commands retain their original handlers and reactive icons. */
+export declare function attachToolbarMore(toolbar: HTMLElement, messages: ReadonlySignal<FlipbookMessages>, store: FlipbookStore): void;

package/dist/components/Viewer.d.ts

@@ -11,6 +11,8 @@ interface ViewerProps {
     onHotspotClose: () => void;
     onAnnotationActivate: (annotation: FlipbookAnnotation) => void;
     onAnnotationClose: () => void;
+    onPlaceAnnotation: (pageIndex: number, x: number, y: number) => void;
+    signal: AbortSignal;
 }
 export declare function Viewer(props: ViewerProps): import('@serenity-is/domwise').JSXElement;
 export {};

package/dist/core/TextLayerLoader.d.ts

@@ -0,0 +1,5 @@
+import { FlipbookStore } from '../state/store';
+import { FlipbookTextLayerProvider } from '../model/text-layer';
+
+/** At most three visible/adjacent pages; stale requests cannot update a new session. */
+export declare function loadTextLayers(store: FlipbookStore, provider: FlipbookTextLayerProvider, lifetime: AbortSignal): () => void;

package/dist/core/domSignal.d.ts

@@ -0,0 +1,2 @@
+/** DOM event listeners require the AbortSignal from their own document realm. */
+export declare function domSignal(element: HTMLElement, session: AbortSignal): AbortSignal;

package/dist/core-entry.d.ts

@@ -11,3 +11,4 @@ export type { FlipbookThemeMode, FlipbookBackgroundStyle, FlipbookBackgrounds }
 export type { PdfPageMode, PdfPageLayout } from './core/PdfRenderer';
 export { isA3Landscape } from './core/PdfRenderer';
 export type { FlipbookHotspot, FlipbookHotspotKind, FlipbookHotspotMedia, FlipbookHotspotMediaType, FlipbookHotspotGalleryItem } from './model/hotspots';
+export type { FlipbookTextRun, FlipbookTextPage, FlipbookTextLayerProvider } from './model/text-layer';