@prose-reader/core 1.20.0 → 1.22.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 (35) hide show
  1. package/dist/context.d.ts +6 -1
  2. package/dist/createReaderWithEnhancer.d.ts +233 -805
  3. package/dist/enhancers/accessibility.d.ts +231 -805
  4. package/dist/enhancers/chrome.d.ts +231 -805
  5. package/dist/enhancers/cssFix.d.ts +6639 -0
  6. package/dist/enhancers/fonts.d.ts +233 -807
  7. package/dist/enhancers/hotkeys.d.ts +231 -805
  8. package/dist/enhancers/layoutEnhancer/layoutEnhancer.d.ts +231 -805
  9. package/dist/enhancers/links.d.ts +231 -805
  10. package/dist/enhancers/loadingEnhancer.d.ts +231 -805
  11. package/dist/enhancers/media.d.ts +231 -805
  12. package/dist/enhancers/navigation.d.ts +231 -805
  13. package/dist/enhancers/pagination.d.ts +233 -805
  14. package/dist/enhancers/progression.d.ts +231 -805
  15. package/dist/enhancers/resources/index.d.ts +231 -805
  16. package/dist/enhancers/theme.d.ts +231 -805
  17. package/dist/enhancers/types/enhancer.d.ts +231 -805
  18. package/dist/enhancers/utils.d.ts +231 -805
  19. package/dist/enhancers/webkit.d.ts +231 -805
  20. package/dist/enhancers/zoom/index.d.ts +231 -805
  21. package/dist/prose.js +300 -278
  22. package/dist/prose.js.map +1 -1
  23. package/dist/prose.umd.cjs +299 -277
  24. package/dist/prose.umd.cjs.map +1 -1
  25. package/dist/reader.d.ts +231 -805
  26. package/dist/spine/locationResolver.d.ts +7 -17
  27. package/dist/spine/navigationResolver.d.ts +5 -8
  28. package/dist/spine/types.d.ts +10 -0
  29. package/dist/spineItem/locationResolver.d.ts +3 -7
  30. package/dist/spineItem/navigationResolver.d.ts +7 -17
  31. package/dist/spineItem/types.d.ts +19 -0
  32. package/dist/spineItemManager.d.ts +6 -519
  33. package/dist/types/Hook.d.ts +6 -6
  34. package/dist/types/Spine.d.ts +1 -5
  35. package/package.json +3 -3
@@ -2,24 +2,17 @@ import { Context } from "../context";
2
2
  import { SpineItem } from "../spineItem/createSpineItem";
3
3
  import { createLocationResolver as createSpineItemLocator } from "../spineItem/locationResolver";
4
4
  import { SpineItemManager } from "../spineItemManager";
