@prose-reader/core 1.201.0 → 1.203.0

package/dist/navigation/InternalNavigator.d.ts

@@ -6,10 +6,10 @@ import { SpinePosition } from '../spine/types';
 import { SpineItemPosition } from '../spineItem/types';
 import { DestroyableClass } from '../utils/DestroyableClass';
 import { Locker } from './Locker';
-import { UserNavigationEntry } from './UserNavigator';
 import { ControlledNavigationController, DeprecatedViewportPosition } from './controllers/ControlledNavigationController';
 import { ScrollNavigationController } from './controllers/ScrollNavigationController';
 import { createNavigationResolver } from './resolvers/NavigationResolver';
+import { UserNavigationEntry } from './types';
 export type NavigationConsolidation = {
     spineItemHeight?: number;
     spineItemWidth?: number;

package/dist/navigation/Navigator.d.ts

@@ -5,8 +5,10 @@ import { Spine } from '../spine/Spine';
 import { SpineItemsManager } from '../spine/SpineItemsManager';
 import { Viewport } from '../viewport/Viewport';
 import { InternalNavigator } from './InternalNavigator';
+import { Locker } from './Locker';
 import { ControlledNavigationController } from './controllers/ControlledNavigationController';
 import { ScrollNavigationController } from './controllers/ScrollNavigationController';
+import { UserNavigationEntry } from './types';
 export declare const createNavigator: ({ spineItemsManager, context, hookManager, spine, settings, viewport, }: {
     spineItemsManager: SpineItemsManager;
     context: Context;
@@ -20,9 +22,9 @@ export declare const createNavigator: ({ spineItemsManager, context, hookManager
     internalNavigator: InternalNavigator;
     scrollNavigationController: ScrollNavigationController;
     controlledNavigationController: ControlledNavigationController;
-    isLocked$: import('rxjs').Observable<boolean>;
+    locker: Locker;
     viewportState$: import('rxjs').Observable<"free" | "busy">;
-    navigate: (to: import('./UserNavigator').UserNavigationEntry) => void;
+    navigate: (to: UserNavigationEntry) => void;
     lock(): () => void;
     navigationResolver: {
         getNavigationForUrl: (url: string | URL) => {

package/dist/navigation/UserScrollNavigation.d.ts

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

package/dist/navigation/consolidation/mapUserNavigationToInternal.d.ts

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
-import { UserNavigationEntry } from '../UserNavigator';
 import { InternalNavigationEntry, InternalNavigationInput } from '../InternalNavigator';
+import { UserNavigationEntry } from '../types';
 export declare const mapUserNavigationToInternal: (stream: Observable<[UserNavigationEntry, InternalNavigationEntry]>) => Observable<{
     navigation: InternalNavigationInput;
     previousNavigation: InternalNavigationEntry;

package/dist/navigation/controllers/ScrollNavigationController.d.ts

@@ -19,6 +19,7 @@ export declare class ScrollNavigationController extends ReactiveEntity<{
     protected scrollingSubject: BehaviorSubject<boolean>;
     isScrolling$: Observable<boolean>;
     isNavigating$: Observable<boolean>;
+    userScroll$: Observable<Event>;
     constructor(viewport: Viewport, settings: ReaderSettingsManager, hookManager: HookManager, spine: Spine, context: Context);
     protected setViewportPosition: ({ position }: ViewportNavigationEntry) => void;
     navigate(navigation: ViewportNavigationEntry): void;

package/dist/navigation/tests/utils.d.ts

@@ -4,15 +4,4 @@ import { HookManager } from '../../hooks/HookManager';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { Spine } from '../../spine/Spine';
 import { SpineItemsManager } from '../../spine/SpineItemsManager';
-import { InternalNavigator } from '../InternalNavigator';
-import { UserNavigator } from '../UserNavigator';
 export declare const generateItems: (size: number, number: number, context: Context, settings: ReaderSettingsManager, hookManager: HookManager, spine: Spine, spineItemsManager: SpineItemsManager) => SpineItem[];
-export declare const createNavigator: () => {
-    internalNavigator: InternalNavigator;
-    userNavigator: UserNavigator;
-    context: Context;
-    spineItemsManagerMock: SpineItemsManager;
-    spine: Spine;
-    settings: ReaderSettingsManager;
-    hookManager: HookManager<import('../../hooks/types').CoreHook>;
-};

package/dist/navigation/types.d.ts

@@ -0,0 +1,11 @@
+import { SpinePosition } from '../spine/types';
+import { DeprecatedViewportPosition } from './controllers/ControlledNavigationController';
+export type UserNavigationEntry = {
+    position?: DeprecatedViewportPosition | SpinePosition;
+    spineItem?: number | string;
+    url?: string | URL;
+    cfi?: string;
+    animation?: boolean | "turn" | "snap";
+    type?: "api" | "scroll";
+    direction?: "left" | "right" | "top" | "bottom";
+};

package/dist/reader.d.ts

@@ -53,9 +53,9 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
         internalNavigator: import('./navigation/InternalNavigator').InternalNavigator;
         scrollNavigationController: import('./navigation/controllers/ScrollNavigationController').ScrollNavigationController;
         controlledNavigationController: import('./navigation/controllers/ControlledNavigationController').ControlledNavigationController;
-        isLocked$: import('rxjs').Observable<boolean>;
+        locker: import('./navigation/Locker').Locker;
         viewportState$: import('rxjs').Observable<"free" | "busy">;
-        navigate: (to: import('./navigation/UserNavigator').UserNavigationEntry) => void;
+        navigate: (to: import('./navigation/types').UserNavigationEntry) => void;
         lock(): () => void;
         navigationResolver: {
             getNavigationForUrl: (url: string | URL) => {

package/dist/settings/SettingsManagerOverload.d.ts

@@ -18,6 +18,7 @@ export declare abstract class SettingsManagerOverload<InputSettings, OutputSetti
     };
     update(settings: Partial<InputSettings & ParentInputSettings>): void;
     get values(): ParentOutputSettings & OutputSettings;
+    watch<K extends keyof ObservedValueOf<typeof this.values$>>(key: K): Observable<(ParentOutputSettings & OutputSettings)[K]>;
     watch<K extends keyof ObservedValueOf<typeof this.values$>>(keys: K[]): Observable<Pick<ParentOutputSettings & OutputSettings, K>>;
     destroy(): void;
 }

package/dist/spine/loader/SpineItemsLoader.d.ts

@@ -1,3 +1,4 @@
+import { SpineItem } from '../..';
 import { Context } from '../../context/Context';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { DestroyableClass } from '../../utils/DestroyableClass';
@@ -12,6 +13,6 @@ export declare class SpineItemsLoader extends DestroyableClass {
     protected spineLayout: SpineLayout;
     private forcedOpenSubject;
     constructor(context: Context, spineItemsManager: SpineItemsManager, spineLocator: SpineLocator, settings: ReaderSettingsManager, spineLayout: SpineLayout);
-    forceOpen(spineItems: number[]): () => void;
+    forceOpen(spineItems: (number | SpineItem)[]): () => void;
     destroy(): void;
 }

package/dist/spineItem/renderer/DocumentRenderer.d.ts

@@ -20,6 +20,7 @@ type LayoutParams = {
     minimumWidth: number;
 };
 export declare abstract class DocumentRenderer extends DestroyableClass {
+    static readonly DOCUMENT_CONTAINER_CLASS_NAME = "prose-reader-document-container";
     private triggerSubject;
     protected context: Context;
     protected settings: ReaderSettingsManager;
@@ -30,7 +31,7 @@ export declare abstract class DocumentRenderer extends DestroyableClass {
     protected stateSubject: BehaviorSubject<"loading" | "idle" | "loaded" | "unloading">;
     protected unload$: Observable<undefined>;
     protected load$: Observable<undefined>;
-    documentContainer: HTMLElement | undefined;
+    private _documentContainer;
     constructor(params: {
         context: Context;
         settings: ReaderSettingsManager;
@@ -39,6 +40,7 @@ export declare abstract class DocumentRenderer extends DestroyableClass {
         containerElement: HTMLElement;
         resourcesHandler: ResourceHandler;
     });
+    protected setDocumentContainer(element: HTMLElement): void;
     protected attach(): void;
     protected detach(): void;
     get state$(): BehaviorSubject<"loading" | "idle" | "loaded" | "unloading">;
@@ -65,6 +67,7 @@ export declare abstract class DocumentRenderer extends DestroyableClass {
         height: number;
     } | undefined>;
     abstract getDocumentFrame(): HTMLIFrameElement | undefined;
+    get documentContainer(): HTMLElement | undefined;
     get writingMode(): `vertical-rl` | `horizontal-tb` | undefined;
     get readingDirection(): `rtl` | `ltr` | undefined;
     get renditionLayout(): "reflowable" | "pre-paginated";

package/dist/utils/rxjs.d.ts

@@ -7,3 +7,4 @@ export declare const deferNextResult: <T>(stream: Observable<T>) => () => Observ
 export declare function idle(): Observable<void>;
 export declare function deferIdle<T>(callback: () => Observable<T>): Observable<T>;
 export declare const observeMutation: (target: Node, options?: MutationObserverInit) => Observable<MutationRecord[]>;
+export declare function observeIntersection(element: HTMLElement, options?: IntersectionObserverInit): Observable<IntersectionObserverEntry[]>;

package/dist/viewport/Viewport.d.ts

@@ -3,11 +3,15 @@ import { ReactiveEntity } from '../utils/ReactiveEntity';
 import { AbsoluteViewport, RelativeViewport } from './types';
 type State = {
     element: HTMLElement;
+    pageSize: {
+        width: number;
+        height: number;
+    };
 };
 export declare class Viewport extends ReactiveEntity<State> {
     protected context: Context;
     constructor(context: Context);
-    getPageSize(): {
+    protected calculatePageSize(): {
         width: number;
         height: number;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/core",
-  "version": "1.201.0",
+  "version": "1.203.0",
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",
@@ -23,7 +23,7 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@prose-reader/shared": "^1.201.0"
+    "@prose-reader/shared": "^1.203.0"
   },
   "peerDependencies": {
     "rxjs": "*"
@@ -31,5 +31,5 @@
   "devDependencies": {
     "happy-dom": "^17.1.0"
   },
-  "gitHead": "bf5a124e26d14cd42d88e623a85f010c08cc44e8"
+  "gitHead": "3d7485595c3a36462daf1921b08454d7cba84dc5"
 }

package/dist/navigation/UserNavigator.d.ts

@@ -1,29 +0,0 @@
-import { Observable, Subject } from 'rxjs';
-import { Context } from '../context/Context';
-import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
-import { Spine } from '../spine/Spine';
-import { SpinePosition } from '../spine/types';
-import { DestroyableClass } from '../utils/DestroyableClass';
-import { Locker } from './Locker';
-import { DeprecatedViewportPosition } from './controllers/ControlledNavigationController';
-export type UserNavigationEntry = {
-    position?: DeprecatedViewportPosition | SpinePosition;
-    spineItem?: number | string;
-    url?: string | URL;
-    cfi?: string;
-    animation?: boolean | "turn" | "snap";
-    type?: "api" | "scroll";
-    direction?: "left" | "right" | "top" | "bottom";
-};
-export declare class UserNavigator extends DestroyableClass {
-    protected settings: ReaderSettingsManager;
-    protected scrollNavigatorElement$: Observable<HTMLElement | undefined>;
-    protected context: Context;
-    protected scrollHappeningFromBrowser$: Observable<unknown>;
-    protected spine: Spine;
-    protected navigationSubject: Subject<UserNavigationEntry>;
-    locker: Locker;
-    navigation$: Observable<UserNavigationEntry>;
-    constructor(settings: ReaderSettingsManager, scrollNavigatorElement$: Observable<HTMLElement | undefined>, context: Context, scrollHappeningFromBrowser$: Observable<unknown>, spine: Spine);
-    navigate(to: UserNavigationEntry): void;
-}

package/dist/enhancers/{layoutEnhancer → layout}/SettingsManager.d.ts

@@ -1,6 +1,6 @@
-import { InputSettings, OutputSettings } from './types';
 import { SettingsManagerOverload } from '../../settings/SettingsManagerOverload';
 import { CoreInputSettings, CoreOutputSettings } from '../../settings/types';
+import { InputSettings, OutputSettings } from './types';
 export declare class SettingsManager<ParentInputSettings extends CoreInputSettings, ParentOutputSettings extends CoreOutputSettings> extends SettingsManagerOverload<InputSettings, OutputSettings, ParentInputSettings, ParentOutputSettings> {
     computeOutputSettings(inputSettings: InputSettings): InputSettings;
     hasSettingsChanged(newOutputSettings: InputSettings): boolean;