@prose-reader/core 1.23.0 → 1.25.0

package/dist/spine/cfiLocator.d.ts

@@ -1,371 +1,450 @@
-import { Context } from "../context";
-import { SpineItem } from "../spineItem/createSpineItem";
-import { createLocationResolver } from "../spineItem/locationResolver";
-import { SpineItemManager } from "../spineItemManager";
-import { Manifest } from "../types";
-export declare const createCfiLocator: ({ spineItemManager, spineItemLocator, }: {
-    spineItemManager: SpineItemManager;
-    context: Context;
-    spineItemLocator: ReturnType<typeof createLocationResolver>;
+import { Context } from "../context"
+import { SpineItem } from "../spineItem/createSpineItem"
+import { createLocationResolver } from "../spineItem/locationResolver"
+import { SpineItemManager } from "../spineItemManager"
+import { Manifest } from "../types"
+export declare const createCfiLocator: ({
+  spineItemManager,
+  spineItemLocator,
+}: {
+  spineItemManager: SpineItemManager
+  context: Context
+  spineItemLocator: ReturnType<typeof createLocationResolver>
 }) => {
-    getSpineItemFromCfi: (cfi: string) => {
-        layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
-            blankPagePosition: "after" | "before" | "none";
-            minimumWidth: number;
-            spreadPosition: "none" | "right" | "left";
+  getSpineItemFromCfi: (cfi: string) =>
+    | {
+        layout: ({
+          blankPagePosition,
+          minimumWidth,
+          spreadPosition,
+        }: {
+          blankPagePosition: "after" | "before" | "none"
+          minimumWidth: number
+          spreadPosition: "none" | "right" | "left"
         }) => {
-            width: number;
-            height: number;
-        };
+          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;
+          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;
+          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;
+          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;
-            }>;
-        };
+          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";
+          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;
-        };
+                  x: number
+                  y: number
+                }
+              }
+            | {
+                event: "fingerout"
+                data: undefined
+              }
+          >
+        }
+        getDimensionsForReflowableContent: (
+          isUsingVerticalWriting: boolean,
+          minimumWidth: number
+        ) => {
+          columnHeight: number
+          columnWidth: number
+          width: number
+        }
         getDimensionsForPaginatedContent: () => {
-            columnHeight: number;
-            columnWidth: number;
-        };
+          columnHeight: number
+          columnWidth: number
+        }
         $: {
-            contentLayout$: import("rxjs").Observable<{
-                isFirstLayout: boolean;
-                isReady: boolean;
-            }>;
-            loaded$: import("rxjs").Observable<HTMLIFrameElement>;
-            isReady$: import("rxjs").Observable<boolean>;
-        };
-    } | undefined;
-    getCfiMetaInformation: (cfi: string) => {
-        spineItemIndex: number | undefined;
-    } | undefined;
-    getCfi: ((pageIndex: number, spineItem: SpineItem) => string) | ((pageIndex: 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;
+          contentLayout$: import("rxjs").Observable<{
+            isFirstLayout: boolean
+            isReady: boolean
+          }>
+          loaded$: import("rxjs").Observable<HTMLIFrameElement>
+          isReady$: import("rxjs").Observable<boolean>
+        }
+      }
+    | undefined
+  getCfiMetaInformation: (cfi: string) =>
+    | {
+        spineItemIndex: number | undefined
+      }
+    | undefined
+  getCfi:
+    | ((pageIndex: number, spineItem: SpineItem) => string)
+    | ((
+        pageIndex: 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;
-        };
-        $: {
+              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>;
-        };
-    }) => string);
-    getRootCfi: (spineItem: SpineItem) => string;
-    resolveCfi: (cfiString: string) => {
-        node: Node | undefined;
-        offset: number | undefined;
-        spineItemIndex: number;
-    } | {
-        spineItemIndex: number;
-        node?: undefined;
-        offset?: undefined;
-    } | undefined;
-    generateFromRange: ({ startNode, start, end, endNode }: {
-        startNode: Node;
-        start: number;
-        endNode: Node;
-        end: number;
-    }, item: Manifest[`spineItems`][number]) => {
-        start: string;
-        end: string;
-    };
-};
+              isFirstLayout: boolean
+              isReady: boolean
+            }>
+            loaded$: import("rxjs").Observable<HTMLIFrameElement>
+            isReady$: import("rxjs").Observable<boolean>
+          }
+        }
+      ) => string)
+  getRootCfi: (spineItem: SpineItem) => string
+  resolveCfi: (cfiString: string) =>
+    | {
+        node: Node | undefined
+        offset: number | undefined
+        spineItemIndex: number
+      }
+    | {
+        spineItemIndex: number
+        node?: undefined
+        offset?: undefined
+      }
+    | undefined
+  generateFromRange: (
+    {
+      startNode,
+      start,
+      end,
+      endNode,
+    }: {
+      startNode: Node
+      start: number
+      endNode: Node
+      end: number
+    },
+    item: Manifest[`spineItems`][number]
+  ) => {
+    start: string
+    end: string
+  }
+}