@prose-reader/core 1.208.0 → 1.210.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 (62) hide show
  1. package/dist/cfi/generate.d.ts +22 -0
  2. package/dist/cfi/generate.test.d.ts +1 -0
  3. package/dist/cfi/index.d.ts +3 -0
  4. package/dist/cfi/{lookup/parseCfi.d.ts → parse.d.ts} +1 -0
  5. package/dist/cfi/parse.test.d.ts +1 -0
  6. package/dist/cfi/{lookup/resolveCfi.d.ts → resolve.d.ts} +4 -4
  7. package/dist/context/BridgeEvent.d.ts +2 -2
  8. package/dist/context/Context.d.ts +1 -1
  9. package/dist/createReaderWithEnhancer.d.ts +18 -18
  10. package/dist/enhancers/html/renderer/HtmlRenderer.d.ts +1 -1
  11. package/dist/enhancers/navigation/resolvers/getNavigationForLeftOrTopPage.d.ts +1 -1
  12. package/dist/enhancers/navigation/resolvers/getNavigationForLeftSinglePage.d.ts +1 -1
  13. package/dist/enhancers/navigation/resolvers/getNavigationForRightOrBottomPage.d.ts +1 -1
  14. package/dist/enhancers/navigation/resolvers/getNavigationForRightSinglePage.d.ts +1 -1
  15. package/dist/enhancers/pagination/pagination.d.ts +1 -1
  16. package/dist/enhancers/pagination/types.d.ts +1 -1
  17. package/dist/index.js +2753 -3236
  18. package/dist/index.js.map +1 -1
  19. package/dist/index.umd.cjs +49 -49
  20. package/dist/index.umd.cjs.map +1 -1
  21. package/dist/navigation/InternalNavigator.d.ts +4 -32
  22. package/dist/navigation/Navigator.d.ts +10 -10
  23. package/dist/navigation/consolidation/consolidateWithPagination.d.ts +2 -2
  24. package/dist/navigation/consolidation/mapUserNavigationToInternal.d.ts +1 -2
  25. package/dist/navigation/consolidation/withCfiPosition.d.ts +1 -1
  26. package/dist/navigation/consolidation/withDirection.d.ts +1 -1
  27. package/dist/navigation/consolidation/withFallbackPosition.d.ts +1 -1
  28. package/dist/navigation/consolidation/withPaginationInfo.d.ts +2 -2
  29. package/dist/navigation/consolidation/withSpineItem.d.ts +1 -1
  30. package/dist/navigation/consolidation/withSpineItemLayoutInfo.d.ts +1 -1
  31. package/dist/navigation/consolidation/withSpineItemPosition.d.ts +1 -1
  32. package/dist/navigation/consolidation/withUrlInfo.d.ts +1 -1
  33. package/dist/navigation/controllers/ControlledNavigationController.d.ts +0 -1
  34. package/dist/navigation/controllers/getScaledDownPosition.d.ts +1 -1
  35. package/dist/navigation/resolvers/NavigationResolver.d.ts +1 -1
  36. package/dist/navigation/resolvers/getAdjustedPositionForSpread.d.ts +1 -1
  37. package/dist/navigation/resolvers/getAdjustedPositionWithSafeEdge.d.ts +1 -1
  38. package/dist/navigation/resolvers/getNavigationForPosition.d.ts +1 -1
  39. package/dist/navigation/resolvers/getNavigationForSpineItemPage.d.ts +1 -1
  40. package/dist/navigation/resolvers/getNavigationForUrl.d.ts +1 -1
  41. package/dist/navigation/restoration/restoreNavigationForControlledPageTurnMode.d.ts +1 -1
  42. package/dist/navigation/restoration/restorePosition.d.ts +1 -2
  43. package/dist/navigation/restoration/withRestoredPosition.d.ts +1 -1
  44. package/dist/navigation/types.d.ts +29 -1
  45. package/dist/pagination/Pagination.d.ts +1 -11
  46. package/dist/pagination/index.d.ts +2 -0
  47. package/dist/pagination/types.d.ts +11 -0
  48. package/dist/reader.d.ts +13 -13
  49. package/dist/spine/loader/SpineItemsLoader.d.ts +1 -1
  50. package/dist/spine/locator/getSpineItemFromPosition.d.ts +1 -1
  51. package/dist/spine/locator/getVisibleSpineItemsFromPosition.d.ts +1 -1
  52. package/dist/spineItem/SpineItem.d.ts +1 -1
  53. package/dist/viewport/translateSpinePositionToRelativeViewport.d.ts +1 -1
  54. package/package.json +11 -3
  55. package/dist/cfi/CfiHandler.d.ts +0 -72
  56. package/dist/cfi/generate/generateCfi.d.ts +0 -2
  57. package/dist/cfi/generate/generateCfiForSpineItemPage.d.ts +0 -7
  58. package/dist/cfi/generate/generateCfiFromRange.d.ts +0 -5
  59. package/dist/cfi/generate/generateCfiFronSelection.d.ts +0 -8
  60. package/dist/cfi/generate/getItemAnchor.d.ts +0 -2
  61. package/dist/cfi/generate/getRootCfi.d.ts +0 -2
  62. package/dist/cfi/lookup/isRootCfi.d.ts +0 -1
