flipbookengine 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CHANGELOG.md +113 -94
  2. package/README.md +427 -421
  3. package/dist/components/AnnotationPlacement.d.ts +5 -0
  4. package/dist/components/AnnotationPopover.d.ts +10 -0
  5. package/dist/components/App.d.ts +9 -2
  6. package/dist/components/NoteEditor.d.ts +13 -0
  7. package/dist/components/NotePlacementLayer.d.ts +11 -0
  8. package/dist/components/NotesPanel.d.ts +9 -6
  9. package/dist/components/ReaderHelp.d.ts +3 -0
  10. package/dist/components/ReaderShortcuts.d.ts +16 -0
  11. package/dist/components/TableOfContents.d.ts +1 -0
  12. package/dist/components/TextLayer.d.ts +8 -0
  13. package/dist/components/Toolbar.d.ts +1 -1
  14. package/dist/components/ToolbarMore.d.ts +6 -0
  15. package/dist/components/Viewer.d.ts +2 -0
  16. package/dist/core/TextLayerLoader.d.ts +5 -0
  17. package/dist/core/domSignal.d.ts +2 -0
  18. package/dist/core-entry.d.ts +1 -0
  19. package/dist/engine-DD5qEHLm.js +4657 -0
  20. package/dist/engine-DD5qEHLm.js.map +1 -0
  21. package/dist/engine.d.ts +23 -0
  22. package/dist/flipbook-engine.core.js +1 -1
  23. package/dist/flipbook-engine.css +1 -1
  24. package/dist/flipbook-engine.iife.js +34 -47
  25. package/dist/flipbook-engine.iife.js.map +1 -1
  26. package/dist/flipbook-engine.js +1 -1
  27. package/dist/flipbook-engine.react.js +1 -1
  28. package/dist/flipbook-engine.vue.js +1 -1
  29. package/dist/i18n/locales/en.d.ts +22 -0
  30. package/dist/i18n/locales/tr.d.ts +22 -0
  31. package/dist/i18n/service.d.ts +66 -0
  32. package/dist/index.d.ts +3 -0
  33. package/dist/model/annotations.d.ts +1 -0
  34. package/dist/model/backend.d.ts +8 -0
  35. package/dist/model/note-editor.d.ts +22 -0
  36. package/dist/model/text-layer.d.ts +21 -0
  37. package/dist/state/store.d.ts +16 -0
  38. package/docs/api-reference.md +227 -205
  39. package/docs/backend-text-layers.md +40 -0
  40. package/package.json +165 -165
  41. package/dist/engine-Dt2Fn6O-.js +0 -4060
  42. package/dist/engine-Dt2Fn6O-.js.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,96 +1,115 @@
1
- # Changelog
2
-
3
- ## 1.0.0 - 2026-09-14
4
-
5
- - first stable open-source release of the FlipbookEngine viewer
6
- - added framework-agnostic plugin contract with install/uninstall lifecycle, typed events, toolbar buttons, panels, and namespaced APIs
7
- - added independent `flipbookengine/core` and `flipbookengine/plugins/*` entry points for notes, bookmarks, TOC, search, annotations, hotspots, share, and deep links
8
- - added runtime `getToc()/setToc()` APIs and origin-validated iframe TOC read/update commands
9
- - added interactive hotspot overlays with image/video/audio previews, selectable image galleries, and commerce/product links
10
- - added plugin and embed regression coverage; full suite passes 84/84 tests
11
- - documented PDF outline extraction, OCR, analytics, backend rendering, and protected downloads as commercial/backend responsibilities
1
+ # Changelog
2
+
3
+ ## 1.0.2 - 2026-10-24
4
+
5
+ - Native backend search, page-note and coordinate-annotation providers, including multiple note markers per page and host-owned persistence.
6
+ - Optional restricted rich-note editor factory and validated structured-note rendering; native note list, marker popups, edit/delete and failed-save draft retention.
7
+ - Responsive native panels and More actions menu, localized keyboard help, focus restoration and gesture isolation for notes, zoom and page navigation.
8
+ - Optional backend text-layer provider for image/WebP books, with schema v1 normalized logical-page runs and UTF-16 offsets.
9
+ - Bounded current/adjacent-page loading, abort/stale-response isolation, defensive geometry validation and opt-in native text selection.
10
+ - Isolated page images from host padding/margins so normalized overlays align with the complete page viewport.
11
+ - Select-text command in the native More actions menu; Escape exits selection without hijacking page flipping or note gestures.
12
+ - Backend search highlights continue to work independently of a text layer. OCR, persistence and search indexing remain host responsibilities.
13
+ - Muted toolbar and More-menu items no longer show a diagonal strike line; they are only dimmed.
14
+ - Toolbar play/pause and sound icons now switch by rendering a single icon instead of toggling two hidden ones.
15
+ - The bottom toolbar adapts its buttons to the available width.
16
+ - PDF mode renders the previous, current and next pages ahead of time (and the facing page in two-page view), so flipping shows pages without a blank flash; zoom reuses the rendered page image.
17
+ - Page overlays (text layer, search highlights, hotspots, note placement) are drawn only in single-page view where they belong; page images no longer use native lazy loading.
18
+ - The note popover is more compact, with smaller action buttons on mouse devices and touch-sized buttons on touch devices.
19
+ - Removed a duplicate region landmark around the viewer for cleaner screen-reader navigation.
20
+ - Fixed a type error in PDF page rendering when a rendered page has no image data.
21
+
22
+ ## 1.0.0 - 2026-09-14
23
+
24
+ - first stable open-source release of the FlipbookEngine viewer
25
+ - added framework-agnostic plugin contract with install/uninstall lifecycle, typed events, toolbar buttons, panels, and namespaced APIs
26
+ - added independent `flipbookengine/core` and `flipbookengine/plugins/*` entry points for notes, bookmarks, TOC, search, annotations, hotspots, share, and deep links
27
+ - added runtime `getToc()/setToc()` APIs and origin-validated iframe TOC read/update commands
28
+ - added interactive hotspot overlays with image/video/audio previews, selectable image galleries, and commerce/product links
29
+ - added plugin and embed regression coverage; full suite passes 84/84 tests
30
+ - documented PDF outline extraction, OCR, analytics, backend rendering, and protected downloads as commercial/backend responsibilities
12
31
  - breaking change: 0.x releases were alpha/beta and are not compatibility guarantees; applications should validate imports and options against the 1.0 API before upgrading
