@prose-reader/core 1.40.0 → 1.42.0

package/dist/spine/locationResolver.d.ts

@@ -1,697 +0,0 @@
-import { Context } from "../context";
-import { SpineItem } from "../spineItem/createSpineItem";
-import { createLocationResolver as createSpineItemLocator } from "../spineItem/locationResolver";
-import { SpineItemManager } from "../spineItemManager";
-import { SpineItemNavigationPosition, SpineItemPosition, UnsafeSpineItemPosition } from "../spineItem/types";
-import { SpinePosition, UnsafeSpinePosition } from "./types";
-export declare const createLocationResolver: ({ spineItemManager, context, spineItemLocator, }: {
-    spineItemManager: SpineItemManager;
-    context: Context;
-    spineItemLocator: ReturnType<typeof createSpineItemLocator>;
-}) => {
-    getSpinePositionFromSpineItemPosition: (spineItemPosition: SpineItemNavigationPosition | SpineItemPosition, spineItem: SpineItem) => SpinePosition;
-    getSpinePositionFromSpineItem: (spineItem: SpineItem) => SpinePosition;
-    getSpinePositionFromSpineItemAnchor: (anchor: string, spineItem: SpineItem) => SpinePosition;
-    getSpineItemPositionFromSpinePosition: ((position: UnsafeSpinePosition, spineItem: SpineItem) => UnsafeSpineItemPosition) | ((position: UnsafeSpinePosition, 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>;
-        };
-    }) => UnsafeSpineItemPosition);
-    getSpineItemFromPosition: ((position: UnsafeSpinePosition) => {
-        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) | ((position: UnsafeSpinePosition) => {
-        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);
-    getSpineItemFromIframe: (iframe: Element) => {
-        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;
-    getSpineItemPageIndexFromNode: (node: Node, offset: number | undefined, spineItemOrIndex: SpineItem | number) => number | undefined;
-    getSpineItemsFromReadingOrderPosition: (position: SpinePosition) => {
-        begin: number;
-        beginPosition: SpinePosition;
-        end: number;
-        endPosition: SpinePosition;
-    } | undefined;
-};