@prose-reader/core 1.28.0 → 1.29.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 (75) hide show
  1. package/dist/cfi.d.ts +71 -101
  2. package/dist/constants.d.ts +6 -6
  3. package/dist/context.d.ts +43 -38
  4. package/dist/createReaderWithEnhancer.d.ts +5286 -6297
  5. package/dist/enhancers/accessibility.d.ts +4785 -5685
  6. package/dist/enhancers/chrome.d.ts +4785 -5685
  7. package/dist/enhancers/fonts.d.ts +4798 -5699
  8. package/dist/enhancers/hotkeys.d.ts +4785 -5685
  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 +4792 -5696
  12. package/dist/enhancers/layoutEnhancer/types.d.ts +6 -6
  13. package/dist/enhancers/links.d.ts +4794 -5694
  14. package/dist/enhancers/loadingEnhancer.d.ts +4810 -5707
  15. package/dist/enhancers/media.d.ts +4785 -5685
  16. package/dist/enhancers/navigation.d.ts +4788 -5688
  17. package/dist/enhancers/pagination.d.ts +5165 -6133
  18. package/dist/enhancers/progression.d.ts +4798 -5709
  19. package/dist/enhancers/resources/index.d.ts +4785 -5685
  20. package/dist/enhancers/resources/indexedDB.d.ts +5 -5
  21. package/dist/enhancers/resources/resourcesManager.d.ts +5 -8
  22. package/dist/enhancers/theme.d.ts +4811 -5717
  23. package/dist/enhancers/types/enhancer.d.ts +4789 -5689
  24. package/dist/enhancers/utils.d.ts +4789 -5689
  25. package/dist/enhancers/webkit.d.ts +4785 -5685
  26. package/dist/enhancers/zoom/elementZoomer.d.ts +17 -25
  27. package/dist/enhancers/zoom/index.d.ts +4786 -5686
  28. package/dist/enhancers/zoom/types.d.ts +21 -26
  29. package/dist/enhancers/zoom/viewportZoomer.d.ts +17 -22
  30. package/dist/frames.d.ts +5 -7
  31. package/dist/index.d.ts +8 -8
  32. package/dist/pagination.d.ts +64 -73
  33. package/dist/prose.js +4851 -5294
  34. package/dist/prose.js.map +1 -1
  35. package/dist/prose.umd.cjs +4975 -5457
  36. package/dist/prose.umd.cjs.map +1 -1
  37. package/dist/reader.d.ts +4791 -5692
  38. package/dist/report.d.ts +25 -49
  39. package/dist/selection.d.ts +6 -9
  40. package/dist/settings.d.ts +36 -38
  41. package/dist/spine/cfiLocator.d.ts +359 -438
  42. package/dist/spine/createSpine.d.ts +29 -43
  43. package/dist/spine/eventsHelper.d.ts +10 -13
  44. package/dist/spine/locationResolver.d.ts +682 -820
  45. package/dist/spine/navigationResolver.d.ts +42 -51
  46. package/dist/spine/types.d.ts +8 -8
  47. package/dist/spineItem/commonSpineItem.d.ts +169 -205
  48. package/dist/spineItem/createSpineItem.d.ts +178 -213
  49. package/dist/spineItem/frameItem/createFrame$.d.ts +1 -3
  50. package/dist/spineItem/frameItem/createFrameManipulator.d.ts +4 -4
  51. package/dist/spineItem/frameItem/createHtmlPageFromResource.d.ts +2 -5
  52. package/dist/spineItem/frameItem/frameItem.d.ts +45 -54
  53. package/dist/spineItem/frameItem/loader.d.ts +26 -33
  54. package/dist/spineItem/locationResolver.d.ts +23 -35
  55. package/dist/spineItem/navigationResolver.d.ts +13 -11
  56. package/dist/spineItem/prePaginatedSpineItem.d.ts +177 -212
  57. package/dist/spineItem/reflowableSpineItem.d.ts +176 -204
  58. package/dist/spineItem/styles/getStyleForViewportDocument.d.ts +1 -1
  59. package/dist/spineItem/trackers.d.ts +31 -40
  60. package/dist/spineItem/types.d.ts +15 -12
  61. package/dist/spineItemManager.d.ts +532 -618
  62. package/dist/types/Hook.d.ts +69 -113
  63. package/dist/types/Spine.d.ts +37 -41
  64. package/dist/types/index.d.ts +8 -8
  65. package/dist/utils/dom.d.ts +18 -30
  66. package/dist/utils/layout.d.ts +7 -12
  67. package/dist/utils/manifest.d.ts +2 -2
  68. package/dist/utils/objects.d.ts +6 -12
  69. package/dist/utils/rxjs.d.ts +4 -9
  70. package/dist/viewportNavigator/manualViewportNavigator.d.ts +1367 -1624
  71. package/dist/viewportNavigator/panViewportNavigator.d.ts +214 -271
  72. package/dist/viewportNavigator/scrollViewportNavigator.d.ts +34 -37
  73. package/dist/viewportNavigator/types.d.ts +31 -36
  74. package/dist/viewportNavigator/viewportNavigator.d.ts +70 -100
  75. package/package.json +3 -3
