@prose-reader/core 1.240.0 → 1.242.0

package/dist/createReaderWithEnhancer.d.ts

@@ -1,4 +1,4 @@
-import { CoreInputSettings, EnhancerLayoutInputSettings, Theme, EnhancerFontsInputSettings, Context, Spine, SpineItem, InternalNavigationEntry, InternalNavigator, ScrollNavigationController, ControlledNavigationController, Locker, UserNavigationEntry, SpinePosition, SpineItemPosition, DeprecatedViewportPosition, SpineItemsObserver, SpineItemsManager, ContextState, SettingsInterface, CoreOutputSettings, SpineItemReference, Viewport, Features, LayoutEnhancerOutput, ComputedCoreSettings, ExtraPaginationInfo, ResourcesLocator, NavigationEnhancerOutput, ZoomEnhancerOutput } from '.';
+import { CoreInputSettings, EnhancerLayoutInputSettings, Theme, EnhancerFontsInputSettings, Context, Spine, SpineItem, InternalNavigationEntry, InternalNavigator, ScrollNavigationController, ControlledNavigationController, Locker, UserNavigationEntry, SpinePosition, SpineItemPosition, UnboundSpinePosition, SpineItemsObserver, SpineItemsManager, ContextState, SettingsInterface, CoreOutputSettings, SpineItemReference, Viewport, Features, LayoutEnhancerOutput, ComputedCoreSettings, ExtraPaginationInfo, ResourcesLocator, NavigationEnhancerOutput, ZoomEnhancerOutput } from '.';
 import { HookManager, CoreHook } from './hooks';
 import { Manifest } from '@prose-reader/shared';
 import { resolveCfi } from './cfi';
@@ -69,13 +69,14 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
                 spineItemPosition: SpineItemPosition;
                 spineItem: SpineItem;
             }) => SpinePosition;
-            getNavigationForCfi: (cfi: string) => DeprecatedViewportPosition | undefined;
-            getNavigationForLastPage: (spineItem: SpineItem) => DeprecatedViewportPosition;
-            getNavigationForSpineIndexOrId: (indexOrId: number | string | SpineItem) => DeprecatedViewportPosition;
-            getNavigationForPosition: (viewportPosition: DeprecatedViewportPosition | SpinePosition) => SpinePosition;
-            getMostPredominantNavigationForPosition: (viewportPosition: DeprecatedViewportPosition) => DeprecatedViewportPosition;
-            getAdjustedPositionWithSafeEdge: (position: DeprecatedViewportPosition | SpinePosition) => SpinePosition;
-            isNavigationGoingForwardFrom: (to: DeprecatedViewportPosition, from: DeprecatedViewportPosition) => boolean;
+            getNavigationForCfi: (cfi: string) => SpinePosition | undefined;
+            getNavigationForLastPage: (spineItem: SpineItem) => SpinePosition;
+            getNavigationForSpineIndexOrId: (indexOrId: number | string | SpineItem) => SpinePosition;
+            getNavigationForPosition: (viewportPosition: SpinePosition | UnboundSpinePosition) => SpinePosition;
+            getMostPredominantNavigationForPosition: (viewportPosition: SpinePosition) => SpinePosition;
+            fromUnboundSpinePosition: (position: SpinePosition | UnboundSpinePosition) => SpinePosition;
+            fromOutOfBoundsSpinePosition: (position: SpinePosition | UnboundSpinePosition) => SpinePosition | UnboundSpinePosition;
+            isNavigationGoingForwardFrom: (to: SpinePosition, from: SpinePosition) => boolean;
             arePositionsDifferent: (a: {
                 x: number;
                 y: number;
@@ -83,7 +84,7 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
                 x: number;
                 y: number;
             }) => boolean;
-            getAdjustedPositionForSpread: (position: DeprecatedViewportPosition | SpinePosition) => SpinePosition;
+            getAdjustedPositionForSpread: (position: SpinePosition | UnboundSpinePosition) => SpinePosition;
             spineItemNavigator: {
                 getNavigationForLastPage: (spineItem: SpineItem) => SpineItemPosition;
                 getNavigationForPosition: (spineItem: SpineItem, position: SpineItemPosition) => SpineItemPosition;
@@ -91,7 +92,7 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
             };
         };
         navigation$: Observable<{
-            position: SpinePosition;
+            position: SpinePosition | UnboundSpinePosition;
             id: symbol;
         }>;
     };

package/dist/enhancers/layout/coordinates.d.ts

@@ -1,12 +1,12 @@
 import { Reader } from '../../reader';
