@prose-reader/core 1.71.0 → 1.73.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/cfi/generate/{getCfiForSpineItemPage.d.ts → generateCfiForSpineItemPage.d.ts} +1 -1
- package/dist/cfi/lookup/resolveCfi.d.ts +236 -0
- package/dist/constants.d.ts +0 -1
- package/dist/context/Context.d.ts +6 -29
- package/dist/createReaderWithEnhancer.d.ts +259 -16
- package/dist/enhancers/events/events.d.ts +1 -6
- package/dist/enhancers/events/frames.d.ts +3 -0
- package/dist/enhancers/events/normalizeEventForViewport.d.ts +1 -5
- package/dist/enhancers/navigation/index.d.ts +1 -1
- package/dist/enhancers/navigation/navigators/manualNavigator.d.ts +4 -0
- package/dist/enhancers/navigation/resolvers/{getNavigationForLeftPage.d.ts → getNavigationForLeftOrTopPage.d.ts} +1 -1
- package/dist/enhancers/navigation/resolvers/{getNavigationForRightPage.d.ts → getNavigationForRightOrBottomPage.d.ts} +1 -1
- package/dist/enhancers/navigation/types.d.ts +8 -0
- package/dist/enhancers/pagination/enhancer.d.ts +3 -3
- package/dist/enhancers/zoom/ControllableZoomer.d.ts +19 -0
- package/dist/enhancers/zoom/ScrollableZoomer.d.ts +16 -0
- package/dist/enhancers/zoom/Zoomer.d.ts +21 -0
- package/dist/enhancers/zoom/index.d.ts +2 -2
- package/dist/enhancers/zoom/types.d.ts +10 -12
- package/dist/index.d.ts +3 -1
- package/dist/index.js +1034 -936
- package/dist/index.js.map +1 -1
- package/dist/index.umd.cjs +1054 -954
- package/dist/index.umd.cjs.map +1 -1
- package/dist/navigation/InternalNavigator.d.ts +3 -5
- package/dist/navigation/Navigator.d.ts +1 -3
- package/dist/navigation/UserNavigator.d.ts +3 -1
- package/dist/navigation/consolidation/withSpineItemLayoutInfo.d.ts +3 -3
- package/dist/navigation/consolidation/withSpineItemPosition.d.ts +0 -2
- package/dist/navigation/resolvers/NavigationResolver.d.ts +3 -1
- package/dist/navigation/resolvers/getAdjustedPositionWithSafeEdge.d.ts +3 -1
- package/dist/navigation/restoration/restoreNavigationForControlledPageTurnMode.d.ts +3 -1
- package/dist/navigation/restoration/restorePosition.d.ts +3 -1
- package/dist/navigation/restoration/withRestoredPosition.d.ts +3 -7
- package/dist/navigation/tests/SpineItemsManagerMock.d.ts +2 -1
- package/dist/navigation/tests/utils.d.ts +2 -0
- package/dist/navigation/viewport/getScaledDownPosition.d.ts +2 -3
- package/dist/pagination/Pagination.d.ts +2 -2
- package/dist/reader.d.ts +262 -20
- package/dist/settings/SettingsInterface.d.ts +2 -2
- package/dist/settings/SettingsManager.d.ts +2 -2
- package/dist/settings/SettingsManagerOverload.d.ts +2 -2
- package/dist/spine/Spine.d.ts +5 -2
- package/dist/spine/SpineItemsManager.d.ts +5 -26
- package/dist/spine/SpineItemsObserver.d.ts +3 -1
- package/dist/spine/SpineLayout.d.ts +49 -0
- package/dist/spine/layout/convertViewportPositionToLayoutPosition.d.ts +10 -0
- package/dist/spine/loader/SpineItemsLoader.d.ts +3 -1
- package/dist/spine/locator/SpineLocator.d.ts +146 -5
- package/dist/spine/locator/getAbsolutePageIndexFromPageIndex.d.ts +14 -0
- package/dist/spine/locator/getSpineInfoFromAbsolutePageIndex.d.ts +134 -0
- package/dist/spine/locator/getSpineItemFromPosition.d.ts +3 -1
- package/dist/spine/locator/getSpinePositionFromSpineItemPageIndex.d.ts +13 -0
- package/dist/spine/locator/getSpinePositionFromSpineItemPosition.d.ts +10 -0
- package/dist/spine/locator/getVisibleSpineItemsFromPosition.d.ts +3 -1
- package/dist/spineItem/locationResolver.d.ts +12 -2
- package/dist/spineItem/locator/getSpineItemNumberOfPages.d.ts +10 -0
- package/dist/spineItem/locator/getSpineItemPagesPosition.d.ts +12 -0
- package/dist/spineItem/locator/getSpineItemPositionFromPageIndex.d.ts +12 -0
- package/dist/utils/frames.d.ts +1 -0
- package/dist/utils/objects.d.ts +1 -6
- package/package.json +3 -3
- package/dist/enhancers/events/createIframeEventBridgeElement.d.ts +0 -1
- package/dist/enhancers/zoom/elementZoomer.d.ts +0 -19
- package/dist/enhancers/zoom/viewportZoomer.d.ts +0 -19
- package/dist/frames.d.ts +0 -5
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import { EnhancerOptions, EnhancerOutput, RootEnhancer } from '../types/enhancer';
|
|
2
2
|
import { NavigationEnhancerOutput } from './types';
|
|
3
3
|
|
|
4
|
-
export declare const navigationEnhancer: <InheritOptions extends EnhancerOptions<RootEnhancer>, InheritOutput extends EnhancerOutput<RootEnhancer>>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => InheritOutput & NavigationEnhancerOutput;
|
|
4
|
+
export declare const navigationEnhancer: <InheritOptions extends EnhancerOptions<RootEnhancer>, InheritOutput extends EnhancerOutput<RootEnhancer>>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => Omit<InheritOutput, "load"> & NavigationEnhancerOutput;
|
|
@@ -12,6 +12,10 @@ export declare class ManualNavigator {
|
|
|
12
12
|
constructor(reader: Reader);
|
|
13
13
|
turnRight(): void;
|
|
14
14
|
turnLeft(): void;
|
|
15
|
+
turnTop(): void;
|
|
16
|
+
turnBottom(): void;
|
|
17
|
+
turnRightOrBottom(): void;
|
|
18
|
+
turnLeftOrTop(): void;
|
|
15
19
|
goToCfi(cfi: string, options?: {
|
|
16
20
|
animate: boolean;
|
|
17
21
|
}): void;
|
|
@@ -5,7 +5,7 @@ import { SpineLocator } from '../../../spine/locator/SpineLocator';
|
|
|
5
5
|
import { SpineItem } from '../../../spineItem/createSpineItem';
|
|
6
6
|
import { SpineItemsManager } from '../../../spine/SpineItemsManager';
|
|
7
7
|
|
|
8
|
-
export declare const
|
|
8
|
+
export declare const getNavigationForLeftOrTopPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, }: {
|
|
9
9
|
position: ViewportPosition;
|
|
10
10
|
spineItem: SpineItem;
|
|
11
11
|
context: Context;
|
|
@@ -5,7 +5,7 @@ import { SpineLocator } from '../../../spine/locator/SpineLocator';
|
|
|
5
5
|
import { SpineItem } from '../../../spineItem/createSpineItem';
|
|
6
6
|
import { SpineItemsManager } from '../../../spine/SpineItemsManager';
|
|
7
7
|
|
|
8
|
-
export declare const
|
|
8
|
+
export declare const getNavigationForRightOrBottomPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, }: {
|
|
9
9
|
position: ViewportPosition;
|
|
10
10
|
spineItem: SpineItem;
|
|
11
11
|
context: Context;
|
|
@@ -1,11 +1,19 @@
|
|
|
1
|
+
import { Reader } from '../../reader';
|
|
1
2
|
import { ManualNavigator } from './navigators/manualNavigator';
|
|
2
3
|
import { PanNavigator } from './navigators/panNavigator';
|
|
3
4
|
import { observeState } from './state';
|
|
4
5
|
|
|
5
6
|
export type NavigationEnhancerOutput = {
|
|
7
|
+
load: (options: Parameters<Reader["load"]>[0] & {
|
|
8
|
+
cfi?: string;
|
|
9
|
+
}) => void;
|
|
6
10
|
navigation: {
|
|
7
11
|
state$: ReturnType<typeof observeState>;
|
|
8
12
|
moveTo: PanNavigator["moveTo"];
|
|
13
|
+
turnTop: ManualNavigator["turnTop"];
|
|
14
|
+
turnBottom: ManualNavigator["turnBottom"];
|
|
15
|
+
turnLeftOrTop: ManualNavigator["turnLeftOrTop"];
|
|
16
|
+
turnRightOrBottom: ManualNavigator["turnRightOrBottom"];
|
|
9
17
|
turnLeft: ManualNavigator["turnLeft"];
|
|
10
18
|
turnRight: ManualNavigator["turnRight"];
|
|
11
19
|
goToCfi: ManualNavigator["goToCfi"];
|
|
@@ -5,9 +5,9 @@ import { PaginationInfo } from '../../pagination/Pagination';
|
|
|
5
5
|
import { ExtraPaginationInfo } from './types';
|
|
6
6
|
|
|
7
7
|
type ProgressionEnhancer = typeof progressionEnhancer;
|
|
8
|
-
export declare const paginationEnhancer: <InheritOptions, InheritOutput extends EnhancerOutput<ProgressionEnhancer>, PaginationOutput extends Omit<InheritOutput["pagination"], "
|
|
9
|
-
|
|
10
|
-
|
|
8
|
+
export declare const paginationEnhancer: <InheritOptions, InheritOutput extends EnhancerOutput<ProgressionEnhancer>, PaginationOutput extends Omit<InheritOutput["pagination"], "state$" | "state"> & {
|
|
9
|
+
state$: Observable<PaginationInfo & ExtraPaginationInfo>;
|
|
10
|
+
state: PaginationInfo & ExtraPaginationInfo;
|
|
11
11
|
}>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => Omit<InheritOutput, "pagination"> & {
|
|
12
12
|
pagination: PaginationOutput;
|
|
13
13
|
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { BehaviorSubject } from 'rxjs';
|
|
2
|
+
import { Zoomer } from './Zoomer';
|
|
3
|
+
|
|
4
|
+
export declare class ControllableZoomer extends Zoomer {
|
|
5
|
+
element: HTMLDivElement | undefined;
|
|
6
|
+
isZooming$: BehaviorSubject<boolean>;
|
|
7
|
+
currentScale: number;
|
|
8
|
+
currentPosition: {
|
|
9
|
+
x: number;
|
|
10
|
+
y: number;
|
|
11
|
+
};
|
|
12
|
+
enter(element?: HTMLImageElement): void;
|
|
13
|
+
exit(): void;
|
|
14
|
+
moveAt(position: {
|
|
15
|
+
x: number;
|
|
16
|
+
y: number;
|
|
17
|
+
}): void;
|
|
18
|
+
scaleAt(userScale: number): void;
|
|
19
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { BehaviorSubject } from 'rxjs';
|
|
2
|
+
import { Zoomer } from './Zoomer';
|
|
3
|
+
|
|
4
|
+
export declare class ScrollableZoomer extends Zoomer {
|
|
5
|
+
element: HTMLDivElement | undefined;
|
|
6
|
+
isZooming$: BehaviorSubject<boolean>;
|
|
7
|
+
currentScale: number;
|
|
8
|
+
currentPosition: {
|
|
9
|
+
x: number;
|
|
10
|
+
y: number;
|
|
11
|
+
};
|
|
12
|
+
enter(): void;
|
|
13
|
+
exit(): void;
|
|
14
|
+
moveAt(): void;
|
|
15
|
+
scaleAt(userScale: number): void;
|
|
16
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { BehaviorSubject } from 'rxjs';
|
|
2
|
+
import { Reader } from '../../reader';
|
|
3
|
+
|
|
4
|
+
export declare abstract class Zoomer {
|
|
5
|
+
protected reader: Reader;
|
|
6
|
+
constructor(reader: Reader);
|
|
7
|
+
abstract enter(element?: HTMLImageElement): void;
|
|
8
|
+
abstract exit(): void;
|
|
9
|
+
abstract moveAt(position: {
|
|
10
|
+
x: number;
|
|
11
|
+
y: number;
|
|
12
|
+
}): void;
|
|
13
|
+
abstract scaleAt(scale: number): void;
|
|
14
|
+
abstract element: HTMLDivElement | undefined;
|
|
15
|
+
abstract isZooming$: BehaviorSubject<boolean>;
|
|
16
|
+
abstract currentScale: number;
|
|
17
|
+
abstract currentPosition: {
|
|
18
|
+
x: number;
|
|
19
|
+
y: number;
|
|
20
|
+
};
|
|
21
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import { Reader } from '../../reader';
|
|
2
|
-
import {
|
|
2
|
+
import { EnhancerApi } from './types';
|
|
3
3
|
|
|
4
|
-
export declare const zoomEnhancer: <InheritOptions, InheritOutput extends Reader>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => InheritOutput &
|
|
4
|
+
export declare const zoomEnhancer: <InheritOptions, InheritOutput extends Reader>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => InheritOutput & EnhancerApi;
|
|
@@ -1,23 +1,21 @@
|
|
|
1
1
|
import { Observable } from 'rxjs';
|
|
2
2
|
|
|
3
|
-
export type
|
|
3
|
+
export type EnhancerApi = {
|
|
4
4
|
zoom: {
|
|
5
5
|
enter: (imgElement?: HTMLImageElement) => void;
|
|
6
6
|
exit: () => void;
|
|
7
|
-
|
|
7
|
+
moveAt: (position: {
|
|
8
8
|
x: number;
|
|
9
9
|
y: number;
|
|
10
|
-
} | undefined, details: {
|
|
11
|
-
isFirst: boolean;
|
|
12
|
-
isLast: boolean;
|
|
13
10
|
}) => void;
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
$: {
|
|
20
|
-
isZooming$: Observable<boolean>;
|
|
11
|
+
scaleAt: (scale: number) => void;
|
|
12
|
+
currentScale: number;
|
|
13
|
+
currentPosition: {
|
|
14
|
+
x: number;
|
|
15
|
+
y: number;
|
|
21
16
|
};
|
|
17
|
+
zoomContainerElement: HTMLDivElement | undefined;
|
|
18
|
+
isZooming$: Observable<boolean>;
|
|
19
|
+
isZooming: boolean;
|
|
22
20
|
};
|
|
23
21
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -8,4 +8,6 @@ export type Reader = ReturnType<typeof createReader>;
|
|
|
8
8
|
export { createReader };
|
|
9
9
|
export type ReaderSelection = ReturnType<typeof createSelection>;
|
|
10
10
|
export { Report } from './report';
|
|
11
|
-
export {
|
|
11
|
+
export { isHtmlElement } from './utils/dom';
|
|
12
|
+
export { isShallowEqual } from './utils/objects';
|
|
13
|
+
export { waitForSwitch } from './utils/rxjs';
|