@prose-reader/core 1.24.0 → 1.26.0

package/dist/spine/navigationResolver.d.ts

@@ -1,45 +1,54 @@
-import { Context } from "../context";
-import { SpineItemManager } from "../spineItemManager";
-import { SpineItem } from "../spineItem/createSpineItem";
-import { createLocationResolver } from "./locationResolver";
-import { createCfiLocator } from "./cfiLocator";
-import { SpinePosition, UnsafeSpinePosition } from "./types";
+import { Context } from "../context"
+import { SpineItemManager } from "../spineItemManager"
+import { SpineItem } from "../spineItem/createSpineItem"
+import { createLocationResolver } from "./locationResolver"
+import { createCfiLocator } from "./cfiLocator"
+import { SpinePosition, UnsafeSpinePosition } from "./types"
 export type ViewportNavigationEntry = {
-    x: number;
-    y: number;
-    spineItem?: SpineItem;
-};
+  x: number
+  y: number
+  spineItem?: SpineItem
+}
 type ViewportPosition = {
-    x: number;
-    y: number;
-};
-export declare const createNavigationResolver: ({ context, spineItemManager, cfiLocator, locator, }: {
-    context: Context;
-    spineItemManager: SpineItemManager;
-    cfiLocator: ReturnType<typeof createCfiLocator>;
-    locator: ReturnType<typeof createLocationResolver>;
+  x: number
+  y: number
+}
+export declare const createNavigationResolver: ({
+  context,
+  spineItemManager,
+  cfiLocator,
+  locator,
+}: {
+  context: Context
+  spineItemManager: SpineItemManager
+  cfiLocator: ReturnType<typeof createCfiLocator>
+  locator: ReturnType<typeof createLocationResolver>
 }) => {
-    getNavigationForCfi: (cfi: string) => ViewportNavigationEntry;
-    getNavigationForPage: (pageIndex: number, spineItem?: SpineItem) => ViewportNavigationEntry;
-    getNavigationForLastPage: (spineItem: SpineItem) => ViewportNavigationEntry;
-    getNavigationForSpineIndexOrId: (indexOrId: number | string) => ViewportNavigationEntry;
-    getNavigationForRightPage: (position: SpinePosition) => ViewportNavigationEntry;
-    getNavigationForLeftPage: (position: UnsafeSpinePosition) => SpinePosition;
-    getNavigationForUrl: (url: string | URL) => (ViewportNavigationEntry & {
-        url: URL;
-    }) | undefined;
-    getNavigationForAnchor: (anchor: string, spineItem: SpineItem) => ViewportNavigationEntry;
-    getNavigationForPosition: (viewportPosition: ViewportPosition) => ViewportNavigationEntry;
-    getMostPredominantNavigationForPosition: (viewportPosition: ViewportPosition) => ViewportNavigationEntry;
-    wrapPositionWithSafeEdge: ((position: SpinePosition) => {
-        x: number;
-        y: number;
-    }) | ((position: SpinePosition) => {
-        x: number;
-        y: number;
-    });
-    isNavigationGoingForwardFrom: (to: ViewportPosition, from: ViewportPosition) => boolean;
-    areNavigationDifferent: (a: ViewportNavigationEntry, b: ViewportNavigationEntry) => boolean;
-    arePositionsDifferent: (a: ViewportNavigationEntry, b: ViewportNavigationEntry) => boolean;
-};
-export {};
+  getNavigationForCfi: (cfi: string) => ViewportNavigationEntry
+  getNavigationForPage: (pageIndex: number, spineItem?: SpineItem) => ViewportNavigationEntry
+  getNavigationForLastPage: (spineItem: SpineItem) => ViewportNavigationEntry
+  getNavigationForSpineIndexOrId: (indexOrId: number | string) => ViewportNavigationEntry
+  getNavigationForRightPage: (position: SpinePosition) => ViewportNavigationEntry
+  getNavigationForLeftPage: (position: UnsafeSpinePosition) => SpinePosition
+  getNavigationForUrl: (url: string | URL) =>
+    | (ViewportNavigationEntry & {
+        url: URL
+      })
+    | undefined
+  getNavigationForAnchor: (anchor: string, spineItem: SpineItem) => ViewportNavigationEntry
+  getNavigationForPosition: (viewportPosition: ViewportPosition) => ViewportNavigationEntry
+  getMostPredominantNavigationForPosition: (viewportPosition: ViewportPosition) => ViewportNavigationEntry
+  wrapPositionWithSafeEdge:
+    | ((position: SpinePosition) => {
+        x: number
+        y: number
+      })
+    | ((position: SpinePosition) => {
+        x: number
+        y: number
+      })
+  isNavigationGoingForwardFrom: (to: ViewportPosition, from: ViewportPosition) => boolean
+  areNavigationDifferent: (a: ViewportNavigationEntry, b: ViewportNavigationEntry) => boolean
+  arePositionsDifferent: (a: ViewportNavigationEntry, b: ViewportNavigationEntry) => boolean
+}
+export {}

