flipbookengine 1.0.0 → 1.0.2

package/dist/flipbook-engine.js

@@ -1,4 +1,4 @@
-import { F as e, a as i, c as s, i as l, b as r, n as b, d as p } from "./engine-Dt2Fn6O-.js";
+import { F as e, a as i, c as s, i as l, b as r, n as b, d as p } from "./engine-DD5qEHLm.js";
 import { F as n } from "./index-BhTR2SK6.js";
 export {
   e as FlipbookEmbedBridge,

package/dist/flipbook-engine.react.js

@@ -1,6 +1,6 @@
 import { jsx as m } from "react/jsx-runtime";
 import { forwardRef as P, useRef as g, useImperativeHandle as x, useEffect as c } from "react";
-import { a as d } from "./engine-Dt2Fn6O-.js";
+import { a as d } from "./engine-DD5qEHLm.js";
 const v = P(({
   className: a,
   style: f,

package/dist/flipbook-engine.vue.js

@@ -1,5 +1,5 @@
 import { defineComponent as d, ref as s, onMounted as g, onBeforeUnmount as P, watch as l, h as c } from "vue";
-import { a as h } from "./engine-Dt2Fn6O-.js";
+import { a as h } from "./engine-DD5qEHLm.js";
 const v = d({
   name: "Flipbook",
   props: {

package/dist/i18n/locales/en.d.ts

@@ -36,4 +36,26 @@ export declare const enMessages: {
     readonly searchUnavailable: "Text search is available only in Direct PDF mode.";
     readonly closeHotspot: "Close popup";
     readonly annotation: "Page annotation";
+    readonly saving: "Saving…";
+    readonly noteFailed: "Could not save the note. Your draft is retained; try again.";
+    readonly searching: "Searching…";
+    readonly searchFailed: "Search failed. Try again.";
+    readonly closeContents: "Close table of contents";
+    readonly moreActions: "More actions";
+    readonly sound: "Sound";
+    readonly myNotes: "My notes";
+    readonly currentPage: "This page";
+    readonly allNotes: "All notes";
+    readonly privateNotes: "Your personal notes for this document.";
+    readonly noNotes: "No notes yet. Select a place on the page to add your first note.";
+    readonly addNote: "Place a note";
+    readonly pageHasNote: "This page has a note";
+    readonly page: "Page";
+    readonly noteSaved: "Saved";
+    readonly confirmDeleteNote: "Delete this note?";
+    readonly cancel: "Cancel";
+    readonly placeNote: "Click or tap a place on the page for your note.";
+    readonly keyboardShortcuts: "Keyboard shortcuts";
+    readonly textSelection: "Select text";
+    readonly resetZoom: "Fit page";
 };

package/dist/i18n/locales/tr.d.ts

@@ -36,4 +36,26 @@ export declare const trMessages: {
     readonly searchUnavailable: "Metin arama yalnızca Doğrudan PDF modunda desteklenir.";
     readonly closeHotspot: "Açılır pencereyi kapat";
     readonly annotation: "Sayfa açıklaması";
+    readonly saving: "Kaydediliyor…";
+    readonly noteFailed: "Not kaydedilemedi. Taslağınız korundu; tekrar deneyin.";
+    readonly searching: "Aranıyor…";
+    readonly searchFailed: "Arama başarısız oldu. Tekrar deneyin.";
+    readonly closeContents: "İçindekileri kapat";
+    readonly moreActions: "Diğer işlemler";
+    readonly sound: "Ses";
+    readonly myNotes: "Notlarım";
+    readonly currentPage: "Bu sayfa";
+    readonly allNotes: "Tüm notlar";
+    readonly privateNotes: "Bu belge için kişisel notlarınız.";
+    readonly noNotes: "Henüz not yok. İlk notunuz için sayfada bir yer seçin.";
+    readonly addNote: "Konuma not ekle";
+    readonly pageHasNote: "Bu sayfada not var";
+    readonly page: "Sayfa";
+    readonly noteSaved: "Kaydedildi";
+    readonly confirmDeleteNote: "Bu not silinsin mi?";
+    readonly cancel: "Vazgeç";
+    readonly placeNote: "Not eklemek için sayfada bir yere tıklayın veya dokunun.";
+    readonly keyboardShortcuts: "Klavye kısayolları";
+    readonly textSelection: "Metin seçimi";
+    readonly resetZoom: "Sayfaya sığdır";
 };

package/dist/i18n/service.d.ts

@@ -5,6 +5,7 @@
  * https://flipbookengine.com
  */
 export interface FlipbookMessages {
+    textSelection: string;
     emptyStateTitle: string;
     thumbnails: string;
     singlePageMode: string;
@@ -36,6 +37,27 @@ export interface FlipbookMessages {
     searchUnavailable: string;
     closeHotspot: string;
     annotation: string;
+    saving: string;
+    noteFailed: string;
+    searching: string;
+    searchFailed: string;
+    closeContents: string;
+    moreActions: string;
+    sound: string;
+    myNotes: string;
+    currentPage: string;
+    allNotes: string;
+    privateNotes: string;
+    noNotes: string;
+    addNote: string;
+    pageHasNote: string;
+    page: string;
+    noteSaved: string;
+    confirmDeleteNote: string;
+    cancel: string;
+    placeNote: string;
+    keyboardShortcuts: string;
+    resetZoom: string;
 }
 export declare const builtInMessages: {
     readonly en: {
@@ -70,6 +92,28 @@ export declare const builtInMessages: {
         readonly searchUnavailable: "Text search is available only in Direct PDF mode.";
         readonly closeHotspot: "Close popup";
         readonly annotation: "Page annotation";
+        readonly saving: "Saving…";
+        readonly noteFailed: "Could not save the note. Your draft is retained; try again.";
+        readonly searching: "Searching…";
+        readonly searchFailed: "Search failed. Try again.";
+        readonly closeContents: "Close table of contents";
+        readonly moreActions: "More actions";
+        readonly sound: "Sound";
+        readonly myNotes: "My notes";
+        readonly currentPage: "This page";
+        readonly allNotes: "All notes";
+        readonly privateNotes: "Your personal notes for this document.";
+        readonly noNotes: "No notes yet. Select a place on the page to add your first note.";
+        readonly addNote: "Place a note";
+        readonly pageHasNote: "This page has a note";
+        readonly page: "Page";
+        readonly noteSaved: "Saved";
+        readonly confirmDeleteNote: "Delete this note?";
+        readonly cancel: "Cancel";
+        readonly placeNote: "Click or tap a place on the page for your note.";
+        readonly keyboardShortcuts: "Keyboard shortcuts";
+        readonly textSelection: "Select text";
+        readonly resetZoom: "Fit page";
     };
     readonly tr: {
         readonly emptyStateTitle: "Veri bulunamadi.";
@@ -103,6 +147,28 @@ export declare const builtInMessages: {
         readonly searchUnavailable: "Metin arama yalnızca Doğrudan PDF modunda desteklenir.";
         readonly closeHotspot: "Açılır pencereyi kapat";
         readonly annotation: "Sayfa açıklaması";
+        readonly saving: "Kaydediliyor…";
+        readonly noteFailed: "Not kaydedilemedi. Taslağınız korundu; tekrar deneyin.";
+        readonly searching: "Aranıyor…";
+        readonly searchFailed: "Arama başarısız oldu. Tekrar deneyin.";
+        readonly closeContents: "İçindekileri kapat";
+        readonly moreActions: "Diğer işlemler";
+        readonly sound: "Ses";
+        readonly myNotes: "Notlarım";
+        readonly currentPage: "Bu sayfa";
+        readonly allNotes: "Tüm notlar";
+        readonly privateNotes: "Bu belge için kişisel notlarınız.";
+        readonly noNotes: "Henüz not yok. İlk notunuz için sayfada bir yer seçin.";
+        readonly addNote: "Konuma not ekle";
+        readonly pageHasNote: "Bu sayfada not var";
+        readonly page: "Sayfa";
+        readonly noteSaved: "Kaydedildi";
+        readonly confirmDeleteNote: "Bu not silinsin mi?";
+        readonly cancel: "Vazgeç";
+        readonly placeNote: "Not eklemek için sayfada bir yere tıklayın veya dokunun.";
+        readonly keyboardShortcuts: "Klavye kısayolları";
+        readonly textSelection: "Metin seçimi";
+        readonly resetZoom: "Sayfaya sığdır";
     };
 };
 export type FlipbookLocale = keyof typeof builtInMessages;

package/dist/index.d.ts

@@ -7,9 +7,11 @@
 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 type { FlipbookTocEntry } from './model/toc';
+export type { FlipbookSearchProvider, FlipbookNoteProvider, FlipbookAnnotationProvider } from './model/backend';
 export type { FlipbookSearchHighlight, FlipbookSearchResult, FlipbookSearchOptions } from './model/search';
 export type { FlipbookHotspot, FlipbookHotspotKind, FlipbookHotspotMedia, FlipbookHotspotMediaType, FlipbookHotspotGalleryItem } from './model/hotspots';
 export type { FlipbookAnnotation } from './model/annotations';
+export type { FlipbookNoteDocument, FlipbookNoteValue, FlipbookNoteEditor, FlipbookNoteEditorFactory } from './model/note-editor';
 export { FlipbookPluginRegistry } from './plugins';
 export type { FlipbookPlugin, FlipbookPluginContext, FlipbookPluginApiHandler, FlipbookPluginEventHandler, FlipbookPluginPanel, FlipbookPluginToolbarButton } from './plugins';
 export { normalizeFlipbookToc } from './model/toc';
@@ -20,3 +22,4 @@ export type { PdfPageMode, PdfPageLayout } from './core/PdfRenderer';
 export { isA3Landscape } from './core/PdfRenderer';
 export { FlipbookEmbedBridge, createFlipbookEmbedController } from './embed';
 export type { FlipbookEmbedOptions, FlipbookEmbedCommandName, FlipbookEmbedCommand, FlipbookEmbedEvent, FlipbookEmbedResponse, FlipbookEmbedState, FlipbookEmbedController } from './embed';
+export type { FlipbookTextRun, FlipbookTextPage, FlipbookTextLayerProvider } from './model/text-layer';

package/dist/model/annotations.d.ts

@@ -5,6 +5,7 @@
  */
 /** A host-provided note marker anchored to a logical page using 0..1 coordinates. */
 export interface FlipbookAnnotation {
+    document?: import('./note-editor').FlipbookNoteDocument;
     id: string;
     pageIndex: number;
     x: number;

package/dist/model/backend.d.ts

@@ -0,0 +1,8 @@
+import { FlipbookSearchOptions, FlipbookSearchResult } from './search';
+import { FlipbookAnnotation } from './annotations';
+import { FlipbookNoteDocument } from './note-editor';
+
+/** Host-owned storage and authorization stay outside the viewer. Indexes are zero-based. */
+export type FlipbookSearchProvider = (query: string, options: FlipbookSearchOptions, signal: AbortSignal) => Promise<FlipbookSearchResult[]>;
+export type FlipbookNoteProvider = (pageIndex: number, note: string | null, signal: AbortSignal, document?: FlipbookNoteDocument) => Promise<void>;
+export type FlipbookAnnotationProvider = (annotation: FlipbookAnnotation, action: 'save' | 'delete', signal: AbortSignal) => Promise<void>;

package/dist/model/note-editor.d.ts

@@ -0,0 +1,22 @@
+export interface FlipbookNoteMark {
+    type: string;
+    attrs?: Record<string, string | null>;
+}
+export interface FlipbookNoteDocument {
+    type: string;
+    text?: string;
+    content?: FlipbookNoteDocument[];
+    marks?: FlipbookNoteMark[];
+}
+export interface FlipbookNoteValue {
+    text: string;
+    document?: FlipbookNoteDocument;
+}
+export interface FlipbookNoteEditor {
+    getValue(): FlipbookNoteValue;
+    setReadOnly(value: boolean): void;
+    destroy(): void;
+}
+export type FlipbookNoteEditorFactory = (container: HTMLElement, value: FlipbookNoteValue, signal: AbortSignal) => FlipbookNoteEditor | Promise<FlipbookNoteEditor>;
+/** Render a restricted document as DOM nodes. Raw HTML is never accepted. */
+export declare function renderNoteDocument(value: FlipbookNoteDocument | undefined, fallback: string): HTMLElement;

package/dist/model/text-layer.d.ts

@@ -0,0 +1,21 @@
+/** Backend-owned text in logical-page, top-left, normalized coordinates. */
+export interface FlipbookTextRun {
+    text: string;
+    start: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    direction?: 'ltr' | 'rtl';
+}
+export interface FlipbookTextPage {
+    schemaVersion: 1;
+    pageIndex: number;
+    /** Immutable source/extraction generation, shared with the image manifest. */
+    revision: string;
+    text: string;
+    runs: FlipbookTextRun[];
+}
+export type FlipbookTextLayerProvider = (pageIndex: number, signal: AbortSignal) => Promise<FlipbookTextPage | null>;
+/** Reject invalid host data before creating DOM or CSS. Run offsets use UTF-16 code units. */
+export declare function validateTextPage(page: FlipbookTextPage, index: number): FlipbookTextPage;

package/dist/state/store.d.ts

@@ -1,3 +1,4 @@
+import { FlipbookTextPage } from '../model/text-layer';
 import { Signal, ReadonlySignal } from '@preact/signals-core';
 import { FlipbookThemeMode } from '../theme/theme';
 import { NormalizedFlipbookPage } from '../model/pages';
@@ -7,6 +8,7 @@ import { PartialFlipbookMessages } from '../i18n/service';
 import { FlipbookSearchResult } from '../model/search';
 import { FlipbookHotspot } from '../model/hotspots';
 import { FlipbookAnnotation } from '../model/annotations';
+import { FlipbookNoteDocument, FlipbookNoteEditorFactory } from '../model/note-editor';
 
 export type FlipState = 'read' | 'fold_corner' | 'flipping';
 export type Orientation = 'landscape' | 'portrait';
@@ -18,6 +20,20 @@ export interface ZoomState {
     scale: number;
 }
 export interface FlipbookStore {
+    textAvailable: Signal<boolean>;
+    textPages: Signal<ReadonlyMap<number, FlipbookTextPage>>;
+    textSelection: Signal<boolean>;
+    pageNoteDocuments: Signal<ReadonlyMap<number, FlipbookNoteDocument>>;
+    noteEditor: Signal<FlipbookNoteEditorFactory | undefined>;
+    canAnnotate: Signal<boolean>;
+    placingNote: Signal<boolean>;
+    pendingAnnotation: Signal<FlipbookAnnotation | null>;
+    notesView: Signal<'page' | 'all'>;
+    searchAvailable: Signal<boolean>;
+    searchBusy: Signal<boolean>;
+    searchFailed: Signal<boolean>;
+    notesSaving: Signal<boolean>;
+    notesFailed: Signal<boolean>;
     currentPage: Signal<number>;
     totalPages: Signal<number>;
     isSingleMode: Signal<boolean>;