@prose-reader/core 1.199.0 → 1.200.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.
- package/dist/context/Context.d.ts +3 -0
- package/dist/createReaderWithEnhancer.d.ts +12 -19
- package/dist/enhancers/layoutEnhancer/layoutInfo.d.ts +2 -2
- package/dist/enhancers/navigation/navigators/manualNavigator.d.ts +2 -2
- package/dist/enhancers/navigation/navigators/panNavigator.d.ts +3 -3
- package/dist/enhancers/navigation/resolvers/getNavigationForLeftOrTopPage.d.ts +3 -3
- package/dist/enhancers/navigation/resolvers/getNavigationForLeftSinglePage.d.ts +3 -3
- package/dist/enhancers/navigation/resolvers/getNavigationForRightOrBottomPage.d.ts +3 -3
- package/dist/enhancers/navigation/resolvers/getNavigationForRightSinglePage.d.ts +3 -3
- package/dist/index.js +211 -89
- package/dist/index.js.map +1 -1
- package/dist/index.umd.cjs +211 -89
- package/dist/index.umd.cjs.map +1 -1
- package/dist/navigation/InternalNavigator.d.ts +7 -5
- package/dist/navigation/Navigator.d.ts +12 -16
- package/dist/navigation/UserNavigator.d.ts +5 -4
- package/dist/navigation/consolidation/consolidateWithPagination.d.ts +1 -1
- package/dist/navigation/consolidation/withFallbackPosition.d.ts +1 -1
- package/dist/navigation/consolidation/withSpineItem.d.ts +2 -2
- package/dist/navigation/resolvers/NavigationResolver.d.ts +12 -16
- package/dist/navigation/resolvers/getAdjustedPositionForSpread.d.ts +3 -3
- package/dist/navigation/resolvers/getAdjustedPositionWithSafeEdge.d.ts +3 -6
- package/dist/navigation/resolvers/getNavigationForPosition.d.ts +3 -3
- package/dist/navigation/resolvers/getNavigationForSpineItemPage.d.ts +2 -2
- package/dist/navigation/resolvers/getNavigationForUrl.d.ts +2 -2
- package/dist/navigation/resolvers/getNavigationFromSpineItemPosition.d.ts +1 -1
- package/dist/navigation/restoration/restoreNavigationForControlledPageTurnMode.d.ts +3 -4
- package/dist/navigation/restoration/restorePosition.d.ts +2 -2
- package/dist/navigation/viewport/ViewportNavigator.d.ts +4 -12
- package/dist/navigation/viewport/getScaledDownPosition.d.ts +4 -6
- package/dist/navigation/viewport/positions.d.ts +9 -0
- package/dist/reader.d.ts +12 -19
- package/dist/spine/loader/SpineItemsLoader.d.ts +2 -2
- package/dist/spine/locator/SpineLocator.d.ts +7 -6
- package/dist/spine/locator/getItemVisibilityForPosition.d.ts +3 -6
- package/dist/spine/locator/getSpineItemFromPosition.d.ts +2 -2
- package/dist/spine/locator/getVisibleSpineItemsFromPosition.d.ts +4 -3
- package/dist/spine/types.d.ts +13 -3
- package/dist/viewport/translateSpinePositionToRelativeViewport.d.ts +4 -0
- package/dist/viewport/types.d.ts +29 -0
- package/package.json +3 -3
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Manifest } from '@prose-reader/shared';
|
|
2
2
|
import { BehaviorSubject, Subject } from 'rxjs';
|
|
3
|
+
import { AbsoluteViewport, RelativeViewport } from '../viewport/types';
|
|
3
4
|
import { BridgeEvent } from './BridgeEvent';
|
|
4
5
|
export type ContextState = {
|
|
5
6
|
containerElement?: HTMLElement;
|
|
@@ -37,5 +38,7 @@ export declare class Context {
|
|
|
37
38
|
width: number;
|
|
38
39
|
height: number;
|
|
39
40
|
};
|
|
41
|
+
get absoluteViewport(): AbsoluteViewport;
|
|
42
|
+
get relativeViewport(): RelativeViewport;
|
|
40
43
|
destroy: () => void;
|
|
41
44
|
}
|
|
@@ -51,35 +51,28 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
|
|
|
51
51
|
};
|
|
52
52
|
navigation: {
|
|
53
53
|
viewportBusy$: import('rxjs').Observable<"busy">;
|
|
54
|
-
getViewportPosition: () =>
|
|
55
|
-
x: number;
|
|
56
|
-
y: number;
|
|
57
|
-
};
|
|
54
|
+
getViewportPosition: () => import('./spine/types').SpinePosition;
|
|
58
55
|
getNavigation: () => import('./navigation/InternalNavigator').InternalNavigationEntry;
|
|
59
56
|
getElement: () => HTMLElement;
|
|
60
57
|
navigate: (to: import('./navigation/UserNavigator').UserNavigationEntry) => void;
|
|
61
58
|
lock: () => () => void;
|
|
62
59
|
navigationResolver: {
|
|
63
60
|
getNavigationForUrl: (url: string | URL) => {
|
|
64
|
-
position: import('./navigation/viewport/ViewportNavigator').
|
|
61
|
+
position: import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition;
|
|
65
62
|
spineItemId: string;
|
|
66
63
|
} | undefined;
|
|
67
|
-
getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./navigation/resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('./
|
|
64
|
+
getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./navigation/resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('./spine/types').SpinePosition;
|
|
68
65
|
getNavigationFromSpineItemPosition: (params: {
|
|
69
66
|
spineItemPosition: import('./spineItem/types').SpineItemPosition;
|
|
70
67
|
spineItem: import('.').SpineItem;
|
|
71
|
-
}) => import('./
|
|
72
|
-
getNavigationForCfi: (cfi: string) => import('./navigation/viewport/ViewportNavigator').
|
|
73
|
-
getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./navigation/viewport/ViewportNavigator').
|
|
74
|
-
getNavigationForSpineIndexOrId: (indexOrId: number | string | import('.').SpineItem) => import('./navigation/viewport/ViewportNavigator').
|
|
75
|
-
getNavigationForPosition: (viewportPosition: import('./navigation/viewport/ViewportNavigator').
|
|
76
|
-
getMostPredominantNavigationForPosition: (viewportPosition: import('./navigation/viewport/ViewportNavigator').
|
|
77
|
-
getAdjustedPositionWithSafeEdge: (position: import('./navigation/viewport/ViewportNavigator').
|
|
78
|
-
|
|
79
|
-
y: number;
|
|
80
|
-
};
|
|
81
|
-
isNavigationGoingForwardFrom: (to: import('./navigation/viewport/ViewportNavigator').ViewportPosition, from: import('./navigation/viewport/ViewportNavigator').ViewportPosition) => boolean;
|
|
82
|
-
areNavigationDifferent: (a: import('./navigation/viewport/ViewportNavigator').ViewportPosition, b: import('./navigation/viewport/ViewportNavigator').ViewportPosition) => boolean;
|
|
68
|
+
}) => import('./spine/types').SpinePosition;
|
|
69
|
+
getNavigationForCfi: (cfi: string) => import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition | undefined;
|
|
70
|
+
getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition;
|
|
71
|
+
getNavigationForSpineIndexOrId: (indexOrId: number | string | import('.').SpineItem) => import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition;
|
|
72
|
+
getNavigationForPosition: (viewportPosition: import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
|
|
73
|
+
getMostPredominantNavigationForPosition: (viewportPosition: import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition) => import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition;
|
|
74
|
+
getAdjustedPositionWithSafeEdge: (position: import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
|
|
75
|
+
isNavigationGoingForwardFrom: (to: import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition, from: import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition) => boolean;
|
|
83
76
|
arePositionsDifferent: (a: {
|
|
84
77
|
x: number;
|
|
85
78
|
y: number;
|
|
@@ -87,7 +80,7 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
|
|
|
87
80
|
x: number;
|
|
88
81
|
y: number;
|
|
89
82
|
}) => boolean;
|
|
90
|
-
getAdjustedPositionForSpread: (position: import('./navigation/viewport/ViewportNavigator').
|
|
83
|
+
getAdjustedPositionForSpread: (position: import('./navigation/viewport/ViewportNavigator').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
|
|
91
84
|
spineItemNavigator: {
|
|
92
85
|
getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./spineItem/types').SpineItemPosition;
|
|
93
86
|
getNavigationForPosition: (spineItem: import('.').SpineItem, position: import('./spineItem/types').SpineItemPosition) => import('./spineItem/types').SpineItemPosition;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { Reader } from '../../reader';
|
|
2
|
-
import { SpineItemPageSpineLayout,
|
|
2
|
+
import { SpineItemPageSpineLayout, SpinePosition } from '../../spine/types';
|
|
3
3
|
export type PageLayoutInformation = {
|
|
4
4
|
absolutePageIndex: number;
|
|
5
5
|
itemIndex: number;
|
|
6
|
-
absolutePosition:
|
|
6
|
+
absolutePosition: SpineItemPageSpineLayout;
|
|
7
7
|
};
|
|
8
8
|
export type LayoutInfo = {
|
|
9
9
|
pages: PageLayoutInformation[];
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { UserNavigationEntry } from '../../../navigation/UserNavigator';
|
|
2
|
-
import { ViewportPosition } from '../../../navigation/viewport/ViewportNavigator';
|
|
3
2
|
import { Reader } from '../../../reader';
|
|
3
|
+
import { SpinePosition } from '../../../spine/types';
|
|
4
4
|
export declare class ManualNavigator {
|
|
5
5
|
protected reader: Reader;
|
|
6
6
|
movingLastDelta: {
|
|
7
7
|
x: number;
|
|
8
8
|
y: number;
|
|
9
9
|
};
|
|
10
|
-
movingLastPosition:
|
|
10
|
+
movingLastPosition: SpinePosition;
|
|
11
11
|
unlock: ReturnType<Reader["navigation"]["lock"]> | undefined;
|
|
12
12
|
constructor(reader: Reader);
|
|
13
13
|
turnRight(): void;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { Reader } from '../../../reader';
|
|
2
|
-
import {
|
|
2
|
+
import { SpinePosition } from '../../../spine/types';
|
|
3
3
|
export declare class PanNavigator {
|
|
4
4
|
protected reader: Reader;
|
|
5
5
|
lastDelta: {
|
|
6
6
|
x: number;
|
|
7
7
|
y: number;
|
|
8
8
|
};
|
|
9
|
-
lastPosition:
|
|
10
|
-
lastStartPosition:
|
|
9
|
+
lastPosition: SpinePosition;
|
|
10
|
+
lastStartPosition: SpinePosition;
|
|
11
11
|
unlock: ReturnType<Reader["navigation"]["lock"]> | undefined;
|
|
12
12
|
constructor(reader: Reader);
|
|
13
13
|
moveTo(delta: {
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import { Context } from '../../../context/Context';
|
|
2
2
|
import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
|
|
3
|
-
import {
|
|
3
|
+
import { DeprecatedViewportPosition } from '../../../navigation/viewport/ViewportNavigator';
|
|
4
4
|
import { SpineItemsManager } from '../../../spine/SpineItemsManager';
|
|
5
5
|
import { SpineLocator } from '../../../spine/locator/SpineLocator';
|
|
6
6
|
import { SpinePosition } from '../../../spine/types';
|
|
7
7
|
import { SpineItem } from '../../../spineItem/SpineItem';
|
|
8
8
|
export declare const getNavigationForLeftOrTopPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, }: {
|
|
9
|
-
position:
|
|
9
|
+
position: DeprecatedViewportPosition | SpinePosition;
|
|
10
10
|
spineItem: SpineItem;
|
|
11
11
|
context: Context;
|
|
12
12
|
spineItemsManager: SpineItemsManager;
|
|
13
13
|
navigationResolver: NavigationResolver;
|
|
14
14
|
spineLocator: SpineLocator;
|
|
15
15
|
computedPageTurnDirection: "horizontal" | "vertical";
|
|
16
|
-
}) =>
|
|
16
|
+
}) => DeprecatedViewportPosition;
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { Context } from '../../../context/Context';
|
|
2
2
|
import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
|
|
3
|
-
import {
|
|
3
|
+
import { DeprecatedViewportPosition } from '../../../navigation/viewport/ViewportNavigator';
|
|
4
4
|
import { SpineItemsManager } from '../../../spine/SpineItemsManager';
|
|
5
5
|
import { SpineLocator } from '../../../spine/locator/SpineLocator';
|
|
6
6
|
import { SpinePosition } from '../../../spine/types';
|
|
7
7
|
export declare const getNavigationForLeftSinglePage: ({ position, navigationResolver, computedPageTurnDirection, spineItemsManager, spineLocator, context, }: {
|
|
8
|
-
position:
|
|
8
|
+
position: DeprecatedViewportPosition | SpinePosition;
|
|
9
9
|
navigationResolver: NavigationResolver;
|
|
10
10
|
computedPageTurnDirection: "horizontal" | "vertical";
|
|
11
11
|
spineItemsManager: SpineItemsManager;
|
|
12
12
|
spineLocator: SpineLocator;
|
|
13
13
|
context: Context;
|
|
14
|
-
}) =>
|
|
14
|
+
}) => DeprecatedViewportPosition | SpinePosition;
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import { Context } from '../../../context/Context';
|
|
2
2
|
import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
|
|
3
|
-
import {
|
|
3
|
+
import { DeprecatedViewportPosition } from '../../../navigation/viewport/ViewportNavigator';
|
|
4
4
|
import { SpineItemsManager } from '../../../spine/SpineItemsManager';
|
|
5
5
|
import { SpineLocator } from '../../../spine/locator/SpineLocator';
|
|
6
6
|
import { SpinePosition } from '../../../spine/types';
|
|
7
7
|
import { SpineItem } from '../../../spineItem/SpineItem';
|
|
8
8
|
export declare const getNavigationForRightOrBottomPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, }: {
|
|
9
|
-
position:
|
|
9
|
+
position: DeprecatedViewportPosition | SpinePosition;
|
|
10
10
|
spineItem: SpineItem;
|
|
11
11
|
context: Context;
|
|
12
12
|
spineItemsManager: SpineItemsManager;
|
|
13
13
|
navigationResolver: NavigationResolver;
|
|
14
14
|
spineLocator: SpineLocator;
|
|
15
15
|
computedPageTurnDirection: "horizontal" | "vertical";
|
|
16
|
-
}) =>
|
|
16
|
+
}) => DeprecatedViewportPosition;
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { Context } from '../../../context/Context';
|
|
2
2
|
import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
|
|
3
|
-
import {
|
|
3
|
+
import { DeprecatedViewportPosition } from '../../../navigation/viewport/ViewportNavigator';
|
|
4
4
|
import { SpineItemsManager } from '../../../spine/SpineItemsManager';
|
|
5
5
|
import { SpineLocator } from '../../../spine/locator/SpineLocator';
|
|
6
6
|
import { SpinePosition } from '../../../spine/types';
|
|
7
7
|
export declare const getNavigationForRightSinglePage: ({ position, navigationResolver, computedPageTurnDirection, spineItemsManager, spineLocator, context, }: {
|
|
8
|
-
position:
|
|
8
|
+
position: DeprecatedViewportPosition | SpinePosition;
|
|
9
9
|
navigationResolver: NavigationResolver;
|
|
10
10
|
computedPageTurnDirection: "horizontal" | "vertical";
|
|
11
11
|
spineItemsManager: SpineItemsManager;
|
|
12
12
|
spineLocator: SpineLocator;
|
|
13
13
|
context: Context;
|
|
14
|
-
}) =>
|
|
14
|
+
}) => DeprecatedViewportPosition | SpinePosition;
|