package/dist/spine/types.d.ts

@@ -1,10 +1,10 @@
 export type SpinePosition = {
-    x: number;
-    y: number;
-    __symbol?: `SpinePosition`;
-};
+  x: number
+  y: number
+  __symbol?: `SpinePosition`
+}
 export type UnsafeSpinePosition = {
-    x: number;
-    y: number;
-    __symbol?: `UnsafeSpinePosition` | `SpinePosition`;
-};
+  x: number
+  y: number
+  __symbol?: `UnsafeSpinePosition` | `SpinePosition`
+}

package/dist/spineItem/commonSpineItem.d.ts

@@ -1,171 +1,207 @@
-import { Context } from "../context";
-import { Manifest } from "../types";
-import { BehaviorSubject, Observable } from "rxjs";
-import { Hook } from "../types/Hook";
-import { createFrameManipulator } from "./frameItem/createFrameManipulator";
-export declare const createCommonSpineItem: ({ item, context, parentElement, iframeEventBridgeElement, hooks$, viewportState$, }: {
-    item: Manifest[`spineItems`][number];
-    parentElement: HTMLElement;
-    iframeEventBridgeElement: HTMLElement;
-    context: Context;
-    hooks$: BehaviorSubject<Hook[]>;
-    viewportState$: Observable<`free` | `busy`>;
+import { Context } from "../context"
+import { Manifest } from "../types"
+import { BehaviorSubject, Observable } from "rxjs"
+import { Hook } from "../types/Hook"
+import { createFrameManipulator } from "./frameItem/createFrameManipulator"
+export declare const createCommonSpineItem: ({
+  item,
+  context,
+  parentElement,
+  iframeEventBridgeElement,
+  hooks$,
+  viewportState$,
+}: {
+  item: Manifest[`spineItems`][number]
+  parentElement: HTMLElement
+  iframeEventBridgeElement: HTMLElement
+  context: Context
+  hooks$: BehaviorSubject<Hook[]>
+  viewportState$: Observable<`free` | `busy`>
 }) => {
-    item: {
-        id: string;
-        href: string;
-        renditionLayout: "reflowable" | "pre-paginated";
-        progressionWeight: number;
-        pageSpreadLeft: true | undefined;
-        pageSpreadRight: true | undefined;
-        mediaType?: string | undefined;
-    };
-    load: () => void;
-    layout: ({ height, width, blankPagePosition, minimumWidth, }: {
-        height: number;
-        width: number;
-        blankPagePosition: `before` | `after` | `none`;
-        minimumWidth: number;
-    }) => 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$: Observable<void>;
-            unloaded$: Observable<void>;
-            loaded$: Observable<HTMLIFrameElement>;
-            ready$: Observable<FontFaceSet | undefined>;
-            isReady$: Observable<boolean>;
-            contentLayoutChange$: 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: Manifest[`spineItems`][number];
-        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;
-        $: 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;
-        $: 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;
-    };
+  item: {
+    id: string
+    href: string
+    renditionLayout: "reflowable" | "pre-paginated"
+    progressionWeight: number
+    pageSpreadLeft: true | undefined
+    pageSpreadRight: true | undefined
+    mediaType?: string | undefined
+  }
+  load: () => void
+  layout: ({
+    height,
+    width,
+    blankPagePosition,
+    minimumWidth,
+  }: {
+    height: number
+    width: number
+    blankPagePosition: `before` | `after` | `none`
+    minimumWidth: number
+  }) => 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
     $: {
-        contentLayout$: Observable<{
-            isFirstLayout: boolean;
-            isReady: boolean;
-        }>;
-        loaded$: Observable<HTMLIFrameElement>;
-        isReady$: Observable<boolean>;
-    };
-};
+      unload$: Observable<void>
+      unloaded$: Observable<void>
+      loaded$: Observable<HTMLIFrameElement>
+      ready$: Observable<FontFaceSet | undefined>
+      isReady$: Observable<boolean>
+      contentLayoutChange$: 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: Manifest[`spineItems`][number]
+        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
+    $: 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
+    $: 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$: Observable<{
+      isFirstLayout: boolean
+      isReady: boolean
+    }>
+    loaded$: Observable<HTMLIFrameElement>
+    isReady$: Observable<boolean>
+  }
+}