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