@prose-reader/core 0.0.43 → 0.0.44

package/dist/spine/createSpine.d.ts

@@ -1,15 +1,29 @@
-import { BehaviorSubject } from "rxjs";
+import { BehaviorSubject, Observable } from "rxjs";
 import { Context } from "../context";
 import { Pagination } from "../pagination";
 import { SpineItemManager } from "../spineItemManager";
+import { createLocationResolver as createSpineLocationResolver } from "./locationResolver";
+import { createLocationResolver as createSpineItemLocationResolver } from "../spineItem/locationResolver";
+import { createCfiLocator } from "./cfiLocator";
 import { Hook } from "../types/Hook";
 import { Spine } from "../types/Spine";
-export declare const createSpine: ({ parentElement, context, pagination, iframeEventBridgeElement, spineItemManager, hooks$ }: {
-    parentElement: HTMLElement;
+import { AdjustedNavigation, Navigation } from "../viewportNavigator/types";
+export declare const createSpine: ({ ownerDocument, context, pagination, iframeEventBridgeElement, spineItemManager, hooks$, spineItemLocator, spineLocator, cfiLocator, navigation$, navigationAdjusted$, currentNavigationPosition$, viewportState$ }: {
+    ownerDocument: Document;
     iframeEventBridgeElement: HTMLElement;
     context: Context;
     pagination: Pagination;
     spineItemManager: SpineItemManager;
     hooks$: BehaviorSubject<Hook[]>;
+    spineItemLocator: ReturnType<typeof createSpineItemLocationResolver>;
+    spineLocator: ReturnType<typeof createSpineLocationResolver>;
+    cfiLocator: ReturnType<typeof createCfiLocator>;
+    navigation$: Observable<Navigation>;
+    navigationAdjusted$: Observable<AdjustedNavigation>;
+    currentNavigationPosition$: Observable<{
+        x: number;
+        y: number;
+    }>;
+    viewportState$: Observable<`free` | `busy`>;
 }) => Spine;
 export { Spine };

package/dist/types/Hook.d.ts

@@ -37,6 +37,9 @@ export declare type Hook = {
 } | {
     name: `spine.onBeforeContainerCreated`;
     fn: (payload: HTMLElement) => HTMLElement;
+} | {
+    name: `viewportNavigator.onBeforeContainerCreated`;
+    fn: (payload: HTMLElement) => HTMLElement;
 } | {
     name: `onViewportOffsetAdjust`;
     fn: () => void;

package/dist/types/Reader.d.ts

@@ -6,7 +6,9 @@ import { Manifest } from "@prose-reader/shared";
 import { Pagination } from "../pagination";
 import { Observable } from "rxjs";
 import { createSelection } from "../selection";
+import { createViewportNavigator } from "../viewportNavigator/viewportNavigator";
 declare type ContextSettings = Parameters<Context[`setSettings`]>[0];
+declare type ViewportNavigator = ReturnType<typeof createViewportNavigator>;
 export declare type LoadOptions = {
     cfi?: string;
     fetchResource?: ((item: Manifest[`spineItems`][number]) => Promise<Response>);
@@ -16,17 +18,18 @@ export declare type Reader = {
     context: Context;
     registerHook: RegisterHook;
     spine: Spine;
+    viewportNavigator: ViewportNavigator;
     manipulateSpineItems: Spine[`manipulateSpineItems`];
     manipulateSpineItem: Spine[`manipulateSpineItem`];
     manipulateContainer: (cb: (container: HTMLElement) => boolean) => void;
-    moveTo: Spine[`viewportNavigator`][`moveTo`];
-    turnLeft: Spine[`viewportNavigator`][`turnLeft`];
-    turnRight: Spine[`viewportNavigator`][`turnRight`];
-    goToPageOfCurrentChapter: Spine[`viewportNavigator`][`goToPageOfCurrentChapter`];
-    goToPage: Spine[`viewportNavigator`][`goToPage`];
-    goToUrl: Spine[`viewportNavigator`][`goToUrl`];
-    goToCfi: Spine[`viewportNavigator`][`goToCfi`];
-    goToSpineItem: Spine[`viewportNavigator`][`goToSpineItem`];
+    moveTo: ViewportNavigator[`moveTo`];
+    turnLeft: ViewportNavigator[`turnLeft`];
+    turnRight: ViewportNavigator[`turnRight`];
+    goToPageOfCurrentChapter: ViewportNavigator[`goToPageOfCurrentChapter`];
+    goToPage: ViewportNavigator[`goToPage`];
+    goToUrl: ViewportNavigator[`goToUrl`];
+    goToCfi: ViewportNavigator[`goToCfi`];
+    goToSpineItem: ViewportNavigator[`goToSpineItem`];
     getFocusedSpineItemIndex: SpineItemManager[`getFocusedSpineItemIndex`];
     getSpineItem: SpineItemManager[`get`];
     getSpineItems: SpineItemManager[`getAll`];
@@ -38,8 +41,8 @@ export declare type Reader = {
     resolveCfi: Spine[`cfiLocator`][`resolveCfi`];
     generateCfi: Spine[`cfiLocator`][`generateFromRange`];
     locator: Spine[`locator`];
-    getCurrentNavigationPosition: Spine[`viewportNavigator`][`getCurrentNavigationPosition`];
-    getCurrentViewportPosition: Spine[`viewportNavigator`][`getCurrentViewportPosition`];
+    getCurrentNavigationPosition: ViewportNavigator[`getCurrentNavigationPosition`];
+    getCurrentViewportPosition: ViewportNavigator[`getCurrentViewportPosition`];
     layout: () => void;
     load: (manifest: Manifest, loadOptions?: LoadOptions) => void;
     destroy: () => void;
@@ -55,7 +58,7 @@ export declare type Reader = {
         }>;
         ready$: Observable<void>;
         selection$: Observable<ReturnType<typeof createSelection> | null>;
-        viewportState$: Spine[`$`][`viewportState$`];
+        viewportState$: ViewportNavigator[`$`][`state$`];
         layout$: Spine[`$`][`layout$`];
         itemsCreated$: Spine[`$`][`itemsCreated$`];
         itemsBeforeDestroy$: Spine[`$`][`itemsBeforeDestroy$`];

package/dist/types/Spine.d.ts

@@ -1,15 +1,14 @@
 import { Observable } from "rxjs";
 import { Manifest } from "@prose-reader/shared";
-import { createViewportNavigator } from "../spine/viewportNavigator/viewportNavigator";
 import { SpineItem } from "../spineItem/createSpineItem";
 import { createSelection } from "../selection";
 import { createCfiLocator } from "../spine/cfiLocator";
 import { createLocationResolver } from "../spine/locationResolver";
 import { createLocationResolver as createSpineItemLocator } from "../spineItem/locationResolver";
+import { ViewportNavigationEntry } from "../spine/navigationResolver";
 declare type RequireLayout = boolean;
 declare type ManipulableSpineItemCallback = Parameters<SpineItem[`manipulateSpineItem`]>[0];
 declare type ManipulableSpineItemCallbackPayload = Parameters<ManipulableSpineItemCallback>[0];
-declare type ViewportNavigator = ReturnType<typeof createViewportNavigator>;
 declare type CfiLocator = ReturnType<typeof createCfiLocator>;
 declare type SpineItemLocator = ReturnType<typeof createSpineItemLocator>;
 declare type Locator = ReturnType<typeof createLocationResolver>;
@@ -18,7 +17,6 @@ declare type Event = {
     data: ReturnType<typeof createSelection> | null;
 };
 export declare type Spine = {
-    viewportNavigator: ViewportNavigator;
     element: HTMLElement;
     locator: Locator;
     spineItemLocator: SpineItemLocator;
@@ -32,9 +30,9 @@ export declare type Spine = {
     destroy: () => void;
     isSelecting: () => boolean | undefined;
     getSelection: () => Selection | undefined;
+    adjustPagination: (position: ViewportNavigationEntry) => Observable<`free` | `busy`>;
     $: {
         $: Observable<Event>;
-        viewportState$: Observable<`free` | `busy`>;
         layout$: Observable<boolean>;
         itemsCreated$: Observable<{
             item: Manifest[`spineItems`][number];

package/dist/utils/layout.d.ts

@@ -0,0 +1,7 @@
+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

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

package/dist/{spine/viewportNavigator → viewportNavigator}/manualViewportNavigator.d.ts

@@ -1,8 +1,8 @@
 import { BehaviorSubject } from "rxjs";
-import { Context } from "../../context";
-import { SpineItemManager } from "../../spineItemManager";
-import { createNavigationResolver, ViewportNavigationEntry } from "../navigationResolver";
-import { createLocationResolver } from "../locationResolver";
+import { Context } from "../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;
     element: HTMLElement;
@@ -41,7 +41,7 @@ export declare const createManualViewportNavigator: ({ navigator, spineItemManag
             };
             x: number;
             y: number;
-            spineItem?: import("../../spineItem/createSpineItem").SpineItem | undefined;
+            spineItem?: import("../spineItem/createSpineItem").SpineItem | undefined;
             url: URL;
         } | {
             animate: boolean;
@@ -50,13 +50,13 @@ export declare const createManualViewportNavigator: ({ navigator, spineItemManag
             };
             x: number;
             y: number;
-            spineItem?: import("../../spineItem/createSpineItem").SpineItem | undefined;
+            spineItem?: import("../spineItem/createSpineItem").SpineItem | undefined;
         } | {
             lastUserExpectedNavigation: undefined;
             animate: boolean;
             x: number;
             y: number;
-            spineItem?: import("../../spineItem/createSpineItem").SpineItem | undefined;
+            spineItem?: import("../spineItem/createSpineItem").SpineItem | undefined;
         } | {
             lastUserExpectedNavigation: {
                 type: "navigate-from-next-item";
@@ -64,7 +64,7 @@ export declare const createManualViewportNavigator: ({ navigator, spineItemManag
             animate: boolean;
             x: number;
             y: number;
-            spineItem?: import("../../spineItem/createSpineItem").SpineItem | undefined;
+            spineItem?: import("../spineItem/createSpineItem").SpineItem | undefined;
         } | {
             lastUserExpectedNavigation: {
                 type: "navigate-from-previous-item";
@@ -72,13 +72,13 @@ export declare const createManualViewportNavigator: ({ navigator, spineItemManag
             animate: boolean;
             x: number;
             y: number;
-            spineItem?: import("../../spineItem/createSpineItem").SpineItem | undefined;
+            spineItem?: import("../spineItem/createSpineItem").SpineItem | undefined;
         } | {
             lastUserExpectedNavigation: undefined;
             animate: boolean;
             x: number;
             y: number;
-            spineItem?: import("../../spineItem/createSpineItem").SpineItem | undefined;
+            spineItem?: import("../spineItem/createSpineItem").SpineItem | undefined;
         } | {
             animate: boolean;
             lastUserExpectedNavigation: {
@@ -87,13 +87,13 @@ export declare const createManualViewportNavigator: ({ navigator, spineItemManag
             };
             x: number;
             y: number;
-            spineItem?: import("../../spineItem/createSpineItem").SpineItem | undefined;
+            spineItem?: import("../spineItem/createSpineItem").SpineItem | undefined;
         } | {
             lastUserExpectedNavigation: undefined;
             animate: boolean;
             x: number;
             y: number;
-            spineItem?: import("../../spineItem/createSpineItem").SpineItem | undefined;
+            spineItem?: import("../spineItem/createSpineItem").SpineItem | undefined;
         }>;
     };
 };

package/dist/{spine/viewportNavigator → viewportNavigator}/panViewportNavigator.d.ts

@@ -1,9 +1,9 @@
 import { BehaviorSubject, Subject } from "rxjs";
-import { Context } from "../../context";
-import { SpineItemManager } from "../../spineItemManager";
-import { createNavigationResolver, ViewportNavigationEntry } from "../navigationResolver";
-import { createLocationResolver } from "../locationResolver";
-import { ViewportPosition } from "../../types";
+import { Context } from "../context";
+import { SpineItemManager } from "../spineItemManager";
+import { createNavigationResolver, ViewportNavigationEntry } from "../spine/navigationResolver";
+import { createLocationResolver } from "../spine/locationResolver";
+import { ViewportPosition } from "../types";
 export declare const createPanViewportNavigator: ({ getCurrentViewportPosition, navigator, spineItemManager, locator, context, currentNavigationSubject$ }: {
     context: Context;
     element: HTMLElement;
@@ -44,7 +44,7 @@ export declare const createPanViewportNavigator: ({ getCurrentViewportPosition,
             } | undefined;
             x: number;
             y: number;
-            spineItem?: import("../../spineItem/createSpineItem").SpineItem | undefined;
+            spineItem?: import("../spineItem/createSpineItem").SpineItem | undefined;
         }>;
     };
 };

package/dist/{spine/viewportNavigator → viewportNavigator}/scrollViewportNavigator.d.ts

@@ -1,19 +1,30 @@
 import { BehaviorSubject, Observable } from "rxjs";
-import { Context } from "../../context";
-import { createNavigationResolver, ViewportNavigationEntry } from "../navigationResolver";
-export declare const createScrollViewportNavigator: ({ context, element, navigator, currentNavigationSubject$ }: {
+import { Context } from "../context";
+import { Spine } from "../spine/createSpine";
+import { createNavigationResolver, ViewportNavigationEntry } from "../spine/navigationResolver";
+import { SpineItemManager } from "../spineItemManager";
+import { ViewportPosition } from "../types";
+declare type ScaledDownPosition = ViewportPosition;
+export declare const createScrollViewportNavigator: ({ context, element, navigator, currentNavigationSubject$, spine }: {
     context: Context;
     element: 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<string>;
+        state$: Observable<"start" | "end">;
         navigation$: Observable<{
             position: ViewportNavigationEntry;
             animate: boolean;
@@ -21,3 +32,4 @@ export declare const createScrollViewportNavigator: ({ context, element, navigat
         }>;
     };
 };
+export {};

package/dist/viewportNavigator/types.d.ts

@@ -0,0 +1,33 @@
+import { SpineItem } from "../spineItem/createSpineItem";
+export declare 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 declare type Navigation = {
+    position: {
+        x: number;
+        y: number;
+        spineItem?: SpineItem | undefined;
+    };
+    triggeredBy: `scroll` | `manual` | `adjust`;
+    animation: false | `turn` | `snap`;
+    lastUserExpectedNavigation: LastUserExpectedNavigation;
+};
+export declare type AdjustedNavigation = {
+    previousNavigationPosition: {
+        x: number;
+        y: number;
+    };
+    adjustedSpinePosition: {
+        x: number;
+        y: number;
+    };
+    areDifferent: boolean;
+};

package/dist/{spine/viewportNavigator → viewportNavigator}/viewportNavigator.d.ts

@@ -1,24 +1,29 @@
-import { Context } from "../../context";
-import { Pagination } from "../../pagination";
-import { SpineItemManager } from "../../spineItemManager";
-import { createLocationResolver } from "../locationResolver";
-import { ViewportNavigationEntry } from "../navigationResolver";
-import { Observable } from "rxjs";
-import { SpineItem } from "../../spineItem/createSpineItem";
-import { createCfiLocator } from "../cfiLocator";
-import { Hook } from "../../types/Hook";
-export declare const createViewportNavigator: ({ spineItemManager, context, pagination, element, cfiLocator, locator, hooks$ }: {
+import { Context } from "../context";
+import { Pagination } from "../pagination";
+import { SpineItemManager } from "../spineItemManager";
+import { createLocationResolver } from "../spine/locationResolver";
+import { BehaviorSubject, Observable } from "rxjs";
+import { SpineItem } from "../spineItem/createSpineItem";
+import { createCfiLocator } from "../spine/cfiLocator";
+import { Hook } from "../types/Hook";
+import { LastUserExpectedNavigation, Navigation } from "./types";
+import { Spine } from "../spine/createSpine";
+export declare const createViewportNavigator: ({ spineItemManager, context, pagination, parentElement, cfiLocator, spineLocator, hooks$, spine }: {
     spineItemManager: SpineItemManager;
     pagination: Pagination;
     context: Context;
-    element: HTMLElement;
+    parentElement: HTMLElement;
     cfiLocator: ReturnType<typeof createCfiLocator>;
-    locator: ReturnType<typeof createLocationResolver>;
-    hooks$: Observable<Hook[]>;
+    spineLocator: ReturnType<typeof createLocationResolver>;
+    hooks$: BehaviorSubject<Hook[]>;
+    spine: Spine;
 }) => {
     destroy: () => void;
     layout: () => void;
-    getCurrentNavigationPosition: () => ViewportNavigationEntry;
+    getCurrentNavigationPosition: () => {
+        x: number;
+        y: number;
+    };
     getCurrentViewportPosition: (() => {
         x: number;
         y: number;
@@ -42,8 +47,14 @@ export declare const createViewportNavigator: ({ spineItemManager, context, pagi
     }) => void;
     goToPageOfCurrentChapter: (pageIndex: number) => void;
     adjustNavigation: (spineItem: SpineItem) => Observable<{
-        previousNavigationPosition: ViewportNavigationEntry;
-        adjustedSpinePosition: ViewportNavigationEntry;
+        previousNavigationPosition: {
+            x: number;
+            y: number;
+        };
+        adjustedSpinePosition: {
+            x: number;
+            y: number;
+        };
         areDifferent: boolean;
     }>;
     moveTo: ((delta: {
@@ -59,27 +70,25 @@ export declare const createViewportNavigator: ({ spineItemManager, context, pagi
         start?: boolean | undefined;
         final?: boolean | undefined;
     } | undefined) => void);
-    getLastUserExpectedNavigation: () => {
-        type: `navigate-from-previous-item`;
-    } | {
-        type: `navigate-from-next-item`;
-    } | {
-        type: `navigate-from-cfi`;
-        data: string;
-    } | {
-        type: `navigate-from-anchor`;
-        data: string;
-    } | undefined;
+    getLastUserExpectedNavigation: () => LastUserExpectedNavigation;
+    element: HTMLElement;
     $: {
         state$: Observable<"free" | "busy">;
-        navigation$: Observable<{
-            position: {
+        navigation$: Observable<Navigation>;
+        navigationAdjustedAfterLayout$: Observable<{
+            previousNavigationPosition: {
                 x: number;
                 y: number;
-                spineItem?: SpineItem;
             };
-            triggeredBy: `manual` | `adjust` | `scroll`;
-            animation: false | `turn` | `snap`;
+            adjustedSpinePosition: {
+                x: number;
+                y: number;
+            };
+            areDifferent: boolean;
+        }>;
+        currentNavigationPosition$: Observable<{
+            x: number;
+            y: number;
         }>;
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/core",
-  "version": "0.0.43",
+  "version": "0.0.44",
   "main": "dist/index.js",
   "license": "MIT",
   "files": [
@@ -39,5 +39,5 @@
     "webpack-bundle-analyzer": "^4.5.0",
     "webpack-cli": "^4.9.1"
   },
-  "gitHead": "21ca4ff1a57ca4959bf81d65541294fc425873c1"
+  "gitHead": "693da1fcbc70bc97f2574db4803a25d8b3df0823"
 }

package/dist/enhancers/zoom.d.ts

@@ -1,16 +0,0 @@
-import { Enhancer } from "./types";
-export declare const zoomEnhancer: Enhancer<{}, {
-    zoom: {
-        enter: (imgElement: HTMLImageElement) => void;
-        exit: () => void;
-        move: (position: {
-            x: number;
-            y: number;
-        } | undefined, details: {
-            isFirst: boolean;
-            isLast: boolean;
-        }) => void;
-        isEnabled: () => boolean;
-        scale: (scale: number) => void;
-    };
-}>;