@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,215 +0,0 @@
1
- import { BehaviorSubject, Subject } from "rxjs";
2
- import { Context } from "../context";
3
- import { SpineItemManager } from "../spineItemManager";
4
- import { createNavigationResolver, ViewportNavigationEntry } from "../spine/navigationResolver";
5
- import { createLocationResolver } from "../spine/locationResolver";
6
- import { ViewportPosition } from "../types";
7
- export declare const createPanViewportNavigator: ({ getCurrentViewportPosition, navigator, spineItemManager, locator, context, currentNavigationSubject$, }: {
8
- context: Context;
9
- element: HTMLElement;
10
- navigator: ReturnType<typeof createNavigationResolver>;
11
- currentNavigationSubject$: BehaviorSubject<ViewportNavigationEntry>;
12
- spineItemManager: SpineItemManager;
13
- locator: ReturnType<typeof createLocationResolver>;
14
- getCurrentViewportPosition: () => ViewportPosition;
15
- }) => {
16
- moveTo: ((delta: {
17
- x: number;
18
- y: number;
19
- } | undefined, { final, start }?: {
20
- start?: boolean | undefined;
21
- final?: boolean | undefined;
22
- }) => void) | ((args_0: {
23
- x: number;
24
- y: number;
25
- } | undefined, args_1?: {
26
- start?: boolean | undefined;
27
- final?: boolean | undefined;
28
- } | undefined) => void);
29
- destroy: () => void;
30
- adjustReadingOffset: () => boolean;
31
- $: {
32
- moveToSubject$: Subject<{
33
- position: ViewportNavigationEntry;
34
- }>;
35
- state$: import("rxjs").Observable<"start" | "end">;
36
- navigation$: import("rxjs").Observable<{
37
- lastUserExpectedNavigation: {
38
- type: "navigate-from-next-item";
39
- } | {
40
- type: "navigate-from-previous-item";
41
- } | undefined;
42
- x: number;
43
- y: number;
44
- spineItem?: {
45
- layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
46
- blankPagePosition: "after" | "before" | "none";
47
- minimumWidth: number;
48
- spreadPosition: "none" | "right" | "left";
49
- }) => {
50
- width: number;
51
- height: number;
52
- };
53
- item: {
54
- id: string;
55
- href: string;
56
- renditionLayout: "reflowable" | "pre-paginated";
57
- progressionWeight: number;
58
- pageSpreadLeft: true | undefined;
59
- pageSpreadRight: true | undefined;
60
- mediaType?: string | undefined;
61
- };
62
- load: () => void;
63
- adjustPositionOfElement: ({ right, left, top }: {
64
- right?: number | undefined;
65
- left?: number | undefined;
66
- top?: number | undefined;
67
- }) => void;
68
- getElementDimensions: () => {
69
- width: number;
70
- height: number;
71
- };
72
- getHtmlFromResource: (response: Response) => Promise<string>;
73
- getResource: () => Promise<Response>;
74
- translateFramePositionIntoPage: (position: {
75
- clientX: number;
76
- clientY: number;
77
- }) => {
78
- clientX: number;
79
- clientY: number;
80
- };
81
- setLayoutDirty: () => void;
82
- injectStyle: (cssText: string) => void;
83
- loadContent: () => void;
84
- unloadContent: () => void;
85
- spineItemFrame: {
86
- getIsLoaded: () => boolean;
87
- getIsReady: () => boolean;
88
- getViewportDimensions: () => {
89
- width: number;
90
- height: number;
91
- } | undefined;
92
- getFrameElement: () => HTMLIFrameElement | undefined;
93
- getHtmlFromResource: (response: Response) => Promise<string>;
94
- load: () => void;
95
- unload: () => void;
96
- staticLayout: (size: {
97
- width: number;
98
- height: number;
99
- }) => void;
100
- getManipulableFrame: () => {
101
- frame: HTMLIFrameElement;
102
- removeStyle: (id: string) => void;
103
- addStyle: (id: string, style: string, prepend?: boolean) => void;
104
- } | undefined;
105
- getReadingDirection: () => "ltr" | "rtl" | undefined;
106
- isUsingVerticalWriting: () => boolean;
107
- getWritingMode: () => "vertical-rl" | "horizontal-tb" | undefined;
108
- destroy: () => void;
109
- $: {
110
- unload$: import("rxjs").Observable<void>;
111
- unloaded$: import("rxjs").Observable<void>;
112
- loaded$: import("rxjs").Observable<HTMLIFrameElement>;
113
- ready$: import("rxjs").Observable<FontFaceSet | undefined>;
114
- isReady$: import("rxjs").Observable<boolean>;
115
- contentLayoutChange$: import("rxjs").Observable<{
116
- isFirstLayout: boolean;
117
- } | {
118
- isFirstLayout: boolean;
119
- }>;
120
- };
121
- };
122
- element: HTMLElement;
123
- getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
124
- getViewPortInformation: () => {
125
- computedScale: number;
126
- computedWidthScale: number;
127
- viewportDimensions: {
128
- width: number;
129
- height: number;
130
- };
131
- } | undefined;
132
- isImageType: () => boolean;
133
- isReady: () => boolean;
134
- destroy: () => void;
135
- isUsingVerticalWriting: () => boolean | undefined;
136
- getReadingDirection: () => "ltr" | "rtl" | undefined;
137
- manipulateSpineItem: (cb: (options: {
138
- container: HTMLElement;
139
- item: {
140
- id: string;
141
- href: string;
142
- renditionLayout: "reflowable" | "pre-paginated";
143
- progressionWeight: number;
144
- pageSpreadLeft: true | undefined;
145
- pageSpreadRight: true | undefined;
146
- mediaType?: string | undefined;
147
- };
148
- overlayElement: HTMLDivElement;
149
- } & ({
150
- frame: HTMLIFrameElement;
151
- removeStyle: (id: string) => void;
152
- addStyle: (id: string, style: string, prepend?: boolean) => void;
153
- } | {
154
- frame: undefined;
155
- removeStyle: (id: string) => void;
156
- addStyle: (id: string, style: string) => void;
157
- })) => boolean) => boolean;
158
- executeOnLayoutBeforeMeasurementHook: (options: {
159
- minimumWidth: number;
160
- }) => void;
161
- selectionTracker: {
162
- track: (frameToTrack: HTMLIFrameElement) => void;
163
- destroy: () => void;
164
- isSelecting: () => boolean;
165
- getSelection: () => Selection | undefined;
166
- $: import("rxjs").Observable<{
167
- event: "selectionchange";
168
- data: Selection | null;
169
- } | {
170
- event: "selectstart";
171
- data: Selection | null;
172
- } | {
173
- event: "selectend";
174
- data: Selection | null;
175
- }>;
176
- };
177
- fingerTracker: {
178
- track: (frame: HTMLIFrameElement) => void;
179
- getFingerPositionInIframe(): {
180
- x: number | undefined;
181
- y: number | undefined;
182
- } | undefined;
183
- destroy: () => void;
184
- $: import("rxjs").Observable<{
185
- event: "fingermove";
186
- data: {
187
- x: number;
188
- y: number;
189
- };
190
- } | {
191
- event: "fingerout";
192
- data: undefined;
193
- }>;
194
- };
195
- getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
196
- columnHeight: number;
197
- columnWidth: number;
198
- width: number;
199
- };
200
- getDimensionsForPaginatedContent: () => {
201
- columnHeight: number;
202
- columnWidth: number;
203
- };
204
- $: {
205
- contentLayout$: import("rxjs").Observable<{
206
- isFirstLayout: boolean;
207
- isReady: boolean;
208
- }>;
209
- loaded$: import("rxjs").Observable<HTMLIFrameElement>;
210
- isReady$: import("rxjs").Observable<boolean>;
211
- };
212
- } | undefined;
213
- }>;
214
- };
215
- };
@@ -1,35 +0,0 @@
1
- import { BehaviorSubject, Observable } from "rxjs";
2
- import { Context } from "../context";
3
- import { Spine } from "../spine/createSpine";
4
- import { createNavigationResolver, ViewportNavigationEntry } from "../spine/navigationResolver";
5
- import { SpineItemManager } from "../spineItemManager";
6
- import { ViewportPosition } from "../types";
7
- type ScaledDownPosition = ViewportPosition;
8
- export declare const createScrollViewportNavigator: ({ context, element, navigator, currentNavigationSubject$, spine, }: {
9
- context: Context;
10
- element: HTMLElement;
11
- navigator: ReturnType<typeof createNavigationResolver>;
12
- currentNavigationSubject$: BehaviorSubject<ViewportNavigationEntry>;
13
- spine: Spine;
14
- spineItemManager: SpineItemManager;
15
- }) => {
16
- destroy: () => void;
17
- adjustReadingOffset: ({ x, y }: {
18
- x: number;
19
- y: number;
20
- }) => boolean;
21
- getNavigationForPosition: (position: ScaledDownPosition) => ViewportNavigationEntry;
22
- getCurrentViewportPosition: () => {
23
- x: number;
24
- y: number;
25
- };
26
- $: {
27
- state$: Observable<"start" | "end">;
28
- navigation$: Observable<{
29
- position: ViewportNavigationEntry;
30
- animate: boolean;
31
- lastUserExpectedNavigation: undefined;
32
- }>;
33
- };
34
- };
35
- export {};
@@ -1,33 +0,0 @@
1
- import { SpineItem } from "../spineItem/createSpineItem";
2
- export type LastUserExpectedNavigation = undefined | {
3
- type: `navigate-from-previous-item`;
4
- } | {
5
- type: `navigate-from-next-item`;
6
- } | {
7
- type: `navigate-from-cfi`;
8
- data: string;
9
- } | {
10
- type: `navigate-from-anchor`;
11
- data: string;
12
- };
13
- export type Navigation = {
14
- position: {
15
- x: number;
16
- y: number;
17
- spineItem?: SpineItem | undefined;
18
- };
19
- triggeredBy: `scroll` | `manual` | `adjust`;
20
- animation: false | `turn` | `snap`;
21
- lastUserExpectedNavigation: LastUserExpectedNavigation;
22
- };
23
- export type AdjustedNavigation = {
24
- previousNavigationPosition: {
25
- x: number;
26
- y: number;
27
- };
28
- adjustedSpinePosition: {
29
- x: number;
30
- y: number;
31
- };
32
- areDifferent: boolean;
33
- };
@@ -1,71 +0,0 @@
1
- import { Context } from "../context";
2
- import { Pagination } from "../pagination";
3
- import { SpineItemManager } from "../spineItemManager";
4
- import { createLocationResolver } from "../spine/locationResolver";
5
- import { ViewportNavigationEntry } from "../spine/navigationResolver";
6
- import { BehaviorSubject, Observable } from "rxjs";
7
- import { createCfiLocator } from "../spine/cfiLocator";
8
- import { Hook } from "../types/Hook";
9
- import { LastUserExpectedNavigation, Navigation } from "./types";
10
- import { Spine } from "../spine/createSpine";
11
- export declare const createViewportNavigator: ({ spineItemManager, context, pagination, parentElement, cfiLocator, spineLocator, hooks$, spine, }: {
12
- spineItemManager: SpineItemManager;
13
- pagination: Pagination;
14
- context: Context;
15
- parentElement: HTMLElement;
16
- cfiLocator: ReturnType<typeof createCfiLocator>;
17
- spineLocator: ReturnType<typeof createLocationResolver>;
18
- hooks$: BehaviorSubject<Hook[]>;
19
- spine: Spine;
20
- }) => {
21
- destroy: () => void;
22
- layout: () => void;
23
- getCurrentNavigationPosition: () => ViewportNavigationEntry;
24
- getCurrentViewportPosition: (() => {
25
- x: number;
26
- y: number;
27
- }) | (() => {
28
- x: number;
29
- y: number;
30
- });
31
- turnLeft: ({ allowSpineItemChange }?: {
32
- allowSpineItemChange?: boolean | undefined;
33
- }) => void;
34
- turnRight: ({ allowSpineItemChange }?: {
35
- allowSpineItemChange?: boolean | undefined;
36
- }) => void;
37
- goToPage: (pageIndex: number) => void;
38
- goToSpineItem: (indexOrId: string | number, options?: {
39
- animate: boolean;
40
- }) => void;
41
- goToUrl: (url: string | URL) => void;
42
- goToCfi: (cfi: string, options?: {
43
- animate: boolean;
44
- }) => void;
45
- goToPageOfCurrentChapter: (pageIndex: number) => void;
46
- moveTo: ((delta: {
47
- x: number;
48
- y: number;
49
- } | undefined, { final, start }?: {
50
- start?: boolean | undefined;
51
- final?: boolean | undefined;
52
- }) => void) | ((args_0: {
53
- x: number;
54
- y: number;
55
- } | undefined, args_1?: {
56
- start?: boolean | undefined;
57
- final?: boolean | undefined;
58
- } | undefined) => void);
59
- getLastUserExpectedNavigation: () => LastUserExpectedNavigation;
60
- element: HTMLElement;
61
- $: {
62
- state$: Observable<"free" | "busy">;
63
- navigation$: Observable<Navigation>;
64
- navigationAdjustedAfterLayout$: Observable<{
65
- previousNavigationPosition: ViewportNavigationEntry;
66
- adjustedSpinePosition: ViewportNavigationEntry;
67
- areDifferent: boolean;
68
- }>;
69
- currentNavigationPosition$: Observable<ViewportNavigationEntry>;
70
- };
71
- };