@prose-reader/core 1.24.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 (73) 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
@@ -1,22 +1,27 @@
1
- import { Observable } from "rxjs";
1
+ import { Observable } from "rxjs"
2
2
  export type Api = {
3
- zoom: {
4
- enter: (imgElement?: HTMLImageElement) => void;
5
- exit: () => void;
6
- move: (position: {
7
- x: number;
8
- y: number;
9
- } | undefined, details: {
10
- isFirst: boolean;
11
- isLast: boolean;
12
- }) => void;
13
- isZooming: () => boolean;
14
- isUsingScrollableZoom: () => boolean;
15
- getScaleValue: () => number;
16
- scale: (scale: number) => void;
17
- setCurrentScaleAsBase: () => void;
18
- $: {
19
- isZooming$: Observable<boolean>;
20
- };
21
- };
22
- };
3
+ zoom: {
4
+ enter: (imgElement?: HTMLImageElement) => void
5
+ exit: () => void
6
+ move: (
7
+ position:
8
+ | {
9
+ x: number
10
+ y: number
11
+ }
12
+ | undefined,
13
+ details: {
14
+ isFirst: boolean
15
+ isLast: boolean
16
+ }
17
+ ) => void
18
+ isZooming: () => boolean
19
+ isUsingScrollableZoom: () => boolean
20
+ getScaleValue: () => number
21
+ scale: (scale: number) => void
22
+ setCurrentScaleAsBase: () => void
23
+ $: {
24
+ isZooming$: Observable<boolean>
25
+ }
26
+ }
27
+ }
@@ -1,18 +1,23 @@
1
- import { Reader } from "../../reader";
1
+ import { Reader } from "../../reader"
2
2
  export declare const createViewportZoomer: (reader: Reader) => {
3
- enter: () => void;
4
- exit: () => void;
5
- move: (_: {
6
- x: number;
7
- y: number;
8
- } | undefined, __: {
9
- isFirst: boolean;
10
- isLast: boolean;
11
- }) => void;
12
- scale: (userScale: number) => void;
13
- setCurrentScaleAsBase: () => void;
14
- getScaleValue: () => number;
15
- isZooming: () => boolean;
16
- destroy: () => void;
17
- isZooming$: import("rxjs").Observable<boolean>;
18
- };
3
+ enter: () => void
4
+ exit: () => void
5
+ move: (
6
+ _:
7
+ | {
8
+ x: number
9
+ y: number
10
+ }
11
+ | undefined,
12
+ __: {
13
+ isFirst: boolean
14
+ isLast: boolean
15
+ }
16
+ ) => void
17
+ scale: (userScale: number) => void
18
+ setCurrentScaleAsBase: () => void
19
+ getScaleValue: () => number
20
+ isZooming: () => boolean
21
+ destroy: () => void
22
+ isZooming$: import("rxjs").Observable<boolean>
23
+ }
package/dist/frames.d.ts CHANGED
@@ -1,5 +1,7 @@
1
- export declare const createRemoveStyleHelper: (frameElement: HTMLIFrameElement | undefined) => (id: string) => void;
2
- export declare const createAddStyleHelper: (frameElement: HTMLIFrameElement | undefined) => (id: string, style: string, prepend?: boolean) => void;
3
- export declare const getAttributeValueFromString: (string: string, key: string) => number;
4
- export declare const getOriginalFrameEventFromDocumentEvent: <E extends Event>(event: E) => E | undefined;
5
- export declare const attachOriginalFrameEventToDocumentEvent: <E extends Event>(event: E, frameEvent: E) => void;
1
+ export declare const createRemoveStyleHelper: (frameElement: HTMLIFrameElement | undefined) => (id: string) => void
2
+ export declare const createAddStyleHelper: (
3
+ frameElement: HTMLIFrameElement | undefined
4
+ ) => (id: string, style: string, prepend?: boolean) => void
5
+ export declare const getAttributeValueFromString: (string: string, key: string) => number
6
+ export declare const getOriginalFrameEventFromDocumentEvent: <E extends Event>(event: E) => E | undefined
7
+ export declare const attachOriginalFrameEventToDocumentEvent: <E extends Event>(event: E, frameEvent: E) => void
package/dist/index.d.ts CHANGED
@@ -1,8 +1,8 @@
1
- import { createSelection } from "./selection";
2
- export type { Manifest } from "./types";
3
- import { createReaderWithEnhancers } from "./createReaderWithEnhancer";
4
- export type Reader = ReturnType<typeof createReaderWithEnhancers>;
5
- export { createReaderWithEnhancers as createReader };
6
- export type ReaderSelection = ReturnType<typeof createSelection>;
7
- export { Report } from "./report";
8
- export { groupBy, isShallowEqual } from "./utils/objects";
1
+ import { createSelection } from "./selection"
2
+ export type { Manifest } from "./types"
3
+ import { createReaderWithEnhancers } from "./createReaderWithEnhancer"
4
+ export type Reader = ReturnType<typeof createReaderWithEnhancers>
5
+ export { createReaderWithEnhancers as createReader }
6
+ export type ReaderSelection = ReturnType<typeof createSelection>
7
+ export { Report } from "./report"
8
+ export { groupBy, isShallowEqual } from "./utils/objects"
@@ -1,65 +1,74 @@
1
- import { Context } from "./context";
2
- import { SpineItem } from "./spineItem/createSpineItem";
3
- import { SpineItemManager } from "./spineItemManager";
1
+ import { Context } from "./context"
2
+ import { SpineItem } from "./spineItem/createSpineItem"
3
+ import { SpineItemManager } from "./spineItemManager"
4
4
  type PaginationInfo = {
5
- beginPageIndex: number | undefined;
6
- beginNumberOfPages: number;
7
- beginCfi: string | undefined;
8
- beginSpineItemIndex: number | undefined;
9
- endPageIndex: number | undefined;
10
- endNumberOfPages: number;
11
- endCfi: string | undefined;
12
- endSpineItemIndex: number | undefined;
13
- };
14
- export declare const createPagination: ({ context }: {
15
- context: Context;
16
- spineItemManager: SpineItemManager;
17
- }) => {
18
- destroy: () => void;
19
- updateBeginAndEnd: ((begin: {
20
- spineItem: SpineItem;
21
- pageIndex: number;
22
- cfi: string | undefined;
23
- options: {
24
- isAtEndOfChapter?: boolean;
25
- };
26
- } & {
27
- spineItemIndex: number;
28
- }, end: {
29
- spineItem: SpineItem;
30
- pageIndex: number;
31
- cfi: string | undefined;
32
- options: {
33
- isAtEndOfChapter?: boolean;
34
- };
35
- } & {
36
- spineItemIndex: number;
37
- }) => void) | ((begin: {
38
- spineItem: SpineItem;
39
- pageIndex: number;
40
- cfi: string | undefined;
41
- options: {
42
- isAtEndOfChapter?: boolean;
43
- };
44
- } & {
45
- spineItemIndex: number;
46
- }, end: {
47
- spineItem: SpineItem;
48
- pageIndex: number;
49
- cfi: string | undefined;
50
- options: {
51
- isAtEndOfChapter?: boolean;
52
- };
53
- } & {
54
- spineItemIndex: number;
55
- }) => void);
56
- getInfo: () => PaginationInfo;
57
- $: {
58
- info$: import("rxjs").Observable<PaginationInfo>;
59
- };
60
- };
61
- export type Pagination = ReturnType<typeof createPagination>;
62
- export declare const getItemOffsetFromPageIndex: (pageWidth: number, pageIndex: number, itemWidth: number) => number;
63
- export declare const getNumberOfPages: (itemWidth: number, pageWidth: number) => number;
64
- export declare const getClosestValidOffsetFromApproximateOffsetInPages: (offset: number, pageWidth: number, itemWidth: number) => number;
65
- export {};
5
+ beginPageIndex: number | undefined
6
+ beginNumberOfPages: number
7
+ beginCfi: string | undefined
8
+ beginSpineItemIndex: number | undefined
9
+ endPageIndex: number | undefined
10
+ endNumberOfPages: number
11
+ endCfi: string | undefined
12
+ endSpineItemIndex: number | undefined
13
+ }
14
+ export declare const createPagination: ({ context }: { context: Context; spineItemManager: SpineItemManager }) => {
15
+ destroy: () => void
16
+ updateBeginAndEnd:
17
+ | ((
18
+ begin: {
19
+ spineItem: SpineItem
20
+ pageIndex: number
21
+ cfi: string | undefined
22
+ options: {
23
+ isAtEndOfChapter?: boolean
24
+ }
25
+ } & {
26
+ spineItemIndex: number
27
+ },
28
+ end: {
29
+ spineItem: SpineItem
30
+ pageIndex: number
31
+ cfi: string | undefined
32
+ options: {
33
+ isAtEndOfChapter?: boolean
34
+ }
35
+ } & {
36
+ spineItemIndex: number
37
+ }
38
+ ) => void)
39
+ | ((
40
+ begin: {
41
+ spineItem: SpineItem
42
+ pageIndex: number
43
+ cfi: string | undefined
44
+ options: {
45
+ isAtEndOfChapter?: boolean
46
+ }
47
+ } & {
48
+ spineItemIndex: number
49
+ },
50
+ end: {
51
+ spineItem: SpineItem
52
+ pageIndex: number
53
+ cfi: string | undefined
54
+ options: {
55
+ isAtEndOfChapter?: boolean
56
+ }
57
+ } & {
58
+ spineItemIndex: number
59
+ }
60
+ ) => void)
61
+ getInfo: () => PaginationInfo
62
+ $: {
63
+ info$: import("rxjs").Observable<PaginationInfo>
64
+ }
65
+ }
66
+ export type Pagination = ReturnType<typeof createPagination>
67
+ export declare const getItemOffsetFromPageIndex: (pageWidth: number, pageIndex: number, itemWidth: number) => number
68
+ export declare const getNumberOfPages: (itemWidth: number, pageWidth: number) => number
69
+ export declare const getClosestValidOffsetFromApproximateOffsetInPages: (
70
+ offset: number,
71
+ pageWidth: number,
72
+ itemWidth: number
73
+ ) => number
74
+ export {}