13
- - 0.8.0 to 1.0.0 migration: documented public entrypoint changes, explicit plugin activation/deactivation, nested TOC/embed APIs, expanded hotspot payloads, and the unchanged image-mode search limitation
14
- - added an origin-validated iframe embed bridge with parent-side command and event helpers
15
- - added opt-in deep links, localized share controls, host-managed bookmarks and notes, and their regression coverage
16
- - added localized notes toolbar/editor; persistence remains with the host application
17
-
18
- ## 0.8.0 - 2026-09-14
19
-
20
- - added precise PDF.js text-match rectangles and logical left/right split-page mapping
21
- - replaced full-page search tint with lightweight text-position highlights
22
- - hardened DOMWise search result rendering so result buttons are not stringified
23
- - unified search and note focus styling with a single thin accent border and glow
24
- - disabled text search in image/WebP page-list mode with localized explanation; download URL handling remains independent
25
- - added localized image-mode messaging and regression coverage
26
-
27
- ## 0.6.5
28
-
29
- - added automatic A3 landscape PDF splitting with configurable auto, single, and split modes
30
- - added source-page-aware lazy rendering for split PDF pages
31
- - added optional light/dark viewer backgrounds and responsive presentation gutters
32
- - enlarged the opt-in thumbnail rail and moved page labels into transparent, high-contrast overlays
33
- - kept thumbnail labels black in both themes and preserved a thin neon selected state
34
- - enabled native mobile scrolling to avoid non-cancelable touchstart interventions
35
- - fixed single-view PDF hydration after switching from spread mode
36
- - added regression coverage for PDF splitting, backgrounds, presentation layout, and PDF hydration
37
-
38
- ## 0.6.0
39
-
40
- - added a localized, theme-aware Table of Contents panel with nested host-provided page entries
41
- - added TOC visibility events, page navigation, normalization, accessibility, and regression tests
42
-
43
- ## 0.5.4
44
-
45
- - restored the modular FlipbookEngine source line after an unreleased post-0.5.3 source regression
46
- - hardened engine lifecycle cleanup, locale API compatibility, and PDF render error propagation
47
- - added regression coverage for the fixes above
48
- - The published 0.5.3 package remains valid; upgrade to 0.5.4 or later for the fixes in this release. The post-tag source regression was not published to npm.
49
-
50
- ## 0.5.3
51
-
52
- - pinned the jsdom test dependency to a Node 18-compatible release so the full CI matrix runs consistently
53
-
54
-
55
-
56
- ## 0.5.2
57
-
58
- - restored the domwise project acknowledgement in the package README
59
- - kept commercial backend roadmap details separate from the open-source viewer documentation
60
-
61
-
62
-
63
- ## 0.5.1
64
-
65
- - removed maintainer-only npm publishing instructions from the package README
66
- - clarified the open-source viewer and commercial backend roadmap
67
-
68
-
69
-
70
- ## 0.5.0
71
-
72
- - added on-demand PDF page rendering with first-page readiness and next-page prefetch
73
- - added bounded per-instance PDF render cache via `pdfRenderCacheSize`
74
- - added React/Vue wrapper, browser E2E, and large-document regression coverage
75
- - added reduced-motion support for JavaScript page turns and CSS transitions
76
- - removed test exception suppression so asynchronous teardown failures surface
77
-
78
-
79
-
80
- ## 0.4.0
81
-
82
- - externalized PDF.js as an npm dependency with consumer-provided worker configuration
83
- - fixed PDF-only initialization when `pages` is omitted
84
- - isolated engine state and lifecycle cancellation per instance
85
- - aligned framework wrappers, events, options, fullscreen, audio, and download controls
86
- - added progressive image quality loading and bounded PDF rendering with cancellation
87
- - added accessibility semantics, structured PDF progress/error events, and expanded regression tests
88
- - added CI dependency audit, reproducible package verification, and provenance-enabled release workflow
89
-
90
- ## 0.1.0
91
-
92
- - renamed public product identity to FlipbookEngine
93
- - introduced dual-license documentation structure
94
- - prepared package metadata for public distribution
95
- - preserved legacy `BizekaFlipEngine` compatibility alias
32
+ - 0.8.0 to 1.0.0 migration: documented public entrypoint changes, explicit plugin activation/deactivation, nested TOC/embed APIs, expanded hotspot payloads, and the unchanged image-mode search limitation
33
+ - added an origin-validated iframe embed bridge with parent-side command and event helpers
34
+ - added opt-in deep links, localized share controls, host-managed bookmarks and notes, and their regression coverage
35
+ - added localized notes toolbar/editor; persistence remains with the host application
36
+
37
+ ## 0.8.0 - 2026-09-14
38
+
39
+ - added precise PDF.js text-match rectangles and logical left/right split-page mapping
40
+ - replaced full-page search tint with lightweight text-position highlights
41
+ - hardened DOMWise search result rendering so result buttons are not stringified
42
+ - unified search and note focus styling with a single thin accent border and glow
43
+ - disabled text search in image/WebP page-list mode with localized explanation; download URL handling remains independent
44
+ - added localized image-mode messaging and regression coverage
45
+
46
+ ## 0.6.5
47
+
48
+ - added automatic A3 landscape PDF splitting with configurable auto, single, and split modes
49
+ - added source-page-aware lazy rendering for split PDF pages
50
+ - added optional light/dark viewer backgrounds and responsive presentation gutters
51
+ - enlarged the opt-in thumbnail rail and moved page labels into transparent, high-contrast overlays
52
+ - kept thumbnail labels black in both themes and preserved a thin neon selected state
53
+ - enabled native mobile scrolling to avoid non-cancelable touchstart interventions
54
+ - fixed single-view PDF hydration after switching from spread mode
55
+ - added regression coverage for PDF splitting, backgrounds, presentation layout, and PDF hydration
56
+
57
+ ## 0.6.0
58
+
59
+ - added a localized, theme-aware Table of Contents panel with nested host-provided page entries
60
+ - added TOC visibility events, page navigation, normalization, accessibility, and regression tests
61
+
62
+ ## 0.5.4
63
+
64
+ - restored the modular FlipbookEngine source line after an unreleased post-0.5.3 source regression
65
+ - hardened engine lifecycle cleanup, locale API compatibility, and PDF render error propagation
66
+ - added regression coverage for the fixes above
67
+ - The published 0.5.3 package remains valid; upgrade to 0.5.4 or later for the fixes in this release. The post-tag source regression was not published to npm.
68
+
69
+ ## 0.5.3
70
+
71
+ - pinned the jsdom test dependency to a Node 18-compatible release so the full CI matrix runs consistently
72
+
73
+
74
+
75
+ ## 0.5.2
76
+
77
+ - restored the domwise project acknowledgement in the package README
78
+ - kept commercial backend roadmap details separate from the open-source viewer documentation
79
+
80
+
81
+
82
+ ## 0.5.1
83
+
84
+ - removed maintainer-only npm publishing instructions from the package README
85
+ - clarified the open-source viewer and commercial backend roadmap
86
+
87
+
88
+
89
+ ## 0.5.0
90
+
91
+ - added on-demand PDF page rendering with first-page readiness and next-page prefetch
92
+ - added bounded per-instance PDF render cache via `pdfRenderCacheSize`
93
+ - added React/Vue wrapper, browser E2E, and large-document regression coverage
94
+ - added reduced-motion support for JavaScript page turns and CSS transitions
95
+ - removed test exception suppression so asynchronous teardown failures surface
96
+
97
+
98
+
99
+ ## 0.4.0
100
+
101
+ - externalized PDF.js as an npm dependency with consumer-provided worker configuration
102
+ - fixed PDF-only initialization when `pages` is omitted
103
+ - isolated engine state and lifecycle cancellation per instance
104
+ - aligned framework wrappers, events, options, fullscreen, audio, and download controls
105
+ - added progressive image quality loading and bounded PDF rendering with cancellation
106
+ - added accessibility semantics, structured PDF progress/error events, and expanded regression tests
107
+ - added CI dependency audit, reproducible package verification, and provenance-enabled release workflow
108
+
109
+ ## 0.1.0
110
+
111
+ - renamed public product identity to FlipbookEngine
112
+ - introduced dual-license documentation structure
113
+ - prepared package metadata for public distribution
114
+ - preserved legacy `BizekaFlipEngine` compatibility alias
96
115
  - added contribution, security, and trademark policy documents