@prose-reader/core 1.239.0 → 1.241.0

package/dist/context/Context.d.ts

@@ -1,40 +1,20 @@
 import { Manifest } from '@prose-reader/shared';
-import { Subject, Observable } from 'rxjs';
 import { ReactiveEntity } from '../utils/ReactiveEntity';
 import { BridgeEvent } from './BridgeEvent';
+import { Observable } from 'rxjs';
 export type ContextState = {
     rootElement?: HTMLElement;
     manifest?: Manifest;
     hasVerticalWriting?: boolean;
-    isUsingSpreadMode?: boolean;
     assumedRenditionLayout: "reflowable" | "pre-paginated";
     isFullyPrePaginated?: boolean;
-    forceSinglePageMode?: boolean;
-    calculatedInnerMargin: number;
-    marginTop: number;
-    marginBottom: number;
-    visibleAreaRect: {
-        width: number;
-        height: number;
-        x: number;
-        y: number;
-    };
 };
 export declare class Context extends ReactiveEntity<ContextState> {
     bridgeEvent: BridgeEvent;
-    destroy$: Subject<void>;
-    state$: Observable<ContextState>;
     manifest$: Observable<Manifest>;
-    hasVerticalWriting$: Observable<boolean>;
-    isUsingSpreadMode$: Observable<boolean | undefined>;
     constructor();
     update(newState: Partial<ContextState>): void;
     isRTL: () => boolean;
-    get state(): ContextState;
     get manifest(): Manifest | undefined;
     get readingDirection(): "ltr" | "rtl" | undefined;
-    getPageSize(): {
-        width: number;
-        height: number;
-    };
 }

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';
@@ -64,18 +64,18 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
                 position: SpinePosition;
                 spineItemId: string;
             } | undefined;