@@ -0,0 +1,22 @@
1
+ import { Manifest } from '@prose-reader/shared';
2
+ import { SpineItem } from '../spineItem/SpineItem';
3
+ import { SpineItemLocator } from '../spineItem/locationResolver';
4
+ export declare const generateRootCfi: (item: Manifest["spineItems"][number]) => string;
5
+ export declare const generateCfi: (node: Node, offset: number, item: Manifest["spineItems"][number]) => string;
6
+ export declare const generateCfiForSpineItemPage: ({ pageIndex, spineItem, spineItemLocator, }: {
7
+ pageIndex: number;
8
+ spineItem: SpineItem;
9
+ spineItemLocator: SpineItemLocator;
10
+ }) => string;
11
+ export declare const generateCfiFromRange: (range: Range, item: Manifest[`spineItems`][number]) => {
12
+ start: string;
13
+ end: string;
14
+ };
15
+ export declare const generateCfiFromSelection: ({ item, selection, }: {
16
+ selection: Selection;
17
+ item: Manifest["spineItems"][number];
18
+ }) => {
19
+ anchorCfi: string | undefined;
20
+ focusCfi: string | undefined;
21
+ };
22
+ export declare const getItemAnchor: (item: Manifest["spineItems"][number]) => string;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,3 @@
1
+ export * from './generate';
2
+ export * from './parse';
3
+ export * from './resolve';
@@ -1,3 +1,4 @@
1
+ export declare const isRootCfi: (cfi: string) => boolean;
1
2
  export declare const parseCfi: (cfi: string) => {
2
3
  cleanedCfi: string;
3
4
  itemIndex?: number;
@@ -0,0 +1 @@
1
+ export {};
@@ -1,13 +1,13 @@
1
- import { SpineItemsManager } from '../../spine/SpineItemsManager';
1
+ import { SpineItemsManager } from '../spine/SpineItemsManager';
2
2
  export declare const resolveCfi: ({ cfi, spineItemsManager, }: {
3
3
  cfi: string;
4
4
  spineItemsManager: SpineItemsManager;
5
5
  }) => {
6
- node: Node | undefined;
6
+ node: Node | null | undefined;
7
7
  offset: number | undefined;
8
- spineItem: import('../..').SpineItem;
8
+ spineItem: import('..').SpineItem;
9
9
  } | {
10
- spineItem: import('../..').SpineItem;
10
+ spineItem: import('..').SpineItem;
11
11
  node?: undefined;
12
12
  offset?: undefined;
13
13
  } | undefined;
@@ -1,6 +1,6 @@
1
1
  import { BehaviorSubject, ReplaySubject } from 'rxjs';
2
- import { Navigation } from '../navigation/InternalNavigator';
3
- import { PaginationInfo } from '../pagination/Pagination';
2
+ import { Navigation } from '../navigation/types';
3
+ import { PaginationInfo } from '../pagination/types';
4
4
  export declare class BridgeEvent {
5
5
  navigationSubject: ReplaySubject<Navigation>;
6
6
  viewportStateSubject: BehaviorSubject<"free" | "busy">;
@@ -34,7 +34,7 @@ export declare class Context extends ReactiveEntity<ContextState> {
34
34
  isRTL: () => boolean;
35
35
  get state(): ContextState;
36
36
  get manifest(): Manifest | undefined;
37
- get readingDirection(): "rtl" | "ltr" | undefined;
37
+ get readingDirection(): "ltr" | "rtl" | undefined;
38
38
  getPageSize(): {
39
39
  width: number;
40
40
  height: number;
@@ -39,8 +39,8 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
39
39
  pageIndex: number;
40
40
  spineItem: import('.').SpineItem;
41
41
  }) => string;
42
- resolveCfi: (params: Omit<Parameters<typeof import('./cfi/lookup/resolveCfi').resolveCfi>[0], "spineItemsManager">) => {
43
- node: Node | undefined;
42
+ resolveCfi: (params: Omit<Parameters<typeof import('./cfi').resolveCfi>[0], "spineItemsManager">) => {
43
+ node: Node | null | undefined;
44
44
  offset: number | undefined;
45
45
  spineItem: import('.').SpineItem;
46
46
  } | {
@@ -51,7 +51,7 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
51
51
  };
52
52
  navigation: {
53
53
  destroy: () => void;
54
- getNavigation: () => import('./navigation/InternalNavigator').InternalNavigationEntry;
54
+ getNavigation: () => import('./navigation/types').InternalNavigationEntry;
55
55
  internalNavigator: import('./navigation/InternalNavigator').InternalNavigator;
56
56
  scrollNavigationController: import('./navigation/controllers/ScrollNavigationController').ScrollNavigationController;
57
57
  controlledNavigationController: import('./navigation/controllers/ControlledNavigationController').ControlledNavigationController;
@@ -61,7 +61,7 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
61
61
  lock(): () => void;
62
62
  navigationResolver: {
63
63
  getNavigationForUrl: (url: string | URL) => {
64
- position: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition;
64
+ position: import('./navigation/types').DeprecatedViewportPosition;
65
65
  spineItemId: string;
66
66
  } | undefined;
67
67
  getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./navigation/resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('./spine/types').SpinePosition;
@@ -69,13 +69,13 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
69
69
  spineItemPosition: import('./spineItem/types').SpineItemPosition;
70
70
  spineItem: import('.').SpineItem;
71
71
  }) => import('./spine/types').SpinePosition;
72
- getNavigationForCfi: (cfi: string) => import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition | undefined;
73
- getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition;
74
- getNavigationForSpineIndexOrId: (indexOrId: number | string | import('.').SpineItem) => import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition;
75
- getNavigationForPosition: (viewportPosition: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
76
- getMostPredominantNavigationForPosition: (viewportPosition: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition) => import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition;
77
- getAdjustedPositionWithSafeEdge: (position: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
78
- isNavigationGoingForwardFrom: (to: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition, from: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition) => boolean;
72
+ getNavigationForCfi: (cfi: string) => import('./navigation/types').DeprecatedViewportPosition | undefined;
73
+ getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./navigation/types').DeprecatedViewportPosition;
74
+ getNavigationForSpineIndexOrId: (indexOrId: number | string | import('.').SpineItem) => import('./navigation/types').DeprecatedViewportPosition;
75
+ getNavigationForPosition: (viewportPosition: import('./navigation/types').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
76
+ getMostPredominantNavigationForPosition: (viewportPosition: import('./navigation/types').DeprecatedViewportPosition) => import('./navigation/types').DeprecatedViewportPosition;
77
+ getAdjustedPositionWithSafeEdge: (position: import('./navigation/types').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
78
+ isNavigationGoingForwardFrom: (to: import('./navigation/types').DeprecatedViewportPosition, from: import('./navigation/types').DeprecatedViewportPosition) => boolean;
79
79
  arePositionsDifferent: (a: {
80
80
  x: number;
81
81
  y: number;
@@ -83,7 +83,7 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
83
83
  x: number;
84
84
  y: number;
85
85
  }) => boolean;
86
- getAdjustedPositionForSpread: (position: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
86
+ getAdjustedPositionForSpread: (position: import('./navigation/types').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
87
87
  spineItemNavigator: {
88
88
  getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./spineItem/types').SpineItemPosition;
89
89
  getNavigationForPosition: (spineItem: import('.').SpineItem, position: import('./spineItem/types').SpineItemPosition) => import('./spineItem/types').SpineItemPosition;
@@ -101,8 +101,8 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
101
101
  load: (options: Required<Pick<import('./context/Context').ContextState, "manifest" | "containerElement">>) => void;
102
102
  destroy: () => void;
103
103
  pagination: {
104
- readonly state: import('./pagination/Pagination').PaginationInfo;
105
- readonly state$: import('rxjs').Observable<import('rxjs').ObservedValueOf<import('./pagination/Pagination').Pagination>>;
104
+ readonly state: import('./pagination').PaginationInfo;
105
+ readonly state$: import('rxjs').Observable<import('rxjs').ObservedValueOf<import('./pagination').Pagination>>;
106
106
  };
107
107
  settings: import('./settings/SettingsInterface').SettingsInterface<NonNullable<import('./settings/types').CoreInputSettings>, NonNullable<import('./settings/types').CoreOutputSettings | undefined>>;
108
108
  viewport: import('./viewport/Viewport').Viewport;
@@ -118,11 +118,11 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
118
118
  settings: import('./settings/SettingsInterface').SettingsInterface<import('./settings/types').CoreInputSettings & import('./enhancers/layout/types').InputSettings, import('./enhancers/layout/types').InputSettings & import('./settings/types').CoreInputSettings & import('./settings/types').ComputedCoreSettings>;
119
119
  }, "pagination"> & {
120
120
  pagination: Omit<{
121
- readonly state: import('./pagination/Pagination').PaginationInfo;
122
- readonly state$: import('rxjs').Observable<import('rxjs').ObservedValueOf<import('./pagination/Pagination').Pagination>>;
121
+ readonly state: import('./pagination').PaginationInfo;
122
+ readonly state$: import('rxjs').Observable<import('rxjs').ObservedValueOf<import('./pagination').Pagination>>;
123
123
  }, "state" | "state$"> & {
124
- state$: import('rxjs').Observable<import('./pagination/Pagination').PaginationInfo & import('./enhancers/pagination/types').ExtraPaginationInfo>;
125
- state: import('./pagination/Pagination').PaginationInfo & import('./enhancers/pagination/types').ExtraPaginationInfo;
124
+ state$: import('rxjs').Observable<import('./pagination').PaginationInfo & import('./enhancers/pagination/types').ExtraPaginationInfo>;
125
+ state: import('./pagination').PaginationInfo & import('./enhancers/pagination/types').ExtraPaginationInfo;
126
126
  };
127
127
  locateResource: import('./enhancers/pagination/ResourcesLocator').ResourcesLocator["locateResource"];
128
128
  } & {
@@ -17,6 +17,6 @@ export declare class HtmlRenderer extends DocumentRenderer {
17
17
  private getFrameElement;
18
18
  getComputedStyleAfterLoad(): CSSStyleDeclaration | undefined;
19
19
  get writingMode(): `vertical-rl` | `horizontal-tb` | undefined;
20
- get readingDirection(): "rtl" | "ltr" | undefined;
20
+ get readingDirection(): "ltr" | "rtl" | undefined;
21
21
  getDocumentFrame(): HTMLIFrameElement | undefined;
22
22
  }
@@ -1,6 +1,6 @@
1
1
  import { Context } from '../../../context/Context';
2
- import { DeprecatedViewportPosition } from '../../../navigation/controllers/ControlledNavigationController';
3
2
  import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
3
+ import { DeprecatedViewportPosition } from '../../../navigation/types';
4
4
  import { SpineItemsManager } from '../../../spine/SpineItemsManager';
5
5
  import { SpineLocator } from '../../../spine/locator/SpineLocator';
6
6
  import { SpinePosition } from '../../../spine/types';
@@ -1,6 +1,6 @@
1
1
  import { Context } from '../../../context/Context';
2
- import { DeprecatedViewportPosition } from '../../../navigation/controllers/ControlledNavigationController';
3
2
  import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
3
+ import { DeprecatedViewportPosition } from '../../../navigation/types';
4
4
  import { SpineItemsManager } from '../../../spine/SpineItemsManager';
5
5
  import { SpineLocator } from '../../../spine/locator/SpineLocator';
6
6
  import { SpinePosition } from '../../../spine/types';
@@ -1,6 +1,6 @@
1
1
  import { Context } from '../../../context/Context';
2
- import { DeprecatedViewportPosition } from '../../../navigation/controllers/ControlledNavigationController';
3
2
  import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
3
+ import { DeprecatedViewportPosition } from '../../../navigation/types';
4
4
  import { SpineItemsManager } from '../../../spine/SpineItemsManager';
5
5
  import { SpineLocator } from '../../../spine/locator/SpineLocator';
6
6
  import { SpinePosition } from '../../../spine/types';
@@ -1,6 +1,6 @@
1
1
  import { Context } from '../../../context/Context';
2
- import { DeprecatedViewportPosition } from '../../../navigation/controllers/ControlledNavigationController';
3
2
  import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
3
+ import { DeprecatedViewportPosition } from '../../../navigation/types';
4
4
  import { SpineItemsManager } from '../../../spine/SpineItemsManager';
5
5
  import { SpineLocator } from '../../../spine/locator/SpineLocator';
6
6
  import { SpinePosition } from '../../../spine/types';
@@ -1,5 +1,5 @@
1
1
  import { Observable, ObservedValueOf } from 'rxjs';
2
- import { PaginationInfo } from '../../pagination/Pagination';
2
+ import { PaginationInfo } from '../../pagination/types';
3
3
  import { Reader } from '../../reader';
4
4
  import { LayoutEnhancerOutput } from '../layout/layoutEnhancer';
5
5
  import { trackChapterInfo } from './chapters';
@@ -1,5 +1,5 @@
1
1
  import { Observable } from 'rxjs';
2
- import { PaginationInfo } from '../../pagination/Pagination';
2
+ import { PaginationInfo } from '../../pagination/types';
3
3
  import { LayoutEnhancerOutput } from '../layout/layoutEnhancer';
4
4
  import { EnhancerOutput, RootEnhancer } from '../types/enhancer';
5
5
  import { ResourcesLocator } from './ResourcesLocator';