@prose-reader/core 1.199.0 → 1.201.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 (52) hide show
  1. package/dist/context/Context.d.ts +5 -4
  2. package/dist/createReaderWithEnhancer.d.ts +23 -22
  3. package/dist/enhancers/layoutEnhancer/layoutInfo.d.ts +2 -2
  4. package/dist/enhancers/navigation/navigators/manualNavigator.d.ts +2 -2
  5. package/dist/enhancers/navigation/navigators/panNavigator.d.ts +3 -3
  6. package/dist/enhancers/navigation/resolvers/getNavigationForLeftOrTopPage.d.ts +3 -3
  7. package/dist/enhancers/navigation/resolvers/getNavigationForLeftSinglePage.d.ts +3 -3
  8. package/dist/enhancers/navigation/resolvers/getNavigationForRightOrBottomPage.d.ts +3 -3
  9. package/dist/enhancers/navigation/resolvers/getNavigationForRightSinglePage.d.ts +3 -3
  10. package/dist/hooks/types.d.ts +0 -5
  11. package/dist/index.js +2970 -2716
  12. package/dist/index.js.map +1 -1
  13. package/dist/index.umd.cjs +2967 -2714
  14. package/dist/index.umd.cjs.map +1 -1
  15. package/dist/navigation/InternalNavigator.d.ts +11 -8
  16. package/dist/navigation/Navigator.d.ts +22 -26
  17. package/dist/navigation/UserNavigator.d.ts +7 -6
  18. package/dist/navigation/consolidation/consolidateWithPagination.d.ts +1 -1
  19. package/dist/navigation/consolidation/withFallbackPosition.d.ts +1 -1
  20. package/dist/navigation/consolidation/withSpineItem.d.ts +2 -2
  21. package/dist/navigation/{viewport/ViewportNavigator.d.ts → controllers/ControlledNavigationController.d.ts} +9 -17
  22. package/dist/navigation/controllers/ScrollNavigationController.d.ts +26 -0
  23. package/dist/navigation/controllers/getScaledDownPosition.d.ts +7 -0
  24. package/dist/navigation/controllers/positions.d.ts +9 -0
  25. package/dist/navigation/resolvers/NavigationResolver.d.ts +12 -16
  26. package/dist/navigation/resolvers/getAdjustedPositionForSpread.d.ts +3 -3
  27. package/dist/navigation/resolvers/getAdjustedPositionWithSafeEdge.d.ts +3 -6
  28. package/dist/navigation/resolvers/getNavigationForPosition.d.ts +3 -3
  29. package/dist/navigation/resolvers/getNavigationForSpineItemPage.d.ts +2 -2
  30. package/dist/navigation/resolvers/getNavigationForUrl.d.ts +2 -2
  31. package/dist/navigation/resolvers/getNavigationFromSpineItemPosition.d.ts +1 -1
  32. package/dist/navigation/restoration/restoreNavigationForControlledPageTurnMode.d.ts +3 -4
  33. package/dist/navigation/restoration/restorePosition.d.ts +2 -2
  34. package/dist/reader.d.ts +24 -22
  35. package/dist/spine/Spine.d.ts +8 -6
  36. package/dist/spine/SpineLayout.d.ts +3 -1
  37. package/dist/spine/layout/layoutItem.d.ts +3 -1
  38. package/dist/spine/loader/SpineItemsLoader.d.ts +2 -2
  39. package/dist/spine/locator/SpineLocator.d.ts +15 -8
  40. package/dist/spine/locator/getItemVisibilityForPosition.d.ts +3 -6
  41. package/dist/spine/locator/getSpineItemFromPosition.d.ts +2 -2
  42. package/dist/spine/locator/getVisibleSpineItemsFromPosition.d.ts +6 -5
  43. package/dist/spine/types.d.ts +13 -3
  44. package/dist/spineItem/SpineItemLayout.d.ts +3 -1
  45. package/dist/utils/ReactiveEntity.d.ts +8 -0
  46. package/dist/utils/rxjs.d.ts +1 -0
  47. package/dist/viewport/Viewport.d.ts +17 -0
  48. package/dist/viewport/translateSpinePositionToRelativeViewport.d.ts +4 -0
  49. package/dist/viewport/types.d.ts +29 -0
  50. package/package.json +3 -3
  51. package/dist/navigation/tests/SpineItemsManagerMock.d.ts +0 -30
  52. package/dist/navigation/viewport/getScaledDownPosition.d.ts +0 -9
@@ -7,8 +7,9 @@ import { SpineItemPosition } from '../spineItem/types';
7
7
  import { DestroyableClass } from '../utils/DestroyableClass';
8
8
  import { Locker } from './Locker';
9
9
  import { UserNavigationEntry } from './UserNavigator';
10
+ import { ControlledNavigationController, DeprecatedViewportPosition } from './controllers/ControlledNavigationController';
11
+ import { ScrollNavigationController } from './controllers/ScrollNavigationController';
10
12
  import { createNavigationResolver } from './resolvers/NavigationResolver';
