@prose-reader/core 1.117.0 → 1.118.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 (66) hide show
  1. package/dist/cfi/generate/generateCfiForSpineItemPage.d.ts +1 -1
  2. package/dist/cfi/generate/getItemAnchor.d.ts +1 -1
  3. package/dist/cfi/generate/getRootCfi.d.ts +1 -1
  4. package/dist/cfi/lookup/resolveCfi.d.ts +2 -236
  5. package/dist/context/Context.d.ts +1 -1
  6. package/dist/createReaderWithEnhancer.d.ts +11 -245
  7. package/dist/enhancers/events/normalizeEventForViewport.d.ts +2 -1
  8. package/dist/enhancers/events/translateFramePositionIntoPage.d.ts +12 -0
  9. package/dist/enhancers/html/enhancer.d.ts +2 -0
  10. package/dist/enhancers/html/renderer/HtmlRenderer.d.ts +26 -0
  11. package/dist/{spineItem/frame/loader → enhancers/html/renderer}/attachFrameSrc.d.ts +4 -2
  12. package/dist/{spineItem/frame → enhancers/html/renderer}/createHtmlPageFromResource.d.ts +1 -1
  13. package/dist/enhancers/html/renderer/prePaginated/renderPrePaginated.d.ts +31 -0
  14. package/dist/enhancers/html/renderer/reflowable/renderReflowable.d.ts +22 -0
  15. package/dist/enhancers/loading/constants.d.ts +2 -0
  16. package/dist/enhancers/loading/createLoadingElement.d.ts +7 -0
  17. package/dist/enhancers/{loadingEnhancer.d.ts → loading/loadingEnhancer.d.ts} +3 -3
  18. package/dist/enhancers/media/ImageRenderer.d.ts +15 -0
  19. package/dist/enhancers/media/media.d.ts +2 -0
  20. package/dist/enhancers/navigation/resolvers/getNavigationForLeftOrTopPage.d.ts +1 -1
  21. package/dist/enhancers/navigation/resolvers/getNavigationForRightOrBottomPage.d.ts +1 -1
  22. package/dist/enhancers/navigation/resolvers/getSpineItemPositionForLeftPage.d.ts +1 -1
  23. package/dist/enhancers/navigation/resolvers/getSpineItemPositionForRightPage.d.ts +1 -1
  24. package/dist/enhancers/progression.d.ts +1 -1
  25. package/dist/hooks/types.d.ts +19 -9
  26. package/dist/index.d.ts +2 -0
  27. package/dist/index.js +2314 -2181
  28. package/dist/index.js.map +1 -1
  29. package/dist/index.umd.cjs +3010 -2877
  30. package/dist/index.umd.cjs.map +1 -1
  31. package/dist/navigation/Navigator.d.ts +6 -6
  32. package/dist/navigation/resolvers/NavigationResolver.d.ts +1 -1
  33. package/dist/navigation/resolvers/getNavigationForSpineItemPage.d.ts +1 -1
  34. package/dist/navigation/resolvers/getNavigationFromSpineItemPosition.d.ts +1 -1
  35. package/dist/reader.d.ts +3 -237
  36. package/dist/settings/SettingsManager.d.ts +2 -1
  37. package/dist/settings/types.d.ts +9 -1
  38. package/dist/spine/SpineItemsManager.d.ts +6 -591
  39. package/dist/spine/SpineItemsObserver.d.ts +2 -1
  40. package/dist/spine/SpineLayout.d.ts +1 -1
  41. package/dist/spine/locator/SpineLocator.d.ts +5 -473
  42. package/dist/spine/locator/getAbsolutePageIndexFromPageIndex.d.ts +1 -1
  43. package/dist/spine/locator/getSpineInfoFromAbsolutePageIndex.d.ts +2 -118
  44. package/dist/spine/locator/getSpineItemFromPosition.d.ts +1 -118
  45. package/dist/spineItem/DocumentRenderer.d.ts +48 -0
  46. package/dist/spineItem/ResourceHandler.d.ts +15 -0
  47. package/dist/spineItem/SpineItem.d.ts +64 -0
  48. package/dist/spineItem/locationResolver.d.ts +1 -1
  49. package/dist/spineItem/navigationResolver.d.ts +1 -1
  50. package/dist/utils/frames.d.ts +15 -0
  51. package/package.json +3 -3
  52. package/dist/enhancers/media.d.ts +0 -2
  53. package/dist/spineItem/commonSpineItem.d.ts +0 -128
  54. package/dist/spineItem/createSpineItem.d.ts +0 -130
  55. package/dist/spineItem/frame/FrameItem.d.ts +0 -43
  56. package/dist/spineItem/frame/loader/configureFrame.d.ts +0 -9
  57. package/dist/spineItem/frame/loader/loadFrame.d.ts +0 -11
  58. package/dist/spineItem/frame/loader/loader.d.ts +0 -22
  59. package/dist/spineItem/frame/loader/unloadFrame.d.ts +0 -8
  60. package/dist/spineItem/frame/loader/waitForFrameLoad.d.ts +0 -2
  61. package/dist/spineItem/frame/loader/waitForFrameReady.d.ts +0 -2
  62. package/dist/spineItem/prePaginatedSpineItem.d.ts +0 -129
  63. package/dist/spineItem/reflowable/ReflowableSpineItems.d.ts +0 -128
  64. package/dist/spineItem/styles/getStyleForViewportDocument.d.ts +0 -1
  65. /package/dist/{spineItem/frame/loader → enhancers/html/renderer}/createFrameElement.d.ts +0 -0
  66. /package/dist/{spineItem → enhancers/html/renderer}/reflowable/styles.d.ts +0 -0
