@prose-reader/core 1.72.0 → 1.74.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 (64) hide show
  1. package/dist/cfi/generate/{getCfiForSpineItemPage.d.ts → generateCfiForSpineItemPage.d.ts} +1 -1
  2. package/dist/cfi/lookup/resolveCfi.d.ts +236 -0
  3. package/dist/constants.d.ts +0 -1
  4. package/dist/context/Context.d.ts +6 -29
  5. package/dist/createReaderWithEnhancer.d.ts +252 -9
  6. package/dist/enhancers/events/events.d.ts +1 -6
  7. package/dist/enhancers/events/frames.d.ts +3 -0
  8. package/dist/enhancers/events/normalizeEventForViewport.d.ts +1 -5
  9. package/dist/enhancers/navigation/index.d.ts +1 -1
  10. package/dist/enhancers/navigation/navigators/manualNavigator.d.ts +4 -0
  11. package/dist/enhancers/navigation/resolvers/{getNavigationForLeftPage.d.ts → getNavigationForLeftOrTopPage.d.ts} +1 -1
  12. package/dist/enhancers/navigation/resolvers/{getNavigationForRightPage.d.ts → getNavigationForRightOrBottomPage.d.ts} +1 -1
  13. package/dist/enhancers/navigation/types.d.ts +8 -0
  14. package/dist/enhancers/zoom/ControllableZoomer.d.ts +19 -0
  15. package/dist/enhancers/zoom/ScrollableZoomer.d.ts +16 -0
  16. package/dist/enhancers/zoom/Zoomer.d.ts +21 -0
  17. package/dist/enhancers/zoom/index.d.ts +2 -2
  18. package/dist/enhancers/zoom/types.d.ts +10 -12
  19. package/dist/index.d.ts +3 -1
  20. package/dist/index.js +1021 -923
  21. package/dist/index.js.map +1 -1
  22. package/dist/index.umd.cjs +1041 -941
  23. package/dist/index.umd.cjs.map +1 -1
  24. package/dist/navigation/InternalNavigator.d.ts +3 -5
  25. package/dist/navigation/Navigator.d.ts +1 -3
  26. package/dist/navigation/UserNavigator.d.ts +3 -1
  27. package/dist/navigation/consolidation/withSpineItemLayoutInfo.d.ts +3 -3
  28. package/dist/navigation/consolidation/withSpineItemPosition.d.ts +0 -2
  29. package/dist/navigation/resolvers/NavigationResolver.d.ts +3 -1
  30. package/dist/navigation/resolvers/getAdjustedPositionWithSafeEdge.d.ts +3 -1
  31. package/dist/navigation/restoration/restoreNavigationForControlledPageTurnMode.d.ts +3 -1
  32. package/dist/navigation/restoration/restorePosition.d.ts +3 -1
  33. package/dist/navigation/restoration/withRestoredPosition.d.ts +3 -7
  34. package/dist/navigation/tests/SpineItemsManagerMock.d.ts +2 -1
  35. package/dist/navigation/tests/utils.d.ts +2 -0
  36. package/dist/navigation/viewport/getScaledDownPosition.d.ts +2 -3
  37. package/dist/reader.d.ts +260 -18
  38. package/dist/settings/SettingsInterface.d.ts +2 -2
  39. package/dist/settings/SettingsManager.d.ts +2 -2
  40. package/dist/settings/SettingsManagerOverload.d.ts +2 -2
  41. package/dist/spine/Spine.d.ts +5 -2
  42. package/dist/spine/SpineItemsManager.d.ts +5 -26
  43. package/dist/spine/SpineItemsObserver.d.ts +3 -1
  44. package/dist/spine/SpineLayout.d.ts +49 -0
  45. package/dist/spine/layout/convertViewportPositionToLayoutPosition.d.ts +10 -0
  46. package/dist/spine/loader/SpineItemsLoader.d.ts +3 -1
  47. package/dist/spine/locator/SpineLocator.d.ts +146 -5
  48. package/dist/spine/locator/getAbsolutePageIndexFromPageIndex.d.ts +14 -0
  49. package/dist/spine/locator/getSpineInfoFromAbsolutePageIndex.d.ts +134 -0
  50. package/dist/spine/locator/getSpineItemFromPosition.d.ts +3 -1
  51. package/dist/spine/locator/getSpinePositionFromSpineItemPageIndex.d.ts +13 -0
  52. package/dist/spine/locator/getSpinePositionFromSpineItemPosition.d.ts +10 -0
  53. package/dist/spine/locator/getVisibleSpineItemsFromPosition.d.ts +3 -1
  54. package/dist/spineItem/locationResolver.d.ts +12 -2
  55. package/dist/spineItem/locator/getSpineItemNumberOfPages.d.ts +10 -0
  56. package/dist/spineItem/locator/getSpineItemPagesPosition.d.ts +12 -0
  57. package/dist/spineItem/locator/getSpineItemPositionFromPageIndex.d.ts +12 -0
  58. package/dist/utils/frames.d.ts +1 -0
  59. package/dist/utils/objects.d.ts +1 -6
  60. package/package.json +3 -3
  61. package/dist/enhancers/events/createIframeEventBridgeElement.d.ts +0 -1
  62. package/dist/enhancers/zoom/elementZoomer.d.ts +0 -19
  63. package/dist/enhancers/zoom/viewportZoomer.d.ts +0 -19
  64. package/dist/frames.d.ts +0 -5
@@ -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 getNavigationForLeftPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, }: {
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 getNavigationForRightPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, }: {
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"];
@@ -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 { Api } from './types';
2
+ import { EnhancerApi } from './types';
3
3
 
4
- export declare const zoomEnhancer: <InheritOptions, InheritOutput extends Reader>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => InheritOutput & Api;
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 Api = {
3
+ export type EnhancerApi = {
4
4
  zoom: {
5
5
  enter: (imgElement?: HTMLImageElement) => void;
6
6
  exit: () => void;
7
- move: (position: {
7
+ moveAt: (position: {
8
8
  x: number;
9
9
  y: number;
10
- } | undefined, details: {
11
- isFirst: boolean;
12
- isLast: boolean;
13
10
  }) => void;
14
- isZooming: () => boolean;
15
- isUsingScrollableZoom: () => boolean;
16
- getScaleValue: () => number;
17
- scale: (scale: number) => void;
18
- setCurrentScaleAsBase: () => void;
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 { groupBy, isShallowEqual } from './utils/objects';
11
+ export { isHtmlElement } from './utils/dom';
12
+ export { isShallowEqual } from './utils/objects';
13
+ export { waitForSwitch } from './utils/rxjs';