@prose-reader/core 1.23.0 → 1.25.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 (74) 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
  74. package/dist/enhancers/cssFix.d.ts +0 -6639
package/dist/cfi.d.ts CHANGED
@@ -1,74 +1,104 @@
1
1
  declare class CFI {
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
- };
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
+ | {
23
+ x: number
24
+ y: number
25
+ }
26
+ | undefined
27
+ parse(cfi: any): {
28
+ parsed: {}
29
+ offset: number
30
+ newDoc: boolean
31
+ }
32
+ getChildNodeByCFIIndex(
33
+ dom: Document,
34
+ parentNode: Element,
35
+ index: number,
36
+ offset: number
37
+ ):
38
+ | {
39
+ relativeToNode: string
40
+ offset: number
41
+ }
42
+ | {
43
+ node: ChildNode | undefined
44
+ relativeToNode: string
45
+ offset: number
46
+ }
47
+ | {
48
+ node: ChildNode | undefined
49
+ offset: number
50
+ relativeToNode?: undefined
51
+ }
52
+ | undefined
53
+ isTextNode(node: Element): boolean
54
+ correctOffset(
55
+ dom: Document,
56
+ node: Element,
57
+ offset: number,
58
+ assertion: any
59
+ ): {
60
+ node: Element
61
+ offset: any
62
+ }
63
+ resolveNode(
64
+ index: number,
65
+ subparts: {
66
+ nodeIndex: number
67
+ nodeID?: string
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
+ }
68
98
  }
69
- export { CFI };
99
+ export { CFI }
70
100
  export declare const extractProseMetadataFromCfi: (cfi: string) => {
71
- cleanedCfi: string;
72
- itemId?: string | undefined;
73
- offset?: number | undefined;
74
- };
101
+ cleanedCfi: string
102
+ itemId?: string | undefined
103
+ offset?: number | undefined
104
+ }
@@ -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,44 +1,39 @@
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
- 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 {};
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: { x: number; y: number; width: number; height: number }) => void
28
+ isRTL: () => boolean
29
+ destroy: () => void
30
+ $: {
31
+ hasVerticalWriting$: Observable<boolean>
32
+ settings$: Observable<ReturnType<SettingsManager[`getSettings`]>>
33
+ destroy$: Observable<void>
34
+ load$: Observable<Manifest>
35
+ }
36
+ }
37
+ export type ContextObservableEvents = {}
38
+ export declare const createContext: (initialSettings: Parameters<typeof createSettings>[0]) => Context
39
+ export {}