@@ -1,2 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- export declare const waitForFrameReady: (stream: Observable<HTMLIFrameElement>) => Observable<FontFaceSet | undefined>;
@@ -1,129 +0,0 @@
1
- import { Context } from '../context/Context';
2
- import { Manifest } from '..';
3
- import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
4
- import { HookManager } from '../hooks/HookManager';
5
- export declare const createPrePaginatedSpineItem: ({ item, context, containerElement, settings, hookManager, index, }: {
6
- item: Manifest[`spineItems`][number];
7
- containerElement: HTMLElement;
8
- context: Context;
9
- settings: ReaderSettingsManager;
10
- hookManager: HookManager;
11
- index: number;
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;
29
- };
30
- overlayElement: HTMLDivElement;
31
- adjustPositionOfElement: ({ right, left, top, }: {
32
- right?: number;
33
- left?: number;
34
- top?: number;
35
- }) => void;
36
- getElementDimensions: () => {
37
- width: number;
38
- height: number;
39
- x: number;
40
- y: number;
41
- bottom: number;
42
- left: number;
43
- right: number;
44
- top: number;
45
- toJSON(): any;
46
- };
47
- getHtmlFromResource: (response: Response) => Promise<string>;
48
- getResource: () => Promise<Response>;
49
- translateFramePositionIntoPage: (position: {
50
- clientX: number;
51
- clientY: number;
52
- }) => {
53
- clientX: number;
54
- clientY: number;
55
- };
56
- injectStyle: (cssText: string) => void;
57
- load: () => void;
58
- unload: () => void;
59
- frame: import('./frame/FrameItem').FrameItem;
60
- element: HTMLElement;
61
- getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
62
- getViewPortInformation: () => {
63
- computedScale: number;
64
- computedWidthScale: number;
65
- viewportDimensions: {
66
- width: number;
67
- height: number;
68
- };
69
- } | undefined;
70
- isImageType: () => boolean;
71
- isReady: () => boolean;
72
- destroy: () => void;
73
- readingDirection: "ltr" | "rtl" | undefined;
74
- isUsingVerticalWriting: () => boolean | undefined;
75
- executeOnLayoutBeforeMeasurementHook: (options: {
76
- minimumWidth: number;
77
- }) => void[];
78
- selectionTracker: {
79
- track: (frameToTrack: HTMLIFrameElement) => void;
80
- destroy: () => void;
81
- isSelecting: () => boolean;
82
- getSelection: () => Selection | undefined;
83
- $: import('rxjs').Observable<{
84
- event: `selectionchange`;
85
- data: Selection | null;
86
- } | {
87
- event: `selectstart`;
88
- data: Selection | null;
89
- } | {
90
- event: `selectend`;
91
- data: Selection | null;
92
- }>;
93
- };
94
- fingerTracker: {
95
- track: (frame: HTMLIFrameElement) => void;
96
- getFingerPositionInIframe(): {
97
- x: number | undefined;
98
- y: number | undefined;
99
- } | undefined;
100
- destroy: () => void;
101
- $: import('rxjs').Observable<{
102
- event: `fingermove`;
103
- data: {
104
- x: number;
105
- y: number;
106
- };
107
- } | {
108
- event: `fingerout`;
109
- data: undefined;
110
- }>;
111
- };
112
- getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
113
- columnHeight: number;
114
- columnWidth: number;
115
- width: number;
116
- };
117
- getDimensionsForPaginatedContent: () => {
118
- columnHeight: number;
119
- columnWidth: number;
120
- };
121
- $: {
122
- contentLayout$: import('rxjs').Observable<{
123
- isFirstLayout: boolean;
124
- isReady: boolean;
125
- }>;
126
- loaded$: import('rxjs').Observable<HTMLIFrameElement>;
127
- isReady$: import('rxjs').Observable<boolean>;
128
- };
129
- };
@@ -1,128 +0,0 @@
1
- import { Context } from '../../context/Context';
2
- import { Manifest } from '../..';
3
- import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
4
- import { HookManager } from '../../hooks/HookManager';
5
- export declare const createReflowableSpineItem: ({ item, context, containerElement, settings, hookManager, index, }: {
6
- item: Manifest[`spineItems`][number];
7
- containerElement: HTMLElement;
8
- context: Context;
9
- settings: ReaderSettingsManager;
10
- hookManager: HookManager;
11
- index: number;
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;
28
- };
29
- overlayElement: HTMLDivElement;
30
- adjustPositionOfElement: ({ right, left, top, }: {
31
- right?: number;
32
- left?: number;
33
- top?: number;
34
- }) => void;
35
- getElementDimensions: () => {
36
- width: number;
37
- height: number;
38
- x: number;
39
- y: number;
40
- bottom: number;
41
- left: number;
42
- right: number;
43
- top: number;
44
- toJSON(): any;
45
- };
46
- getHtmlFromResource: (response: Response) => Promise<string>;
47
- getResource: () => Promise<Response>;
48
- translateFramePositionIntoPage: (position: {
49
- clientX: number;
50
- clientY: number;
51
- }) => {
52
- clientX: number;
53
- clientY: number;
54
- };
55
- injectStyle: (cssText: string) => void;
56
- load: () => void;
57
- unload: () => void;
58
- frame: import('../frame/FrameItem').FrameItem;
59
- element: HTMLElement;
60
- getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
61
- getViewPortInformation: () => {
62
- computedScale: number;
63
- computedWidthScale: number;
64
- viewportDimensions: {
65
- width: number;
66
- height: number;
67
- };
68
- } | undefined;
69
- isImageType: () => boolean;
70
- isReady: () => boolean;
71
- destroy: () => void;
72
- readingDirection: "ltr" | "rtl" | undefined;
73
- isUsingVerticalWriting: () => boolean | undefined;
74
- executeOnLayoutBeforeMeasurementHook: (options: {
75
- minimumWidth: number;
76
- }) => void[];
77
- selectionTracker: {
78
- track: (frameToTrack: HTMLIFrameElement) => void;
79
- destroy: () => void;
80
- isSelecting: () => boolean;
81
- getSelection: () => Selection | undefined;
82
- $: import('rxjs').Observable<{
83
- event: `selectionchange`;
84
- data: Selection | null;
85
- } | {
86
- event: `selectstart`;
87
- data: Selection | null;
88
- } | {
89
- event: `selectend`;
90
- data: Selection | null;
91
- }>;
92
- };
93
- fingerTracker: {
94
- track: (frame: HTMLIFrameElement) => void;
95
- getFingerPositionInIframe(): {
96
- x: number | undefined;
97
- y: number | undefined;
98
- } | undefined;
99
- destroy: () => void;
100
- $: import('rxjs').Observable<{
101
- event: `fingermove`;
102
- data: {
103
- x: number;
104
- y: number;
105
- };
106
- } | {
107
- event: `fingerout`;
108
- data: undefined;
109
- }>;
110
- };
111
- getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
112
- columnHeight: number;
113
- columnWidth: number;
114
- width: number;
115
- };
116
- getDimensionsForPaginatedContent: () => {
117
- columnHeight: number;
118
- columnWidth: number;
119
- };
120
- $: {
121
- contentLayout$: import('rxjs').Observable<{
122
- isFirstLayout: boolean;
123
- isReady: boolean;
124
- }>;
125
- loaded$: import('rxjs').Observable<HTMLIFrameElement>;
126
- isReady$: import('rxjs').Observable<boolean>;
127
- };
128
- };
@@ -1 +0,0 @@
1
- export declare const getStyleForViewportDocument: () => string;