package/dist/report.d.ts CHANGED
@@ -1,50 +1,26 @@
1
1
  export declare const Report: {
2
- namespace: (namespace: string) => {
3
- log: (...data: any[]) => void
4
- warn: (...data: any[]) => void
5
- error: (...data: any[]) => void
6
- time: (name: string, targetDuration?: number) => () => void
7
- logMetric: (
8
- performanceEntry:
9
- | PerformanceEntry
10
- | {
11
- name: string
12
- duration: number
13
- },
14
- targetDuration?: number
15
- ) => void
16
- measurePerformance: <F extends (...args: any[]) => any>(
17
- name: string,
18
- targetDuration: number | undefined,
19
- functionToMeasure: F,
20
- {
21
- disable,
22
- }?: {
23
- disable?: boolean | undefined
24
- }
25
- ) => F | ((...args: Parameters<F>) => ReturnType<F>)
26
- }
27
- log: (...data: any[]) => void
28
- warn: (...data: any[]) => void
29
- error: (...data: any[]) => void
30
- time: (name: string, targetDuration?: number) => () => void
31
- logMetric: (
32
- performanceEntry:
33
- | PerformanceEntry
34
- | {
35
- name: string
36
- duration: number
37
- },
38
- targetDuration?: number
39
- ) => void
40
- measurePerformance: <F extends (...args: any[]) => any>(
41
- name: string,
42
- targetDuration: number | undefined,
43
- functionToMeasure: F,
44
- {
45
- disable,
46
- }?: {
47
- disable?: boolean | undefined
48
- }
49
- ) => F | ((...args: Parameters<F>) => ReturnType<F>)
50
- }
2
+ namespace: (namespace: string) => {
3
+ log: (...data: any[]) => void;
4
+ warn: (...data: any[]) => void;
5
+ error: (...data: any[]) => void;
6
+ time: (name: string, targetDuration?: number) => () => void;
7
+ logMetric: (performanceEntry: PerformanceEntry | {
8
+ name: string;
9
+ duration: number;
10
+ }, targetDuration?: number) => void;
11
+ measurePerformance: <F extends (...args: any[]) => any>(name: string, targetDuration: number | undefined, functionToMeasure: F, { disable }?: {
12
+ disable?: boolean | undefined;
13
+ }) => F | ((...args: Parameters<F>) => ReturnType<F>);
14
+ };
15
+ log: (...data: any[]) => void;
16
+ warn: (...data: any[]) => void;
17
+ error: (...data: any[]) => void;
18
+ time: (name: string, targetDuration?: number) => () => void;
19
+ logMetric: (performanceEntry: PerformanceEntry | {
20
+ name: string;
21
+ duration: number;
22
+ }, targetDuration?: number) => void;
23
+ measurePerformance: <F extends (...args: any[]) => any>(name: string, targetDuration: number | undefined, functionToMeasure: F, { disable }?: {
24
+ disable?: boolean | undefined;
25
+ }) => F | ((...args: Parameters<F>) => ReturnType<F>);
26
+ };
@@ -1,9 +1,6 @@
1
- import { Manifest } from "./types"
2
- export declare const createSelection: (
3
- selection: Selection,
4
- item: Manifest[`spineItems`][number]
5
- ) => {
6
- toString: () => string
7
- getAnchorCfi: () => string | undefined
8
- getFocusCfi: () => string | undefined
9
- }
1
+ import { Manifest } from "./types";
2
+ export declare const createSelection: (selection: Selection, item: Manifest[`spineItems`][number]) => {
3
+ toString: () => string;
4
+ getAnchorCfi: () => string | undefined;
5
+ getFocusCfi: () => string | undefined;
6
+ };
@@ -1,41 +1,39 @@
1
- import { Manifest } from "./types"
1
+ import { Manifest } from "./types";
2
2
  export type PublicSettings = {
3
- forceSinglePageMode: boolean
4
- pageTurnAnimation: `none` | `fade` | `slide`
5
- pageTurnAnimationDuration: undefined | number
6
- pageTurnDirection: `vertical` | `horizontal`
7
- pageTurnMode: `controlled` | `scrollable`
8
- navigationSnapThreshold: number
9
- numberOfAdjacentSpineItemToPreLoad: number
10
- }
3
+ forceSinglePageMode: boolean;
4
+ pageTurnAnimation: `none` | `fade` | `slide`;
5
+ pageTurnAnimationDuration: undefined | number;
6
+ pageTurnDirection: `vertical` | `horizontal`;
7
+ pageTurnMode: `controlled` | `scrollable`;
8
+ navigationSnapThreshold: number;
9
+ numberOfAdjacentSpineItemToPreLoad: number;
10
+ };
11
11
  type InnerSettings = PublicSettings & {
12
- computedPageTurnMode: PublicSettings[`pageTurnMode`]
13
- computedPageTurnDirection: PublicSettings[`pageTurnDirection`]
14
- computedPageTurnAnimation: PublicSettings[`pageTurnAnimation`]
15
- computedPageTurnAnimationDuration: number
16
- computedSnapAnimationDuration: number
17
- }
12
+ computedPageTurnMode: PublicSettings[`pageTurnMode`];
13
+ computedPageTurnDirection: PublicSettings[`pageTurnDirection`];
14
+ computedPageTurnAnimation: PublicSettings[`pageTurnAnimation`];
15
+ computedPageTurnAnimationDuration: number;
16
+ computedSnapAnimationDuration: number;
17
+ };
18
18
  export declare const createSettings: (initialSettings: Partial<PublicSettings>) => {
19
- getSettings: () => InnerSettings
20
- setSettings: (
21
- newSettings: Partial<PublicSettings>,
22
- options: {
23
- hasVerticalWritingSubject: boolean
24
- manifest: Manifest | undefined
25
- }
26
- ) => void
27
- recompute: (options: { hasVerticalWritingSubject: boolean; manifest: Manifest | undefined }) => void
28
- destroy: () => void
29
- $: {
30
- settings$: import("rxjs").Observable<
31
- PublicSettings & {
32
- computedPageTurnMode: PublicSettings[`pageTurnMode`]
33
- computedPageTurnDirection: PublicSettings[`pageTurnDirection`]
34
- computedPageTurnAnimation: PublicSettings[`pageTurnAnimation`]
35
- computedPageTurnAnimationDuration: number
36
- computedSnapAnimationDuration: number
37
- }
38
- >
39
- }
40
- }
41
- export {}
19
+ getSettings: () => InnerSettings;
20
+ setSettings: (newSettings: Partial<PublicSettings>, options: {
21
+ hasVerticalWritingSubject: boolean;
22
+ manifest: Manifest | undefined;
23
+ }) => void;
24
+ recompute: (options: {
25
+ hasVerticalWritingSubject: boolean;
26
+ manifest: Manifest | undefined;
27
+ }) => void;
28
+ destroy: () => void;
29
+ $: {
30
+ settings$: import("rxjs").Observable<PublicSettings & {
31
+ computedPageTurnMode: PublicSettings[`pageTurnMode`];
32
+ computedPageTurnDirection: PublicSettings[`pageTurnDirection`];
33
+ computedPageTurnAnimation: PublicSettings[`pageTurnAnimation`];
34
+ computedPageTurnAnimationDuration: number;
35
+ computedSnapAnimationDuration: number;
36
+ }>;
37
+ };
38
+ };
39
+ export {};