@prose-reader/core 1.41.0 → 1.43.0

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 (76) hide show
  1. package/dist/index.d.ts +4366 -8
  2. package/dist/{prose.js → index.js} +632 -443
  3. package/dist/index.js.map +1 -0
  4. package/dist/{prose.umd.cjs → index.umd.cjs} +630 -441
  5. package/dist/index.umd.cjs.map +1 -0
  6. package/package.json +7 -7
  7. package/dist/cfi.d.ts +0 -74
  8. package/dist/constants.d.ts +0 -6
  9. package/dist/context.d.ts +0 -44
  10. package/dist/createReaderWithEnhancer.d.ts +0 -5381
  11. package/dist/enhancers/accessibility.d.ts +0 -4890
  12. package/dist/enhancers/chrome.d.ts +0 -4890
  13. package/dist/enhancers/fonts.d.ts +0 -4904
  14. package/dist/enhancers/hotkeys.d.ts +0 -4890
  15. package/dist/enhancers/layoutEnhancer/createMovingSafePan$.d.ts +0 -3
  16. package/dist/enhancers/layoutEnhancer/fixReflowable.d.ts +0 -2
  17. package/dist/enhancers/layoutEnhancer/layoutEnhancer.d.ts +0 -4897
  18. package/dist/enhancers/layoutEnhancer/types.d.ts +0 -8
  19. package/dist/enhancers/links.d.ts +0 -4900
  20. package/dist/enhancers/loadingEnhancer.d.ts +0 -4919
  21. package/dist/enhancers/media.d.ts +0 -4890
  22. package/dist/enhancers/navigation.d.ts +0 -4893
  23. package/dist/enhancers/pagination.d.ts +0 -5279
  24. package/dist/enhancers/progression.d.ts +0 -4903
  25. package/dist/enhancers/resources/index.d.ts +0 -4890
  26. package/dist/enhancers/resources/indexedDB.d.ts +0 -6
  27. package/dist/enhancers/resources/resourcesManager.d.ts +0 -6
  28. package/dist/enhancers/theme.d.ts +0 -4916
  29. package/dist/enhancers/types/enhancer.d.ts +0 -4894
  30. package/dist/enhancers/utils.d.ts +0 -4894
  31. package/dist/enhancers/webkit.d.ts +0 -4890
  32. package/dist/enhancers/zoom/elementZoomer.d.ts +0 -18
  33. package/dist/enhancers/zoom/index.d.ts +0 -4891
  34. package/dist/enhancers/zoom/types.d.ts +0 -22
  35. package/dist/enhancers/zoom/viewportZoomer.d.ts +0 -18
  36. package/dist/frames.d.ts +0 -5
  37. package/dist/pagination.d.ts +0 -65
  38. package/dist/prose.js.map +0 -1
  39. package/dist/prose.umd.cjs.map +0 -1
  40. package/dist/reader.d.ts +0 -4907
  41. package/dist/report.d.ts +0 -26
  42. package/dist/selection.d.ts +0 -6
  43. package/dist/settings.d.ts +0 -39
  44. package/dist/spine/cfiLocator.d.ts +0 -371
  45. package/dist/spine/createSpine.d.ts +0 -29
  46. package/dist/spine/eventsHelper.d.ts +0 -11
  47. package/dist/spine/locationResolver.d.ts +0 -697
  48. package/dist/spine/navigationResolver.d.ts +0 -45
  49. package/dist/spine/types.d.ts +0 -10
  50. package/dist/spineItem/commonSpineItem.d.ts +0 -171
  51. package/dist/spineItem/createSpineItem.d.ts +0 -181
  52. package/dist/spineItem/frameItem/createFrame$.d.ts +0 -1
  53. package/dist/spineItem/frameItem/createFrameManipulator.d.ts +0 -5
  54. package/dist/spineItem/frameItem/createHtmlPageFromResource.d.ts +0 -2
  55. package/dist/spineItem/frameItem/frameItem.d.ts +0 -46
  56. package/dist/spineItem/frameItem/loader.d.ts +0 -27
  57. package/dist/spineItem/locationResolver.d.ts +0 -23
  58. package/dist/spineItem/navigationResolver.d.ts +0 -13
  59. package/dist/spineItem/prePaginatedSpineItem.d.ts +0 -180
  60. package/dist/spineItem/reflowableSpineItem.d.ts +0 -179
  61. package/dist/spineItem/styles/getStyleForViewportDocument.d.ts +0 -1
  62. package/dist/spineItem/trackers.d.ts +0 -34
  63. package/dist/spineItem/types.d.ts +0 -19
  64. package/dist/spineItemManager.d.ts +0 -550
  65. package/dist/types/Hook.d.ts +0 -73
  66. package/dist/types/Spine.d.ts +0 -39
  67. package/dist/types/index.d.ts +0 -11
  68. package/dist/utils/dom.d.ts +0 -19
  69. package/dist/utils/layout.d.ts +0 -7
  70. package/dist/utils/objects.d.ts +0 -6
  71. package/dist/utils/rxjs.d.ts +0 -4
  72. package/dist/viewportNavigator/manualViewportNavigator.d.ts +0 -1440
  73. package/dist/viewportNavigator/panViewportNavigator.d.ts +0 -215
  74. package/dist/viewportNavigator/scrollViewportNavigator.d.ts +0 -35
  75. package/dist/viewportNavigator/types.d.ts +0 -33
  76. package/dist/viewportNavigator/viewportNavigator.d.ts +0 -71
