@prose-reader/core 1.288.0 → 1.290.0

package/dist/context/BridgeEvent.d.ts

@@ -1,15 +1,16 @@
 import { BehaviorSubject, ReplaySubject, Observable } from 'rxjs';
 import { Navigation } from '../navigation/types';
 import { PaginationInfo } from '../pagination/types';
+import { SpinePosition, UnboundSpinePosition } from '../spine/types';
 export declare class BridgeEvent {
     navigationSubject: ReplaySubject<Navigation>;
+    positionSubject: ReplaySubject<SpinePosition | UnboundSpinePosition>;
     viewportStateSubject: BehaviorSubject<"free" | "busy">;
     paginationSubject: ReplaySubject<PaginationInfo>;
-    navigationIsLockedSubject: BehaviorSubject<boolean>;
     pagination$: Observable<PaginationInfo>;
-    navigationUnlocked$: Observable<boolean>;
     viewportState$: Observable<"free" | "busy">;
     viewportFree$: Observable<"free">;
     viewportBusy$: Observable<"busy">;
     navigation$: Observable<Navigation>;
+    position$: Observable<SpinePosition | UnboundSpinePosition>;
 }

package/dist/createReaderWithEnhancer.d.ts

@@ -1,4 +1,4 @@
-import { CoreInputSettings, Theme, EnhancerLayoutInputSettings, EnhancerFontsInputSettings, Context, Spine, PageEntry, 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 { CoreInputSettings, Theme, EnhancerLayoutInputSettings, EnhancerFontsInputSettings, Context, Spine, PageEntry, SpineItem, InternalNavigationEntry, InternalNavigator, ScrollNavigationController, ControlledNavigationController, UserNavigationEntry, SpinePosition, SpineItemPosition, UnboundSpinePosition, NavigationVisibleArea, SpineBoundary, 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 { ProseParsedCfi, resolveCfi } from './cfi';
@@ -36,10 +36,10 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
         internalNavigator: InternalNavigator;
         scrollNavigationController: ScrollNavigationController;
         controlledNavigationController: ControlledNavigationController;
-        locker: Locker;
         navigationState$: Observable<"free" | "busy">;
         navigate: (to: UserNavigationEntry) => void;
-        lock(): () => void;
+        lock: () => () => void;
+        isLocked$: Observable<boolean>;
         navigationResolver: {
             getNavigationForUrl: (url: string | URL) => {
                 position: SpinePosition;
@@ -55,8 +55,8 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
             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;
+            clampPositionInSpine: (position: SpinePosition | UnboundSpinePosition, size: NavigationVisibleArea) => UnboundSpinePosition;
+            getBoundaryForPosition: (position: SpinePosition | UnboundSpinePosition, size?: NavigationVisibleArea) => SpineBoundary | undefined;
             isNavigationGoingForwardFrom: (to: SpinePosition, from: SpinePosition) => boolean;
             arePositionsDifferent: (a: {
                 x: number;
@@ -65,17 +65,17 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
                 x: number;
                 y: number;
             }) => boolean;
-            getAdjustedPositionForSpread: (position: SpinePosition | UnboundSpinePosition) => SpinePosition;
+            getAdjustedPositionForSpread: (position: SpinePosition | UnboundSpinePosition) => SpinePosition | UnboundSpinePosition;
             spineItemNavigator: {
                 getNavigationForLastPage: (spineItem: SpineItem) => SpineItemPosition;
                 getNavigationForPosition: (spineItem: SpineItem, position: SpineItemPosition) => SpineItemPosition;
                 getNavigationFromNode: (spineItem: SpineItem, node: Node, offset: number) => SpineItemPosition;
             };
         };
-        navigation$: Observable<{
-            position: SpinePosition | UnboundSpinePosition;
-            id: symbol;
+        navigation$: Observable<Pick< InternalNavigationEntry, "id" | "position" | "requestedPosition" | "requestedVisibleArea"> & {
+            triggeredBy: InternalNavigationEntry["meta"]["triggeredBy"];
         }>;
+        position$: Observable< SpinePosition | UnboundSpinePosition>;
     };
     spineItemsObserver: SpineItemsObserver;
     spineItemsManager: SpineItemsManager;

package/dist/enhancers/navigation/bookBoundary.d.ts

@@ -0,0 +1,8 @@
+import { Observable } from 'rxjs';
+import { Reader } from '../../reader';
+import { BoundaryReachedEvent } from './boundary';
+export type BookBoundaryReachedOptions = {
+    itemReadinessTimeoutMs?: number;
+};
+export type BookBoundaryReachedEvent = BoundaryReachedEvent;
+export declare const observeBookBoundaryReached: (reader: Reader, { itemReadinessTimeoutMs, }?: BookBoundaryReachedOptions) => Observable<BookBoundaryReachedEvent>;

package/dist/enhancers/navigation/bookBoundary.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/enhancers/navigation/boundary.d.ts

@@ -0,0 +1,6 @@
+import { Observable } from 'rxjs';
+import { Reader } from '../../reader';
+export type BoundaryReachedEvent = {
+    boundary: "start" | "end";
+};
+export declare const outOfSpineBoundary: (reader: Reader) => Observable<BoundaryReachedEvent>;

package/dist/enhancers/navigation/boundary.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,12 +1,11 @@
 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 lock: () => () => void;
     protected navigationSubject: Subject<UserNavigationEntry>;
     navigation$: Observable<UserNavigationEntry>;
-    constructor(scrollNavigationController: ScrollNavigationController, locker: Locker);
+    constructor(scrollNavigationController: ScrollNavigationController, lock: () => () => void);
 }

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

@@ -17,4 +17,4 @@ export declare const getNavigationForRightOrBottomPage: ({ position, spineItem,
     computedPageTurnDirection: "horizontal" | "vertical";
     viewport: Viewport;
     settings: SettingsInterface<CoreInputSettings, CoreInputSettings & ComputedCoreSettings>;
-}) => SpinePosition;
+}) => SpinePosition | UnboundSpinePosition;

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

@@ -0,0 +1 @@
+export {};

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

@@ -1,5 +1,6 @@
 import { Observable } from 'rxjs';
 import { Reader } from '../../reader';
+import { outOfSpineBoundary } from './boundary';
 import { ManualNavigator } from './navigators/manualNavigator';
 import { PanNavigator } from './navigators/panNavigator';
 import { observeState } from './state';
@@ -9,6 +10,7 @@ export type NavigationEnhancerOutput = {
     }) => void;
     navigation: {
         state$: ReturnType<typeof observeState>;
+        outOfSpineBoundary$: ReturnType<typeof outOfSpineBoundary>;
         throttleLock: <T>(params: {
             duration: number;
             trigger: Observable<T>;

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

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -37,8 +37,8 @@ export * from './spine/types';
 export * from './spineItem/SpineItem';
 export { SpineItem } from './spineItem/SpineItem';
 export * from './spineItem/types';
+export * from './utilities';
 export * from './utils/DestroyableClass';
-export { isHtmlElement, isHtmlTagElement } from './utils/dom';
 export * from './utils/frames';
 export * from './utils/isDefined';
 export * from './utils/objects';