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/package.json CHANGED
@@ -1,165 +1,165 @@
1
- {
2
- "name": "flipbookengine",
3
- "version": "1.0.0",
4
- "description": "A modern, embeddable HTML flipbook engine for PDF-backed catalogs and digital publications.",
5
- "private": false,
6
- "scripts": {
7
- "dev": "vite",
8
- "build": "vite build && vite build --config vite.config.iife.js",
9
- "test": "tsx --loader ./tests/css-loader.js --test tests/*.test.ts",
10
- "test:e2e": "playwright test",
11
- "typecheck": "tsc --noEmit",
12
- "clean": "rimraf dist",
13
- "pack:check": "npm pack --dry-run",
14
- "audit:deps": "npm audit --omit=dev --audit-level=high",
15
- "release:verify": "npm run typecheck && npm test && npm run build && npm run audit:deps && npm run pack:check"
16
- },
17
- "keywords": [
18
- "flipbook",
19
- "catalog",
20
- "pdf",
21
- "viewer",
22
- "publication",
23
- "pageflip",
24
- "digital-catalog",
25
- "page-flip",
26
- "typescript"
27
- ],
28
- "author": "Murat Dogan",
29
- "license": "AGPL-3.0-or-later",
30
- "homepage": "https://flipbookengine.com",
31
- "repository": {
32
- "type": "git",
33
- "url": "git+https://github.com/Bizeka/flipbook-engine.git"
34
- },
35
- "bugs": {
36
- "url": "https://github.com/Bizeka/flipbook-engine/issues"
37
- },
38
- "engines": {
39
- "node": ">=18"
40
- },
41
- "sideEffects": [
42
- "**/*.css"
43
- ],
44
- "files": [
45
- "dist",
46
- "docs",
47
- "react",
48
- "vue",
49
- "README.md",
50
- "LICENSE",
51
- "CHANGELOG.md",
52
- "COMMERCIAL_LICENSE.md",
53
- "TRADEMARK_POLICY.md",
54
- "THIRD-PARTY-NOTICES.md"
55
- ],
56
- "main": "./dist/flipbook-engine.js",
57
- "module": "./dist/flipbook-engine.js",
58
- "types": "./dist/index.d.ts",
59
- "exports": {
60
- ".": {
61
- "types": "./dist/index.d.ts",
62
- "import": "./dist/flipbook-engine.js",
63
- "default": "./dist/flipbook-engine.js"
64
- },
65
- "./styles.css": {
66
- "default": "./dist/flipbook-engine.css"
67
- },
68
- "./react": {
69
- "types": "./dist/react/index.d.ts",
70
- "import": "./dist/flipbook-engine.react.js",
71
- "default": "./dist/flipbook-engine.react.js"
72
- },
73
- "./vue": {
74
- "types": "./dist/vue/index.d.ts",
75
- "import": "./dist/flipbook-engine.vue.js",
76
- "default": "./dist/flipbook-engine.vue.js"
77
- },
78
- "./core": {
79
- "types": "./dist/core-entry.d.ts",
80
- "import": "./dist/flipbook-engine.core.js",
81
- "default": "./dist/flipbook-engine.core.js"
82
- },
83
- "./plugins": {
84
- "types": "./dist/plugins/index.d.ts",
85
- "import": "./dist/flipbook-engine.plugins.js",
86
- "default": "./dist/flipbook-engine.plugins.js"
87
- },
88
- "./plugins/notes": {
89
- "types": "./dist/plugins-notes.d.ts",
90
- "import": "./dist/flipbook-engine.plugins-notes.js",
91
- "default": "./dist/flipbook-engine.plugins-notes.js"
92
- },
93
- "./plugins/bookmarks": {
94
- "types": "./dist/plugins-bookmarks.d.ts",
95
- "import": "./dist/flipbook-engine.plugins-bookmarks.js",
96
- "default": "./dist/flipbook-engine.plugins-bookmarks.js"
97
- },
98
- "./plugins/toc": {
99
- "types": "./dist/plugins-toc.d.ts",
100
- "import": "./dist/flipbook-engine.plugins-toc.js",
101
- "default": "./dist/flipbook-engine.plugins-toc.js"
102
- },
103
- "./plugins/search": {
104
- "types": "./dist/plugins-search.d.ts",
105
- "import": "./dist/flipbook-engine.plugins-search.js",
106
- "default": "./dist/flipbook-engine.plugins-search.js"
107
- },
108
- "./plugins/annotations": {
109
- "types": "./dist/plugins-annotations.d.ts",
110
- "import": "./dist/flipbook-engine.plugins-annotations.js",
111
- "default": "./dist/flipbook-engine.plugins-annotations.js"
112
- },
113
- "./plugins/hotspots": {
114
- "types": "./dist/plugins-hotspots.d.ts",
115
- "import": "./dist/flipbook-engine.plugins-hotspots.js",
116
- "default": "./dist/flipbook-engine.plugins-hotspots.js"
117
- },
118
- "./plugins/share": {
119
- "types": "./dist/plugins-share.d.ts",
120
- "import": "./dist/flipbook-engine.plugins-share.js",
121
- "default": "./dist/flipbook-engine.plugins-share.js"
122
- },
123
- "./plugins/deep-link": {
124
- "types": "./dist/plugins-deep-link.d.ts",
125
- "import": "./dist/flipbook-engine.plugins-deep-link.js",
126
- "default": "./dist/flipbook-engine.plugins-deep-link.js"
127
- }
128
- },
129
- "peerDependencies": {
130
- "react": ">=16.8.0",
131
- "vue": ">=3.0.0"
132
- },
133
- "peerDependenciesMeta": {
134
- "react": {
135
- "optional": true
136
- },
137
- "vue": {
138
- "optional": true
139
- }
140
- },
141
- "devDependencies": {
142
- "@playwright/test": "^1.63.0",
143
- "@types/jsdom": "^28.0.3",
144
- "@types/node": "^25.0.10",
145
- "@types/page-flip": "^2.0.4",
146
- "@types/react": "^19.2.14",
147
- "@types/react-dom": "^19.2.3",
148
- "jsdom": "^26.1.0",
149
- "react": "^19.2.6",
150
- "react-dom": "^19.2.6",
151
- "rimraf": "^6.0.0",
152
- "tsx": "^4.22.4",
153
- "typescript": "^5.0.0",
154
- "vite": "^5.0.0",
155
- "vite-plugin-dts": "^3.0.0",
156
- "vue": "^3.5.34"
157
- },
158
- "type": "module",
159
- "dependencies": {
160
- "@preact/signals-core": "^1.14.3",
161
- "@serenity-is/domwise": "^10.2.3",
162
- "page-flip": "^2.0.7",
163
- "pdfjs-dist": "^5.4.530"
164
- }
165
- }
1
+ {
2
+ "name": "flipbookengine",
3
+ "version": "1.0.2",
4
+ "description": "A modern, embeddable HTML flipbook engine for PDF-backed catalogs and digital publications.",
5
+ "private": false,
6
+ "scripts": {
7
+ "dev": "vite",
8
+ "build": "vite build && vite build --config vite.config.iife.js",
9
+ "test": "tsx --loader ./tests/css-loader.js --test tests/*.test.ts",
10
+ "test:e2e": "playwright test",
11
+ "typecheck": "tsc --noEmit",
12
+ "clean": "rimraf dist",
13
+ "pack:check": "npm pack --dry-run",
14
+ "audit:deps": "npm audit --omit=dev --audit-level=high",
15
+ "release:verify": "npm run typecheck && npm test && npm run build && npm run audit:deps && npm run pack:check"
16
+ },
17
+ "keywords": [
18
+ "flipbook",
19
+ "catalog",
20
+ "pdf",
21
+ "viewer",
22
+ "publication",
23
+ "pageflip",
24
+ "digital-catalog",
25
+ "page-flip",
26
+ "typescript"
27
+ ],
28
+ "author": "Murat Dogan",
29
+ "license": "AGPL-3.0-or-later",
30
+ "homepage": "https://flipbookengine.com",
31
+ "repository": {
32
+ "type": "git",
33
+ "url": "git+https://github.com/Bizeka/flipbook-engine.git"
34
+ },
35
+ "bugs": {
36
+ "url": "https://github.com/Bizeka/flipbook-engine/issues"
37
+ },
38
+ "engines": {
39
+ "node": ">=18"
40
+ },
41
+ "sideEffects": [
42
+ "**/*.css"
43
+ ],
44
+ "files": [
45
+ "dist",
46
+ "docs",
47
+ "react",
48
+ "vue",
49
+ "README.md",
50
+ "LICENSE",
51
+ "CHANGELOG.md",
52
+ "COMMERCIAL_LICENSE.md",
53
+ "TRADEMARK_POLICY.md",
54
+ "THIRD-PARTY-NOTICES.md"
55
+ ],
56
+ "main": "./dist/flipbook-engine.js",
57
+ "module": "./dist/flipbook-engine.js",
58
+ "types": "./dist/index.d.ts",
59
+ "exports": {
60
+ ".": {
61
+ "types": "./dist/index.d.ts",
62
+ "import": "./dist/flipbook-engine.js",
63
+ "default": "./dist/flipbook-engine.js"
64
+ },
65
+ "./styles.css": {
66
+ "default": "./dist/flipbook-engine.css"
67
+ },
68
+ "./react": {
69
+ "types": "./dist/react/index.d.ts",
70
+ "import": "./dist/flipbook-engine.react.js",
71
+ "default": "./dist/flipbook-engine.react.js"
72
+ },
73
+ "./vue": {
74
+ "types": "./dist/vue/index.d.ts",
75
+ "import": "./dist/flipbook-engine.vue.js",
76
+ "default": "./dist/flipbook-engine.vue.js"
77
+ },
78
+ "./core": {
79
+ "types": "./dist/core-entry.d.ts",
80
+ "import": "./dist/flipbook-engine.core.js",
81
+ "default": "./dist/flipbook-engine.core.js"
82
+ },
83
+ "./plugins": {
84
+ "types": "./dist/plugins/index.d.ts",
85
+ "import": "./dist/flipbook-engine.plugins.js",
86
+ "default": "./dist/flipbook-engine.plugins.js"
87
+ },
88
+ "./plugins/notes": {
89
+ "types": "./dist/plugins-notes.d.ts",
90
+ "import": "./dist/flipbook-engine.plugins-notes.js",
91
+ "default": "./dist/flipbook-engine.plugins-notes.js"
92
+ },
93
+ "./plugins/bookmarks": {
94
+ "types": "./dist/plugins-bookmarks.d.ts",
95
+ "import": "./dist/flipbook-engine.plugins-bookmarks.js",
96
+ "default": "./dist/flipbook-engine.plugins-bookmarks.js"
97
+ },
98
+ "./plugins/toc": {
99
+ "types": "./dist/plugins-toc.d.ts",
100
+ "import": "./dist/flipbook-engine.plugins-toc.js",
101
+ "default": "./dist/flipbook-engine.plugins-toc.js"
102
+ },
103
+ "./plugins/search": {
104
+ "types": "./dist/plugins-search.d.ts",
105
+ "import": "./dist/flipbook-engine.plugins-search.js",
106
+ "default": "./dist/flipbook-engine.plugins-search.js"
107
+ },
108
+ "./plugins/annotations": {
109
+ "types": "./dist/plugins-annotations.d.ts",
110
+ "import": "./dist/flipbook-engine.plugins-annotations.js",
111
+ "default": "./dist/flipbook-engine.plugins-annotations.js"
112
+ },
113
+ "./plugins/hotspots": {
114
+ "types": "./dist/plugins-hotspots.d.ts",
115
+ "import": "./dist/flipbook-engine.plugins-hotspots.js",
116
+ "default": "./dist/flipbook-engine.plugins-hotspots.js"
117
+ },
118
+ "./plugins/share": {
119
+ "types": "./dist/plugins-share.d.ts",
120
+ "import": "./dist/flipbook-engine.plugins-share.js",
121
+ "default": "./dist/flipbook-engine.plugins-share.js"
122
+ },
123
+ "./plugins/deep-link": {
124
+ "types": "./dist/plugins-deep-link.d.ts",
125
+ "import": "./dist/flipbook-engine.plugins-deep-link.js",
126
+ "default": "./dist/flipbook-engine.plugins-deep-link.js"
127
+ }
128
+ },
129
+ "peerDependencies": {
130
+ "react": ">=16.8.0",
131
+ "vue": ">=3.0.0"
132
+ },
133
+ "peerDependenciesMeta": {
134
+ "react": {
135
+ "optional": true
136
+ },
137
+ "vue": {
138
+ "optional": true
139
+ }
140
+ },
141
+ "devDependencies": {
142
+ "@playwright/test": "^1.63.0",
143
+ "@types/jsdom": "^28.0.3",
144
+ "@types/node": "^25.0.10",
145
+ "@types/page-flip": "^2.0.4",
146
+ "@types/react": "^19.2.14",
147
+ "@types/react-dom": "^19.2.3",
148
+ "jsdom": "^26.1.0",
149
+ "react": "^19.2.6",
150
+ "react-dom": "^19.2.6",
151
+ "rimraf": "^6.0.0",
152
+ "tsx": "^4.22.4",
153
+ "typescript": "^5.0.0",
154
+ "vite": "^5.0.0",
155
+ "vite-plugin-dts": "^3.0.0",
156
+ "vue": "^3.5.34"
157
+ },
158
+ "type": "module",
159
+ "dependencies": {
160
+ "@preact/signals-core": "^1.14.3",
161
+ "@serenity-is/domwise": "^10.2.3",
162
+ "page-flip": "^2.0.7",
163
+ "pdfjs-dist": "^5.4.530"
164
+ }
165
+ }