@prose-reader/core 1.56.0 → 1.58.0

package/dist/viewportNavigator/manualViewportNavigator.d.ts

@@ -0,0 +1,96 @@
+import { BehaviorSubject } from 'rxjs';
+import { Context } from '../context/Context';
+import { SpineItemManager } from '../spineItemManager';
+import { createNavigationResolver, ViewportNavigationEntry } from '../spine/navigationResolver';
+import { createLocationResolver } from '../spine/locationResolver';
+
+export declare const createManualViewportNavigator: ({ navigator, spineItemManager, currentNavigationSubject$, locator, context, }: {
+    context: Context;
+    navigator: ReturnType<typeof createNavigationResolver>;
+    currentNavigationSubject$: BehaviorSubject<ViewportNavigationEntry>;
+    spineItemManager: SpineItemManager;
+    locator: ReturnType<typeof createLocationResolver>;
+}) => {
+    destroy: () => void;
+    adjustReadingOffset: () => boolean;
+    turnLeft: ({ allowSpineItemChange }?: {
+        allowSpineItemChange?: boolean;
+    }) => void;
+    turnRight: ({ allowSpineItemChange }?: {
+        allowSpineItemChange?: boolean;
+    }) => void;
+    goToCfi: (cfi: string, options?: {
+        animate: boolean;
+    }) => void;
+    goToPageOfCurrentChapter: (pageIndex: number) => void;
+    goToSpineItem: (indexOrId: number | string, options?: {
+        animate: boolean;
+    }) => void;
+    goToUrl: (url: string | URL) => void;
+    goToPage: (pageIndex: number) => void;
+    $: {
+        state$: import('rxjs').Observable<"start" | "end">;
+        navigation$: import('rxjs').Observable<{
+            animate: boolean;
+            lastUserExpectedNavigation: {
+                type: "navigate-from-anchor";
+                data: string;
+            };
+            x: number;
+            y: number;
+            spineItem?: import('../spineItem/createSpineItem').SpineItem;
+            url: URL;
+        } | {
+            animate: boolean;
+            lastUserExpectedNavigation: {
+                type: "navigate-from-previous-item";
+            };
+            x: number;
+            y: number;
+            spineItem?: import('../spineItem/createSpineItem').SpineItem;
+        } | {
+            lastUserExpectedNavigation: undefined;
+            animate: boolean;
+            x: number;
+            y: number;
+            spineItem?: import('../spineItem/createSpineItem').SpineItem;
+        } | {
+            lastUserExpectedNavigation: {
+                type: "navigate-from-next-item";
+            };
+            animate: boolean;
+            x: number;
+            y: number;
+            spineItem?: import('../spineItem/createSpineItem').SpineItem;
+        } | {
+            lastUserExpectedNavigation: {
+                type: "navigate-from-previous-item";
+            };
+            animate: boolean;
+            x: number;
+            y: number;
+            spineItem?: import('../spineItem/createSpineItem').SpineItem;
+        } | {
+            lastUserExpectedNavigation: undefined;
+            animate: boolean;
+            x: number;
+            y: number;
+            spineItem?: import('../spineItem/createSpineItem').SpineItem;
+        } | {
+            animate: boolean;
+            lastUserExpectedNavigation: {
+                type: "navigate-from-cfi";
+                data: string;
+            };
+            x: number;
+            y: number;
+            spineItem?: import('../spineItem/createSpineItem').SpineItem;
+        } | {
+            lastUserExpectedNavigation: undefined;
+            animate: boolean;
+            x: number;
+            y: number;
+            spineItem?: import('../spineItem/createSpineItem').SpineItem;
+        }>;
+    };
+};

package/dist/viewportNavigator/panViewportNavigator.d.ts

