@prose-reader/core 1.200.0 → 1.202.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 +5 -7
- package/dist/createReaderWithEnhancer.d.ts +30 -22
- package/dist/enhancers/{layoutEnhancer → layout}/types.d.ts +1 -0
- package/dist/enhancers/layout/viewportMode.d.ts +3 -0
- package/dist/enhancers/navigation/navigators/manualNavigator.d.ts +1 -1
- package/dist/enhancers/navigation/resolvers/getNavigationForLeftOrTopPage.d.ts +1 -1
- package/dist/enhancers/navigation/resolvers/getNavigationForLeftSinglePage.d.ts +1 -1
- package/dist/enhancers/navigation/resolvers/getNavigationForRightOrBottomPage.d.ts +1 -1
- package/dist/enhancers/navigation/resolvers/getNavigationForRightSinglePage.d.ts +1 -1
- package/dist/enhancers/pagination/enhancer.d.ts +1 -1
- package/dist/enhancers/pagination/pagination.d.ts +1 -1
- package/dist/enhancers/pagination/progression.d.ts +1 -1
- package/dist/hooks/types.d.ts +0 -5
- package/dist/index.d.ts +1 -0
- package/dist/index.js +2753 -2571
- package/dist/index.js.map +1 -1
- package/dist/index.umd.cjs +2749 -2567
- package/dist/index.umd.cjs.map +1 -1
- package/dist/navigation/InternalNavigator.d.ts +6 -5
- package/dist/navigation/Navigator.d.ts +23 -21
- package/dist/navigation/UserScrollNavigation.d.ts +18 -0
- package/dist/navigation/consolidation/consolidateWithPagination.d.ts +1 -1
- package/dist/navigation/consolidation/mapUserNavigationToInternal.d.ts +1 -1
- package/dist/navigation/{viewport/ViewportNavigator.d.ts → controllers/ControlledNavigationController.d.ts} +5 -5
- package/dist/navigation/controllers/ScrollNavigationController.d.ts +27 -0
- package/dist/navigation/{viewport → controllers}/getScaledDownPosition.d.ts +1 -1
- package/dist/navigation/resolvers/NavigationResolver.d.ts +1 -1
- package/dist/navigation/resolvers/getAdjustedPositionForSpread.d.ts +1 -1
- package/dist/navigation/resolvers/getAdjustedPositionWithSafeEdge.d.ts +1 -1
- package/dist/navigation/resolvers/getNavigationForPosition.d.ts +1 -1
- package/dist/navigation/resolvers/getNavigationForSpineItemPage.d.ts +1 -1
- package/dist/navigation/resolvers/getNavigationForUrl.d.ts +1 -1
- package/dist/navigation/restoration/restorePosition.d.ts +1 -1
- package/dist/navigation/tests/utils.d.ts +0 -11
- package/dist/navigation/types.d.ts +11 -0
- package/dist/reader.d.ts +23 -14
- package/dist/settings/SettingsManagerOverload.d.ts +1 -0
- package/dist/spine/Spine.d.ts +8 -6
- package/dist/spine/SpineLayout.d.ts +3 -1
- package/dist/spine/layout/layoutItem.d.ts +3 -1
- package/dist/spine/loader/SpineItemsLoader.d.ts +2 -1
- package/dist/spine/locator/SpineLocator.d.ts +9 -3
- package/dist/spine/locator/getSpineItemFromPosition.d.ts +1 -1
- package/dist/spine/locator/getVisibleSpineItemsFromPosition.d.ts +4 -4
- package/dist/spineItem/SpineItemLayout.d.ts +3 -1
- package/dist/utils/ReactiveEntity.d.ts +8 -0
- package/dist/utils/rxjs.d.ts +1 -0
- package/dist/viewport/Viewport.d.ts +21 -0
- package/dist/viewport/translateSpinePositionToRelativeViewport.d.ts +1 -1
- package/package.json +3 -3
- package/dist/navigation/UserNavigator.d.ts +0 -29
- package/dist/navigation/tests/SpineItemsManagerMock.d.ts +0 -30
- package/dist/enhancers/{layoutEnhancer → layout}/SettingsManager.d.ts +1 -1
- /package/dist/enhancers/{layoutEnhancer → layout}/createMovingSafePan$.d.ts +0 -0
- /package/dist/enhancers/{layoutEnhancer → layout}/fixReflowable.d.ts +0 -0
- /package/dist/enhancers/{layoutEnhancer → layout}/layoutEnhancer.d.ts +0 -0
- /package/dist/enhancers/{layoutEnhancer → layout}/layoutInfo.d.ts +0 -0
- /package/dist/navigation/{viewport → controllers}/positions.d.ts +0 -0
|
@@ -2,6 +2,7 @@ import { Manifest } from '@prose-reader/shared';
|
|
|
2
2
|
import { Observable, ObservedValueOf } from 'rxjs';
|
|
3
3
|
import { Context } from '../context/Context';
|
|
4
4
|
import { HookManager } from '../hooks/HookManager';
|
|
5
|
+
import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
|
|
5
6
|
import { DestroyableClass } from '../utils/DestroyableClass';
|
|
6
7
|
import { DocumentRenderer } from './renderer/DocumentRenderer';
|
|
7
8
|
export declare class SpineItemLayout extends DestroyableClass {
|
|
@@ -10,6 +11,7 @@ export declare class SpineItemLayout extends DestroyableClass {
|
|
|
10
11
|
context: Context;
|
|
11
12
|
hookManager: HookManager;
|
|
12
13
|
renderer: DocumentRenderer;
|
|
14
|
+
settings: ReaderSettingsManager;
|
|
13
15
|
private layoutTriggerSubject;
|
|
14
16
|
private lastLayout;
|
|
15
17
|
readonly layout$: Observable<{
|
|
@@ -25,7 +27,7 @@ export declare class SpineItemLayout extends DestroyableClass {
|
|
|
25
27
|
height: number;
|
|
26
28
|
};
|
|
27
29
|
}>;
|
|
28
|
-
constructor(item: Manifest[`spineItems`][number], containerElement: HTMLElement, context: Context, hookManager: HookManager, renderer: DocumentRenderer);
|
|
30
|
+
constructor(item: Manifest[`spineItems`][number], containerElement: HTMLElement, context: Context, hookManager: HookManager, renderer: DocumentRenderer, settings: ReaderSettingsManager);
|
|
29
31
|
private validateDimension;
|
|
30
32
|
private applyDimsAfterLayout;
|
|
31
33
|
layout: (params: ObservedValueOf<typeof this.layoutTriggerSubject>) => Observable<{
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { BehaviorSubject, Observable, Subject } from 'rxjs';
|
|
2
|
+
export declare class ReactiveEntity<T extends Record<string, unknown>> extends BehaviorSubject<T> {
|
|
3
|
+
protected destroy$: Subject<void>;
|
|
4
|
+
update(value: Partial<T>): void;
|
|
5
|
+
watch<K extends keyof T>(key: K): Observable<T[K]>;
|
|
6
|
+
watch<K extends keyof T>(keys: K[]): Observable<Pick<T, K>>;
|
|
7
|
+
destroy(): void;
|
|
8
|
+
}
|
package/dist/utils/rxjs.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Observable, OperatorFunction } from 'rxjs';
|
|
2
2
|
export declare const mapKeysTo: <R extends Record<string, unknown>, K extends keyof R>(keys: K[]) => OperatorFunction<R, Pick<R, K>>;
|
|
3
|
+
export declare const watchKeys: <R extends Record<string, unknown>, K extends keyof R>(keys: K[]) => (stream: Observable<R>) => Observable<Pick<R, K>>;
|
|
3
4
|
export declare function observeResize(element: HTMLElement): Observable<ResizeObserverEntry[]>;
|
|
4
5
|
export declare const waitForSwitch: <O>(waitForStream: Observable<O>) => <N>(stream: Observable<N>) => Observable<N>;
|
|
5
6
|
export declare const deferNextResult: <T>(stream: Observable<T>) => () => Observable<T>;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { Context } from '../context/Context';
|
|
2
|
+
import { ReactiveEntity } from '../utils/ReactiveEntity';
|
|
3
|
+
import { AbsoluteViewport, RelativeViewport } from './types';
|
|
4
|
+
type State = {
|
|
5
|
+
element: HTMLElement;
|
|
6
|
+
pageSize: {
|
|
7
|
+
width: number;
|
|
8
|
+
height: number;
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
export declare class Viewport extends ReactiveEntity<State> {
|
|
12
|
+
protected context: Context;
|
|
13
|
+
constructor(context: Context);
|
|
14
|
+
protected calculatePageSize(): {
|
|
15
|
+
width: number;
|
|
16
|
+
height: number;
|
|
17
|
+
};
|
|
18
|
+
get absoluteViewport(): AbsoluteViewport;
|
|
19
|
+
get relativeViewport(): RelativeViewport;
|
|
20
|
+
}
|
|
21
|
+
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DeprecatedViewportPosition } from '../navigation/
|
|
1
|
+
import { DeprecatedViewportPosition } from '../navigation/controllers/ControlledNavigationController';
|
|
2
2
|
import { SpinePosition, UnsafeSpinePosition } from '../spine/types';
|
|
3
3
|
import { AbsoluteViewport, RelativeViewport } from './types';
|
|
4
4
|
export declare const translateSpinePositionToRelativeViewport: (absolutePosition: DeprecatedViewportPosition | SpinePosition, absoluteViewport: AbsoluteViewport, relativeViewport: RelativeViewport | AbsoluteViewport) => UnsafeSpinePosition;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@prose-reader/core",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.202.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.umd.cjs",
|
|
6
6
|
"module": "./dist/index.js",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"tsc": "tsc"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@prose-reader/shared": "^1.
|
|
26
|
+
"@prose-reader/shared": "^1.202.0"
|
|
27
27
|
},
|
|
28
28
|
"peerDependencies": {
|
|
29
29
|
"rxjs": "*"
|
|
@@ -31,5 +31,5 @@
|
|
|
31
31
|
"devDependencies": {
|
|
32
32
|
"happy-dom": "^17.1.0"
|
|
33
33
|
},
|
|
34
|
-
"gitHead": "
|
|
34
|
+
"gitHead": "837cabcb81eb875998a9b3fa3670eda80134eae6"
|
|
35
35
|
}
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
import { Observable, Subject } from 'rxjs';
|
|
2
|
-
import { Context } from '../context/Context';
|
|
3
|
-
import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
|
|
4
|
-
import { Spine } from '../spine/Spine';
|
|
5
|
-
import { SpinePosition } from '../spine/types';
|
|
6
|
-
import { DestroyableClass } from '../utils/DestroyableClass';
|
|
7
|
-
import { Locker } from './Locker';
|
|
8
|
-
import { DeprecatedViewportPosition } from './viewport/ViewportNavigator';
|
|
9
|
-
export type UserNavigationEntry = {
|
|
10
|
-
position?: DeprecatedViewportPosition | SpinePosition;
|
|
11
|
-
spineItem?: number | string;
|
|
12
|
-
url?: string | URL;
|
|
13
|
-
cfi?: string;
|
|
14
|
-
animation?: boolean | "turn" | "snap";
|
|
15
|
-
type?: "api" | "scroll";
|
|
16
|
-
direction?: "left" | "right" | "top" | "bottom";
|
|
17
|
-
};
|
|
18
|
-
export declare class UserNavigator extends DestroyableClass {
|
|
19
|
-
protected settings: ReaderSettingsManager;
|
|
20
|
-
protected element$: Observable<HTMLElement>;
|
|
21
|
-
protected context: Context;
|
|
22
|
-
protected scrollHappeningFromBrowser$: Observable<unknown>;
|
|
23
|
-
protected spine: Spine;
|
|
24
|
-
protected navigationSubject: Subject<UserNavigationEntry>;
|
|
25
|
-
locker: Locker;
|
|
26
|
-
navigation$: Observable<UserNavigationEntry>;
|
|
27
|
-
constructor(settings: ReaderSettingsManager, element$: Observable<HTMLElement>, context: Context, scrollHappeningFromBrowser$: Observable<unknown>, spine: Spine);
|
|
28
|
-
navigate(to: UserNavigationEntry): void;
|
|
29
|
-
}
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
import { BehaviorSubject, Subject } from 'rxjs';
|
|
2
|
-
export type Item = {
|
|
3
|
-
left: number;
|
|
4
|
-
top: number;
|
|
5
|
-
right: number;
|
|
6
|
-
bottom: number;
|
|
7
|
-
width: number;
|
|
8
|
-
height: number;
|
|
9
|
-
};
|
|
10
|
-
export declare class SpineItemsManagerMock {
|
|
11
|
-
items: Item[];
|
|
12
|
-
layout$: Subject<{
|
|
13
|
-
width: number;
|
|
14
|
-
height: number;
|
|
15
|
-
}>;
|
|
16
|
-
items$: BehaviorSubject<Item[]>;
|
|
17
|
-
load(items: {
|
|
18
|
-
left: number;
|
|
19
|
-
top: number;
|
|
20
|
-
right: number;
|
|
21
|
-
bottom: number;
|
|
22
|
-
width: number;
|
|
23
|
-
height: number;
|
|
24
|
-
}[]): void;
|
|
25
|
-
get(id: number): Item | undefined;
|
|
26
|
-
getAll(): Item[];
|
|
27
|
-
getLength(): number;
|
|
28
|
-
getSpineItemIndex(item: Item): number;
|
|
29
|
-
getSpineItemSpineLayoutInfo(spineItem: any): Item;
|
|
30
|
-
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { InputSettings, OutputSettings } from './types';
|
|
2
1
|
import { SettingsManagerOverload } from '../../settings/SettingsManagerOverload';
|
|
3
2
|
import { CoreInputSettings, CoreOutputSettings } from '../../settings/types';
|
|
3
|
+
import { InputSettings, OutputSettings } from './types';
|
|
4
4
|
export declare class SettingsManager<ParentInputSettings extends CoreInputSettings, ParentOutputSettings extends CoreOutputSettings> extends SettingsManagerOverload<InputSettings, OutputSettings, ParentInputSettings, ParentOutputSettings> {
|
|
5
5
|
computeOutputSettings(inputSettings: InputSettings): InputSettings;
|
|
6
6
|
hasSettingsChanged(newOutputSettings: InputSettings): boolean;
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|