@prose-reader/core 0.0.41 → 0.0.44

package/dist/createReaderWithEnhancer.d.ts

@@ -5,6 +5,7 @@ declare const withPublicApiOnly: <Api extends {
     context: any;
     registerHook: any;
     spine: any;
+    viewportNavigator: any;
     manipulateSpineItems: any;
     manipulateSpineItem: any;
     manipulateContainer: any;
@@ -115,6 +116,81 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
     context: import("./context").Context;
     registerHook: import("./types/Hook").RegisterHook;
     spine: import("./types/Spine").Spine;
+    viewportNavigator: {
+        destroy: () => void;
+        layout: () => void;
+        getCurrentNavigationPosition: () => {
+            x: number;
+            y: number;
+        };
+        getCurrentViewportPosition: (() => {
+            x: number;
+            y: number;
+        }) | (() => {
+            x: number;
+            y: number;
+        });
+        turnLeft: ({ allowSpineItemChange }?: {
+            allowSpineItemChange?: boolean | undefined;
+        }) => void;
+        turnRight: ({ allowSpineItemChange }?: {
+            allowSpineItemChange?: boolean | undefined;
+        }) => void;
+        goToPage: (pageIndex: number) => void;
+        goToSpineItem: (indexOrId: string | number, options?: {
+            animate: boolean;
+        }) => void;
+        goToUrl: (url: string | URL) => void;
+        goToCfi: (cfi: string, options?: {
+            animate: boolean;
+        }) => void;
+        goToPageOfCurrentChapter: (pageIndex: number) => void;
+        adjustNavigation: (spineItem: import("./spineItem/createSpineItem").SpineItem) => import("rxjs").Observable<{
+            previousNavigationPosition: {
+                x: number;
+                y: number;
+            };
+            adjustedSpinePosition: {
+                x: number;
+                y: number;
+            };
+            areDifferent: boolean;
+        }>;
+        moveTo: ((delta: {
+            x: number;
+            y: number;
+        } | undefined, { final, start }?: {
+            start?: boolean | undefined;
+            final?: boolean | undefined;
+        }) => void) | ((args_0: {
+            x: number;
+            y: number;
+        } | undefined, args_1?: {
+            start?: boolean | undefined;
+            final?: boolean | undefined;
+        } | undefined) => void);
+        getLastUserExpectedNavigation: () => import("./viewportNavigator/types").LastUserExpectedNavigation;
+        element: HTMLElement;
+        $: {
+            state$: import("rxjs").Observable<"free" | "busy">;
+            navigation$: import("rxjs").Observable<import("./viewportNavigator/types").Navigation>;
+            navigationAdjustedAfterLayout$: import("rxjs").Observable<{
+                previousNavigationPosition: {
+                    x: number;
+                    y: number;
+                };
+                adjustedSpinePosition: {
+                    x: number;
+                    y: number;
+                };
+                areDifferent: boolean;
+            }>;
+            currentNavigationPosition$: import("rxjs").Observable<{
+                x: number;
+                y: number;
+            }>;
+        };
+    };
     manipulateSpineItems: (cb: (payload: ({
         container: HTMLElement;
         item: {
@@ -373,7 +449,7 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
                 computedWidthScale: number;
                 viewportDimensions?: undefined;
             };
-            isImageType: () => boolean | undefined;
+            isImageType: () => boolean;
             isReady: () => boolean;
             destroy: () => void;
             isUsingVerticalWriting: () => boolean | undefined;
@@ -545,7 +621,7 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
                 computedWidthScale: number;
                 viewportDimensions?: undefined;
             };
-            isImageType: () => boolean | undefined;
+            isImageType: () => boolean;
             isReady: () => boolean;
             destroy: () => void;
             isUsingVerticalWriting: () => boolean | undefined;
@@ -638,7 +714,10 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
             };
         } | undefined;
     };
-    getCurrentNavigationPosition: () => import("./spine/navigationResolver").ViewportNavigationEntry;
+    getCurrentNavigationPosition: () => {
+        x: number;
+        y: number;
+    };
     getCurrentViewportPosition: (() => {
         x: number;
         y: number;
@@ -732,7 +811,7 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
             y: number;
         }, currentItem: import("./spineItem/createSpineItem").SpineItem) => number;
     };