@@ -0,0 +1,55 @@
+import { BehaviorSubject, Subject } from 'rxjs';
+import { Context } from '../context/Context';
+import { SpineItemManager } from '../spineItemManager';
+import { createNavigationResolver, ViewportNavigationEntry } from '../spine/navigationResolver';
+import { createLocationResolver } from '../spine/locationResolver';
+import { ViewportPosition } from '../types';
+import { SettingsManager } from '../settings/SettingsManager';
+
+export declare const createPanViewportNavigator: ({ getCurrentViewportPosition, navigator, spineItemManager, locator, context, currentNavigationSubject$, settings, }: {
+    context: Context;
+    navigator: ReturnType<typeof createNavigationResolver>;
+    currentNavigationSubject$: BehaviorSubject<ViewportNavigationEntry>;
+    spineItemManager: SpineItemManager;
+    locator: ReturnType<typeof createLocationResolver>;
+    getCurrentViewportPosition: () => ViewportPosition;
+    settings: SettingsManager;
+}) => {
+    moveTo: ((delta: {
+        x: number;
+        y: number;
+    } | undefined, { final, start }?: {
+        start?: boolean;
+        final?: boolean;
+    }) => void) | ((delta: {
+        x: number;
+        y: number;
+    } | undefined, args_1?: {
+        start?: boolean;
+        final?: boolean;
+    } | undefined) => ReturnType<(delta: {
+        x: number;
+        y: number;
+    } | undefined, { final, start }?: {
+        start?: boolean;
+        final?: boolean;
+    }) => void>);
+    destroy: () => void;
+    adjustReadingOffset: () => boolean;
+    $: {
+        moveToSubject$: Subject<{
+            position: ViewportNavigationEntry;
+        }>;
+        state$: import('rxjs').Observable<"start" | "end">;
+        navigation$: import('rxjs').Observable<{
+            lastUserExpectedNavigation: {
+                type: "navigate-from-next-item";
+            } | {
+                type: "navigate-from-previous-item";
+            } | undefined;
+            x: number;
+            y: number;
+            spineItem?: import('../spineItem/createSpineItem').SpineItem;
+        }>;
+    };
+};

package/dist/viewportNavigator/scrollViewportNavigator.d.ts

@@ -0,0 +1,38 @@
+import { BehaviorSubject, Observable } from 'rxjs';
+import { Context } from '../context/Context';
+import { Spine } from '../spine/createSpine';
+import { createNavigationResolver, ViewportNavigationEntry } from '../spine/navigationResolver';
+import { SpineItemManager } from '../spineItemManager';
+import { ViewportPosition } from '../types';
+import { SettingsManager } from '../settings/SettingsManager';
+
+type ScaledDownPosition = ViewportPosition;
+export declare const createScrollViewportNavigator: ({ context, element$, navigator, currentNavigationSubject$, settings, spine, }: {
+    context: Context;
+    settings: SettingsManager;
+    element$: BehaviorSubject<HTMLElement>;
+    navigator: ReturnType<typeof createNavigationResolver>;
+    currentNavigationSubject$: BehaviorSubject<ViewportNavigationEntry>;
+    spine: Spine;
+    spineItemManager: SpineItemManager;
+}) => {
+    destroy: () => void;
+    adjustReadingOffset: ({ x, y }: {
+        x: number;
+        y: number;
+    }) => boolean;
+    getNavigationForPosition: (position: ScaledDownPosition) => ViewportNavigationEntry;
+    getCurrentViewportPosition: () => {
+        x: number;
+        y: number;
+    };
+    $: {
+        state$: Observable<"start" | "end">;
+        navigation$: Observable<{
+            position: ViewportNavigationEntry;
+            animate: boolean;
+            lastUserExpectedNavigation: undefined;
+        }>;
+    };
+};
+export {};

package/dist/viewportNavigator/types.d.ts

@@ -0,0 +1,34 @@
+import { SpineItem } from '../spineItem/createSpineItem';
+
+export type LastUserExpectedNavigation = undefined | {
+    type: `navigate-from-previous-item`;
+} | {
+    type: `navigate-from-next-item`;
+} | {
+    type: `navigate-from-cfi`;
+    data: string;
+} | {
+    type: `navigate-from-anchor`;
+    data: string;
+};
+export type Navigation = {
+    position: {
+        x: number;
+        y: number;
+        spineItem?: SpineItem | undefined;
+    };
+    triggeredBy: `scroll` | `manual` | `adjust`;
+    animation: false | `turn` | `snap`;
+    lastUserExpectedNavigation: LastUserExpectedNavigation;
+};
+export type AdjustedNavigation = {
+    previousNavigationPosition: {
+        x: number;
+        y: number;
+    };
+    adjustedSpinePosition: {
+        x: number;
+        y: number;
+    };
+    areDifferent: boolean;
+};