-            getNavigationForSpineItemPage: (params: Omit<Parameters< getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => SpinePosition;
+            getNavigationForSpineItemPage: (params: Omit<Parameters< getNavigationForSpineItemPage>[0], "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator" | "viewport">) => SpinePosition;
             getNavigationFromSpineItemPosition: (params: {
                 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;
+            isNavigationGoingForwardFrom: (to: SpinePosition, from: SpinePosition) => boolean;
             arePositionsDifferent: (a: {
                 x: number;
                 y: number;
@@ -83,7 +83,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 +91,7 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
             };
         };
         navigation$: Observable<{
-            position: SpinePosition;
+            position: SpinePosition | UnboundSpinePosition;
             id: symbol;
         }>;
     };
@@ -112,7 +112,6 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
         release: () => void;
     } | undefined>;
     viewport: Viewport;
-    element$: Observable<HTMLElement | undefined>;
     viewportState$: Observable<"free" | "busy">;
     viewportFree$: Observable<"free">;
     state$: Observable<"idle" | "ready">;

package/dist/enhancers/events/normalizeEventForViewport.d.ts

@@ -1,3 +1,3 @@
-import { Context } from '../../context/Context';
 import { SpineLocator } from '../../spine/locator/SpineLocator';
-export declare const normalizeEventForViewport: <E extends MouseEvent | TouchEvent | PointerEvent>(event: E, iframeOriginalEvent: E, locator: SpineLocator, context: Context) => E;
+import { Viewport } from '../../viewport/Viewport';
+export declare const normalizeEventForViewport: <E extends MouseEvent | TouchEvent | PointerEvent>(event: E, iframeOriginalEvent: E, locator: SpineLocator, viewport: Viewport) => E;

package/dist/enhancers/hotkeys.d.ts

@@ -1,3 +1,3 @@
-import { EnhancerOptions, EnhancerOutput, RootEnhancer } from './types/enhancer';
 import { NavigationEnhancerOutput } from './navigation/types';
+import { EnhancerOptions, EnhancerOutput, RootEnhancer } from './types/enhancer';
 export declare const hotkeysEnhancer: <InheritOptions extends EnhancerOptions<RootEnhancer>, InheritOutput extends EnhancerOutput<RootEnhancer> & NavigationEnhancerOutput>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => InheritOutput;

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/updateSpreadMode.d.ts

@@ -0,0 +1,12 @@
+import { Reader } from '../../reader';
+import { Observable } from 'rxjs';
+import { Manifest } from '@prose-reader/shared';
+export declare const updateSpreadMode: (reader: Reader) => Observable<[Pick<{
+    element: HTMLElement;
+    pageSize: {
+        width: number;
+        height: number;
+    };
+    width: number;
+    height: number;
+}, "width" | "height">, Manifest | undefined]>;

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

@@ -1,3 +1,7 @@
 import { Observable } from 'rxjs';
 import { Reader } from '../../reader';
+export declare const adjustScrollToKeepContentCentered: (scrollContainer: HTMLElement, fromScale: number, toScale: number) => {
+    newScrollLeft: number;
+    newScrollTop: number;
+};
 export declare const createViewportModeHandler: (reader: Reader, viewportMode$: Observable<`normal` | `thumbnails`>) => Observable<0>;

package/dist/enhancers/loading/createLoadingElement.d.ts

@@ -1,6 +1,6 @@
 import { Manifest } from '@prose-reader/shared';
-import { Context } from '../../context/Context';
-export declare const createLoadingElementContainer: (containerElement: HTMLElement, context: Context) => HTMLDivElement;
+import { Viewport } from '../../viewport/Viewport';
+export declare const createLoadingElementContainer: (containerElement: HTMLElement, viewport: Viewport) => HTMLDivElement;
 export declare const defaultLoadingElementCreate: ({ container, item, }: {
     container: HTMLElement;
     item: Manifest[`spineItems`][number];

package/dist/enhancers/navigation/navigators/UserScrollNavigation.d.ts

@@ -0,0 +1,12 @@
+import { Subject, Observable } from 'rxjs';
+import { ScrollNavigationController } from '../../../navigation/controllers/ScrollNavigationController';
+import { Locker } from '../../../navigation/Locker';
+import { UserNavigationEntry } from '../../../navigation/types';
+import { DestroyableClass } from '../../../utils/DestroyableClass';
+export declare class UserScrollNavigation extends DestroyableClass {
+    protected scrollNavigationController: ScrollNavigationController;
+    protected locker: Locker;
+    protected navigationSubject: Subject<UserNavigationEntry>;
+    navigation$: Observable<UserNavigationEntry>;
+    constructor(scrollNavigationController: ScrollNavigationController, locker: Locker);
+}

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

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

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

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

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

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

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

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

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

@@ -1,6 +1,6 @@
 import { BehaviorSubject } from 'rxjs';
-import { Zoomer } from './Zoomer';
-export declare class ControllableZoomer extends Zoomer {
+import { ZoomController } from './ZoomController';
+export declare class ControllableZoomer extends ZoomController {
     element: HTMLDivElement | undefined;
     isZooming$: BehaviorSubject<boolean>;
     currentScale: number;

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

@@ -1,6 +1,6 @@
 import { BehaviorSubject } from 'rxjs';
-import { Zoomer } from './Zoomer';
-export declare class ScrollableZoomer extends Zoomer {
+import { ZoomController } from './ZoomController';
+export declare class ScrollableZoomer extends ZoomController {
     element: HTMLDivElement | undefined;
     isZooming$: BehaviorSubject<boolean>;
     currentScale: number;

package/dist/enhancers/zoom/{Zoomer.d.ts → ZoomController.d.ts}

@@ -1,6 +1,6 @@
 import { BehaviorSubject } from 'rxjs';
 import { Reader } from '../../reader';
-export declare abstract class Zoomer {
+export declare abstract class ZoomController {
     protected reader: Reader;
     constructor(reader: Reader);
     abstract enter(element?: HTMLImageElement): void;