5
- type SpinePosition = {
6
- x: number;
7
- y: number;
8
- };
9
- type SpineItemPosition = {
10
- x: number;
11
- y: number;
12
- outsideOfBoundaries?: boolean;
13
- };
5
+ import { SpineItemNavigationPosition, SpineItemPosition, UnsafeSpineItemPosition } from "../spineItem/types";
6
+ import { SpinePosition, UnsafeSpinePosition } from "./types";
14
7
  export declare const createLocationResolver: ({ spineItemManager, context, spineItemLocator, }: {
15
8
  spineItemManager: SpineItemManager;
16
9
  context: Context;
17
10
  spineItemLocator: ReturnType<typeof createSpineItemLocator>;
18
11
  }) => {
19
- getSpinePositionFromSpineItemPosition: (spineItemPosition: SpineItemPosition, spineItem: SpineItem) => SpinePosition;
12
+ getSpinePositionFromSpineItemPosition: (spineItemPosition: SpineItemNavigationPosition | SpineItemPosition, spineItem: SpineItem) => SpinePosition;
20
13
  getSpinePositionFromSpineItem: (spineItem: SpineItem) => SpinePosition;
21
14
  getSpinePositionFromSpineItemAnchor: (anchor: string, spineItem: SpineItem) => SpinePosition;
22
- getSpineItemPositionFromSpinePosition: ((position: SpinePosition, spineItem: SpineItem) => SpineItemPosition) | ((position: SpinePosition, spineItem: {
15
+ getSpineItemPositionFromSpinePosition: ((position: UnsafeSpinePosition, spineItem: SpineItem) => UnsafeSpineItemPosition) | ((position: UnsafeSpinePosition, spineItem: {
23
16
  layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
24
17
  blankPagePosition: "after" | "before" | "none";
25
18
  minimumWidth: number;
@@ -187,8 +180,8 @@ export declare const createLocationResolver: ({ spineItemManager, context, spine
187
180
  loaded$: import("rxjs").Observable<HTMLIFrameElement>;
188
181
  isReady$: import("rxjs").Observable<boolean>;
189
182
  };
190
- }) => SpineItemPosition);
191
- getSpineItemFromPosition: ((position: SpinePosition) => {
183
+ }) => UnsafeSpineItemPosition);
184
+ getSpineItemFromPosition: ((position: UnsafeSpinePosition) => {
192
185
  layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
193
186
  blankPagePosition: "after" | "before" | "none";
194
187
  minimumWidth: number;
@@ -356,7 +349,7 @@ export declare const createLocationResolver: ({ spineItemManager, context, spine
356
349
  loaded$: import("rxjs").Observable<HTMLIFrameElement>;
357
350
  isReady$: import("rxjs").Observable<boolean>;
358
351
  };
359
- } | undefined) | ((position: SpinePosition) => {
352
+ } | undefined) | ((position: UnsafeSpinePosition) => {
360
353
  layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
361
354
  blankPagePosition: "after" | "before" | "none";
362
355
  minimumWidth: number;
@@ -696,12 +689,9 @@ export declare const createLocationResolver: ({ spineItemManager, context, spine
696
689
  } | undefined;
697
690
  getSpineItemPageIndexFromNode: (node: Node, offset: number | undefined, spineItemOrIndex: SpineItem | number) => number | undefined;
698
691
  getSpineItemsFromReadingOrderPosition: (position: SpinePosition) => {
699
- left: number;
700
- right: number;
701
692
  begin: number;
702
693
  beginPosition: SpinePosition;
703
694
  end: number;
704
695
  endPosition: SpinePosition;
705
696
  } | undefined;
706
697
  };
707
- export {};
@@ -3,6 +3,7 @@ import { SpineItemManager } from "../spineItemManager";
3
3
  import { SpineItem } from "../spineItem/createSpineItem";
4
4
  import { createLocationResolver } from "./locationResolver";
5
5
  import { createCfiLocator } from "./cfiLocator";
6
+ import { SpinePosition, UnsafeSpinePosition } from "./types";
6
7
  export type ViewportNavigationEntry = {
7
8
  x: number;
8
9
  y: number;
@@ -12,10 +13,6 @@ type ViewportPosition = {
12
13
  x: number;
13
14
  y: number;
14
15
  };
15
- type SpineItemPosition = {
16
- x: number;
17
- y: number;
18
- };
19
16
  export declare const createNavigationResolver: ({ context, spineItemManager, cfiLocator, locator, }: {
20
17
  context: Context;
21
18
  spineItemManager: SpineItemManager;
@@ -26,18 +23,18 @@ export declare const createNavigationResolver: ({ context, spineItemManager, cfi
26
23
  getNavigationForPage: (pageIndex: number, spineItem?: SpineItem) => ViewportNavigationEntry;
27
24
  getNavigationForLastPage: (spineItem: SpineItem) => ViewportNavigationEntry;
28
25
  getNavigationForSpineIndexOrId: (indexOrId: number | string) => ViewportNavigationEntry;
29
- getNavigationForRightPage: (position: SpineItemPosition) => ViewportNavigationEntry;
30
- getNavigationForLeftPage: (position: SpineItemPosition) => ViewportNavigationEntry;
26
+ getNavigationForRightPage: (position: SpinePosition) => ViewportNavigationEntry;
27
+ getNavigationForLeftPage: (position: UnsafeSpinePosition) => SpinePosition;
31
28
  getNavigationForUrl: (url: string | URL) => (ViewportNavigationEntry & {
32
29
  url: URL;
33
30
  }) | undefined;
34
31
  getNavigationForAnchor: (anchor: string, spineItem: SpineItem) => ViewportNavigationEntry;
35
32
  getNavigationForPosition: (viewportPosition: ViewportPosition) => ViewportNavigationEntry;
36
33
  getMostPredominantNavigationForPosition: (viewportPosition: ViewportPosition) => ViewportNavigationEntry;
37
- wrapPositionWithSafeEdge: ((position: SpineItemPosition) => {
34
+ wrapPositionWithSafeEdge: ((position: SpinePosition) => {
38
35
  x: number;
39
36
  y: number;
40
- }) | ((position: SpineItemPosition) => {
37
+ }) | ((position: SpinePosition) => {
41
38
  x: number;
42
39
  y: number;
43
40
  });
@@ -0,0 +1,10 @@
1
+ export type SpinePosition = {
2
+ x: number;
3
+ y: number;
4
+ __symbol?: `SpinePosition`;
5
+ };
6
+ export type UnsafeSpinePosition = {
7
+ x: number;
8
+ y: number;
9
+ __symbol?: `UnsafeSpinePosition` | `SpinePosition`;
10
+ };
@@ -1,9 +1,6 @@
1
1
  import { Context } from "../context";
2
2
  import { SpineItem } from "./createSpineItem";
3
- type SpineItemPosition = {
4
- x: number;
5
- y: number;
6
- };
3
+ import { SpineItemPosition, UnsafeSpineItemPosition } from "./types";
7
4
  export declare const createLocationResolver: ({ context }: {
8
5
  context: Context;
9
6
  }) => {
@@ -13,9 +10,9 @@ export declare const createLocationResolver: ({ context }: {
13
10
  } | undefined;
14
11
  getSpineItemPositionFromPageIndex: (pageIndex: number, spineItem: SpineItem) => SpineItemPosition;
15
12
  getSpineItemOffsetFromAnchor: (anchor: string, spineItem: SpineItem) => number;
16
- getSpineItemPageIndexFromPosition: (position: SpineItemPosition, spineItem: SpineItem) => number;
13
+ getSpineItemPageIndexFromPosition: (position: UnsafeSpineItemPosition, spineItem: SpineItem) => number;
17
14
  getSpineItemPageIndexFromNode: (node: Node, offset: number, spineItem: SpineItem) => number | undefined;
18
- getSpineItemClosestPositionFromUnsafePosition: (unsafePosition: SpineItemPosition, spineItem: SpineItem) => {
15
+ getSpineItemClosestPositionFromUnsafePosition: (unsafePosition: UnsafeSpineItemPosition, spineItem: SpineItem) => {
19
16
  x: number;
20
17
  y: number;
21
18
  };
@@ -24,4 +21,3 @@ export declare const createLocationResolver: ({ context }: {
24
21
  offset: number;
25
22
  } | undefined;
26
23
  };
27
- export {};
@@ -1,23 +1,13 @@
1
1
  import { SpineItem } from "./createSpineItem";
2
2
  import { Context } from "../context";
3
- type SpineItemPosition = {
4
- x: number;
5
- y: number;
6
- };
3
+ import { SpineItemNavigationPosition, UnsafeSpineItemPosition } from "./types";
7
4
  export declare const createNavigationResolver: ({ context }: {
8
5
  context: Context;
9
6
  }) => {
10
- getNavigationForLeftPage: (position: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
11
- getNavigationForRightPage: (position: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
12
- getNavigationForLastPage: (spineItem: SpineItem) => SpineItemPosition;
13
- getNavigationForPage: (pageIndex: number, spineItem: SpineItem) => SpineItemPosition;
14
- getNavigationForPosition: (spineItem: SpineItem, position: SpineItemPosition) => {
15
- x: number;
16
- y: number;
17
- };
18
- getNavigationFromNode: (spineItem: SpineItem, node: Node, offset: number) => {
19
- x: number;
20
- y: number;
21
- };
7
+ getNavigationForLeftPage: (position: UnsafeSpineItemPosition, spineItem: SpineItem) => SpineItemNavigationPosition;
8
+ getNavigationForRightPage: (position: UnsafeSpineItemPosition, spineItem: SpineItem) => SpineItemNavigationPosition;
9
+ getNavigationForLastPage: (spineItem: SpineItem) => SpineItemNavigationPosition;
10
+ getNavigationForPage: (pageIndex: number, spineItem: SpineItem) => SpineItemNavigationPosition;
11
+ getNavigationForPosition: (spineItem: SpineItem, position: UnsafeSpineItemPosition) => SpineItemNavigationPosition;
12
+ getNavigationFromNode: (spineItem: SpineItem, node: Node, offset: number) => SpineItemNavigationPosition;
22
13
  };
23
- export {};
@@ -0,0 +1,19 @@
1
+ export type SpineItemPosition = {
2
+ x: number;
3
+ y: number;
4
+ __symbol?: `SpineItemPosition`;
5
+ };
6
+ export type UnsafeSpineItemPosition = {
7
+ x: number;
8
+ y: number;
9
+ __symbol?: `UnsafeSpineItemPosition` | `SpineItemPosition`;
10
+ };
11
+ export declare class SpineItemNavigationPosition {
12
+ __symbol: string;
13
+ x: number;
14
+ y: number;
15
+ constructor(position: {
16
+ x: number;
17
+ y: number;
18
+ });
19
+ }