package/dist/viewportNavigator/viewportNavigator.d.ts

@@ -0,0 +1,82 @@
+import { Context } from '../context/Context';
+import { Pagination } from '../pagination/pagination';
+import { SpineItemManager } from '../spineItemManager';
+import { createLocationResolver } from '../spine/locationResolver';
+import { ViewportNavigationEntry } from '../spine/navigationResolver';
+import { BehaviorSubject, Observable } from 'rxjs';
+import { createCfiLocator } from '../spine/cfiLocator';
+import { LastUserExpectedNavigation, Navigation } from './types';
+import { Spine } from '../spine/createSpine';
+import { SettingsManager } from '../settings/SettingsManager';
+import { HookManager } from '../hooks/HookManager';
+
+export declare const createViewportNavigator: ({ spineItemManager, context, pagination, parentElement$, cfiLocator, spineLocator, hookManager, spine, settings, }: {
+    spineItemManager: SpineItemManager;
+    pagination: Pagination;
+    context: Context;
+    parentElement$: BehaviorSubject<HTMLElement | undefined>;
+    cfiLocator: ReturnType<typeof createCfiLocator>;
+    spineLocator: ReturnType<typeof createLocationResolver>;
+    hookManager: HookManager;
+    spine: Spine;
+    settings: SettingsManager;
+}) => {
+    destroy: () => void;
+    layout: () => void;
+    getCurrentNavigationPosition: () => ViewportNavigationEntry;
+    getCurrentViewportPosition: (() => {
+        x: number;
+        y: number;
+    }) | (() => ReturnType<() => {
+        x: number;
+        y: number;
+    }>);
+    turnLeft: ({ allowSpineItemChange }?: {
+        allowSpineItemChange?: boolean;
+    }) => void;
+    turnRight: ({ allowSpineItemChange }?: {
+        allowSpineItemChange?: boolean;
+    }) => void;
+    goToPage: (pageIndex: number) => void;
+    goToSpineItem: (indexOrId: number | string, options?: {
+        animate: boolean;
+    }) => void;
+    goToUrl: (url: string | URL) => void;
+    goToCfi: (cfi: string, options?: {
+        animate: boolean;
+    }) => void;
+    goToPageOfCurrentChapter: (pageIndex: number) => void;
+    moveTo: ((delta: {
+        x: number;
+        y: number;
+    } | undefined, { final, start }?: {
+        start?: boolean;
+        final?: boolean;
+    }) => void) | ((delta: {
+        x: number;
+        y: number;
+    } | undefined, args_1?: {
+        start?: boolean;
+        final?: boolean;
+    } | undefined) => ReturnType<(delta: {
+        x: number;
+        y: number;
+    } | undefined, { final, start }?: {
+        start?: boolean;
+        final?: boolean;
+    }) => void>);
+    getLastUserExpectedNavigation: () => LastUserExpectedNavigation;
+    element$: BehaviorSubject<HTMLElement>;
+    getElement: () => HTMLElement;
+    $: {
+        state$: Observable<"free" | "busy">;
+        navigation$: Observable<Navigation>;
+        navigationAdjustedAfterLayout$: Observable<{
+            previousNavigationPosition: ViewportNavigationEntry;
+            adjustedSpinePosition: ViewportNavigationEntry;
+            areDifferent: boolean;
+        }>;
+        currentNavigationPosition$: Observable<ViewportNavigationEntry>;
+    };
+};
+export type ViewportNavigator = ReturnType<typeof createViewportNavigator>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/core",
-  "version": "1.56.0",
+  "version": "1.58.0",
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",
@@ -25,7 +25,7 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@prose-reader/shared": "^1.56.0"
+    "@prose-reader/shared": "^1.58.0"
   },
   "peerDependencies": {
     "rxjs": "*"
@@ -33,5 +33,5 @@
   "devDependencies": {
     "jsdom": "^24.0.0"
   },
-  "gitHead": "9ef8778bb817cd4733b1865134eb58e621bf07ca"
+  "gitHead": "c7f234ad646ac19da49d191e4e12e6d0ca1ced55"
 }