@prose-reader/core 0.0.48 → 0.0.49
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.
- package/dist/createReaderWithEnhancer.d.ts +6142 -698
- package/dist/enhancers/layoutEnhancer/fixReflowable.d.ts +2 -0
- package/dist/index.js +1 -1
- package/dist/spine/cfiLocator.d.ts +190 -19
- package/dist/spine/locationResolver.d.ts +373 -31
- package/dist/spineItem/commonSpineItem.d.ts +24 -10
- package/dist/spineItem/createSpineItem.d.ts +15 -184
- package/dist/spineItem/prePaginatedSpineItem.d.ts +22 -10
- package/dist/spineItem/reflowableSpineItem.d.ts +21 -9
- package/dist/spineItem/styles/getStyleForViewportDocument.d.ts +1 -0
- package/dist/spineItemManager.d.ts +870 -19
- package/dist/types/Hook.d.ts +13 -3
- package/dist/viewportNavigator/manualViewportNavigator.d.ts +1368 -8
- package/dist/viewportNavigator/panViewportNavigator.d.ts +171 -1
- package/package.json +2 -2
|
@@ -8,7 +8,15 @@ export declare const createCfiLocator: ({ spineItemManager, spineItemLocator }:
|
|
|
8
8
|
context: Context;
|
|
9
9
|
spineItemLocator: ReturnType<typeof createLocationResolver>;
|
|
10
10
|
}) => {
|
|
11
|
-
getSpineItemFromCfi: (cfi: string) =>
|
|
11
|
+
getSpineItemFromCfi: (cfi: string) => {
|
|
12
|
+
layout: ({ blankPagePosition, minimumWidth, spreadPosition }: {
|
|
13
|
+
blankPagePosition: "before" | "after" | "none";
|
|
14
|
+
minimumWidth: number;
|
|
15
|
+
spreadPosition: "none" | "right" | "left";
|
|
16
|
+
}) => {
|
|
17
|
+
width: number;
|
|
18
|
+
height: number;
|
|
19
|
+
};
|
|
12
20
|
item: {
|
|
13
21
|
id: string;
|
|
14
22
|
href: string;
|
|
@@ -19,15 +27,180 @@ export declare const createCfiLocator: ({ spineItemManager, spineItemLocator }:
|
|
|
19
27
|
pageSpreadRight: true | undefined;
|
|
20
28
|
mediaType?: string | undefined;
|
|
21
29
|
};
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
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$: import("rxjs").Observable<void>;
|
|
79
|
+
unloaded$: import("rxjs").Observable<void>;
|
|
80
|
+
loaded$: import("rxjs").Observable<HTMLIFrameElement>;
|
|
81
|
+
ready$: import("rxjs").Observable<FontFaceSet | undefined>;
|
|
82
|
+
isReady$: import("rxjs").Observable<boolean>;
|
|
83
|
+
contentLayoutChange$: import("rxjs").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
|
+
path: string;
|
|
111
|
+
renditionLayout: "reflowable" | "pre-paginated";
|
|
112
|
+
progressionWeight: number;
|
|
113
|
+
pageSpreadLeft: true | undefined;
|
|
114
|
+
pageSpreadRight: true | undefined;
|
|
115
|
+
mediaType?: string | undefined;
|
|
116
|
+
};
|
|
117
|
+
overlayElement: HTMLDivElement;
|
|
118
|
+
} & ({
|
|
119
|
+
frame: HTMLIFrameElement;
|
|
120
|
+
removeStyle: (id: string) => void;
|
|
121
|
+
addStyle: (id: string, style: string, prepend?: boolean) => void;
|
|
122
|
+
} | {
|
|
123
|
+
frame: undefined;
|
|
124
|
+
removeStyle: (id: string) => void;
|
|
125
|
+
addStyle: (id: string, style: string) => void;
|
|
126
|
+
})) => boolean) => boolean;
|
|
127
|
+
executeOnLayoutBeforeMeasurementHook: (options: {
|
|
128
|
+
minimumWidth: number;
|
|
129
|
+
}) => void;
|
|
130
|
+
selectionTracker: {
|
|
131
|
+
track: (frameToTrack: HTMLIFrameElement) => void;
|
|
132
|
+
destroy: () => void;
|
|
133
|
+
isSelecting: () => boolean;
|
|
134
|
+
getSelection: () => Selection | undefined;
|
|
135
|
+
$: import("rxjs").Observable<{
|
|
136
|
+
event: "selectionchange";
|
|
137
|
+
data: Selection | null;
|
|
138
|
+
} | {
|
|
139
|
+
event: "selectstart";
|
|
140
|
+
data: Selection | null;
|
|
141
|
+
} | {
|
|
142
|
+
event: "selectend";
|
|
143
|
+
data: Selection | null;
|
|
144
|
+
}>;
|
|
145
|
+
};
|
|
146
|
+
fingerTracker: {
|
|
147
|
+
track: (frame: HTMLIFrameElement) => void;
|
|
148
|
+
getFingerPositionInIframe(): {
|
|
149
|
+
x: number | undefined;
|
|
150
|
+
y: number | undefined;
|
|
151
|
+
} | undefined;
|
|
152
|
+
destroy: () => void;
|
|
153
|
+
$: import("rxjs").Observable<{
|
|
154
|
+
event: "fingermove";
|
|
155
|
+
data: {
|
|
156
|
+
x: number;
|
|
157
|
+
y: number;
|
|
158
|
+
};
|
|
159
|
+
} | {
|
|
160
|
+
event: "fingerout";
|
|
161
|
+
data: undefined;
|
|
162
|
+
}>;
|
|
163
|
+
};
|
|
164
|
+
getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
|
|
165
|
+
columnHeight: number;
|
|
166
|
+
columnWidth: number;
|
|
167
|
+
width: number;
|
|
168
|
+
};
|
|
169
|
+
getDimensionsForPaginatedContent: () => {
|
|
170
|
+
columnHeight: number;
|
|
171
|
+
columnWidth: number;
|
|
172
|
+
};
|
|
173
|
+
$: {
|
|
174
|
+
contentLayout$: import("rxjs").Observable<{
|
|
175
|
+
isFirstLayout: boolean;
|
|
176
|
+
isReady: boolean;
|
|
177
|
+
}>;
|
|
178
|
+
loaded$: import("rxjs").Observable<HTMLIFrameElement>;
|
|
179
|
+
isReady$: import("rxjs").Observable<boolean>;
|
|
180
|
+
};
|
|
181
|
+
} | undefined;
|
|
182
|
+
getCfiMetaInformation: (cfi: string) => {
|
|
183
|
+
spineItemIndex: number | undefined;
|
|
184
|
+
} | undefined;
|
|
185
|
+
getCfi: ((pageIndex: number, spineItem: SpineItem) => string) | ((pageIndex: number, spineItem: {
|
|
186
|
+
layout: ({ blankPagePosition, minimumWidth, spreadPosition }: {
|
|
187
|
+
blankPagePosition: "before" | "after" | "none";
|
|
25
188
|
minimumWidth: number;
|
|
26
|
-
spreadPosition: "
|
|
189
|
+
spreadPosition: "none" | "right" | "left";
|
|
27
190
|
}) => {
|
|
28
191
|
width: number;
|
|
29
192
|
height: number;
|
|
30
193
|
};
|
|
194
|
+
item: {
|
|
195
|
+
id: string;
|
|
196
|
+
href: string;
|
|
197
|
+
path: string;
|
|
198
|
+
renditionLayout: "reflowable" | "pre-paginated";
|
|
199
|
+
progressionWeight: number;
|
|
200
|
+
pageSpreadLeft: true | undefined;
|
|
201
|
+
pageSpreadRight: true | undefined;
|
|
202
|
+
mediaType?: string | undefined;
|
|
203
|
+
};
|
|
31
204
|
load: () => void;
|
|
32
205
|
adjustPositionOfElement: ({ right, left, top }: {
|
|
33
206
|
right?: number | undefined;
|
|
@@ -89,7 +262,6 @@ export declare const createCfiLocator: ({ spineItemManager, spineItemLocator }:
|
|
|
89
262
|
};
|
|
90
263
|
};
|
|
91
264
|
element: HTMLElement;
|
|
92
|
-
isReflowable: boolean;
|
|
93
265
|
getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
|
|
94
266
|
getViewPortInformation: () => {
|
|
95
267
|
computedScale: number;
|
|
@@ -98,13 +270,7 @@ export declare const createCfiLocator: ({ spineItemManager, spineItemLocator }:
|
|
|
98
270
|
width: number;
|
|
99
271
|
height: number;
|
|
100
272
|
};
|
|
101
|
-
} |
|
|
102
|
-
width?: number | undefined;
|
|
103
|
-
height?: number | undefined;
|
|
104
|
-
computedScale: number;
|
|
105
|
-
computedWidthScale: number;
|
|
106
|
-
viewportDimensions?: undefined;
|
|
107
|
-
};
|
|
273
|
+
} | undefined;
|
|
108
274
|
isImageType: () => boolean;
|
|
109
275
|
isReady: () => boolean;
|
|
110
276
|
destroy: () => void;
|
|
@@ -132,7 +298,7 @@ export declare const createCfiLocator: ({ spineItemManager, spineItemLocator }:
|
|
|
132
298
|
removeStyle: (id: string) => void;
|
|
133
299
|
addStyle: (id: string, style: string) => void;
|
|
134
300
|
})) => boolean) => boolean;
|
|
135
|
-
|
|
301
|
+
executeOnLayoutBeforeMeasurementHook: (options: {
|
|
136
302
|
minimumWidth: number;
|
|
137
303
|
}) => void;
|
|
138
304
|
selectionTracker: {
|
|
@@ -169,6 +335,15 @@ export declare const createCfiLocator: ({ spineItemManager, spineItemLocator }:
|
|
|
169
335
|
data: undefined;
|
|
170
336
|
}>;
|
|
171
337
|
};
|
|
338
|
+
getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
|
|
339
|
+
columnHeight: number;
|
|
340
|
+
columnWidth: number;
|
|
341
|
+
width: number;
|
|
342
|
+
};
|
|
343
|
+
getDimensionsForPaginatedContent: () => {
|
|
344
|
+
columnHeight: number;
|
|
345
|
+
columnWidth: number;
|
|
346
|
+
};
|
|
172
347
|
$: {
|
|
173
348
|
contentLayout$: import("rxjs").Observable<{
|
|
174
349
|
isFirstLayout: boolean;
|
|
@@ -177,11 +352,7 @@ export declare const createCfiLocator: ({ spineItemManager, spineItemLocator }:
|
|
|
177
352
|
loaded$: import("rxjs").Observable<HTMLIFrameElement>;
|
|
178
353
|
isReady$: import("rxjs").Observable<boolean>;
|
|
179
354
|
};
|
|
180
|
-
})
|
|
181
|
-
getCfiMetaInformation: (cfi: string) => {
|
|
182
|
-
spineItemIndex: number | undefined;
|
|
183
|
-
} | undefined;
|
|
184
|
-
getCfi: ((pageIndex: number, spineItem: SpineItem) => string) | ((pageIndex: number, spineItem: SpineItem) => string);
|
|
355
|
+
}) => string);
|
|
185
356
|
getRootCfi: (spineItem: SpineItem) => string;
|
|
186
357
|
resolveCfi: (cfiString: string) => {
|
|
187
358
|
node: Node | undefined;
|