@prose-reader/core 1.24.0 → 1.26.0

package/dist/viewportNavigator/panViewportNavigator.d.ts

@@ -1,215 +1,272 @@
-import { BehaviorSubject, Subject } from "rxjs";
-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;
-    navigator: ReturnType<typeof createNavigationResolver>;
-    currentNavigationSubject$: BehaviorSubject<ViewportNavigationEntry>;
-    spineItemManager: SpineItemManager;
-    locator: ReturnType<typeof createLocationResolver>;
-    getCurrentViewportPosition: () => ViewportPosition;
+import { BehaviorSubject, Subject } from "rxjs"
+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
+  navigator: ReturnType<typeof createNavigationResolver>
+  currentNavigationSubject$: BehaviorSubject<ViewportNavigationEntry>
+  spineItemManager: SpineItemManager
+  locator: ReturnType<typeof createLocationResolver>
+  getCurrentViewportPosition: () => ViewportPosition
 }) => {
-    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);
-    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?: {
-                layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
-                    blankPagePosition: "after" | "before" | "none";
-                    minimumWidth: number;
-                    spreadPosition: "none" | "right" | "left";
-                }) => {
-                    width: number;
-                    height: number;
-                };
-                item: {
-                    id: string;
-                    href: string;
-                    renditionLayout: "reflowable" | "pre-paginated";
-                    progressionWeight: number;
-                    pageSpreadLeft: true | undefined;
-                    pageSpreadRight: true | undefined;
-                    mediaType?: string | undefined;
-                };
-                load: () => void;
-                adjustPositionOfElement: ({ right, left, top }: {
-                    right?: number | undefined;
-                    left?: number | undefined;
-                    top?: number | undefined;
-                }) => void;
-                getElementDimensions: () => {
-                    width: number;
-                    height: number;
-                };
-                getHtmlFromResource: (response: Response) => Promise<string>;
-                getResource: () => Promise<Response>;
-                translateFramePositionIntoPage: (position: {
-                    clientX: number;
-                    clientY: number;
-                }) => {
-                    clientX: number;
-                    clientY: number;
-                };
-                setLayoutDirty: () => void;
-                injectStyle: (cssText: string) => void;
-                loadContent: () => void;
-                unloadContent: () => void;
-                spineItemFrame: {
-                    getIsLoaded: () => boolean;
-                    getIsReady: () => boolean;
-                    getViewportDimensions: () => {
-                        width: number;
-                        height: number;
-                    } | undefined;
-                    getFrameElement: () => HTMLIFrameElement | undefined;
-                    getHtmlFromResource: (response: Response) => Promise<string>;
-                    load: () => void;
-                    unload: () => void;
-                    staticLayout: (size: {
-                        width: number;
-                        height: number;
-                    }) => void;
-                    getManipulableFrame: () => {
-                        frame: HTMLIFrameElement;
-                        removeStyle: (id: string) => void;
-                        addStyle: (id: string, style: string, prepend?: boolean) => void;
-                    } | undefined;
-                    getReadingDirection: () => "ltr" | "rtl" | undefined;
-                    isUsingVerticalWriting: () => boolean;
-                    getWritingMode: () => "vertical-rl" | "horizontal-tb" | undefined;
-                    destroy: () => void;
-                    $: {
-                        unload$: import("rxjs").Observable<void>;
-                        unloaded$: import("rxjs").Observable<void>;
-                        loaded$: import("rxjs").Observable<HTMLIFrameElement>;
-                        ready$: import("rxjs").Observable<FontFaceSet | undefined>;
-                        isReady$: import("rxjs").Observable<boolean>;
-                        contentLayoutChange$: import("rxjs").Observable<{
-                            isFirstLayout: boolean;
-                        } | {
-                            isFirstLayout: boolean;
-                        }>;
-                    };
-                };
-                element: HTMLElement;
-                getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
-                getViewPortInformation: () => {
-                    computedScale: number;
-                    computedWidthScale: number;
-                    viewportDimensions: {
-                        width: number;
-                        height: number;
-                    };
-                } | undefined;
-                isImageType: () => boolean;
-                isReady: () => boolean;
-                destroy: () => void;
-                isUsingVerticalWriting: () => boolean | undefined;
-                getReadingDirection: () => "ltr" | "rtl" | undefined;
-                manipulateSpineItem: (cb: (options: {
-                    container: HTMLElement;
-                    item: {
-                        id: string;
-                        href: string;
-                        renditionLayout: "reflowable" | "pre-paginated";
-                        progressionWeight: number;
-                        pageSpreadLeft: true | undefined;
-                        pageSpreadRight: true | undefined;
-                        mediaType?: string | undefined;
-                    };
-                    overlayElement: HTMLDivElement;
-                } & ({
-                    frame: HTMLIFrameElement;
-                    removeStyle: (id: string) => void;
-                    addStyle: (id: string, style: string, prepend?: boolean) => void;
-                } | {
-                    frame: undefined;
-                    removeStyle: (id: string) => void;
-                    addStyle: (id: string, style: string) => void;
-                })) => boolean) => boolean;
-                executeOnLayoutBeforeMeasurementHook: (options: {
-                    minimumWidth: number;
-                }) => void;
-                selectionTracker: {
-                    track: (frameToTrack: HTMLIFrameElement) => void;
-                    destroy: () => void;
-                    isSelecting: () => boolean;
-                    getSelection: () => Selection | undefined;
-                    $: import("rxjs").Observable<{
-                        event: "selectionchange";
-                        data: Selection | null;
-                    } | {
-                        event: "selectstart";
-                        data: Selection | null;
-                    } | {
-                        event: "selectend";
-                        data: Selection | null;
-                    }>;
-                };
-                fingerTracker: {
-                    track: (frame: HTMLIFrameElement) => void;
-                    getFingerPositionInIframe(): {
-                        x: number | undefined;
-                        y: number | undefined;
-                    } | undefined;
-                    destroy: () => void;
-                    $: import("rxjs").Observable<{
-                        event: "fingermove";
-                        data: {
-                            x: number;
-                            y: number;
-                        };
-                    } | {
-                        event: "fingerout";
-                        data: undefined;
-                    }>;
-                };
-                getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
-                    columnHeight: number;
-                    columnWidth: number;
-                    width: number;
-                };
-                getDimensionsForPaginatedContent: () => {
-                    columnHeight: number;
-                    columnWidth: number;
-                };
-                $: {
-                    contentLayout$: import("rxjs").Observable<{
-                        isFirstLayout: boolean;
-                        isReady: boolean;
-                    }>;
-                    loaded$: import("rxjs").Observable<HTMLIFrameElement>;
-                    isReady$: import("rxjs").Observable<boolean>;
-                };
-            } | undefined;
-        }>;
-    };
-};
+  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)
+  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?:
+        | {
+            layout: ({
+              blankPagePosition,
+              minimumWidth,
+              spreadPosition,
+            }: {
+              blankPagePosition: "after" | "before" | "none"
+              minimumWidth: number
+              spreadPosition: "none" | "right" | "left"
+            }) => {
+              width: number
+              height: number
+            }
+            item: {
+              id: string
+              href: string
+              renditionLayout: "reflowable" | "pre-paginated"
+              progressionWeight: number
+              pageSpreadLeft: true | undefined
+              pageSpreadRight: true | undefined
+              mediaType?: string | undefined
+            }
+            load: () => void
+            adjustPositionOfElement: ({
+              right,
+              left,
+              top,
+            }: {
+              right?: number | undefined
+              left?: number | undefined
+              top?: number | undefined
+            }) => void
+            getElementDimensions: () => {
+              width: number
+              height: number
+            }
+            getHtmlFromResource: (response: Response) => Promise<string>
+            getResource: () => Promise<Response>
+            translateFramePositionIntoPage: (position: { clientX: number; clientY: number }) => {
+              clientX: number
+              clientY: number
+            }
+            setLayoutDirty: () => void
+            injectStyle: (cssText: string) => void
+            loadContent: () => void
+            unloadContent: () => void
+            spineItemFrame: {
+              getIsLoaded: () => boolean
+              getIsReady: () => boolean
+              getViewportDimensions: () =>
+                | {
+                    width: number
+                    height: number
+                  }
+                | undefined
+              getFrameElement: () => HTMLIFrameElement | undefined
+              getHtmlFromResource: (response: Response) => Promise<string>
+              load: () => void
+              unload: () => void
+              staticLayout: (size: { width: number; height: number }) => void
+              getManipulableFrame: () =>
+                | {
+                    frame: HTMLIFrameElement
+                    removeStyle: (id: string) => void
+                    addStyle: (id: string, style: string, prepend?: boolean) => void
+                  }
+                | undefined
+              getReadingDirection: () => "ltr" | "rtl" | undefined
+              isUsingVerticalWriting: () => boolean
+              getWritingMode: () => "vertical-rl" | "horizontal-tb" | undefined
+              destroy: () => void
+              $: {
+                unload$: import("rxjs").Observable<void>
+                unloaded$: import("rxjs").Observable<void>
+                loaded$: import("rxjs").Observable<HTMLIFrameElement>
+                ready$: import("rxjs").Observable<FontFaceSet | undefined>
+                isReady$: import("rxjs").Observable<boolean>
+                contentLayoutChange$: import("rxjs").Observable<
+                  | {
+                      isFirstLayout: boolean
+                    }
+                  | {
+                      isFirstLayout: boolean
+                    }
+                >
+              }
+            }
+            element: HTMLElement
+            getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined
+            getViewPortInformation: () =>
+              | {
+                  computedScale: number
+                  computedWidthScale: number
+                  viewportDimensions: {
+                    width: number
+                    height: number
+                  }
+                }
+              | undefined
+            isImageType: () => boolean
+            isReady: () => boolean
+            destroy: () => void
+            isUsingVerticalWriting: () => boolean | undefined
+            getReadingDirection: () => "ltr" | "rtl" | undefined
+            manipulateSpineItem: (
+              cb: (
+                options: {
+                  container: HTMLElement
+                  item: {
+                    id: string
+                    href: string
+                    renditionLayout: "reflowable" | "pre-paginated"
+                    progressionWeight: number
+                    pageSpreadLeft: true | undefined
+                    pageSpreadRight: true | undefined
+                    mediaType?: string | undefined
+                  }
+                  overlayElement: HTMLDivElement
+                } & (
+                  | {
+                      frame: HTMLIFrameElement
+                      removeStyle: (id: string) => void
+                      addStyle: (id: string, style: string, prepend?: boolean) => void
+                    }
+                  | {
+                      frame: undefined
+                      removeStyle: (id: string) => void
+                      addStyle: (id: string, style: string) => void
+                    }
+                )
+              ) => boolean
+            ) => boolean
+            executeOnLayoutBeforeMeasurementHook: (options: { minimumWidth: number }) => void
+            selectionTracker: {
+              track: (frameToTrack: HTMLIFrameElement) => void
+              destroy: () => void
+              isSelecting: () => boolean
+              getSelection: () => Selection | undefined
+              $: import("rxjs").Observable<
+                | {
+                    event: "selectionchange"
+                    data: Selection | null
+                  }
+                | {
+                    event: "selectstart"
+                    data: Selection | null
+                  }
+                | {
+                    event: "selectend"
+                    data: Selection | null
+                  }
+              >
+            }
+            fingerTracker: {
+              track: (frame: HTMLIFrameElement) => void
+              getFingerPositionInIframe():
+                | {
+                    x: number | undefined
+                    y: number | undefined
+                  }
+                | undefined
+              destroy: () => void
+              $: import("rxjs").Observable<
+                | {
+                    event: "fingermove"
+                    data: {
+                      x: number
+                      y: number
+                    }
+                  }
+                | {
+                    event: "fingerout"
+                    data: undefined
+                  }
+              >
+            }
+            getDimensionsForReflowableContent: (
+              isUsingVerticalWriting: boolean,
+              minimumWidth: number
+            ) => {
+              columnHeight: number
+              columnWidth: number
+              width: number
+            }
+            getDimensionsForPaginatedContent: () => {
+              columnHeight: number
+              columnWidth: number
+            }
+            $: {
+              contentLayout$: import("rxjs").Observable<{
+                isFirstLayout: boolean
+                isReady: boolean
+              }>
+              loaded$: import("rxjs").Observable<HTMLIFrameElement>
+              isReady$: import("rxjs").Observable<boolean>
+            }
+          }
+        | undefined
+    }>
+  }
+}