11
- import { ViewportNavigator, ViewportPosition } from './viewport/ViewportNavigator';
12
13
  export type NavigationConsolidation = {
13
14
  spineItemHeight?: number;
14
15
  spineItemWidth?: number;
@@ -21,7 +22,7 @@ export type NavigationConsolidation = {
21
22
  directionFromLastNavigation?: "forward" | "backward" | "anchor";
22
23
  };
23
24
  export type InternalNavigationEntry = {
24
- position: SpinePosition | ViewportPosition;
25
+ position: SpinePosition | DeprecatedViewportPosition;
25
26
  id: symbol;
26
27
  meta: {
27
28
  triggeredBy: `user` | `restoration` | `pagination`;
@@ -32,20 +33,22 @@ export type InternalNavigationEntry = {
32
33
  spineItem?: string | number;
33
34
  cfi?: string;
34
35
  } & NavigationConsolidation;
35
- export type InternalNavigationInput = Omit<InternalNavigationEntry, "position"> & Partial<InternalNavigationEntry>;
36
+ export type InternalNavigationInput = Omit<InternalNavigationEntry, "position"> & {
37
+ position?: SpinePosition | DeprecatedViewportPosition;
38
+ };
36
39
  export type Navigation = Pick<InternalNavigationEntry, "position" | "id">;
37
40
  export declare class InternalNavigator extends DestroyableClass {
38
41
  protected settings: ReaderSettingsManager;
39
42
  protected context: Context;
40
43
  protected userNavigation$: Observable<UserNavigationEntry>;
41
- protected viewportController: ViewportNavigator;
44
+ protected viewportController: ControlledNavigationController;
45
+ protected scrollNavigationController: ScrollNavigationController;
42
46
  protected navigationResolver: ReturnType<typeof createNavigationResolver>;
43
47
  protected spine: Spine;
44
- protected element$: Observable<HTMLElement>;
45
48
  protected isUserLocked$: Observable<boolean>;
46
49
  navigationSubject: BehaviorSubject<InternalNavigationEntry>;
47
50
  navigated$: Observable<{
48
- position: SpinePosition | ViewportPosition;
51
+ position: SpinePosition | DeprecatedViewportPosition;
49
52
  id: symbol;
50
53
  meta: {
51
54
  triggeredBy: `user` | `restoration` | `pagination`;
@@ -57,10 +60,10 @@ export declare class InternalNavigator extends DestroyableClass {
57
60
  cfi?: string;
58
61
  } & NavigationConsolidation>;
59
62
  navigation$: Observable<{
60
- position: SpinePosition | ViewportPosition;
63
+ position: SpinePosition;
61
64
  id: symbol;
62
65
  }>;
63
66
  locker: Locker;
64
- constructor(settings: ReaderSettingsManager, context: Context, userNavigation$: Observable<UserNavigationEntry>, viewportController: ViewportNavigator, navigationResolver: ReturnType<typeof createNavigationResolver>, spine: Spine, element$: Observable<HTMLElement>, isUserLocked$: Observable<boolean>);
67
+ constructor(settings: ReaderSettingsManager, context: Context, userNavigation$: Observable<UserNavigationEntry>, viewportController: ControlledNavigationController, scrollNavigationController: ScrollNavigationController, navigationResolver: ReturnType<typeof createNavigationResolver>, spine: Spine, isUserLocked$: Observable<boolean>);
65
68
  get navigation(): InternalNavigationEntry;
66
69
  }
@@ -1,49 +1,46 @@
1
1
  import { Context } from '../context/Context';
2
- import { SpineItemsManager } from '../spine/SpineItemsManager';
3
- import { BehaviorSubject } from 'rxjs';
4
- import { Spine } from '../spine/Spine';
5
- import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
6
2
  import { HookManager } from '../hooks/HookManager';
7
- import { ViewportNavigator } from './viewport/ViewportNavigator';
3
+ import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
4
+ import { Spine } from '../spine/Spine';
5
+ import { SpineItemsManager } from '../spine/SpineItemsManager';
6
+ import { Viewport } from '../viewport/Viewport';
8
7
  import { InternalNavigator } from './InternalNavigator';
9
- export declare const createNavigator: ({ spineItemsManager, context, parentElement$, hookManager, spine, settings, }: {
8
+ import { ControlledNavigationController } from './controllers/ControlledNavigationController';
9
+ import { ScrollNavigationController } from './controllers/ScrollNavigationController';
10
+ export declare const createNavigator: ({ spineItemsManager, context, hookManager, spine, settings, viewport, }: {
10
11
  spineItemsManager: SpineItemsManager;
11
12
  context: Context;
12
- parentElement$: BehaviorSubject<HTMLElement | undefined>;
13
13
  hookManager: HookManager;
14
14
  spine: Spine;
15
15
  settings: ReaderSettingsManager;
16
+ viewport: Viewport;
16
17
  }) => {
17
18
  destroy: () => void;
18
19
  getNavigation: () => import('./InternalNavigator').InternalNavigationEntry;
19
20
  internalNavigator: InternalNavigator;
20
- viewportNavigator: ViewportNavigator;
21
- element$: BehaviorSubject<HTMLElement>;
21
+ scrollNavigationController: ScrollNavigationController;
22
+ controlledNavigationController: ControlledNavigationController;
22
23
  isLocked$: import('rxjs').Observable<boolean>;
23
24
  viewportState$: import('rxjs').Observable<"free" | "busy">;
24
25
  navigate: (to: import('./UserNavigator').UserNavigationEntry) => void;
25
26
  lock(): () => void;
26
27
  navigationResolver: {
27
28
  getNavigationForUrl: (url: string | URL) => {
28
- position: import('./viewport/ViewportNavigator').ViewportPosition;
29
+ position: import('./controllers/ControlledNavigationController').DeprecatedViewportPosition;
29
30
  spineItemId: string;
30
31
  } | undefined;
31
- getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('./viewport/ViewportNavigator').ViewportPosition;
32
+ getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('../spine/types').SpinePosition;
32
33
  getNavigationFromSpineItemPosition: (params: {
33
34
  spineItemPosition: import('../spineItem/types').SpineItemPosition;
34
35
  spineItem: import('..').SpineItem;
35
- }) => import('./viewport/ViewportNavigator').ViewportPosition;
36
- getNavigationForCfi: (cfi: string) => import('./viewport/ViewportNavigator').ViewportPosition | undefined;
37
- getNavigationForLastPage: (spineItem: import('..').SpineItem) => import('./viewport/ViewportNavigator').ViewportPosition;
38
- getNavigationForSpineIndexOrId: (indexOrId: number | string | import('..').SpineItem) => import('./viewport/ViewportNavigator').ViewportPosition;
39
- getNavigationForPosition: (viewportPosition: import('./viewport/ViewportNavigator').ViewportPosition | import('../spine/types').SpinePosition) => import('./viewport/ViewportNavigator').ViewportPosition;
40
- getMostPredominantNavigationForPosition: (viewportPosition: import('./viewport/ViewportNavigator').ViewportPosition) => import('./viewport/ViewportNavigator').ViewportPosition;
41
- getAdjustedPositionWithSafeEdge: (position: import('./viewport/ViewportNavigator').ViewportPosition | import('../spine/types').SpinePosition) => {
42
- x: number;
43
- y: number;
44
- };
45
- isNavigationGoingForwardFrom: (to: import('./viewport/ViewportNavigator').ViewportPosition, from: import('./viewport/ViewportNavigator').ViewportPosition) => boolean;
46
- areNavigationDifferent: (a: import('./viewport/ViewportNavigator').ViewportPosition, b: import('./viewport/ViewportNavigator').ViewportPosition) => boolean;
36
+ }) => import('../spine/types').SpinePosition;
37
+ getNavigationForCfi: (cfi: string) => import('./controllers/ControlledNavigationController').DeprecatedViewportPosition | undefined;
38
+ getNavigationForLastPage: (spineItem: import('..').SpineItem) => import('./controllers/ControlledNavigationController').DeprecatedViewportPosition;
39
+ getNavigationForSpineIndexOrId: (indexOrId: number | string | import('..').SpineItem) => import('./controllers/ControlledNavigationController').DeprecatedViewportPosition;
40
+ getNavigationForPosition: (viewportPosition: import('./controllers/ControlledNavigationController').DeprecatedViewportPosition | import('../spine/types').SpinePosition) => import('../spine/types').SpinePosition;
41
+ getMostPredominantNavigationForPosition: (viewportPosition: import('./controllers/ControlledNavigationController').DeprecatedViewportPosition) => import('./controllers/ControlledNavigationController').DeprecatedViewportPosition;
42
+ getAdjustedPositionWithSafeEdge: (position: import('./controllers/ControlledNavigationController').DeprecatedViewportPosition | import('../spine/types').SpinePosition) => import('../spine/types').SpinePosition;
43
+ isNavigationGoingForwardFrom: (to: import('./controllers/ControlledNavigationController').DeprecatedViewportPosition, from: import('./controllers/ControlledNavigationController').DeprecatedViewportPosition) => boolean;
47
44
  arePositionsDifferent: (a: {
48
45
  x: number;
49
46
  y: number;
@@ -51,7 +48,7 @@ export declare const createNavigator: ({ spineItemsManager, context, parentEleme
51
48
  x: number;
52
49
  y: number;
53
50
  }) => boolean;
54
- getAdjustedPositionForSpread: (position: import('./viewport/ViewportNavigator').ViewportPosition | import('../spine/types').SpinePosition) => import('./viewport/ViewportNavigator').ViewportPosition;
51
+ getAdjustedPositionForSpread: (position: import('./controllers/ControlledNavigationController').DeprecatedViewportPosition | import('../spine/types').SpinePosition) => import('../spine/types').SpinePosition;
55
52
  spineItemNavigator: {
56
53
  getNavigationForLastPage: (spineItem: import('..').SpineItem) => import('../spineItem/types').SpineItemPosition;
57
54
  getNavigationForPosition: (spineItem: import('..').SpineItem, position: import('../spineItem/types').SpineItemPosition) => import('../spineItem/types').SpineItemPosition;
@@ -59,9 +56,8 @@ export declare const createNavigator: ({ spineItemsManager, context, parentEleme
59
56
  };
60
57
  };
61
58
  navigation$: import('rxjs').Observable<{
62
- position: import('../spine/types').SpinePosition | import('./viewport/ViewportNavigator').ViewportPosition;
59
+ position: import('../spine/types').SpinePosition;
63
60
  id: symbol;
64
61
  }>;
65
- getElement: () => HTMLElement;
66
62
  };
67
63
  export type Navigator = ReturnType<typeof createNavigator>;
@@ -1,12 +1,13 @@
1
1
  import { Observable, Subject } from 'rxjs';
2
- import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
3
- import { ViewportPosition } from './viewport/ViewportNavigator';
4
2
  import { Context } from '../context/Context';
3
+ import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
4
+ import { Spine } from '../spine/Spine';
5
+ import { SpinePosition } from '../spine/types';
5
6
  import { DestroyableClass } from '../utils/DestroyableClass';
6
7
  import { Locker } from './Locker';
7
- import { Spine } from '../spine/Spine';
8
+ import { DeprecatedViewportPosition } from './controllers/ControlledNavigationController';
8
9
  export type UserNavigationEntry = {
9
- position?: ViewportPosition;
10
+ position?: DeprecatedViewportPosition | SpinePosition;
10
11
  spineItem?: number | string;
11
12
  url?: string | URL;
12
13
  cfi?: string;
@@ -16,13 +17,13 @@ export type UserNavigationEntry = {
16
17
  };
17
18
  export declare class UserNavigator extends DestroyableClass {
18
19
  protected settings: ReaderSettingsManager;
19
- protected element$: Observable<HTMLElement>;
20
+ protected scrollNavigatorElement$: Observable<HTMLElement | undefined>;
20
21
  protected context: Context;
21
22
  protected scrollHappeningFromBrowser$: Observable<unknown>;
22
23
  protected spine: Spine;
23
24
  protected navigationSubject: Subject<UserNavigationEntry>;
24
25
  locker: Locker;
25
26
  navigation$: Observable<UserNavigationEntry>;
26
- constructor(settings: ReaderSettingsManager, element$: Observable<HTMLElement>, context: Context, scrollHappeningFromBrowser$: Observable<unknown>, spine: Spine);
27
+ constructor(settings: ReaderSettingsManager, scrollNavigatorElement$: Observable<HTMLElement | undefined>, context: Context, scrollHappeningFromBrowser$: Observable<unknown>, spine: Spine);
27
28
  navigate(to: UserNavigationEntry): void;
28
29
  }
@@ -6,7 +6,7 @@ export declare const consolidateWithPagination: (context: Context, navigation$:
6
6
  meta: {
7
7
  triggeredBy: "pagination";
8
8
  };
9
- position: import('../../spine/types').SpinePosition | import('../viewport/ViewportNavigator').ViewportPosition;
9
+ position: import('../../spine/types').SpinePosition | import('../controllers/ControlledNavigationController').DeprecatedViewportPosition;
10
10
  id: symbol;
11
11
  type: `api` | `scroll`;
12
12
  animation?: boolean | `turn` | `snap`;
@@ -1,6 +1,6 @@
1
1
  import { Observable } from 'rxjs';
2
- import { InternalNavigationEntry, InternalNavigationInput } from '../InternalNavigator';
3
2
  import { SpineItemsManager } from '../../spine/SpineItemsManager';
3
+ import { InternalNavigationEntry, InternalNavigationInput } from '../InternalNavigator';
4
4
  import { NavigationResolver } from '../resolvers/NavigationResolver';
5
5
  export declare const withFallbackPosition: ({ spineItemsManager, navigationResolver, }: {
6
6
  spineItemsManager: SpineItemsManager;
@@ -1,10 +1,10 @@
1
1
  import { Observable } from 'rxjs';
2
- import { InternalNavigationInput } from '../InternalNavigator';
3
2
  import { Context } from '../../context/Context';
4
3
  import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
5
4
  import { SpineItemsManager } from '../../spine/SpineItemsManager';
6
- import { NavigationResolver } from '../resolvers/NavigationResolver';
7
5
  import { SpineLocator } from '../../spine/locator/SpineLocator';
6
+ import { InternalNavigationInput } from '../InternalNavigator';
7
+ import { NavigationResolver } from '../resolvers/NavigationResolver';
8
8
  type Navigation = {
9
9
  navigation: InternalNavigationInput;
10
10
  };
@@ -5,32 +5,24 @@ import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
5
5
  import { Spine } from '../../spine/Spine';
6
6
  import { SpinePosition } from '../../spine/types';
7
7
  import { DestroyableClass } from '../../utils/DestroyableClass';
8
- export type ViewportPosition = {
9
- x: number;
10
- y: number;
11
- __symbol?: `ViewportPosition`;
12
- spineItem?: false;
13
- };
8
+ import { Viewport } from '../../viewport/Viewport';
9
+ export type DeprecatedViewportPosition = SpinePosition;
14
10
  export type ViewportNavigationEntry = {
15
- position: ViewportPosition | SpinePosition;
11
+ position: SpinePosition;
16
12
  animation?: boolean | "turn" | "snap";
17
13
  };
18
- export declare class ViewportNavigator extends DestroyableClass {
14
+ export declare class ControlledNavigationController extends DestroyableClass {
19
15
  protected settings: ReaderSettingsManager;
20
- protected viewportElement$: BehaviorSubject<HTMLElement>;
21
16
  protected hookManager: HookManager;
22
17
  protected context: Context;
23
18
  protected spine: Spine;
19
+ protected viewport: Viewport;
24
20
  protected navigateSubject: Subject<ViewportNavigationEntry>;
25
- protected scrollingSubject: BehaviorSubject<boolean>;
21
+ readonly element$: BehaviorSubject<HTMLElement>;
26
22
  isNavigating$: Observable<boolean>;
27
- isScrolling$: Observable<boolean>;
28
23
  layout$: Observable<unknown>;
29
- constructor(settings: ReaderSettingsManager, viewportElement$: BehaviorSubject<HTMLElement>, hookManager: HookManager, context: Context, spine: Spine);
30
- protected setViewportPosition({ x, y }: ViewportPosition | SpinePosition): void;
24
+ constructor(settings: ReaderSettingsManager, hookManager: HookManager, context: Context, spine: Spine, viewport: Viewport);
25
+ protected setViewportPosition(position: SpinePosition): void;
31
26
  navigate(navigation: ViewportNavigationEntry): void;
32
- get viewportPosition(): {
33
- x: number;
34
- y: number;
35
- };
27
+ get viewportPosition(): SpinePosition;
36
28
  }
@@ -0,0 +1,26 @@
1
+ import { BehaviorSubject, Observable, Subject } from 'rxjs';
2
+ import { Context } from '../../context/Context';
3
+ import { HookManager } from '../../hooks/HookManager';
4
+ import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
5
+ import { Spine } from '../../spine/Spine';
6
+ import { SpinePosition } from '../../spine/types';
7
+ import { ReactiveEntity } from '../../utils/ReactiveEntity';
8
+ import { Viewport } from '../../viewport/Viewport';
9
+ import { ViewportNavigationEntry } from './ControlledNavigationController';
10
+ export declare class ScrollNavigationController extends ReactiveEntity<{
11
+ element: HTMLElement | undefined;
12
+ }> {
13
+ protected viewport: Viewport;
14
+ protected settings: ReaderSettingsManager;
15
+ protected hookManager: HookManager;
16
+ protected spine: Spine;
17
+ protected context: Context;
18
+ protected navigateSubject: Subject<ViewportNavigationEntry>;
19
+ protected scrollingSubject: BehaviorSubject<boolean>;
20
+ isScrolling$: Observable<boolean>;
21
+ isNavigating$: Observable<boolean>;
22
+ constructor(viewport: Viewport, settings: ReaderSettingsManager, hookManager: HookManager, spine: Spine, context: Context);
23
+ protected setViewportPosition: ({ position }: ViewportNavigationEntry) => void;
24
+ navigate(navigation: ViewportNavigationEntry): void;
25
+ get viewportPosition(): SpinePosition;
26
+ }
@@ -0,0 +1,7 @@
1
+ import { SpinePosition } from '../../spine/types';
2
+ import { DeprecatedViewportPosition } from './ControlledNavigationController';
3
+ export declare const getScaledDownPosition: ({ position: { x, y }, spineElement, element, }: {
4
+ position: DeprecatedViewportPosition;
5
+ spineElement: HTMLElement;
6
+ element: HTMLElement;
7
+ }) => SpinePosition;
@@ -0,0 +1,9 @@
1
+ import { SpinePosition } from '../../spine/types';
2
+ export declare const spinePositionToTranslation: (position: SpinePosition) => {
3
+ x: number;
4
+ y: number;
5
+ };
6
+ export declare const translationToSpinePosition: (translation: {
7
+ x: number;
8
+ y: number;
9
+ } | DOMMatrix) => SpinePosition;
@@ -6,7 +6,7 @@ import { SpineLocator } from '../../spine/locator/SpineLocator';
6
6
  import { SpinePosition } from '../../spine/types';
7
7
  import { SpineItem } from '../../spineItem/SpineItem';
8
8
  import { SpineItemPosition } from '../../spineItem/types';
9
- import { ViewportPosition } from '../viewport/ViewportNavigator';
9
+ import { DeprecatedViewportPosition } from '../controllers/ControlledNavigationController';
10
10
  import { getNavigationForSpineItemPage } from './getNavigationForSpineItemPage';
11
11
  export declare const NAMESPACE = "spineNavigator";
12
12
  export type NavigationResolver = ReturnType<typeof createNavigationResolver>;
@@ -18,25 +18,21 @@ export declare const createNavigationResolver: ({ context, spineItemsManager, lo
18
18
  spineLayout: SpineLayout;
19
19
  }) => {
20
20
  getNavigationForUrl: (url: string | URL) => {
21
- position: ViewportPosition;
21
+ position: DeprecatedViewportPosition;
22
22
  spineItemId: string;
23
23
  } | undefined;
24
- getNavigationForSpineItemPage: (params: Omit<Parameters<typeof getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => ViewportPosition;
24
+ getNavigationForSpineItemPage: (params: Omit<Parameters<typeof getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => SpinePosition;
25
25
  getNavigationFromSpineItemPosition: (params: {
26
26
  spineItemPosition: SpineItemPosition;
27
27
  spineItem: SpineItem;
28
- }) => ViewportPosition;
29
- getNavigationForCfi: (cfi: string) => ViewportPosition | undefined;
30
- getNavigationForLastPage: (spineItem: SpineItem) => ViewportPosition;
31
- getNavigationForSpineIndexOrId: (indexOrId: number | string | SpineItem) => ViewportPosition;
32
- getNavigationForPosition: (viewportPosition: ViewportPosition | SpinePosition) => ViewportPosition;
33
- getMostPredominantNavigationForPosition: (viewportPosition: ViewportPosition) => ViewportPosition;
34
- getAdjustedPositionWithSafeEdge: (position: ViewportPosition | SpinePosition) => {
35
- x: number;
36
- y: number;
37
- };
38
- isNavigationGoingForwardFrom: (to: ViewportPosition, from: ViewportPosition) => boolean;
39
- areNavigationDifferent: (a: ViewportPosition, b: ViewportPosition) => boolean;
28
+ }) => SpinePosition;
29
+ getNavigationForCfi: (cfi: string) => DeprecatedViewportPosition | undefined;
30
+ getNavigationForLastPage: (spineItem: SpineItem) => DeprecatedViewportPosition;
31
+ getNavigationForSpineIndexOrId: (indexOrId: number | string | SpineItem) => DeprecatedViewportPosition;
32
+ getNavigationForPosition: (viewportPosition: DeprecatedViewportPosition | SpinePosition) => SpinePosition;
33
+ getMostPredominantNavigationForPosition: (viewportPosition: DeprecatedViewportPosition) => DeprecatedViewportPosition;
34
+ getAdjustedPositionWithSafeEdge: (position: DeprecatedViewportPosition | SpinePosition) => SpinePosition;
35
+ isNavigationGoingForwardFrom: (to: DeprecatedViewportPosition, from: DeprecatedViewportPosition) => boolean;
40
36
  arePositionsDifferent: (a: {
41
37
  x: number;
42
38
  y: number;
@@ -44,7 +40,7 @@ export declare const createNavigationResolver: ({ context, spineItemsManager, lo
44
40
  x: number;
45
41
  y: number;
46
42
  }) => boolean;
47
- getAdjustedPositionForSpread: (position: ViewportPosition | SpinePosition) => ViewportPosition;
43
+ getAdjustedPositionForSpread: (position: DeprecatedViewportPosition | SpinePosition) => SpinePosition;
48
44
  spineItemNavigator: {
49
45
  getNavigationForLastPage: (spineItem: SpineItem) => SpineItemPosition;
50
46
  getNavigationForPosition: (spineItem: SpineItem, position: SpineItemPosition) => SpineItemPosition;
@@ -1,7 +1,7 @@
1
1
  import { SpinePosition } from '../../spine/types';
2
- import { ViewportPosition } from '../viewport/ViewportNavigator';
2
+ import { DeprecatedViewportPosition } from '../controllers/ControlledNavigationController';
3
3
  export declare const getAdjustedPositionForSpread: ({ position: { x, y }, pageSizeWidth, visibleAreaRectWidth, }: {
4
- position: ViewportPosition | SpinePosition;
4
+ position: DeprecatedViewportPosition | SpinePosition;
5
5
  pageSizeWidth: number;
6
6
  visibleAreaRectWidth: number;
7
- }) => ViewportPosition;
7
+ }) => DeprecatedViewportPosition;
@@ -1,16 +1,13 @@
1
1
  import { SpineItemsManager } from '../../spine/SpineItemsManager';
2
2
  import { SpineLayout } from '../../spine/SpineLayout';
3
3
  import { SpinePosition } from '../../spine/types';
4
- import { ViewportPosition } from '../viewport/ViewportNavigator';
4
+ import { DeprecatedViewportPosition } from '../controllers/ControlledNavigationController';
5
5
  export declare const NAMESPACE = "spineNavigator";
6
6
  export declare const getAdjustedPositionWithSafeEdge: ({ position, isRTL, pageSizeHeight, spineItemsManager, visibleAreaRectWidth, spineLayout, }: {
7
- position: ViewportPosition | SpinePosition;
7
+ position: DeprecatedViewportPosition | SpinePosition;
8
8
  isRTL: boolean;
9
9
  pageSizeHeight: number;
10
10
  spineItemsManager: SpineItemsManager;
11
11
  visibleAreaRectWidth: number;
12
12
  spineLayout: SpineLayout;
13
- }) => {
14
- x: number;
15
- y: number;
16
- };
13
+ }) => SpinePosition;
@@ -2,10 +2,10 @@ import { Context } from '../../context/Context';
2
2
  import { SpineLocator } from '../../spine/locator/SpineLocator';
3
3
  import { SpinePosition } from '../../spine/types';
4
4
  import { SpineItemNavigationResolver } from '../../spineItem/navigationResolver';
5
- import { ViewportPosition } from '../viewport/ViewportNavigator';
5
+ import { DeprecatedViewportPosition } from '../controllers/ControlledNavigationController';
6
6
  export declare const getNavigationForPosition: ({ viewportPosition, spineLocator, context, spineItemNavigationResolver, }: {
7
- viewportPosition: ViewportPosition | SpinePosition;
7
+ viewportPosition: DeprecatedViewportPosition | SpinePosition;
8
8
  spineLocator: SpineLocator;
9
9
  context: Context;
10
10
  spineItemNavigationResolver: SpineItemNavigationResolver;
11
- }) => ViewportPosition;
11
+ }) => SpinePosition;
@@ -3,7 +3,7 @@ import { SpineItemsManager } from '../../spine/SpineItemsManager';
3
3
  import { SpineLocator } from '../../spine/locator/SpineLocator';
4
4
  import { SpineItem } from '../../spineItem/SpineItem';
5
5
  import { SpineItemNavigationResolver } from '../../spineItem/navigationResolver';
6
- import { ViewportPosition } from '../viewport/ViewportNavigator';
6
+ import { DeprecatedViewportPosition } from '../controllers/ControlledNavigationController';
7
7
  export declare const getNavigationForSpineItemPage: ({ pageIndex, spineItemsManager, spineItemId, context, spineLocator, spineItemNavigationResolver, }: {
8
8
  pageIndex: number;
9
9
  spineItemId: SpineItem | number | string;
@@ -11,4 +11,4 @@ export declare const getNavigationForSpineItemPage: ({ pageIndex, spineItemsMana
11
11
  spineItemNavigationResolver: SpineItemNavigationResolver;
12
12
  spineLocator: SpineLocator;
13
13
  context: Context;
14
- }) => ViewportPosition;
14
+ }) => DeprecatedViewportPosition;
@@ -1,7 +1,7 @@
1
1
  import { Context } from '../../context/Context';
2
2
  import { SpineItemsManager } from '../../spine/SpineItemsManager';
3
3
  import { SpineLocator } from '../../spine/locator/SpineLocator';
4
- import { ViewportPosition } from '../viewport/ViewportNavigator';
4
+ import { DeprecatedViewportPosition } from '../controllers/ControlledNavigationController';
5
5
  export declare const getNavigationForUrl: ({ context, spineItemsManager, spineLocator, url, pageSizeWidth, visibleAreaRectWidth, }: {
6
6
  url: string | URL;
7
7
  spineItemsManager: SpineItemsManager;
@@ -10,6 +10,6 @@ export declare const getNavigationForUrl: ({ context, spineItemsManager, spineLo
10
10
  pageSizeWidth: number;
11
11
  visibleAreaRectWidth: number;
12
12
  }) => {
13
- position: ViewportPosition;
13
+ position: DeprecatedViewportPosition;
14
14
  spineItemId: string;
15
15
  } | undefined;
@@ -9,4 +9,4 @@ export declare const getNavigationFromSpineItemPosition: ({ spineItem, spineItem
9
9
  spineLocator: SpineLocator;
10
10
  spineItemLocator: SpineItemLocator;
11
11
  context: Context;
12
- }) => import('../viewport/ViewportNavigator').ViewportPosition;
12
+ }) => import('../../spine/types').SpinePosition;
@@ -1,6 +1,8 @@
1
+ import { Observable } from 'rxjs';
1
2
  import { SpineItemsManager } from '../../spine/SpineItemsManager';
2
3
  import { SpineLayout } from '../../spine/SpineLayout';
3
4
  import { SpineLocator } from '../../spine/locator/SpineLocator';
5
+ import { SpinePosition } from '../../spine/types';
4
6
  import { InternalNavigationEntry } from '../InternalNavigator';
5
7
  import { NavigationResolver } from '../resolvers/NavigationResolver';
6
8
  export declare const restoreNavigationForControlledPageTurnMode: ({ spineLocator, navigation, navigationResolver, spineItemsManager, spineLayout, }: {
@@ -9,7 +11,4 @@ export declare const restoreNavigationForControlledPageTurnMode: ({ spineLocator
9
11
  navigationResolver: NavigationResolver;
10
12
  spineItemsManager: SpineItemsManager;
11
13
  spineLayout: SpineLayout;
12
- }) => import('rxjs').Observable<{
13
- x: number;
14
- y: number;
15
- }>;
14
+ }) => Observable<SpinePosition>;
@@ -7,8 +7,8 @@ import { SpineLocator } from '../../spine/locator/SpineLocator';
7
7
  import { SpinePosition } from '../../spine/types';
8
8
  import { SpineItemLocator } from '../../spineItem/locationResolver';
9
9
  import { InternalNavigationEntry } from '../InternalNavigator';
10
+ import { DeprecatedViewportPosition } from '../controllers/ControlledNavigationController';
10
11
  import { NavigationResolver } from '../resolvers/NavigationResolver';
11
- import { ViewportPosition } from '../viewport/ViewportNavigator';
12
12
  export declare const restorePosition: ({ navigation, spineItemsManager, settings, spineLocator, navigationResolver, spineLayout, }: {
13
13
  spineLocator: SpineLocator;
14
14
  settings: ReaderSettingsManager;
@@ -18,4 +18,4 @@ export declare const restorePosition: ({ navigation, spineItemsManager, settings
18
18
  spineItemLocator: SpineItemLocator;
19
19
  context: Context;
20
20
  spineLayout: SpineLayout;
21
- }) => Observable<ViewportPosition | SpinePosition>;
21
+ }) => Observable<DeprecatedViewportPosition | SpinePosition>;
package/dist/reader.d.ts CHANGED
@@ -7,6 +7,7 @@ import { CoreInputSettings } from './settings/types';
7
7
  import { Spine } from './spine/Spine';
8
8
  import { SpineItemsManager } from './spine/SpineItemsManager';
9
9
  import { SpineItem } from './spineItem/SpineItem';
10
+ import { Viewport } from './viewport/Viewport';
10
11
  export type CreateReaderOptions = Partial<CoreInputSettings>;
11
12
  export type CreateReaderParameters = CreateReaderOptions;
12
13
  export type ContextSettings = Partial<CoreInputSettings>;
@@ -47,36 +48,32 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
47
48
  } | undefined;
48
49
  };
49
50
  navigation: {
50
- viewportBusy$: import('rxjs').Observable<"busy">;
51
- getViewportPosition: () => {
52
- x: number;
53
- y: number;
54
- };
51
+ destroy: () => void;
55
52
  getNavigation: () => import('./navigation/InternalNavigator').InternalNavigationEntry;
56
- getElement: () => HTMLElement;
53
+ internalNavigator: import('./navigation/InternalNavigator').InternalNavigator;
54
+ scrollNavigationController: import('./navigation/controllers/ScrollNavigationController').ScrollNavigationController;
55
+ controlledNavigationController: import('./navigation/controllers/ControlledNavigationController').ControlledNavigationController;
56
+ isLocked$: import('rxjs').Observable<boolean>;
57
+ viewportState$: import('rxjs').Observable<"free" | "busy">;
57
58
  navigate: (to: import('./navigation/UserNavigator').UserNavigationEntry) => void;
58
- lock: () => () => void;
59
+ lock(): () => void;
59
60
  navigationResolver: {
60
61
  getNavigationForUrl: (url: string | URL) => {
61
- position: import('./navigation/viewport/ViewportNavigator').ViewportPosition;
62
+ position: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition;
62
63
  spineItemId: string;
63
64
  } | undefined;
64
- getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./navigation/resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
65
+ getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./navigation/resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('./spine/types').SpinePosition;
65
66
  getNavigationFromSpineItemPosition: (params: {
66
67
  spineItemPosition: import('./spineItem/types').SpineItemPosition;
67
68
  spineItem: SpineItem;
68
- }) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
69
- getNavigationForCfi: (cfi: string) => import('./navigation/viewport/ViewportNavigator').ViewportPosition | undefined;
70
- getNavigationForLastPage: (spineItem: SpineItem) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
71
- getNavigationForSpineIndexOrId: (indexOrId: number | string | SpineItem) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
72
- getNavigationForPosition: (viewportPosition: import('./navigation/viewport/ViewportNavigator').ViewportPosition | import('./spine/types').SpinePosition) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
73
- getMostPredominantNavigationForPosition: (viewportPosition: import('./navigation/viewport/ViewportNavigator').ViewportPosition) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
74
- getAdjustedPositionWithSafeEdge: (position: import('./navigation/viewport/ViewportNavigator').ViewportPosition | import('./spine/types').SpinePosition) => {
75
- x: number;
76
- y: number;
77
- };
78
- isNavigationGoingForwardFrom: (to: import('./navigation/viewport/ViewportNavigator').ViewportPosition, from: import('./navigation/viewport/ViewportNavigator').ViewportPosition) => boolean;
79
- areNavigationDifferent: (a: import('./navigation/viewport/ViewportNavigator').ViewportPosition, b: import('./navigation/viewport/ViewportNavigator').ViewportPosition) => boolean;
69
+ }) => import('./spine/types').SpinePosition;
70
+ getNavigationForCfi: (cfi: string) => import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition | undefined;
71
+ getNavigationForLastPage: (spineItem: SpineItem) => import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition;
72
+ getNavigationForSpineIndexOrId: (indexOrId: number | string | SpineItem) => import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition;
73
+ getNavigationForPosition: (viewportPosition: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
74
+ getMostPredominantNavigationForPosition: (viewportPosition: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition) => import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition;
75
+ getAdjustedPositionWithSafeEdge: (position: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
76
+ isNavigationGoingForwardFrom: (to: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition, from: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition) => boolean;
80
77
  arePositionsDifferent: (a: {
81
78
  x: number;
82
79
  y: number;
@@ -84,13 +81,17 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
84
81
  x: number;
85
82
  y: number;
86
83
  }) => boolean;
87
- getAdjustedPositionForSpread: (position: import('./navigation/viewport/ViewportNavigator').ViewportPosition | import('./spine/types').SpinePosition) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
84
+ getAdjustedPositionForSpread: (position: import('./navigation/controllers/ControlledNavigationController').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
88
85
  spineItemNavigator: {
89
86
  getNavigationForLastPage: (spineItem: SpineItem) => import('./spineItem/types').SpineItemPosition;
90
87
  getNavigationForPosition: (spineItem: SpineItem, position: import('./spineItem/types').SpineItemPosition) => import('./spineItem/types').SpineItemPosition;
91
88
  getNavigationFromNode: (spineItem: SpineItem, node: Node, offset: number) => import('./spineItem/types').SpineItemPosition;
92
89
  };
93
90
  };
91
+ navigation$: import('rxjs').Observable<{
92
+ position: import('./spine/types').SpinePosition;
93
+ id: symbol;
94
+ }>;
94
95
  };
95
96
  spineItemsObserver: import('./spine/SpineItemsObserver').SpineItemsObserver;
96
97
  spineItemsManager: SpineItemsManager;
@@ -102,6 +103,7 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
102
103
  state$: import('rxjs').Observable<import('./pagination/Pagination').PaginationInfo>;
103
104
  };
104
105
  settings: SettingsInterface<NonNullable<CoreInputSettings>, NonNullable<import('./settings/types').CoreOutputSettings | undefined>>;
106
+ viewport: Viewport;
105
107
  element$: import('rxjs').Observable<HTMLElement>;
106
108
  viewportState$: import('rxjs').Observable<"free" | "busy">;
107
109
  viewportFree$: import('rxjs').Observable<"free">;