@prose-reader/core 1.28.0 → 1.30.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.
- package/dist/cfi.d.ts +71 -101
- package/dist/constants.d.ts +6 -6
- package/dist/context.d.ts +43 -38
- package/dist/createReaderWithEnhancer.d.ts +5286 -6297
- package/dist/enhancers/accessibility.d.ts +4785 -5685
- package/dist/enhancers/chrome.d.ts +4785 -5685
- package/dist/enhancers/fonts.d.ts +4798 -5699
- package/dist/enhancers/hotkeys.d.ts +4785 -5685
- package/dist/enhancers/layoutEnhancer/createMovingSafePan$.d.ts +3 -3
- package/dist/enhancers/layoutEnhancer/fixReflowable.d.ts +2 -2
- package/dist/enhancers/layoutEnhancer/layoutEnhancer.d.ts +4792 -5696
- package/dist/enhancers/layoutEnhancer/types.d.ts +6 -6
- package/dist/enhancers/links.d.ts +4794 -5694
- package/dist/enhancers/loadingEnhancer.d.ts +4810 -5707
- package/dist/enhancers/media.d.ts +4785 -5685
- package/dist/enhancers/navigation.d.ts +4788 -5688
- package/dist/enhancers/pagination.d.ts +5165 -6133
- package/dist/enhancers/progression.d.ts +4798 -5709
- package/dist/enhancers/resources/index.d.ts +4785 -5685
- package/dist/enhancers/resources/indexedDB.d.ts +5 -5
- package/dist/enhancers/resources/resourcesManager.d.ts +5 -8
- package/dist/enhancers/theme.d.ts +4811 -5717
- package/dist/enhancers/types/enhancer.d.ts +4789 -5689
- package/dist/enhancers/utils.d.ts +4789 -5689
- package/dist/enhancers/webkit.d.ts +4785 -5685
- package/dist/enhancers/zoom/elementZoomer.d.ts +17 -25
- package/dist/enhancers/zoom/index.d.ts +4786 -5686
- package/dist/enhancers/zoom/types.d.ts +21 -26
- package/dist/enhancers/zoom/viewportZoomer.d.ts +17 -22
- package/dist/frames.d.ts +5 -7
- package/dist/index.d.ts +8 -8
- package/dist/pagination.d.ts +64 -73
- package/dist/prose.js +4851 -5294
- package/dist/prose.js.map +1 -1
- package/dist/prose.umd.cjs +4975 -5457
- package/dist/prose.umd.cjs.map +1 -1
- package/dist/reader.d.ts +4791 -5692
- package/dist/report.d.ts +25 -49
- package/dist/selection.d.ts +6 -9
- package/dist/settings.d.ts +36 -38
- package/dist/spine/cfiLocator.d.ts +359 -438
- package/dist/spine/createSpine.d.ts +29 -43
- package/dist/spine/eventsHelper.d.ts +10 -13
- package/dist/spine/locationResolver.d.ts +682 -820
- package/dist/spine/navigationResolver.d.ts +42 -51
- package/dist/spine/types.d.ts +8 -8
- package/dist/spineItem/commonSpineItem.d.ts +169 -205
- package/dist/spineItem/createSpineItem.d.ts +178 -213
- package/dist/spineItem/frameItem/createFrame$.d.ts +1 -3
- package/dist/spineItem/frameItem/createFrameManipulator.d.ts +4 -4
- package/dist/spineItem/frameItem/createHtmlPageFromResource.d.ts +2 -5
- package/dist/spineItem/frameItem/frameItem.d.ts +45 -54
- package/dist/spineItem/frameItem/loader.d.ts +26 -33
- package/dist/spineItem/locationResolver.d.ts +23 -35
- package/dist/spineItem/navigationResolver.d.ts +13 -11
- package/dist/spineItem/prePaginatedSpineItem.d.ts +177 -212
- package/dist/spineItem/reflowableSpineItem.d.ts +176 -204
- package/dist/spineItem/styles/getStyleForViewportDocument.d.ts +1 -1
- package/dist/spineItem/trackers.d.ts +31 -40
- package/dist/spineItem/types.d.ts +15 -12
- package/dist/spineItemManager.d.ts +532 -618
- package/dist/types/Hook.d.ts +69 -113
- package/dist/types/Spine.d.ts +37 -41
- package/dist/types/index.d.ts +8 -8
- package/dist/utils/dom.d.ts +18 -30
- package/dist/utils/layout.d.ts +7 -12
- package/dist/utils/manifest.d.ts +2 -2
- package/dist/utils/objects.d.ts +6 -12
- package/dist/utils/rxjs.d.ts +4 -9
- package/dist/viewportNavigator/manualViewportNavigator.d.ts +1367 -1624
- package/dist/viewportNavigator/panViewportNavigator.d.ts +214 -271
- package/dist/viewportNavigator/scrollViewportNavigator.d.ts +34 -37
- package/dist/viewportNavigator/types.d.ts +31 -36
- package/dist/viewportNavigator/viewportNavigator.d.ts +70 -100
- package/package.json +3 -3
package/dist/cfi.d.ts
CHANGED
|
@@ -1,104 +1,74 @@
|
|
|
1
1
|
declare class CFI {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
offset:
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
dom: Document,
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
offset?: number
|
|
69
|
-
}[],
|
|
70
|
-
dom: Document,
|
|
71
|
-
opts: {}
|
|
72
|
-
): {
|
|
73
|
-
node: Document
|
|
74
|
-
offset: number
|
|
75
|
-
}
|
|
76
|
-
resolveURI(
|
|
77
|
-
index: number,
|
|
78
|
-
dom: Document,
|
|
79
|
-
opts: {
|
|
80
|
-
ignoreIDs?: boolean
|
|
81
|
-
}
|
|
82
|
-
): any
|
|
83
|
-
deepClone(o: any): any
|
|
84
|
-
resolveLocation(dom: Document, parts: {}[]): any
|
|
85
|
-
resolveLast(dom: Document, opts: {}): string | {}
|
|
86
|
-
resolve(
|
|
87
|
-
doc: Document,
|
|
88
|
-
opts: {}
|
|
89
|
-
):
|
|
90
|
-
| {
|
|
91
|
-
node: Node
|
|
92
|
-
offset?: number
|
|
93
|
-
}
|
|
94
|
-
| {
|
|
95
|
-
node?: undefined
|
|
96
|
-
offset?: number
|
|
97
|
-
}
|
|
2
|
+
isRange: boolean;
|
|
3
|
+
parts: {}[];
|
|
4
|
+
opts: {};
|
|
5
|
+
cfi: string;
|
|
6
|
+
constructor(str: string, opts: {});
|
|
7
|
+
removeIllegalOpts(parts: any[]): void;
|
|
8
|
+
static generatePart(node: Element | Node, offset?: number, extra?: {}): string;
|
|
9
|
+
static generate(node: Node, offset?: number, extra?: {}): string;
|
|
10
|
+
static toParsed(cfi: any): any;
|
|
11
|
+
static comparePath(a: any[], b: any[]): number;
|
|
12
|
+
static sort(a: any): void;
|
|
13
|
+
static compare(a: any, b: any): number;
|
|
14
|
+
static compareParts(a: any, b: any): number;
|
|
15
|
+
decodeEntities(dom: Document, str: string): string;
|
|
16
|
+
trueLength(dom: Document, str: string): number;
|
|
17
|
+
getFrom(): any;
|
|
18
|
+
getTo(): any;
|
|
19
|
+
get(): any;
|
|
20
|
+
parseSideBias(o: any, loc: any): void;
|
|
21
|
+
parseSpatialRange(range: any): {
|
|
22
|
+
x: number;
|
|
23
|
+
y: number;
|
|
24
|
+
} | undefined;
|
|
25
|
+
parse(cfi: any): {
|
|
26
|
+
parsed: {};
|
|
27
|
+
offset: number;
|
|
28
|
+
newDoc: boolean;
|
|
29
|
+
};
|
|
30
|
+
getChildNodeByCFIIndex(dom: Document, parentNode: Element, index: number, offset: number): {
|
|
31
|
+
relativeToNode: string;
|
|
32
|
+
offset: number;
|
|
33
|
+
} | {
|
|
34
|
+
node: ChildNode | undefined;
|
|
35
|
+
relativeToNode: string;
|
|
36
|
+
offset: number;
|
|
37
|
+
} | {
|
|
38
|
+
node: ChildNode | undefined;
|
|
39
|
+
offset: number;
|
|
40
|
+
relativeToNode?: undefined;
|
|
41
|
+
} | undefined;
|
|
42
|
+
isTextNode(node: Element): boolean;
|
|
43
|
+
correctOffset(dom: Document, node: Element, offset: number, assertion: any): {
|
|
44
|
+
node: Element;
|
|
45
|
+
offset: any;
|
|
46
|
+
};
|
|
47
|
+
resolveNode(index: number, subparts: {
|
|
48
|
+
nodeIndex: number;
|
|
49
|
+
nodeID?: string;
|
|
50
|
+
offset?: number;
|
|
51
|
+
}[], dom: Document, opts: {}): {
|
|
52
|
+
node: Document;
|
|
53
|
+
offset: number;
|
|
54
|
+
};
|
|
55
|
+
resolveURI(index: number, dom: Document, opts: {
|
|
56
|
+
ignoreIDs?: boolean;
|
|
57
|
+
}): any;
|
|
58
|
+
deepClone(o: any): any;
|
|
59
|
+
resolveLocation(dom: Document, parts: {}[]): any;
|
|
60
|
+
resolveLast(dom: Document, opts: {}): string | {};
|
|
61
|
+
resolve(doc: Document, opts: {}): {
|
|
62
|
+
node: Node;
|
|
63
|
+
offset?: number;
|
|
64
|
+
} | {
|
|
65
|
+
node?: undefined;
|
|
66
|
+
offset?: number;
|
|
67
|
+
};
|
|
98
68
|
}
|
|
99
|
-
export { CFI }
|
|
69
|
+
export { CFI };
|
|
100
70
|
export declare const extractProseMetadataFromCfi: (cfi: string) => {
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
}
|
|
71
|
+
cleanedCfi: string;
|
|
72
|
+
itemId?: string | undefined;
|
|
73
|
+
offset?: number | undefined;
|
|
74
|
+
};
|
package/dist/constants.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export declare const __UNSAFE_REFERENCE_ORIGINAL_IFRAME_EVENT_KEY = "__UNSAFE_REFERENCE_ORIGINAL_IFRAME_EVENT"
|
|
2
|
-
export declare const PROSE_READER_NAMESPACE = "@prose-reader/core"
|
|
3
|
-
export declare const VIEWPORT_ADJUSTMENT_THROTTLE = 0
|
|
4
|
-
export declare const PAGINATION_UPDATE_AFTER_VIEWPORT_ADJUSTMENT_DEBOUNCE = 200
|
|
5
|
-
export declare const ITEM_EXTENSION_VALID_FOR_FRAME_SRC: string[]
|
|
6
|
-
export declare const HTML_PREFIX = "prose-reader"
|
|
1
|
+
export declare const __UNSAFE_REFERENCE_ORIGINAL_IFRAME_EVENT_KEY = "__UNSAFE_REFERENCE_ORIGINAL_IFRAME_EVENT";
|
|
2
|
+
export declare const PROSE_READER_NAMESPACE = "@prose-reader/core";
|
|
3
|
+
export declare const VIEWPORT_ADJUSTMENT_THROTTLE = 0;
|
|
4
|
+
export declare const PAGINATION_UPDATE_AFTER_VIEWPORT_ADJUSTMENT_DEBOUNCE = 200;
|
|
5
|
+
export declare const ITEM_EXTENSION_VALID_FOR_FRAME_SRC: string[];
|
|
6
|
+
export declare const HTML_PREFIX = "prose-reader";
|
package/dist/context.d.ts
CHANGED
|
@@ -1,39 +1,44 @@
|
|
|
1
|
-
import { Observable } from "rxjs"
|
|
2
|
-
import { Manifest } from "@prose-reader/shared"
|
|
3
|
-
import { createSettings, PublicSettings } from "./settings"
|
|
4
|
-
import { LoadOptions } from "./reader"
|
|
5
|
-
type SettingsManager = ReturnType<typeof createSettings
|
|
1
|
+
import { Observable } from "rxjs";
|
|
2
|
+
import { Manifest } from "@prose-reader/shared";
|
|
3
|
+
import { createSettings, PublicSettings } from "./settings";
|
|
4
|
+
import { LoadOptions } from "./reader";
|
|
5
|
+
type SettingsManager = ReturnType<typeof createSettings>;
|
|
6
6
|
export type Context = {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
7
|
+
load: (newManifest: Manifest, newLoadOptions: LoadOptions) => void;
|
|
8
|
+
setSettings: (data: Partial<PublicSettings>) => void;
|
|
9
|
+
getSettings: () => ReturnType<SettingsManager[`getSettings`]>;
|
|
10
|
+
getManifest: () => Manifest | undefined;
|
|
11
|
+
areAllItemsPrePaginated: () => boolean;
|
|
12
|
+
getLoadOptions: () => LoadOptions | undefined;
|
|
13
|
+
getCalculatedInnerMargin: () => number;
|
|
14
|
+
getVisibleAreaRect: () => {
|
|
15
|
+
width: number;
|
|
16
|
+
height: number;
|
|
17
|
+
x: number;
|
|
18
|
+
y: number;
|
|
19
|
+
};
|
|
20
|
+
shouldDisplaySpread: () => boolean;
|
|
21
|
+
setHasVerticalWriting: () => void;
|
|
22
|
+
getReadingDirection: () => Manifest[`readingDirection`] | undefined;
|
|
23
|
+
getPageSize: () => {
|
|
24
|
+
height: number;
|
|
25
|
+
width: number;
|
|
26
|
+
};
|
|
27
|
+
setVisibleAreaRect: (options: {
|
|
28
|
+
x: number;
|
|
29
|
+
y: number;
|
|
30
|
+
width: number;
|
|
31
|
+
height: number;
|
|
32
|
+
}) => void;
|
|
33
|
+
isRTL: () => boolean;
|
|
34
|
+
destroy: () => void;
|
|
35
|
+
$: {
|
|
36
|
+
hasVerticalWriting$: Observable<boolean>;
|
|
37
|
+
settings$: Observable<ReturnType<SettingsManager[`getSettings`]>>;
|
|
38
|
+
destroy$: Observable<void>;
|
|
39
|
+
load$: Observable<Manifest>;
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
export type ContextObservableEvents = {};
|
|
43
|
+
export declare const createContext: (initialSettings: Parameters<typeof createSettings>[0]) => Context;
|
|
44
|
+
export {};
|