@prose-reader/core 1.239.0 → 1.241.0

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

@@ -1,16 +1,16 @@
 import { Context } from '../../context/Context';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
-import { SpineItem } from '../../spineItem/SpineItem';
 import { createSpineItemLocator } from '../../spineItem/locationResolver';
+import { SpineItem } from '../../spineItem/SpineItem';
 import { SpineItemPosition } from '../../spineItem/types';
-import { Viewport } from '../../viewport/Viewport';
 import { ViewportSlicePosition } from '../../viewport/types';
+import { Viewport } from '../../viewport/Viewport';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
-import { SpinePosition, UnsafeSpinePosition } from '../types';
+import { SpinePosition, UnboundSpinePosition } from '../types';
 import { getAbsolutePageIndexFromPageIndex } from './getAbsolutePageIndexFromPageIndex';
 import { getVisibleSpineItemsFromPosition } from './getVisibleSpineItemsFromPosition';
-import { UnsafeSpineItemPagePosition } from '../..';
+import { UnboundSpineItemPagePosition } from '../..';
 export type SpineLocator = ReturnType<typeof createSpineLocator>;
 export declare const createSpineLocator: ({ spineItemsManager, context, spineItemLocator, settings, spineLayout, viewport, }: {
     spineItemsManager: SpineItemsManager;
@@ -25,18 +25,18 @@ export declare const createSpineLocator: ({ spineItemsManager, context, spineIte
         spineItem: SpineItem;
     }) => SpinePosition;
     _getAbsolutePageIndexFromPageIndex: (params: Omit<Parameters<typeof getAbsolutePageIndexFromPageIndex>[0], "context" | "settings" | "spineLayout" | "spineItemsManager">) => number | undefined;
-    getSpineItemPagePositionFromSpinePosition: (spinePosition: UnsafeSpinePosition | SpinePosition) => {
+    getSpineItemPagePositionFromSpinePosition: (spinePosition: UnboundSpinePosition | SpinePosition) => {
         spineItem: SpineItem;
         spineItemPageIndex: number;
-        spineItemPagePosition: UnsafeSpineItemPagePosition;
+        spineItemPagePosition: UnboundSpineItemPagePosition;
         pageSize: {
             width: number;
             height: number;
         };
     } | undefined;
     getSpinePositionFromSpineItem: (spineItem: SpineItem) => SpinePosition;
-    getSpineItemPositionFromSpinePosition: (position: SpinePosition | UnsafeSpinePosition, spineItem: SpineItem) => SpineItemPosition;
-    getSpineItemFromPosition: (position: SpinePosition) => SpineItem | undefined;
+    getSpineItemPositionFromSpinePosition: (position: SpinePosition | UnboundSpinePosition, spineItem: SpineItem) => SpineItemPosition;
+    getSpineItemFromPosition: (position: SpinePosition | UnboundSpinePosition) => 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], "spineItemsManager" | "settings" | "spineLayout" | "viewport">) => {
@@ -44,7 +44,7 @@ export declare const createSpineLocator: ({ spineItemsManager, context, spineIte
         endIndex: number;
     } | undefined;
     getVisiblePagesFromViewportPosition: (params: Omit<Parameters<({ position, threshold, spineItem, restrictToScreen, useAbsoluteViewport, viewport, }: {
-        position: SpinePosition;
+        position: SpinePosition | UnboundSpinePosition;
         threshold: {
             type: "percentage";
             value: number;
@@ -63,7 +63,7 @@ export declare const createSpineLocator: ({ spineItemsManager, context, spineIte
         beginPageIndex: number;
         endPageIndex: number;
     } | undefined;
-    isPositionWithinSpineItem: (position: ViewportSlicePosition | SpinePosition, spineItem: SpineItem) => boolean;
+    isPositionWithinSpineItem: (position: ViewportSlicePosition | SpinePosition | UnboundSpinePosition, spineItem: SpineItem) => boolean;
     spineItemLocator: {
         getSpineItemPositionFromNode: (node: Node, offset: number, spineItem: SpineItem) => SpineItemPosition | undefined;
         getSpineItemPositionFromPageIndex: ({ pageIndex, spineItem, }: {
@@ -78,7 +78,7 @@ export declare const createSpineLocator: ({ spineItemsManager, context, spineIte
         }) => number;
         getSpineItemPageIndexFromNode: (node: Node, offset: number, spineItem: SpineItem) => number | undefined;
         getSpineItemClosestPositionFromUnsafePosition: (unsafePosition: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
-        getSpineItemPagePositionFromSpineItemPosition: (position: SpineItemPosition, pageIndex: number, spineItem: SpineItem) => UnsafeSpineItemPagePosition;
+        getSpineItemPagePositionFromSpineItemPosition: (position: SpineItemPosition, pageIndex: number, spineItem: SpineItem) => UnboundSpineItemPagePosition;
     };
     getSafeSpineItemPositionFromUnsafeSpineItemPosition: (unsafePosition: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
 };

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

@@ -1,10 +1,9 @@
-import { DeprecatedViewportPosition } from '../../navigation/types';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
-import { SpinePosition, UnsafeSpinePosition } from '../types';
+import { SpinePosition, UnboundSpinePosition } from '../types';
 import { SpineItem } from '../..';
 export declare const getSpineItemFromPosition: ({ position, spineItemsManager, spineLayout, }: {
-    position: DeprecatedViewportPosition | SpinePosition | UnsafeSpinePosition;
+    position: SpinePosition | SpinePosition | UnboundSpinePosition;
     spineItemsManager: SpineItemsManager;
     spineLayout: SpineLayout;
 }) => SpineItem | undefined;

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

@@ -1,11 +1,10 @@
-import { DeprecatedViewportPosition } from '../../navigation/types';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { Viewport } from '../../viewport/Viewport';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
-import { SpinePosition } from '../types';
+import { SpinePosition, UnboundSpinePosition } from '../types';
 export declare const getVisibleSpineItemsFromPosition: ({ position, threshold, restrictToScreen, spineItemsManager, spineLayout, useAbsoluteViewport, viewport, }: {
-    position: DeprecatedViewportPosition | SpinePosition;
+    position: SpinePosition | UnboundSpinePosition;
     threshold: {
         type: "percentage";
         value: number;

package/dist/spine/types.d.ts

@@ -15,9 +15,9 @@ export declare class AbstractSpinePosition {
 }
 export declare class SpinePosition extends AbstractSpinePosition {
     readonly __symbol = "SpinePosition";
-    static from(position: UnsafeSpinePosition | SpinePosition): SpinePosition;
+    static from(position: UnboundSpinePosition | SpinePosition): SpinePosition;
 }
-export declare class UnsafeSpinePosition extends AbstractSpinePosition {
+export declare class UnboundSpinePosition extends AbstractSpinePosition {
     readonly __symbol = "UnsafeSpinePosition";
-    static from(position: SpinePosition): UnsafeSpinePosition;
+    static from(position: SpinePosition): UnboundSpinePosition;
 }

package/dist/spineItem/SpineItem.d.ts

@@ -4,6 +4,7 @@ import { Context } from '../context/Context';
 import { HookManager } from '../hooks/HookManager';
 import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
 import { ReactiveEntity } from '../utils/ReactiveEntity';
+import { Viewport } from '../viewport/Viewport';
 import { DocumentRenderer } from './renderer/DocumentRenderer';
 import { ResourceHandler } from './resources/ResourceHandler';
 import { SpineItemLayout } from './SpineItemLayout';
@@ -20,12 +21,13 @@ export declare class SpineItem extends ReactiveEntity<SpineItemState> {
     settings: ReaderSettingsManager;
     hookManager: HookManager;
     index: number;
+    viewport: Viewport;
     readonly containerElement: HTMLElement;
     readonly needsLayout$: Observable<unknown>;
     readonly renderer: DocumentRenderer;
     readonly resourcesHandler: ResourceHandler;
     readonly layout: SpineItemLayout;
-    constructor(item: Manifest[`spineItems`][number], parentElement: HTMLElement, context: Context, settings: ReaderSettingsManager, hookManager: HookManager, index: number);
+    constructor(item: Manifest[`spineItems`][number], parentElement: HTMLElement, context: Context, settings: ReaderSettingsManager, hookManager: HookManager, index: number, viewport: Viewport);
     load: () => void;
     unload: () => void;
     markDirty: () => void;

package/dist/spineItem/SpineItemLayout.d.ts

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

package/dist/spineItem/layout/getSpineItemPositionFromPageIndex.d.ts

@@ -1,6 +1,7 @@
 import { Context } from '../../context/Context';
+import { Viewport } from '../../viewport/Viewport';
 import { SpineItemPosition } from '../types';
-export declare const getSpineItemPositionFromPageIndex: ({ pageIndex, itemLayout, context, isUsingVerticalWriting, }: {
+export declare const getSpineItemPositionFromPageIndex: ({ pageIndex, itemLayout, context, isUsingVerticalWriting, viewport, }: {
     pageIndex: number;
     itemLayout: {
         width: number;
@@ -8,4 +9,5 @@ export declare const getSpineItemPositionFromPageIndex: ({ pageIndex, itemLayout
     };
     context: Context;
     isUsingVerticalWriting: boolean;
+    viewport: Viewport;
 }) => SpineItemPosition;

package/dist/spineItem/locationResolver.d.ts

@@ -1,11 +1,13 @@
 import { Context } from '../context/Context';
 import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
+import { Viewport } from '../viewport/Viewport';
 import { SpineItem } from './SpineItem';
-import { SpineItemPosition, UnsafeSpineItemPagePosition } from './types';
+import { SpineItemPosition, UnboundSpineItemPagePosition } from './types';
 export type SpineItemLocator = ReturnType<typeof createSpineItemLocator>;
-export declare const createSpineItemLocator: ({ context, settings, }: {
+export declare const createSpineItemLocator: ({ context, settings, viewport, }: {
     context: Context;
     settings: ReaderSettingsManager;
+    viewport: Viewport;
 }) => {
     getSpineItemPositionFromNode: (node: Node, offset: number, spineItem: SpineItem) => SpineItemPosition | undefined;
     getSpineItemPositionFromPageIndex: ({ pageIndex, spineItem, }: {
@@ -20,5 +22,5 @@ export declare const createSpineItemLocator: ({ context, settings, }: {
     }) => number;
     getSpineItemPageIndexFromNode: (node: Node, offset: number, spineItem: SpineItem) => number | undefined;
     getSpineItemClosestPositionFromUnsafePosition: (unsafePosition: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
-    getSpineItemPagePositionFromSpineItemPosition: (position: SpineItemPosition, pageIndex: number, spineItem: SpineItem) => UnsafeSpineItemPagePosition;
+    getSpineItemPagePositionFromSpineItemPosition: (position: SpineItemPosition, pageIndex: number, spineItem: SpineItem) => UnboundSpineItemPagePosition;
 };

package/dist/spineItem/navigationResolver.d.ts

@@ -1,11 +1,13 @@
 import { Context } from '../context/Context';
 import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
+import { Viewport } from '../viewport/Viewport';
 import { SpineItem } from './SpineItem';
 import { SpineItemPosition } from './types';
 export type SpineItemNavigationResolver = ReturnType<typeof createNavigationResolver>;
-export declare const createNavigationResolver: ({ context, settings, }: {
+export declare const createNavigationResolver: ({ context, settings, viewport, }: {
     context: Context;
     settings: ReaderSettingsManager;
+    viewport: Viewport;
 }) => {
     getNavigationForLastPage: (spineItem: SpineItem) => SpineItemPosition;
     getNavigationForPosition: (spineItem: SpineItem, position: SpineItemPosition) => SpineItemPosition;

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

@@ -4,6 +4,7 @@ import { Context } from '../../context/Context';
 import { HookManager } from '../../hooks/HookManager';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { DestroyableClass } from '../../utils/DestroyableClass';
+import { Viewport } from '../../viewport/Viewport';
 import { ResourceHandler } from '../resources/ResourceHandler';
 export type DocumentRendererParams = {
     context: Context;
@@ -12,6 +13,7 @@ export type DocumentRendererParams = {
     item: Manifest[`spineItems`][number];
     containerElement: HTMLElement;
     resourcesHandler: ResourceHandler;
+    viewport: Viewport;
 };
 type LayoutParams = {
     minPageSpread: number;
@@ -22,6 +24,7 @@ type LayoutParams = {
 export declare abstract class DocumentRenderer extends DestroyableClass {
     static readonly DOCUMENT_CONTAINER_CLASS_NAME = "prose-reader-document-container";
     private triggerSubject;
+    protected viewport: Viewport;
     protected context: Context;
     protected settings: ReaderSettingsManager;
     protected hookManager: HookManager;
@@ -40,6 +43,7 @@ export declare abstract class DocumentRenderer extends DestroyableClass {
         item: Manifest[`spineItems`][number];
         containerElement: HTMLElement;
         resourcesHandler: ResourceHandler;
+        viewport: Viewport;
     });
     protected setDocumentContainer(element: HTMLElement): void;
     protected attach(): void;

package/dist/spineItem/types.d.ts

@@ -27,7 +27,7 @@ export declare class SpineItemPosition {
         y: number;
     });
 }
-export declare class UnsafeSpineItemPagePosition {
+export declare class UnboundSpineItemPagePosition {
     readonly x: number;
     readonly y: number;
     readonly __symbol: symbol;

package/dist/types/index.d.ts

@@ -0,0 +1,10 @@
+import { Manifest } from '@prose-reader/shared';
+export type { Manifest };
+export declare abstract class AbstractPosition {
+    readonly x: number;
+    readonly y: number;
+    constructor(position: {
+        x: number;
+        y: number;
+    });
+}

package/dist/utils/ReactiveEntity.d.ts

@@ -1,12 +1,13 @@
 import { BehaviorSubject, Observable, Subject } from 'rxjs';
 export declare class ReactiveEntity<T extends Record<string, unknown>> extends Observable<T> {
     protected stateSubject: BehaviorSubject<T>;
-    protected destroy$: Subject<void>;
+    protected _destroy$: Subject<void>;
     constructor(initialState: T);
     protected next(value: T): void;
     protected mergeCompare(pagination: Partial<T>): void;
     watch<K extends keyof T>(key: K): Observable<T[K]>;
     watch<K extends keyof T>(keys: K[]): Observable<Pick<T, K>>;
     get value(): T;
+    destroy$: Observable<void>;
     destroy(): void;
 }

package/dist/viewport/Viewport.d.ts

@@ -1,4 +1,5 @@
 import { Context } from '../context/Context';
+import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
 import { ReactiveEntity } from '../utils/ReactiveEntity';
 import { AbsoluteViewport, RelativeViewport } from './types';
 type State = {
@@ -7,15 +8,26 @@ type State = {
         width: number;
         height: number;
     };
+    width: number;
+    height: number;
 };
 export declare class Viewport extends ReactiveEntity<State> {
     protected context: Context;
-    constructor(context: Context);
-    protected calculatePageSize(): {
+    protected settingsManager: ReaderSettingsManager;
+    constructor(context: Context, settingsManager: ReaderSettingsManager);
+    protected calculatePageSize(layout: {
+        width: number;
+        height: number;
+    }): {
         width: number;
         height: number;
     };
+    layout(): void;
     get absoluteViewport(): AbsoluteViewport;
+    get pageSize(): {
+        width: number;
+        height: number;
+    };
     get scaleFactor(): number;
     get relativeViewport(): RelativeViewport;
 }

package/dist/viewport/translateSpinePositionToRelativeViewport.d.ts

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

package/dist/viewport/types.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/core",
-  "version": "1.239.0",
+  "version": "1.241.0",
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",
@@ -23,8 +23,8 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@prose-reader/cfi": "^1.239.0",
-    "@prose-reader/shared": "^1.239.0"
+    "@prose-reader/cfi": "^1.241.0",
+    "@prose-reader/shared": "^1.241.0"
   },
   "peerDependencies": {
     "rxjs": "*"
@@ -39,5 +39,5 @@
       }
     }
   },
-  "gitHead": "1014fc88c110c343adcf7328e5c6d20b8f130e94"
+  "gitHead": "d3dd23d2c43b059c2a254e396800739160083720"
 }

package/dist/context/isUsingSpreadMode.d.ts

@@ -1,9 +0,0 @@
-import { Manifest } from '@prose-reader/shared';
-export declare const isUsingSpreadMode: ({ manifest, visibleAreaRect, forceSinglePageMode, }: {
-    manifest?: Manifest;
-    visibleAreaRect: {
-        height: number;
-        width: number;
-    };
-    forceSinglePageMode?: boolean;
-}) => boolean;

package/dist/navigation/UserScrollNavigation.d.ts

@@ -1,19 +0,0 @@
-import { Subject, Observable } from 'rxjs';
-import { Context } from '../context/Context';
-import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
-import { Spine } from '../spine/Spine';
-import { DestroyableClass } from '../utils/DestroyableClass';
-import { Viewport } from '../viewport/Viewport';
-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$: Observable<UserNavigationEntry>;
-    constructor(settings: ReaderSettingsManager, context: Context, spine: Spine, scrollNavigationController: ScrollNavigationController, locker: Locker, viewport: Viewport);
-}

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

@@ -1,13 +0,0 @@
-import { Context } from '../../context/Context';
-import { SpinePosition } from '../types';
-export declare const getSpinePositionFromSpineItemPageIndex: ({ pageIndex, context, isUsingVerticalWriting, itemLayout, }: {
-    pageIndex: number;
-    isUsingVerticalWriting: boolean;
-    context: Context;
-    itemLayout: {
-        left: number;
-        top: number;
-        width: number;
-        height: number;
-    };
-}) => SpinePosition;

package/dist/utils/layout.d.ts

@@ -1,7 +0,0 @@
-export declare const getNewScaledOffset: ({ newScale, oldScale, screenSize, scrollOffset, }: {
-    screenSize: number;
-    pageSize: number;
-    scrollOffset: number;
-    newScale: number;
-    oldScale: number;
-}) => number;

package/dist/utils/layout.test.d.ts

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