-import { UnsafeSpinePosition } from '../../spine/types';
+import { UnboundSpinePosition } from '../../spine/types';
 export declare const getSpinePositionFromClientPosition: (position: {
     x: number;
     y: number;
-}, spineElement: HTMLElement) => UnsafeSpinePosition;
+}, spineElement: HTMLElement) => UnboundSpinePosition;
 export declare const createCoordinatesApi: (reader: Reader) => {
     getSpinePositionFromClientPosition: (position: {
         x: number;
         y: number;
-    }) => UnsafeSpinePosition | undefined;
+    }) => UnboundSpinePosition | undefined;
 };

package/dist/enhancers/layout/types.d.ts

@@ -3,6 +3,5 @@ export type EnhancerLayoutInputSettings = {
     pageVerticalMargin: number;
     layoutAutoResize: `container` | false;
     layoutLayerTransition: boolean;
-    viewportMode: `normal` | `thumbnails`;
 };
 export type OutputSettings = EnhancerLayoutInputSettings;

package/dist/enhancers/navigation/resolvers/getNavigationForLeftOrTopPage.d.ts

@@ -1,15 +1,14 @@
 import { Context } from '../../../context/Context';
 import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
-import { DeprecatedViewportPosition } from '../../../navigation/types';
 import { SettingsInterface } from '../../../settings/SettingsInterface';
 import { ComputedCoreSettings, CoreInputSettings } from '../../../settings/types';
 import { SpineLocator } from '../../../spine/locator/SpineLocator';
 import { SpineItemsManager } from '../../../spine/SpineItemsManager';
-import { SpinePosition } from '../../../spine/types';
+import { SpinePosition, UnboundSpinePosition } from '../../../spine/types';
 import { SpineItem } from '../../../spineItem/SpineItem';
 import { Viewport } from '../../../viewport/Viewport';
 export declare const getNavigationForLeftOrTopPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, viewport, settings, }: {
-    position: DeprecatedViewportPosition | SpinePosition;
+    position: SpinePosition | UnboundSpinePosition;
     spineItem: SpineItem;
     context: Context;
     spineItemsManager: SpineItemsManager;
@@ -18,4 +17,4 @@ export declare const getNavigationForLeftOrTopPage: ({ position, spineItem, cont
     computedPageTurnDirection: "horizontal" | "vertical";
     viewport: Viewport;
     settings: SettingsInterface<CoreInputSettings, CoreInputSettings & ComputedCoreSettings>;
-}) => DeprecatedViewportPosition;
+}) => SpinePosition | UnboundSpinePosition;

package/dist/enhancers/navigation/resolvers/getNavigationForLeftSinglePage.d.ts

@@ -1,14 +1,13 @@
 import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
-import { DeprecatedViewportPosition } from '../../../navigation/types';
 import { SpineLocator } from '../../../spine/locator/SpineLocator';
 import { SpineItemsManager } from '../../../spine/SpineItemsManager';
-import { SpinePosition } from '../../../spine/types';
+import { SpinePosition, UnboundSpinePosition } from '../../../spine/types';
 import { Viewport } from '../../../viewport/Viewport';
 export declare const getNavigationForLeftSinglePage: ({ position, navigationResolver, computedPageTurnDirection, spineItemsManager, spineLocator, viewport, }: {
-    position: DeprecatedViewportPosition | SpinePosition;
+    position: SpinePosition | UnboundSpinePosition;
     navigationResolver: NavigationResolver;
     computedPageTurnDirection: "horizontal" | "vertical";
     spineItemsManager: SpineItemsManager;
     spineLocator: SpineLocator;
     viewport: Viewport;
-}) => DeprecatedViewportPosition | SpinePosition;
+}) => SpinePosition | UnboundSpinePosition;

package/dist/enhancers/navigation/resolvers/getNavigationForRightOrBottomPage.d.ts

@@ -1,15 +1,14 @@
 import { Context } from '../../../context/Context';
 import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
-import { DeprecatedViewportPosition } from '../../../navigation/types';
 import { SettingsInterface } from '../../../settings/SettingsInterface';
 import { ComputedCoreSettings, CoreInputSettings } from '../../../settings/types';
 import { SpineLocator } from '../../../spine/locator/SpineLocator';
 import { SpineItemsManager } from '../../../spine/SpineItemsManager';
-import { SpinePosition } from '../../../spine/types';
+import { SpinePosition, UnboundSpinePosition } from '../../../spine/types';
 import { SpineItem } from '../../../spineItem/SpineItem';
 import { Viewport } from '../../../viewport/Viewport';
 export declare const getNavigationForRightOrBottomPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, viewport, settings, }: {
-    position: DeprecatedViewportPosition | SpinePosition;
+    position: SpinePosition | UnboundSpinePosition;
     spineItem: SpineItem;
     context: Context;
     spineItemsManager: SpineItemsManager;
@@ -18,4 +17,4 @@ export declare const getNavigationForRightOrBottomPage: ({ position, spineItem,
     computedPageTurnDirection: "horizontal" | "vertical";
     viewport: Viewport;
     settings: SettingsInterface<CoreInputSettings, CoreInputSettings & ComputedCoreSettings>;
-}) => DeprecatedViewportPosition;
+}) => SpinePosition;