package/dist/viewportNavigator/scrollViewportNavigator.d.ts

@@ -1,35 +1,38 @@
-import { BehaviorSubject, Observable } from "rxjs";
-import { Context } from "../context";
-import { Spine } from "../spine/createSpine";
-import { createNavigationResolver, ViewportNavigationEntry } from "../spine/navigationResolver";
-import { SpineItemManager } from "../spineItemManager";
-import { ViewportPosition } from "../types";
-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;
+import { BehaviorSubject, Observable } from "rxjs"
+import { Context } from "../context"
+import { Spine } from "../spine/createSpine"
+import { createNavigationResolver, ViewportNavigationEntry } from "../spine/navigationResolver"
+import { SpineItemManager } from "../spineItemManager"
+import { ViewportPosition } from "../types"
+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<"start" | "end">;
-        navigation$: Observable<{
-            position: ViewportNavigationEntry;
-            animate: boolean;
-            lastUserExpectedNavigation: undefined;
-        }>;
-    };
-};
-export {};
+  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

@@ -1,33 +1,38 @@
-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;
-};
+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;
-};
+  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;
-};
+  previousNavigationPosition: {
+    x: number
+    y: number
+  }
+  adjustedSpinePosition: {
+    x: number
+    y: number
+  }
+  areDifferent: boolean
+}