-}, "context" | "registerHook" | "spine" | "manipulateSpineItems" | "manipulateSpineItem" | "manipulateContainer" | "moveTo" | "turnLeft" | "turnRight" | "goToPageOfCurrentChapter" | "goToPage" | "goToUrl" | "goToCfi" | "goToSpineItem" | "getFocusedSpineItemIndex" | "getSpineItem" | "getSpineItems" | "getAbsolutePositionOf" | "getSelection" | "isSelecting" | "normalizeEventForViewport" | "getCfiMetaInformation" | "resolveCfi" | "generateCfi" | "locator" | "getCurrentNavigationPosition" | "getCurrentViewportPosition" | "layout" | "load" | "destroy" | "setSettings" | "$"> & {
+}, "context" | "registerHook" | "spine" | "viewportNavigator" | "manipulateSpineItems" | "manipulateSpineItem" | "manipulateContainer" | "moveTo" | "turnLeft" | "turnRight" | "goToPageOfCurrentChapter" | "goToPage" | "goToUrl" | "goToCfi" | "goToSpineItem" | "getFocusedSpineItemIndex" | "getSpineItem" | "getSpineItems" | "getAbsolutePositionOf" | "getSelection" | "isSelecting" | "normalizeEventForViewport" | "getCfiMetaInformation" | "resolveCfi" | "generateCfi" | "locator" | "getCurrentNavigationPosition" | "getCurrentViewportPosition" | "layout" | "load" | "destroy" | "setSettings" | "$"> & {
     __API?: {
         progression: {
             getPercentageEstimate: (context: import("./context").Context, currentSpineIndex: number, numberOfPages: number, pageIndex: number, currentPosition: {
@@ -759,21 +838,7 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
 }, {}, {}, (createReader: (options: import("./reader").CreateReaderOptions) => ReaderPublicApi) => (options: import("./reader").CreateReaderOptions) => ReaderPublicApi, ReaderPublicApi>, Enhancer<{}, {
     goToLeftSpineItem: () => void;
     goToRightSpineItem: () => void;
-}, {}, {}, (createReader: (options: import("./reader").CreateReaderOptions) => ReaderPublicApi) => (options: import("./reader").CreateReaderOptions) => ReaderPublicApi, ReaderPublicApi>, Enhancer<{}, {}, {}, {}, (createReader: (options: import("./reader").CreateReaderOptions) => ReaderPublicApi) => (options: import("./reader").CreateReaderOptions) => ReaderPublicApi, ReaderPublicApi>, Enhancer<{}, {}, {}, {}, (createReader: (options: import("./reader").CreateReaderOptions) => ReaderPublicApi) => (options: import("./reader").CreateReaderOptions) => ReaderPublicApi, ReaderPublicApi>, 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;
-    };
-}, {}, {}, (createReader: (options: import("./reader").CreateReaderOptions) => ReaderPublicApi) => (options: import("./reader").CreateReaderOptions) => ReaderPublicApi, ReaderPublicApi>, import("./enhancers/layoutEnhancer/types").LayoutEnhancer, Enhancer<{}, {
+}, {}, {}, (createReader: (options: import("./reader").CreateReaderOptions) => ReaderPublicApi) => (options: import("./reader").CreateReaderOptions) => ReaderPublicApi, ReaderPublicApi>, Enhancer<{}, {}, {}, {}, (createReader: (options: import("./reader").CreateReaderOptions) => ReaderPublicApi) => (options: import("./reader").CreateReaderOptions) => ReaderPublicApi, ReaderPublicApi>, Enhancer<{}, {}, {}, {}, (createReader: (options: import("./reader").CreateReaderOptions) => ReaderPublicApi) => (options: import("./reader").CreateReaderOptions) => ReaderPublicApi, ReaderPublicApi>, import("./enhancers/zoom/types").ZoomEnhancer, import("./enhancers/layoutEnhancer/types").LayoutEnhancer, Enhancer<{}, {
     utils: {
         isOrIsWithinValidLink: (target: EventTarget | null) => boolean;
     };
@@ -835,6 +900,81 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
     context: import("./context").Context;
     registerHook: import("./types/Hook").RegisterHook;
     spine: import("./types/Spine").Spine;
+    viewportNavigator: {
+        destroy: () => void;
+        layout: () => void;
+        getCurrentNavigationPosition: () => {
+            x: number;
+            y: number;
+        };
+        getCurrentViewportPosition: (() => {
+            x: number;
+            y: number;
+        }) | (() => {
+            x: number;
+            y: number;
+        });
+        turnLeft: ({ allowSpineItemChange }?: {
+            allowSpineItemChange?: boolean | undefined;
+        }) => void;
+        turnRight: ({ allowSpineItemChange }?: {
+            allowSpineItemChange?: boolean | undefined;
+        }) => void;
+        goToPage: (pageIndex: number) => void;
+        goToSpineItem: (indexOrId: string | number, options?: {
+            animate: boolean;
+        }) => void;
+        goToUrl: (url: string | URL) => void;
+        goToCfi: (cfi: string, options?: {
+            animate: boolean;
+        }) => void;
+        goToPageOfCurrentChapter: (pageIndex: number) => void;
+        adjustNavigation: (spineItem: import("./spineItem/createSpineItem").SpineItem) => import("rxjs").Observable<{
+            previousNavigationPosition: {
+                x: number;
+                y: number;
+            };
+            adjustedSpinePosition: {
+                x: number;
+                y: number;
+            };
+            areDifferent: boolean;
+        }>;
+        moveTo: ((delta: {
+            x: number;
+            y: number;
+        } | undefined, { final, start }?: {
+            start?: boolean | undefined;
+            final?: boolean | undefined;
+        }) => void) | ((args_0: {
+            x: number;
+            y: number;
+        } | undefined, args_1?: {
+            start?: boolean | undefined;
+            final?: boolean | undefined;
+        } | undefined) => void);
+        getLastUserExpectedNavigation: () => import("./viewportNavigator/types").LastUserExpectedNavigation;
+        element: HTMLElement;
+        $: {
+            state$: import("rxjs").Observable<"free" | "busy">;
+            navigation$: import("rxjs").Observable<import("./viewportNavigator/types").Navigation>;
+            navigationAdjustedAfterLayout$: import("rxjs").Observable<{
+                previousNavigationPosition: {
+                    x: number;
+                    y: number;
+                };
+                adjustedSpinePosition: {
+                    x: number;
+                    y: number;
+                };
+                areDifferent: boolean;
+            }>;
+            currentNavigationPosition$: import("rxjs").Observable<{
+                x: number;
+                y: number;
+            }>;
+        };
+    };
     manipulateSpineItems: (cb: (payload: ({
         container: HTMLElement;
         item: {
@@ -1093,7 +1233,7 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
                 computedWidthScale: number;
                 viewportDimensions?: undefined;
             };
-            isImageType: () => boolean | undefined;
+            isImageType: () => boolean;
             isReady: () => boolean;
             destroy: () => void;
             isUsingVerticalWriting: () => boolean | undefined;
@@ -1265,7 +1405,7 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
                 computedWidthScale: number;
                 viewportDimensions?: undefined;
             };
-            isImageType: () => boolean | undefined;
+            isImageType: () => boolean;
             isReady: () => boolean;
             destroy: () => void;
             isUsingVerticalWriting: () => boolean | undefined;
@@ -1358,7 +1498,10 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
             };
         } | undefined;
     };
-    getCurrentNavigationPosition: () => import("./spine/navigationResolver").ViewportNavigationEntry;
+    getCurrentNavigationPosition: () => {
+        x: number;
+        y: number;
+    };
     getCurrentViewportPosition: (() => {
         x: number;
         y: number;
@@ -1449,7 +1592,7 @@ declare const internalEnhancer: import("./enhancers/composeEnhancer").ComposeEnh
             theme$: import("rxjs").Observable<import("./enhancers/theme").Theme>;
         };
     };
-}, "context" | "registerHook" | "spine" | "manipulateSpineItems" | "manipulateSpineItem" | "manipulateContainer" | "moveTo" | "turnLeft" | "turnRight" | "goToPageOfCurrentChapter" | "goToPage" | "goToUrl" | "goToCfi" | "goToSpineItem" | "getFocusedSpineItemIndex" | "getSpineItem" | "getSpineItems" | "getAbsolutePositionOf" | "getSelection" | "isSelecting" | "normalizeEventForViewport" | "getCfiMetaInformation" | "resolveCfi" | "generateCfi" | "locator" | "getCurrentNavigationPosition" | "getCurrentViewportPosition" | "layout" | "load" | "destroy" | "setSettings" | "$"> & {
+}, "context" | "registerHook" | "spine" | "viewportNavigator" | "manipulateSpineItems" | "manipulateSpineItem" | "manipulateContainer" | "moveTo" | "turnLeft" | "turnRight" | "goToPageOfCurrentChapter" | "goToPage" | "goToUrl" | "goToCfi" | "goToSpineItem" | "getFocusedSpineItemIndex" | "getSpineItem" | "getSpineItems" | "getAbsolutePositionOf" | "getSelection" | "isSelecting" | "normalizeEventForViewport" | "getCfiMetaInformation" | "resolveCfi" | "generateCfi" | "locator" | "getCurrentNavigationPosition" | "getCurrentViewportPosition" | "layout" | "load" | "destroy" | "setSettings" | "$"> & {
     __API?: {
         theme: {
             set: (theme: import("./enhancers/theme").Theme) => void;

package/dist/enhancers/zoom/elementZoomer.d.ts

@@ -0,0 +1,18 @@
+import { ReaderInstance } from "./types";
+export declare const createElementZoomer: (reader: ReaderInstance) => {
+    enter: (imgElement: HTMLImageElement) => void;
+    exit: () => void;
+    move: (delta: {
+        x: number;
+        y: number;
+    } | undefined, { isFirst, isLast }: {
+        isFirst: boolean;
+        isLast: boolean;
+    }) => void;
+    scale: (userScale: number) => void;
+    setCurrentScaleAsBase: () => void;
+    getScaleValue: () => number;
+    isZooming: () => boolean;
+    destroy: () => void;
+    isZooming$: import("rxjs").Observable<boolean>;
+};

package/dist/enhancers/zoom/index.d.ts

@@ -0,0 +1,2 @@
+import { ZoomEnhancer } from "./types";
+export declare const zoomEnhancer: ZoomEnhancer;

package/dist/enhancers/zoom/types.d.ts

@@ -0,0 +1,26 @@
+import { Observable } from "rxjs";
+import { Enhancer } from "../types";
+export declare type SettingsInput = {};
+export declare type SettingsOutput = Required<SettingsInput>;
+export declare type ZoomEnhancer = Enhancer<SettingsInput, {
+    zoom: {
+        enter: (imgElement?: HTMLImageElement) => void;
+        exit: () => void;
+        move: (position: {
+            x: number;
+            y: number;
+        } | undefined, details: {
+            isFirst: boolean;
+            isLast: boolean;
+        }) => void;
+        isZooming: () => boolean;
+        isUsingScrollableZoom: () => boolean;
+        getScaleValue: () => number;
+        scale: (scale: number) => void;
+        setCurrentScaleAsBase: () => void;
+        $: {
+            isZooming$: Observable<boolean>;
+        };
+    };
+}, SettingsInput, SettingsOutput>;
+export declare type ReaderInstance = ReturnType<Parameters<ZoomEnhancer>[0]>;

package/dist/enhancers/zoom/viewportZoomer.d.ts

@@ -0,0 +1,18 @@
+import { ReaderInstance } from "./types";
+export declare const createViewportZoomer: (reader: ReaderInstance) => {
+    enter: () => void;
+    exit: () => void;
+    move: (_: {
+        x: number;
+        y: number;
+    } | undefined, __: {
+        isFirst: boolean;
+        isLast: boolean;
+    }) => void;
+    scale: (userScale: number) => void;
+    setCurrentScaleAsBase: () => void;
+    getScaleValue: () => number;
+    isZooming: () => boolean;
+    destroy: () => void;
+    isZooming$: import("rxjs").Observable<boolean>;
+};