flipbookengine 0.6.5 → 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,6 +1,11 @@
+import { FlipbookNoteDocument } from '../model/note-editor';
+import { FlipbookSearchOptions } from '../model/search';
+import { FlipbookHotspot } from '../model/hotspots';
+import { FlipbookAnnotation } from '../model/annotations';
 import { FlipbookStore } from '../state/store';
 import { PageFlipAdapter } from '../adapters/PageFlipAdapter';
 import { InteractionManager } from '../core/InteractionManager';
+import { FlipbookPluginRegistry } from '../plugins';
 
 interface AppProps {
     pageFlipAdapterRef: {
@@ -14,8 +19,29 @@ interface AppProps {
     bookContainerRef: (el: HTMLElement) => void;
     className?: string;
     onDownload: () => void;
+    onShare: () => void;
+    onToggleBookmark: () => void;
+    onToggleNotes: () => 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;
+    onCloseSearch: () => void;
+    onSelectSearchResult: (pageIndex: number) => void;
+    onHotspotActivate: (hotspot: FlipbookHotspot) => void;
+    onHotspotClose: () => void;
+    onAnnotationActivate: (annotation: FlipbookAnnotation) => void;
+    onAnnotationClose: () => void;
     onToggleFullscreen: () => void;
     store: FlipbookStore;
+    pluginRegistry?: FlipbookPluginRegistry;
+    signal: AbortSignal;
 }
 export declare function App(props: AppProps): import('@serenity-is/domwise').JSXElement;
 export {};

package/dist/components/HotspotLayer.d.ts

@@ -0,0 +1,14 @@
+import { FlipbookHotspot } from '../model/hotspots';
+import { FlipbookAnnotation } from '../model/annotations';
+import { FlipbookStore } from '../state/store';
+
+interface HotspotLayerProps {
+    store: FlipbookStore;
+    pageIndex: number;
+    onActivate: (hotspot: FlipbookHotspot) => void;
+    onClose: () => void;
+    onAnnotationActivate: (annotation: FlipbookAnnotation) => void;
+    onAnnotationClose: () => void;
+}
+export declare function HotspotLayer(props: HotspotLayerProps): 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

@@ -0,0 +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, document?: FlipbookNoteDocument) => Promise<boolean>;
+    onClear: () => Promise<boolean>;
+    onClose: () => void;
+    onSelect: (pageIndex: number) => void;
+    onAnnotation: (annotation: FlipbookAnnotation) => void;
+    onAdd: () => void;
+    signal: AbortSignal;
+}
+/** 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/PluginPanels.d.ts

@@ -0,0 +1,5 @@
+import { FlipbookPluginRegistry } from '../plugins';
+
+export declare function PluginPanels(props: {
+    registry: FlipbookPluginRegistry;
+}): import('@serenity-is/domwise').JSXElement;

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/SearchPanel.d.ts

@@ -0,0 +1,11 @@
+import { FlipbookStore } from '../state/store';
+
+interface SearchPanelProps {
+    store: FlipbookStore;
+    onSearch: (query: string) => void;
+    onClear: () => void;
+    onClose: () => void;
+    onSelect: (pageIndex: number) => void;
+}
+export declare function SearchPanel(props: SearchPanelProps): import('@serenity-is/domwise').JSXElement;
+export {};

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

@@ -1,18 +1,24 @@
 import { FlipbookStore } from '../state/store';
+import { FlipbookPluginRegistry } from '../plugins';
 
 interface ToolbarProps {
     store: FlipbookStore;
     onToggleThumbs: () => void;
     onToggleToc: () => void;
+    onToggleSearch: () => void;
     onToggleSingleMode: () => void;
     onZoomIn: () => void;
     onZoomOut: () => void;
     onDownload?: () => void;
+    onShare: () => void;
+    onToggleBookmark: () => void;
+    onToggleNotes: () => void;
     onSoundToggle: () => void;
     onNextPage: () => void;
     onPrevPage: () => void;
     onToggleAutoPlay: () => void;
     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

@@ -1,10 +1,18 @@
 import { FlipbookStore } from '../state/store';
+import { FlipbookHotspot } from '../model/hotspots';
+import { FlipbookAnnotation } from '../model/annotations';
 
 interface ViewerProps {
     store: FlipbookStore;
     bookWrapperRef: (el: HTMLElement) => void;
     bookSizerRef: (el: HTMLElement) => void;
     bookContainerRef: (el: HTMLElement) => void;
+    onHotspotActivate: (hotspot: FlipbookHotspot) => void;
+    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/LayoutManager.d.ts

@@ -1,7 +1,7 @@
 import { FlipbookStore } from '../state/store';
 
 /**
- * @license FlipbookEngine v0.6.5
+ * @license FlipbookEngine v1.0.0
  * Copyright (c) 2026 Murat Dogan
  *
  * This source code is dual-licensed under the AGPLv3 and a Commercial License.

package/dist/core/PdfRenderer.d.ts

@@ -1,4 +1,5 @@
 import { NormalizedFlipbookPage } from '../model/pages';
+import { FlipbookSearchOptions, FlipbookSearchHighlight } from '../model/search';
 
 export interface PdfRenderProgress {
     completed: number;
@@ -25,11 +26,21 @@ export declare class PdfRenderer {
     private loadingTask;
     private options;
     private readonly cache;
+    private readonly textCache;
     constructor(options?: PdfRenderOptions);
     /** Loads a PDF document and cancels PDF.js loading when the signal aborts. */
     loadDocument(pdfUrl: string, signal?: AbortSignal): Promise<number>;
     /** Renders a specific page to a Data URL. The page index is 1-based. */
     renderPageToDataUrl(pageIndex: number, signal?: AbortSignal): Promise<string>;
