@prose-reader/core 1.199.0 → 1.201.0

package/dist/spine/Spine.d.ts

@@ -1,15 +1,16 @@
 import { BehaviorSubject, Observable } from 'rxjs';
 import { Context } from '../context/Context';
+import { HookManager } from '../hooks/HookManager';
 import { Pagination } from '../pagination/Pagination';
-import { SpineItemsManager } from './SpineItemsManager';
-import { SpineLocator } from './locator/SpineLocator';
-import { createSpineItemLocator as createSpineItemLocationResolver } from '../spineItem/locationResolver';
 import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
-import { HookManager } from '../hooks/HookManager';
-import { SpineItemsLoader } from './loader/SpineItemsLoader';
+import { createSpineItemLocator as createSpineItemLocationResolver } from '../spineItem/locationResolver';
 import { DestroyableClass } from '../utils/DestroyableClass';
+import { Viewport } from '../viewport/Viewport';
+import { SpineItemsManager } from './SpineItemsManager';
 import { SpineItemsObserver } from './SpineItemsObserver';
 import { SpineLayout } from './SpineLayout';
+import { SpineItemsLoader } from './loader/SpineItemsLoader';
+import { SpineLocator } from './locator/SpineLocator';
 export declare class Spine extends DestroyableClass {
     protected parentElement$: Observable<HTMLElement>;
     protected context: Context;
@@ -18,13 +19,14 @@ export declare class Spine extends DestroyableClass {
     spineItemLocator: ReturnType<typeof createSpineItemLocationResolver>;
     protected settings: ReaderSettingsManager;
     protected hookManager: HookManager;
+    protected viewport: Viewport;
     protected elementSubject: BehaviorSubject<HTMLElement>;
     readonly spineItemsLoader: SpineItemsLoader;
     locator: SpineLocator;
     spineItemsObserver: SpineItemsObserver;
     spineLayout: SpineLayout;
     element$: Observable<HTMLElement>;
-    constructor(parentElement$: Observable<HTMLElement>, context: Context, pagination: Pagination, spineItemsManager: SpineItemsManager, spineItemLocator: ReturnType<typeof createSpineItemLocationResolver>, settings: ReaderSettingsManager, hookManager: HookManager);
+    constructor(parentElement$: Observable<HTMLElement>, context: Context, pagination: Pagination, spineItemsManager: SpineItemsManager, spineItemLocator: ReturnType<typeof createSpineItemLocationResolver>, settings: ReaderSettingsManager, hookManager: HookManager, viewport: Viewport);
     get element(): HTMLElement;
     layout(): void;
     destroy(): void;

package/dist/spine/SpineLayout.d.ts

@@ -3,6 +3,7 @@ import { Context } from '../context/Context';
 import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
 import { SpineItem } from '../spineItem/SpineItem';
 import { DestroyableClass } from '../utils/DestroyableClass';
+import { Viewport } from '../viewport/Viewport';
 import { SpineItemsManager } from './SpineItemsManager';
 import { SpineItemSpineLayout } from './types';
 export type PageLayoutInformation = {
@@ -17,10 +18,11 @@ export declare class SpineLayout extends DestroyableClass {
     protected spineItemsManager: SpineItemsManager;
     protected context: Context;
     protected settings: ReaderSettingsManager;
+    protected viewport: Viewport;
     protected layoutSubject: Subject<unknown>;
     protected spineItemsRelativeLayouts: SpineItemSpineLayout[];
     readonly layout$: Observable<unknown>;
-    constructor(spineItemsManager: SpineItemsManager, context: Context, settings: ReaderSettingsManager);
+    constructor(spineItemsManager: SpineItemsManager, context: Context, settings: ReaderSettingsManager, viewport: Viewport);
     layout(): void;
     getSpineItemSpineLayoutInfo(spineItemOrIndex: SpineItem | number | string | undefined): SpineItemSpineLayout;
     get numberOfPages(): number;

package/dist/spine/layout/layoutItem.d.ts

@@ -2,9 +2,10 @@ import { Observable } from 'rxjs';
 import { SpineItem } from '../..';
 import { Context } from '../../context/Context';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
+import { Viewport } from '../../viewport/Viewport';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineItemSpineLayout } from '../types';
-export declare const layoutItem: ({ horizontalOffset, verticalOffset, context, spineItemsManager, isGloballyPrePaginated, settings, index, item, }: {
+export declare const layoutItem: ({ horizontalOffset, verticalOffset, context, spineItemsManager, isGloballyPrePaginated, settings, index, item, viewport, }: {
     horizontalOffset: number;
     verticalOffset: number;
     context: Context;
@@ -13,6 +14,7 @@ export declare const layoutItem: ({ horizontalOffset, verticalOffset, context, s
     settings: ReaderSettingsManager;
     item: SpineItem;
     index: number;
+    viewport: Viewport;
 }) => Observable<{
     horizontalOffset: number;
     verticalOffset: number;

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

@@ -1,9 +1,9 @@
-import { SpineItemsManager } from '../SpineItemsManager';
-import { SpineLocator } from '../locator/SpineLocator';
 import { Context } from '../../context/Context';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { DestroyableClass } from '../../utils/DestroyableClass';
+import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
+import { SpineLocator } from '../locator/SpineLocator';
 export declare class SpineItemsLoader extends DestroyableClass {
     protected context: Context;
     protected spineItemsManager: SpineItemsManager;

package/dist/spine/locator/SpineLocator.d.ts

@@ -1,9 +1,10 @@
 import { Context } from '../../context/Context';
-import { ViewportPosition } from '../../navigation/viewport/ViewportNavigator';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { SpineItem } from '../../spineItem/SpineItem';
 import { createSpineItemLocator } from '../../spineItem/locationResolver';
 import { SpineItemPosition } from '../../spineItem/types';
+import { Viewport } from '../../viewport/Viewport';
+import { ViewportSlicePosition } from '../../viewport/types';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
 import { SpinePosition } from '../types';
@@ -11,12 +12,13 @@ import { getAbsolutePageIndexFromPageIndex } from './getAbsolutePageIndexFromPag
 import { getSpineInfoFromAbsolutePageIndex } from './getSpineInfoFromAbsolutePageIndex';
 import { getVisibleSpineItemsFromPosition } from './getVisibleSpineItemsFromPosition';
 export type SpineLocator = ReturnType<typeof createSpineLocator>;
-export declare const createSpineLocator: ({ spineItemsManager, context, spineItemLocator, settings, spineLayout, }: {
+export declare const createSpineLocator: ({ spineItemsManager, context, spineItemLocator, settings, spineLayout, viewport, }: {
     spineItemsManager: SpineItemsManager;
     context: Context;
     spineItemLocator: ReturnType<typeof createSpineItemLocator>;
     settings: ReaderSettingsManager;
     spineLayout: SpineLayout;
+    viewport: Viewport;
 }) => {
     getSpinePositionFromSpineItemPosition: ({ spineItem, spineItemPosition, }: {
         spineItemPosition: SpineItemPosition;
@@ -30,24 +32,29 @@ export declare const createSpineLocator: ({ spineItemsManager, context, spineIte
         currentAbsolutePage: number;
     } | undefined;
     getSpinePositionFromSpineItem: (spineItem: SpineItem) => SpinePosition;
-    getSpineItemPositionFromSpinePosition: ((position: ViewportPosition | SpinePosition, spineItem: SpineItem) => SpineItemPosition) | ((position: SpinePosition | ViewportPosition, spineItem: SpineItem) => SpineItemPosition);
-    getSpineItemFromPosition: (position: ViewportPosition | SpinePosition) => SpineItem | undefined;
+    getSpineItemPositionFromSpinePosition: (position: SpinePosition, spineItem: SpineItem) => SpineItemPosition;
+    getSpineItemFromPosition: (position: SpinePosition) => SpineItem | undefined;
     getSpineItemFromIframe: (iframe: Element) => SpineItem | undefined;
     getSpineItemPageIndexFromNode: (node: Node, offset: number | undefined, spineItemOrIndex: SpineItem | number) => number | undefined;
-    getVisibleSpineItemsFromPosition: (params: Omit<Parameters<typeof getVisibleSpineItemsFromPosition>[0], "context" | "spineItemsManager" | "settings" | "spineLayout">) => {
+    getVisibleSpineItemsFromPosition: (params: Omit<Parameters<typeof getVisibleSpineItemsFromPosition>[0], "spineItemsManager" | "settings" | "spineLayout" | "viewport">) => {
         beginIndex: number;
         endIndex: number;
     } | undefined;
-    getVisiblePagesFromViewportPosition: ({ position, threshold, spineItem, restrictToScreen, }: {
-        position: ViewportPosition | SpinePosition;
+    getVisiblePagesFromViewportPosition: (params: Omit<Parameters<({ position, threshold, spineItem, restrictToScreen, useAbsoluteViewport, viewport, }: {
+        position: SpinePosition;
         threshold: number;
         spineItem: SpineItem;
         restrictToScreen?: boolean;
+        useAbsoluteViewport?: boolean;
+        viewport: Viewport;
     }) => {
         beginPageIndex: number;
         endPageIndex: number;
+    } | undefined>[0], "viewport">) => {
+        beginPageIndex: number;
+        endPageIndex: number;
     } | undefined;
-    isPositionWithinSpineItem: (position: ViewportPosition | SpinePosition, spineItem: SpineItem) => boolean;
+    isPositionWithinSpineItem: (position: ViewportSlicePosition | SpinePosition, spineItem: SpineItem) => boolean;
     spineItemLocator: {
         getSpineItemPositionFromNode: (node: Node, offset: number, spineItem: SpineItem) => SpineItemPosition | undefined;
         getSpineItemPositionFromPageIndex: ({ pageIndex, spineItem, }: {

package/dist/spine/locator/getItemVisibilityForPosition.d.ts

@@ -1,7 +1,5 @@
-import { Context } from '../../context/Context';
-import { ViewportPosition } from '../../navigation/viewport/ViewportNavigator';
-import { SpinePosition } from '../types';
-export declare const getItemVisibilityForPosition: ({ itemPosition: { bottom, left, right, top, width: itemWidth, height: itemHeight, }, threshold, viewportPosition, restrictToScreen, context, }: {
+import { ViewportSlicePosition } from '../../viewport/types';
+export declare const getItemVisibilityForPosition: ({ itemPosition: { bottom, left, right, top, width: itemWidth, height: itemHeight, }, threshold, viewportPosition, restrictToScreen, }: {
     itemPosition: {
         right: number;
         left: number;
@@ -10,10 +8,9 @@ export declare const getItemVisibilityForPosition: ({ itemPosition: { bottom, le
         height: number;
         width: number;
     };
-    viewportPosition: ViewportPosition | SpinePosition;
+    viewportPosition: ViewportSlicePosition;
     threshold: number;
     restrictToScreen?: boolean;
-    context: Context;
 }) => {
     visible: boolean;
 };

package/dist/spine/locator/getSpineItemFromPosition.d.ts

@@ -1,10 +1,10 @@
-import { ViewportPosition } from '../../navigation/viewport/ViewportNavigator';
+import { DeprecatedViewportPosition } from '../../navigation/controllers/ControlledNavigationController';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
 import { SpinePosition } from '../types';
 export declare const getSpineItemFromPosition: ({ position, spineItemsManager, spineLayout, settings, }: {
-    position: ViewportPosition | SpinePosition;
+    position: DeprecatedViewportPosition | SpinePosition;
     spineItemsManager: SpineItemsManager;
     spineLayout: SpineLayout;
     settings: ReaderSettingsManager;

package/dist/spine/locator/getVisibleSpineItemsFromPosition.d.ts

@@ -1,17 +1,18 @@
-import { Context } from '../../context/Context';
-import { ViewportPosition } from '../../navigation/viewport/ViewportNavigator';
+import { DeprecatedViewportPosition } from '../../navigation/controllers/ControlledNavigationController';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
+import { Viewport } from '../../viewport/Viewport';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
 import { SpinePosition } from '../types';
-export declare const getVisibleSpineItemsFromPosition: ({ position, threshold, restrictToScreen, spineItemsManager, context, settings, spineLayout, }: {
-    position: ViewportPosition | SpinePosition;
+export declare const getVisibleSpineItemsFromPosition: ({ position, threshold, restrictToScreen, spineItemsManager, settings, spineLayout, useAbsoluteViewport, viewport, }: {
+    position: DeprecatedViewportPosition | SpinePosition;
     threshold: number;
     restrictToScreen?: boolean;
     spineItemsManager: SpineItemsManager;
-    context: Context;
     settings: ReaderSettingsManager;
     spineLayout: SpineLayout;
+    useAbsoluteViewport?: boolean;
+    viewport: Viewport;
 }) => {
     beginIndex: number;
     endIndex: number;

package/dist/spine/types.d.ts

@@ -19,17 +19,27 @@ export declare class SpineElementLayout {
     });
 }
 export declare class SpineItemSpineLayout extends SpineElementLayout {
-    readonly __symbol: symbol;
+    readonly __symbol = "SpineItemSpineLayout";
 }
 export declare class SpineItemPageSpineLayout extends SpineElementLayout {
-    readonly __symbol: symbol;
+    readonly __symbol = "SpineItemPageSpineLayout";
 }
 export declare class SpinePosition {
     readonly x: number;
     readonly y: number;
-    readonly __symbol: symbol;
+    readonly __symbol = "SpinePosition";
     constructor(position: {
         x: number;
         y: number;
     });
 }
+export declare class UnsafeSpinePosition {
+    readonly x: number;
+    readonly y: number;
+    readonly __symbol = "UnsafeSpinePosition";
+    constructor(position: {
+        x: number;
+        y: number;
+    });
+    static from(position: SpinePosition): UnsafeSpinePosition;
+}

package/dist/spineItem/SpineItemLayout.d.ts

@@ -2,6 +2,7 @@ import { Manifest } from '@prose-reader/shared';
 import { Observable, ObservedValueOf } from 'rxjs';
 import { Context } from '../context/Context';
 import { HookManager } from '../hooks/HookManager';
+import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
 import { DestroyableClass } from '../utils/DestroyableClass';
 import { DocumentRenderer } from './renderer/DocumentRenderer';
 export declare class SpineItemLayout extends DestroyableClass {
@@ -10,6 +11,7 @@ export declare class SpineItemLayout extends DestroyableClass {
     context: Context;
     hookManager: HookManager;
     renderer: DocumentRenderer;
+    settings: ReaderSettingsManager;
     private layoutTriggerSubject;
     private lastLayout;
     readonly layout$: Observable<{
@@ -25,7 +27,7 @@ export declare class SpineItemLayout extends DestroyableClass {
             height: number;
         };
     }>;
-    constructor(item: Manifest[`spineItems`][number], containerElement: HTMLElement, context: Context, hookManager: HookManager, renderer: DocumentRenderer);
+    constructor(item: Manifest[`spineItems`][number], containerElement: HTMLElement, context: Context, hookManager: HookManager, renderer: DocumentRenderer, settings: ReaderSettingsManager);
     private validateDimension;
     private applyDimsAfterLayout;
     layout: (params: ObservedValueOf<typeof this.layoutTriggerSubject>) => Observable<{

package/dist/utils/ReactiveEntity.d.ts

@@ -0,0 +1,8 @@
+import { BehaviorSubject, Observable, Subject } from 'rxjs';
+export declare class ReactiveEntity<T extends Record<string, unknown>> extends BehaviorSubject<T> {
+    protected destroy$: Subject<void>;
+    update(value: Partial<T>): void;
+    watch<K extends keyof T>(key: K): Observable<T[K]>;
+    watch<K extends keyof T>(keys: K[]): Observable<Pick<T, K>>;
+    destroy(): void;
+}

package/dist/utils/rxjs.d.ts

@@ -1,5 +1,6 @@
 import { Observable, OperatorFunction } from 'rxjs';
 export declare const mapKeysTo: <R extends Record<string, unknown>, K extends keyof R>(keys: K[]) => OperatorFunction<R, Pick<R, K>>;
+export declare const watchKeys: <R extends Record<string, unknown>, K extends keyof R>(keys: K[]) => (stream: Observable<R>) => Observable<Pick<R, K>>;
 export declare function observeResize(element: HTMLElement): Observable<ResizeObserverEntry[]>;
 export declare const waitForSwitch: <O>(waitForStream: Observable<O>) => <N>(stream: Observable<N>) => Observable<N>;
 export declare const deferNextResult: <T>(stream: Observable<T>) => () => Observable<T>;

package/dist/viewport/Viewport.d.ts

@@ -0,0 +1,17 @@
+import { Context } from '../context/Context';
+import { ReactiveEntity } from '../utils/ReactiveEntity';
+import { AbsoluteViewport, RelativeViewport } from './types';
+type State = {
+    element: HTMLElement;
+};
+export declare class Viewport extends ReactiveEntity<State> {
+    protected context: Context;
+    constructor(context: Context);
+    getPageSize(): {
+        width: number;
+        height: number;
+    };
+    get absoluteViewport(): AbsoluteViewport;
+    get relativeViewport(): RelativeViewport;
+}
+export {};

package/dist/viewport/translateSpinePositionToRelativeViewport.d.ts

@@ -0,0 +1,4 @@
+import { DeprecatedViewportPosition } from '../navigation/controllers/ControlledNavigationController';
+import { SpinePosition, UnsafeSpinePosition } from '../spine/types';
+import { AbsoluteViewport, RelativeViewport } from './types';
+export declare const translateSpinePositionToRelativeViewport: (absolutePosition: DeprecatedViewportPosition | SpinePosition, absoluteViewport: AbsoluteViewport, relativeViewport: RelativeViewport | AbsoluteViewport) => UnsafeSpinePosition;

package/dist/viewport/types.d.ts

@@ -0,0 +1,29 @@
+import { SpinePosition, UnsafeSpinePosition } from '../spine/types';
+export declare class ViewportSlicePosition extends DOMRect {
+    readonly __symbol: symbol;
+    static from(rect: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }): ViewportSlicePosition;
+    static from(position: SpinePosition | UnsafeSpinePosition, viewport: AbsoluteViewport | RelativeViewport): ViewportSlicePosition;
+}
+export declare class AbsoluteViewport {
+    width: number;
+    height: number;
+    readonly __symbol: symbol;
+    constructor({ width, height }: {
+        width: number;
+        height: number;
+    });
+}
+export declare class RelativeViewport {
+    width: number;
+    height: number;
+    readonly __symbol: symbol;
+    constructor({ width, height }: {
+        width: number;
+        height: number;
+    });
+}

package/package.json

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

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

@@ -1,30 +0,0 @@
-import { BehaviorSubject, Subject } from 'rxjs';
-export type Item = {
-    left: number;
-    top: number;
-    right: number;
-    bottom: number;
-    width: number;
-    height: number;
-};
-export declare class SpineItemsManagerMock {
-    items: Item[];
-    layout$: Subject<{
-        width: number;
-        height: number;
-    }>;
-    items$: BehaviorSubject<Item[]>;
-    load(items: {
-        left: number;
-        top: number;
-        right: number;
-        bottom: number;
-        width: number;
-        height: number;
-    }[]): void;
-    get(id: number): Item | undefined;
-    getAll(): Item[];
-    getLength(): number;
-    getSpineItemIndex(item: Item): number;
-    getSpineItemSpineLayoutInfo(spineItem: any): Item;
-}

package/dist/navigation/viewport/getScaledDownPosition.d.ts

@@ -1,9 +0,0 @@
-import { ViewportPosition } from './ViewportNavigator';
-export declare const getScaledDownPosition: ({ position: { x, y }, spineElement, element, }: {
-    position: ViewportPosition;
-    spineElement: HTMLElement;
-    element: HTMLElement;
-}) => {
-    x: number;
-    y: number;
-};