@@ -1,180 +0,0 @@
1
- import { BehaviorSubject, Observable } from "rxjs";
2
- import { Context } from "../context";
3
- import { Manifest } from "../types";
4
- import { Hook } from "../types/Hook";
5
- export declare const createPrePaginatedSpineItem: ({ item, context, containerElement, iframeEventBridgeElement, hooks$, viewportState$, }: {
6
- item: Manifest[`spineItems`][number];
7
- containerElement: HTMLElement;
8
- iframeEventBridgeElement: HTMLElement;
9
- context: Context;
10
- hooks$: BehaviorSubject<Hook[]>;
11
- viewportState$: Observable<`free` | `busy`>;
12
- }) => {
13
- layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
14
- blankPagePosition: `before` | `after` | `none`;
15
- minimumWidth: number;
16
- spreadPosition: `none` | `left` | `right`;
17
- }) => {
18
- width: number;
19
- height: number;
20
- };
21
- item: {
22
- id: string;
23
- href: string;
24
- renditionLayout: "reflowable" | "pre-paginated";
25
- progressionWeight: number;
26
- pageSpreadLeft: true | undefined;
27
- pageSpreadRight: true | undefined;
28
- mediaType?: string | undefined;
29
- };
30
- load: () => void;
31
- adjustPositionOfElement: ({ right, left, top }: {
32
- right?: number | undefined;
33
- left?: number | undefined;
34
- top?: number | undefined;
35
- }) => void;
36
- getElementDimensions: () => {
37
- width: number;
38
- height: number;
39
- };
40
- getHtmlFromResource: (response: Response) => Promise<string>;
41
- getResource: () => Promise<Response>;
42
- translateFramePositionIntoPage: (position: {
43
- clientX: number;
44
- clientY: number;
45
- }) => {
46
- clientX: number;
47
- clientY: number;
48
- };
49
- setLayoutDirty: () => void;
50
- injectStyle: (cssText: string) => void;
51
- loadContent: () => void;
52
- unloadContent: () => void;
53
- spineItemFrame: {
54
- getIsLoaded: () => boolean;
55
- getIsReady: () => boolean;
56
- getViewportDimensions: () => {
57
- width: number;
58
- height: number;
59
- } | undefined;
60
- getFrameElement: () => HTMLIFrameElement | undefined;
61
- getHtmlFromResource: (response: Response) => Promise<string>;
62
- load: () => void;
63
- unload: () => void;
64
- staticLayout: (size: {
65
- width: number;
66
- height: number;
67
- }) => void;
68
- getManipulableFrame: () => {
69
- frame: HTMLIFrameElement;
70
- removeStyle: (id: string) => void;
71
- addStyle: (id: string, style: string, prepend?: boolean) => void;
72
- } | undefined;
73
- getReadingDirection: () => "ltr" | "rtl" | undefined;
74
- isUsingVerticalWriting: () => boolean;
75
- getWritingMode: () => "vertical-rl" | "horizontal-tb" | undefined;
76
- destroy: () => void;
77
- $: {
78
- unload$: Observable<void>;
79
- unloaded$: Observable<void>;
80
- loaded$: Observable<HTMLIFrameElement>;
81
- ready$: Observable<FontFaceSet | undefined>;
82
- isReady$: Observable<boolean>;
83
- contentLayoutChange$: Observable<{
84
- isFirstLayout: boolean;
85
- } | {
86
- isFirstLayout: boolean;
87
- }>;
88
- };
89
- };
90
- element: HTMLElement;
91
- getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
92
- getViewPortInformation: () => {
93
- computedScale: number;
94
- computedWidthScale: number;
95
- viewportDimensions: {
96
- width: number;
97
- height: number;
98
- };
99
- } | undefined;
100
- isImageType: () => boolean;
101
- isReady: () => boolean;
102
- destroy: () => void;
103
- isUsingVerticalWriting: () => boolean | undefined;
104
- getReadingDirection: () => "ltr" | "rtl" | undefined;
105
- manipulateSpineItem: (cb: (options: {
106
- container: HTMLElement;
107
- item: {
108
- id: string;
109
- href: string;
110
- renditionLayout: "reflowable" | "pre-paginated";
111
- progressionWeight: number;
112
- pageSpreadLeft: true | undefined;
113
- pageSpreadRight: true | undefined;
114
- mediaType?: string | undefined;
115
- };
116
- overlayElement: HTMLDivElement;
117
- } & ({
118
- frame: HTMLIFrameElement;
119
- removeStyle: (id: string) => void;
120
- addStyle: (id: string, style: string, prepend?: boolean) => void;
121
- } | {
122
- frame: undefined;
123
- removeStyle: (id: string) => void;
124
- addStyle: (id: string, style: string) => void;
125
- })) => boolean) => boolean;
126
- executeOnLayoutBeforeMeasurementHook: (options: {
127
- minimumWidth: number;
128
- }) => void;
129
- selectionTracker: {
130
- track: (frameToTrack: HTMLIFrameElement) => void;
131
- destroy: () => void;
132
- isSelecting: () => boolean;
133
- getSelection: () => Selection | undefined;
134
- $: Observable<{
135
- event: "selectionchange";
136
- data: Selection | null;
137
- } | {
138
- event: "selectstart";
139
- data: Selection | null;
140
- } | {
141
- event: "selectend";
142
- data: Selection | null;
143
- }>;
144
- };
145
- fingerTracker: {
146
- track: (frame: HTMLIFrameElement) => void;
147
- getFingerPositionInIframe(): {
148
- x: number | undefined;
149
- y: number | undefined;
150
- } | undefined;
151
- destroy: () => void;
152
- $: Observable<{
153
- event: "fingermove";
154
- data: {
155
- x: number;
156
- y: number;
157
- };
158
- } | {
159
- event: "fingerout";
160
- data: undefined;
161
- }>;
162
- };
163
- getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
164
- columnHeight: number;
165
- columnWidth: number;
166
- width: number;
167
- };
168
- getDimensionsForPaginatedContent: () => {
169
- columnHeight: number;
170
- columnWidth: number;
171
- };
172
- $: {
173
- contentLayout$: Observable<{
174
- isFirstLayout: boolean;
175
- isReady: boolean;
176
- }>;
177
- loaded$: Observable<HTMLIFrameElement>;
178
- isReady$: Observable<boolean>;
179
- };
180
- };
@@ -1,179 +0,0 @@
1
- import { BehaviorSubject, Observable } from "rxjs";
2
- import { Context } from "../context";
3
- import { Manifest } from "../types";
4
- import { Hook } from "../types/Hook";
5
- export declare const createReflowableSpineItem: ({ item, context, containerElement, iframeEventBridgeElement, hooks$, viewportState$, }: {
6
- item: Manifest[`spineItems`][number];
7
- containerElement: HTMLElement;
8
- iframeEventBridgeElement: HTMLElement;
9
- context: Context;
10
- hooks$: BehaviorSubject<Hook[]>;
11
- viewportState$: Observable<`free` | `busy`>;
12
- }) => {
13
- layout: ({ blankPagePosition, minimumWidth, }: {
14
- blankPagePosition: `before` | `after` | `none`;
15
- minimumWidth: number;
16
- }) => {
17
- width: number;
18
- height: number;
19
- };
20
- item: {
21
- id: string;
22
- href: string;
23
- renditionLayout: "reflowable" | "pre-paginated";
24
- progressionWeight: number;
25
- pageSpreadLeft: true | undefined;
26
- pageSpreadRight: true | undefined;
27
- mediaType?: string | undefined;
28
- };
29
- load: () => void;
30
- adjustPositionOfElement: ({ right, left, top }: {
31
- right?: number | undefined;
32
- left?: number | undefined;
33
- top?: number | undefined;
34
- }) => void;
35
- getElementDimensions: () => {
36
- width: number;
37
- height: number;
38
- };
39
- getHtmlFromResource: (response: Response) => Promise<string>;
40
- getResource: () => Promise<Response>;
41
- translateFramePositionIntoPage: (position: {
42
- clientX: number;
43
- clientY: number;
44
- }) => {
45
- clientX: number;
46
- clientY: number;
47
- };
48
- setLayoutDirty: () => void;
49
- injectStyle: (cssText: string) => void;
50
- loadContent: () => void;
51
- unloadContent: () => void;
52
- spineItemFrame: {
53
- getIsLoaded: () => boolean;
54
- getIsReady: () => boolean;
55
- getViewportDimensions: () => {
56
- width: number;
57
- height: number;
58
- } | undefined;
59
- getFrameElement: () => HTMLIFrameElement | undefined;
60
- getHtmlFromResource: (response: Response) => Promise<string>;
61
- load: () => void;
62
- unload: () => void;
63
- staticLayout: (size: {
64
- width: number;
65
- height: number;
66
- }) => void;
67
- getManipulableFrame: () => {
68
- frame: HTMLIFrameElement;
69
- removeStyle: (id: string) => void;
70
- addStyle: (id: string, style: string, prepend?: boolean) => void;
71
- } | undefined;
72
- getReadingDirection: () => "ltr" | "rtl" | undefined;
73
- isUsingVerticalWriting: () => boolean;
74
- getWritingMode: () => "vertical-rl" | "horizontal-tb" | undefined;
75
- destroy: () => void;
76
- $: {
77
- unload$: Observable<void>;
78
- unloaded$: Observable<void>;
79
- loaded$: Observable<HTMLIFrameElement>;
80
- ready$: Observable<FontFaceSet | undefined>;
81
- isReady$: Observable<boolean>;
82
- contentLayoutChange$: Observable<{
83
- isFirstLayout: boolean;
84
- } | {
85
- isFirstLayout: boolean;
86
- }>;
87
- };
88
- };
89
- element: HTMLElement;
90
- getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
91
- getViewPortInformation: () => {
92
- computedScale: number;
93
- computedWidthScale: number;
94
- viewportDimensions: {
95
- width: number;
96
- height: number;
97
- };
98
- } | undefined;
99
- isImageType: () => boolean;
100
- isReady: () => boolean;
101
- destroy: () => void;
102
- isUsingVerticalWriting: () => boolean | undefined;
103
- getReadingDirection: () => "ltr" | "rtl" | undefined;
104
- manipulateSpineItem: (cb: (options: {
105
- container: HTMLElement;
106
- item: {
107
- id: string;
108
- href: string;
109
- renditionLayout: "reflowable" | "pre-paginated";
110
- progressionWeight: number;
111
- pageSpreadLeft: true | undefined;
112
- pageSpreadRight: true | undefined;
113
- mediaType?: string | undefined;
114
- };
115
- overlayElement: HTMLDivElement;
116
- } & ({
117
- frame: HTMLIFrameElement;
118
- removeStyle: (id: string) => void;
119
- addStyle: (id: string, style: string, prepend?: boolean) => void;
120
- } | {
121
- frame: undefined;
122
- removeStyle: (id: string) => void;
123
- addStyle: (id: string, style: string) => void;
124
- })) => boolean) => boolean;
125
- executeOnLayoutBeforeMeasurementHook: (options: {
126
- minimumWidth: number;
127
- }) => void;
128
- selectionTracker: {
129
- track: (frameToTrack: HTMLIFrameElement) => void;
130
- destroy: () => void;
131
- isSelecting: () => boolean;
132
- getSelection: () => Selection | undefined;
133
- $: Observable<{
134
- event: "selectionchange";
135
- data: Selection | null;
136
- } | {
137
- event: "selectstart";
138
- data: Selection | null;
139
- } | {
140
- event: "selectend";
141
- data: Selection | null;
142
- }>;
143
- };
144
- fingerTracker: {
145
- track: (frame: HTMLIFrameElement) => void;
146
- getFingerPositionInIframe(): {
147
- x: number | undefined;
148
- y: number | undefined;
149
- } | undefined;
150
- destroy: () => void;
151
- $: Observable<{
152
- event: "fingermove";
153
- data: {
154
- x: number;
155
- y: number;
156
- };
157
- } | {
158
- event: "fingerout";
159
- data: undefined;
160
- }>;
161
- };
162
- getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
163
- columnHeight: number;
164
- columnWidth: number;
165
- width: number;
166
- };
167
- getDimensionsForPaginatedContent: () => {
168
- columnHeight: number;
169
- columnWidth: number;
170
- };
171
- $: {
172
- contentLayout$: Observable<{
173
- isFirstLayout: boolean;
174
- isReady: boolean;
175
- }>;
176
- loaded$: Observable<HTMLIFrameElement>;
177
- isReady$: Observable<boolean>;
178
- };
179
- };
@@ -1 +0,0 @@
1
- export declare const getStyleForViewportDocument: () => string;
@@ -1,34 +0,0 @@
1
- export declare const createFingerTracker: () => {
2
- track: (frame: HTMLIFrameElement) => void;
3
- getFingerPositionInIframe(): {
4
- x: number | undefined;
5
- y: number | undefined;
6
- } | undefined;
7
- destroy: () => void;
8
- $: import("rxjs").Observable<{
9
- event: `fingermove`;
10
- data: {
11
- x: number;
12
- y: number;
13
- };
14
- } | {
15
- event: `fingerout`;
16
- data: undefined;
17
- }>;
18
- };
19
- export declare const createSelectionTracker: () => {
20
- track: (frameToTrack: HTMLIFrameElement) => void;
21
- destroy: () => void;
22
- isSelecting: () => boolean;
23
- getSelection: () => Selection | undefined;
24
- $: import("rxjs").Observable<{
25
- event: `selectionchange`;
26
- data: Selection | null;
27
- } | {
28
- event: `selectstart`;
29
- data: Selection | null;
30
- } | {
31
- event: `selectend`;
32
- data: Selection | null;
33
- }>;
34
- };
@@ -1,19 +0,0 @@
1
- export type SpineItemPosition = {
2
- x: number;
3
- y: number;
4
- __symbol?: `SpineItemPosition`;
5
- };
6
- export type UnsafeSpineItemPosition = {
7
- x: number;
8
- y: number;
9
- __symbol?: `UnsafeSpineItemPosition` | `SpineItemPosition`;
10
- };
11
- export declare class SpineItemNavigationPosition {
12
- __symbol: string;
13
- x: number;
14
- y: number;
15
- constructor(position: {
16
- x: number;
17
- y: number;
18
- });
19
- }