flipbookengine 0.6.5 → 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.
- package/CHANGELOG.md +115 -75
- package/README.md +429 -295
- package/dist/components/AnnotationPlacement.d.ts +5 -0
- package/dist/components/AnnotationPopover.d.ts +10 -0
- package/dist/components/App.d.ts +26 -0
- package/dist/components/HotspotLayer.d.ts +14 -0
- package/dist/components/NoteEditor.d.ts +13 -0
- package/dist/components/NotePlacementLayer.d.ts +11 -0
- package/dist/components/NotesPanel.d.ts +17 -0
- package/dist/components/PluginPanels.d.ts +5 -0
- package/dist/components/ReaderHelp.d.ts +3 -0
- package/dist/components/ReaderShortcuts.d.ts +16 -0
- package/dist/components/SearchPanel.d.ts +11 -0
- package/dist/components/TableOfContents.d.ts +1 -0
- package/dist/components/TextLayer.d.ts +8 -0
- package/dist/components/Toolbar.d.ts +7 -1
- package/dist/components/ToolbarMore.d.ts +6 -0
- package/dist/components/Viewer.d.ts +8 -0
- package/dist/core/LayoutManager.d.ts +1 -1
- package/dist/core/PdfRenderer.d.ts +11 -0
- package/dist/core/TextLayerLoader.d.ts +5 -0
- package/dist/core/domSignal.d.ts +2 -0
- package/dist/core-entry.d.ts +14 -0
- package/dist/core.d.ts +1 -0
- package/dist/embed.d.ts +80 -0
- package/dist/engine-DD5qEHLm.js +4657 -0
- package/dist/engine-DD5qEHLm.js.map +1 -0
- package/dist/engine.d.ts +124 -0
- package/dist/feature-Cicli9ie.js +17 -0
- package/dist/feature-Cicli9ie.js.map +1 -0
- package/dist/flipbook-engine.core.js +8 -0
- package/dist/flipbook-engine.core.js.map +1 -0
- package/dist/flipbook-engine.css +1 -1
- package/dist/flipbook-engine.iife.js +51 -55
- package/dist/flipbook-engine.iife.js.map +1 -1
- package/dist/flipbook-engine.js +10 -6
- package/dist/flipbook-engine.js.map +1 -1
- package/dist/flipbook-engine.plugins-annotations.js +14 -0
- package/dist/flipbook-engine.plugins-annotations.js.map +1 -0
- package/dist/flipbook-engine.plugins-bookmarks.js +16 -0
- package/dist/flipbook-engine.plugins-bookmarks.js.map +1 -0
- package/dist/flipbook-engine.plugins-deep-link.js +14 -0
- package/dist/flipbook-engine.plugins-deep-link.js.map +1 -0
- package/dist/flipbook-engine.plugins-hotspots.js +15 -0
- package/dist/flipbook-engine.plugins-hotspots.js.map +1 -0
- package/dist/flipbook-engine.plugins-notes.js +16 -0
- package/dist/flipbook-engine.plugins-notes.js.map +1 -0
- package/dist/flipbook-engine.plugins-search.js +15 -0
- package/dist/flipbook-engine.plugins-search.js.map +1 -0
- package/dist/flipbook-engine.plugins-share.js +13 -0
- package/dist/flipbook-engine.plugins-share.js.map +1 -0
- package/dist/flipbook-engine.plugins-toc.js +14 -0
- package/dist/flipbook-engine.plugins-toc.js.map +1 -0
- package/dist/flipbook-engine.plugins.js +5 -0
- package/dist/flipbook-engine.plugins.js.map +1 -0
- package/dist/flipbook-engine.react.js +1 -1
- package/dist/flipbook-engine.vue.js +1 -1
- package/dist/i18n/locales/en.d.ts +39 -0
- package/dist/i18n/locales/tr.d.ts +39 -0
- package/dist/i18n/service.d.ts +117 -0
- package/dist/index-BhTR2SK6.js +366 -0
- package/dist/index-BhTR2SK6.js.map +1 -0
- package/dist/index.d.ts +10 -0
- package/dist/model/annotations.d.ts +15 -0
- package/dist/model/backend.d.ts +8 -0
- package/dist/model/hotspots.d.ts +40 -0
- package/dist/model/note-editor.d.ts +22 -0
- package/dist/model/search.d.ts +25 -0
- package/dist/model/text-layer.d.ts +21 -0
- package/dist/plugins/annotations.d.ts +4 -0
- package/dist/plugins/bookmarks.d.ts +4 -0
- package/dist/plugins/deep-link.d.ts +4 -0
- package/dist/plugins/feature.d.ts +5 -0
- package/dist/plugins/hotspots.d.ts +4 -0
- package/dist/plugins/index.d.ts +65 -0
- package/dist/plugins/notes.d.ts +4 -0
- package/dist/plugins/search.d.ts +4 -0
- package/dist/plugins/share.d.ts +4 -0
- package/dist/plugins/toc.d.ts +4 -0
- package/dist/plugins-annotations.d.ts +1 -0
- package/dist/plugins-bookmarks.d.ts +1 -0
- package/dist/plugins-deep-link.d.ts +1 -0
- package/dist/plugins-hotspots.d.ts +1 -0
- package/dist/plugins-notes.d.ts +1 -0
- package/dist/plugins-search.d.ts +1 -0
- package/dist/plugins-share.d.ts +1 -0
- package/dist/plugins-toc.d.ts +1 -0
- package/dist/plugins.d.ts +1 -0
- package/dist/state/store.d.ts +35 -5
- package/dist/vue/index.d.ts +1 -1
- package/docs/api-reference.md +228 -0
- package/docs/backend-text-layers.md +40 -0
- package/docs/frameworks.md +73 -0
- package/docs/getting-started.md +128 -0
- package/docs/i18n.md +47 -0
- package/docs/migration-0.4.0.md +24 -0
- package/docs/migration-0.5.0.md +25 -0
- package/docs/migration-1.0.0.md +59 -0
- package/docs/plugin-architecture.md +103 -0
- package/docs/release-checklist.md +37 -0
- package/docs/theming.md +61 -0
- package/package.json +52 -1
- package/dist/engine-DhQ2zxpm.js +0 -3535
- package/dist/engine-DhQ2zxpm.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,75 +1,115 @@
|
|
|
1
|
-
# Changelog
|
|
2
|
-
|
|
3
|
-
##
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
-
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
-
|
|
25
|
-
- added
|
|
26
|
-
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
- added
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
-
|
|
65
|
-
-
|
|
66
|
-
- added
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
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
|
|
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
|
|
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
|
|
115
|
+
- added contribution, security, and trademark policy documents
|