+    /** Extracts text from a 1-based PDF source page using PDF.js text content. */
+    extractPageText(pageNumber: number): Promise<string>;
+    /** Searches all PDF source pages and returns normalized rectangles for matched text. */
+    searchText(query: string, options?: FlipbookSearchOptions): Promise<Array<{
+        sourcePageNumber: number;
+        matches: number;
+        snippet: string;
+        highlights?: FlipbookSearchHighlight[];
+    }>>;
     /** Returns source page dimensions and whether the page should be split. */
     getPageLayouts(mode?: PdfPageMode): Promise<PdfPageLayout[]>;
     /** Calculates the best viewport dimensions based on the first logical page. */

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

@@ -0,0 +1,14 @@
+/**
+ * @license FlipbookEngine v1.0.0
+ * Copyright (c) 2026 Murat Dogan
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+export { FlipbookEngine, type FlipbookEngineOptions, type FlipbookLocaleMessages, type PageImages, type FlipbookEngineEventMap, type FlipbookEngineEventName } from './engine';
+export type { FlipbookPageAsset, FlipbookPageKind, FlipbookCropMode, FlipbookSplitDirection, NormalizedFlipbookPage } from './model/pages';
+export { normalizeFlipbookPages, isFlipbookPageAsset } from './model/pages';
+export type { FlipbookLocale, FlipbookMessages, PartialFlipbookMessages } from './i18n/service';
+export type { FlipbookThemeMode, FlipbookBackgroundStyle, FlipbookBackgrounds } from './theme/theme';
+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';

package/dist/core.d.ts

@@ -0,0 +1 @@
+export * from './core-entry'

package/dist/embed.d.ts

@@ -0,0 +1,80 @@
+import { FlipbookEngine, FlipbookEngineEventMap, FlipbookEngineEventName, FlipbookEngineOptions } from './engine';
+import { FlipbookSearchOptions, FlipbookSearchResult } from './model/search';
+import { FlipbookTocEntry } from './model/toc';
+
+export type FlipbookEmbedCommandName = 'goToPage' | 'nextPage' | 'prevPage' | 'setZoom' | 'setSingleMode' | 'updateOptions' | 'toggleFullscreen' | 'search' | 'clearSearch' | 'getSearchResults' | 'getToc' | 'setToc' | 'getState';
+export interface FlipbookEmbedOptions {
+    /**
+     * Origins allowed to send commands. Defaults to the current origin.
+     * Use an explicit origin for cross-origin iframe integrations.
+     */
+    allowedOrigins?: string[];
+    /** Origin used for messages sent to the embedding parent. */
+    targetOrigin?: string;
+    /** Response timeout for the parent-side controller. */
+    responseTimeout?: number;
+}
+export interface FlipbookEmbedCommand {
+    type: 'flipbook:command';
+    command: FlipbookEmbedCommandName;
+    requestId?: string;
+    payload?: unknown;
+}
+export interface FlipbookEmbedEvent<T extends FlipbookEngineEventName = FlipbookEngineEventName> {
+    type: 'flipbook:event';
+    event: T;
+    payload: FlipbookEngineEventMap[T];
+}
+export interface FlipbookEmbedResponse {
+    type: 'flipbook:response';
+    requestId?: string;
+    ok: boolean;
+    result?: unknown;
+    error?: string;
+}
+export interface FlipbookEmbedState {
+    currentPage: number;
+    totalPages: number;
+    zoom: number;
+}
+/**
+ * Runs inside an iframe and exposes a restricted postMessage command bridge.
+ * Commands are accepted only from window.parent and configured origins.
+ */
+export declare class FlipbookEmbedBridge {
+    private readonly engine;
+    private readonly options;
+    private readonly listener;
+    private readonly unsubs;
+    private connected;
+    private parentOrigin;
+    constructor(engine: FlipbookEngine, options?: FlipbookEmbedOptions);
+    connect(): this;
+    disconnect(): void;
+    private readonly engineEventNames;
+    private isAllowedOrigin;
+    private post;
+    private postEvent;
+    private respond;
+    private handleMessage;
+    private getState;
+}
+export interface FlipbookEmbedController {
+    send(command: FlipbookEmbedCommandName, payload?: unknown): Promise<unknown>;
+    goToPage(pageIndex: number): Promise<FlipbookEmbedState>;
+    nextPage(): Promise<FlipbookEmbedState>;
+    prevPage(): Promise<FlipbookEmbedState>;
+    setZoom(zoom: number): Promise<FlipbookEmbedState>;
+    setSingleMode(isSingle: boolean): Promise<FlipbookEmbedState>;
+    updateOptions(options: Partial<FlipbookEngineOptions>): Promise<FlipbookEmbedState>;
+    toggleFullscreen(): Promise<FlipbookEmbedState>;
+    search(query: string, options?: FlipbookSearchOptions): Promise<FlipbookSearchResult[]>;
+    clearSearch(): Promise<FlipbookEmbedState>;
+    getSearchResults(): Promise<FlipbookSearchResult[]>;
+    getToc(): Promise<FlipbookTocEntry[]>;
+    setToc(entries: FlipbookTocEntry[], show?: boolean): Promise<FlipbookEmbedState>;
+    getState(): Promise<FlipbookEmbedState>;
+    on<T extends FlipbookEngineEventName>(event: T, handler: (payload: FlipbookEngineEventMap[T]) => void): () => void;
+    destroy(): void;
+}
+export declare function createFlipbookEmbedController(iframe: HTMLIFrameElement, options?: FlipbookEmbedOptions): FlipbookEmbedController;