package/dist/enhancers/navigation/resolvers/getNavigationForRightSinglePage.d.ts

@@ -1,14 +1,13 @@
 import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
-import { DeprecatedViewportPosition } from '../../../navigation/types';
 import { SpineLocator } from '../../../spine/locator/SpineLocator';
 import { SpineItemsManager } from '../../../spine/SpineItemsManager';
-import { SpinePosition } from '../../../spine/types';
+import { SpinePosition, UnboundSpinePosition } from '../../../spine/types';
 import { Viewport } from '../../../viewport/Viewport';
 export declare const getNavigationForRightSinglePage: ({ position, navigationResolver, computedPageTurnDirection, spineItemsManager, spineLocator, viewport, }: {
-    position: DeprecatedViewportPosition | SpinePosition;
+    position: SpinePosition | UnboundSpinePosition;
     navigationResolver: NavigationResolver;
     computedPageTurnDirection: "horizontal" | "vertical";
     spineItemsManager: SpineItemsManager;
     spineLocator: SpineLocator;
     viewport: Viewport;
-}) => DeprecatedViewportPosition | SpinePosition;
+}) => SpinePosition | UnboundSpinePosition;

package/dist/enhancers/zoom/ControlledZoomController.d.ts

@@ -0,0 +1,19 @@
+import { Reader } from '../../reader';
+import { ZoomController } from './ZoomController';
+export declare class ControlledZoomController extends ZoomController {
+    constructor(reader: Reader);
+    enter({ element, scale, animate, }?: {
+        element?: HTMLImageElement;
+        scale?: number;
+        animate?: boolean;
+    }): void;
+    exit(): void;
+    moveAt(position: {
+        x: number;
+        y: number;
+    }): void;
+    protected setElementScale(element: HTMLDivElement, scale: number): void;
+    protected setViewportScale(scale: number): void;
+    protected setScale(userScale: number): void;
+    scaleAt(userScale: number): void;
+}

package/dist/enhancers/zoom/ScrollableZoomer.d.ts

@@ -1,15 +1,14 @@
-import { BehaviorSubject } from 'rxjs';
-import { Zoomer } from './Zoomer';
-export declare class ScrollableZoomer extends Zoomer {
-    element: HTMLDivElement | undefined;
-    isZooming$: BehaviorSubject<boolean>;
-    currentScale: number;
-    currentPosition: {
-        x: number;
-        y: number;
-    };
-    enter(): void;
+import { ZoomController } from './ZoomController';
+export declare const adjustScrollToKeepContentCentered: (scrollContainer: HTMLElement, fromScale: number, toScale: number) => {
+    newScrollLeft: number;
+    newScrollTop: number;
+};
+export declare class ScrollableZoomController extends ZoomController {
+    enter({ scale }?: {
+        scale?: number;
+    }): void;
     exit(): void;
     moveAt(): void;
+    protected setScale(scale: number): void;
     scaleAt(userScale: number): void;
 }

package/dist/enhancers/zoom/ZoomController.d.ts

@@ -0,0 +1,26 @@
+import { Reader } from '../../reader';
+import { ReactiveEntity } from '../../utils/ReactiveEntity';
+export type ZoomControllerState = {
+    element: HTMLDivElement | undefined;
+    isZooming: boolean;
+    currentScale: number;
+    currentPosition: {
+        x: number;
+        y: number;
+    };
+};
+export declare abstract class ZoomController extends ReactiveEntity<ZoomControllerState> {
+    protected reader: Reader;
+    constructor(reader: Reader);
+    abstract enter(params?: {
+        element?: HTMLImageElement;
+        scale?: number;
+        animate?: boolean;
+    }): void;
+    abstract exit(): void;
+    abstract moveAt(position: {
+        x: number;
+        y: number;
+    }): void;
+    abstract scaleAt(scale: number): void;
+}

package/dist/enhancers/zoom/types.d.ts

@@ -1,20 +1,19 @@
 import { Observable } from 'rxjs';
+import { ZoomControllerState } from './ZoomController';
 export type ZoomEnhancerOutput = {
     zoom: {
-        enter: (imgElement?: HTMLImageElement) => void;
+        enter: (params?: {
+            element?: HTMLImageElement;
+            scale?: number;
+            animate?: boolean;
+        }) => void;
         exit: () => void;
         moveAt: (position: {
             x: number;
             y: number;
         }) => void;
         scaleAt: (scale: number) => void;
-        currentScale: number;
-        currentPosition: {
-            x: number;
-            y: number;
-        };
-        zoomContainerElement: HTMLDivElement | undefined;
-        isZooming$: Observable<boolean>;
-        isZooming: boolean;
+        state$: Observable<ZoomControllerState>;
+        get state(): ZoomControllerState;
     };
 };