@prose-reader/core 1.41.0 → 1.42.0

package/dist/spineItemManager.d.ts

@@ -1,550 +0,0 @@
-import { Context } from "./context";
-import { SpineItem } from "./spineItem/createSpineItem";
-export declare const createSpineItemManager: ({ context }: {
-    context: Context;
-}) => {
-    destroyItems: () => void;
-    add: (spineItem: SpineItem) => void;
-    get: (indexOrId: number | string) => {
-        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;
-    getAll: () => {
-        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>;
-        };
-    }[];
-    getLength: () => number;
-    layout: () => void;
-    focus: (indexOrSpineItem: number | SpineItem) => void;
-    loadContents: ((rangeOfIndex: [number, number]) => void) | ((rangeOfIndex: [number, number]) => void);
-    comparePositionOf: (toCompare: SpineItem, withItem: SpineItem) => "after" | "before";
-    getAbsolutePositionOf: (spineItemOrIndex: SpineItem | number) => {
-        left: number;
-        right: number;
-        top: number;
-        bottom: number;
-        width: number;
-        height: number;
-    };
-    getFocusedSpineItem: () => {
-        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;
-    getFocusedSpineItemIndex: () => number | undefined;
-    getSpineItemIndex: (spineItem: SpineItem | undefined) => number | undefined;
-    destroy: () => void;
-    $: {
-        focus$: import("rxjs").Observable<{
-            data: SpineItem;
-        }>;
-        layout$: import("rxjs").Observable<boolean>;
-        itemIsReady$: import("rxjs").Observable<{
-            item: {
-                id: string;
-                href: string;
-                renditionLayout: "reflowable" | "pre-paginated";
-                progressionWeight: number;
-                pageSpreadLeft: true | undefined;
-                pageSpreadRight: true | undefined;
-                mediaType?: string | undefined;
-            };
-            isReady: boolean;
-        }>;
-    };
-};
-export type SpineItemManager = ReturnType<typeof createSpineItemManager>;

package/dist/types/Hook.d.ts

@@ -1,73 +0,0 @@
-import { Manifest } from "@prose-reader/shared";
-import { Observable } from "rxjs";
-type ItemOnLoadHook = {
-    name: `item.onLoad`;
-    fn: (manipulableFrame: {
-        frame: HTMLIFrameElement;
-        removeStyle: (id: string) => void;
-        item: Manifest[`spineItems`][number];
-        addStyle: (id: string, style: CSSStyleDeclaration[`cssText`]) => void;
-    }) => (() => void) | Observable<unknown> | void;
-};
-export type Hook = ItemOnLoadHook | {
-    name: `item.onBeforeContainerCreated`;
-    fn: (payload: HTMLElement) => HTMLElement;
-} | {
-    name: `item.onLayoutBeforeMeasurement`;
-    fn: (payload: {
-        frame: {
-            getManipulableFrame: () => undefined | {
-                removeStyle: (id: string) => void;
-                addStyle: (id: string, style: CSSStyleDeclaration[`cssText`]) => void;
-            };
-            getViewportDimensions: () => {
-                width: number;
-                height: number;
-            } | undefined;
-            isUsingVerticalWriting: () => boolean;
-            getIsReady: () => boolean;
-        };
-        container: HTMLElement;
-        item: Manifest[`spineItems`][number];
-        minimumWidth: number;
-        isImageType: () => boolean | undefined;
-    }) => void;
-} | {
-    name: `item.onAfterLayout`;
-    fn: (payload: {
-        item: Manifest[`spineItems`][number];
-        blankPagePosition: `before` | `after` | `none`;
-        minimumWidth: number;
-    }) => void;
-} | {
-    name: `item.onGetResource`;
-    fn: (fetchResource: (item: Manifest[`spineItems`][number]) => Promise<Response>) => (item: Manifest[`spineItems`][number]) => Promise<Response>;
-} | {
-    name: `spine.onBeforeContainerCreated`;
-    fn: (payload: HTMLElement) => HTMLElement;
-} | {
-    name: `viewportNavigator.onBeforeContainerCreated`;
-    fn: (payload: HTMLElement) => HTMLElement;
-} | {
-    name: `onViewportOffsetAdjust`;
-    fn: () => void;
-};
-export interface RegisterHook {
-    (name: `item.onBeforeContainerCreated`, fn: Extract<Hook, {
-        name: `item.onBeforeContainerCreated`;
-    }>[`fn`]): void;
-    (name: `item.onGetResource`, fn: Extract<Hook, {
-        name: `item.onGetResource`;
-    }>[`fn`]): void;
-    (name: `item.onLayoutBeforeMeasurement`, fn: Extract<Hook, {
-        name: `item.onLayoutBeforeMeasurement`;
-    }>[`fn`]): void;
-    (name: `item.onAfterLayout`, fn: Extract<Hook, {
-        name: `item.onAfterLayout`;
-    }>[`fn`]): void;
-    (name: `onViewportOffsetAdjust`, fn: Extract<Hook, {
-        name: `onViewportOffsetAdjust`;
-    }>[`fn`]): void;
-    (name: `item.onLoad`, fn: ItemOnLoadHook["fn"]): void;
-}
-export {};

package/dist/types/Spine.d.ts

@@ -1,39 +0,0 @@
-import { Observable } from "rxjs";
-import { SpineItem } from "../spineItem/createSpineItem";
-import { createSelection } from "../selection";
-import { createCfiLocator } from "../spine/cfiLocator";
-import { createLocationResolver } from "../spine/locationResolver";
-import { createLocationResolver as createSpineItemLocator } from "../spineItem/locationResolver";
-import { ViewportNavigationEntry } from "../spine/navigationResolver";
-type RequireLayout = boolean;
-type ManipulableSpineItemCallback = Parameters<SpineItem[`manipulateSpineItem`]>[0];
-type ManipulableSpineItemCallbackPayload = Parameters<ManipulableSpineItemCallback>[0];
-type CfiLocator = ReturnType<typeof createCfiLocator>;
-type SpineItemLocator = ReturnType<typeof createSpineItemLocator>;
-type Locator = ReturnType<typeof createLocationResolver>;
-type Event = {
-    type: `onSelectionChange`;
-    data: ReturnType<typeof createSelection> | null;
-};
-export type Spine = {
-    element: HTMLElement;
-    locator: Locator;
-    spineItemLocator: SpineItemLocator;
-    cfiLocator: CfiLocator;
-    normalizeEventForViewport: <E extends MouseEvent | TouchEvent | PointerEvent>(event: E) => E;
-    manipulateSpineItems: (cb: (payload: ManipulableSpineItemCallbackPayload & {
-        index: number;
-    }) => RequireLayout) => void;
-    manipulateSpineItem: (id: string, cb: Parameters<SpineItem[`manipulateSpineItem`]>[0]) => void;
-    destroy: () => void;
-    isSelecting: () => boolean | undefined;
-    getSelection: () => Selection | undefined;
-    adjustPagination: (position: ViewportNavigationEntry) => Observable<`free` | `busy`>;
-    $: {
-        $: Observable<Event>;
-        layout$: Observable<boolean>;
-        spineItems$: Observable<SpineItem[]>;
-        itemsBeforeDestroy$: Observable<void>;
-    };
-};
-export {};

package/dist/types/index.d.ts

@@ -1,11 +0,0 @@
-import type { Manifest } from "@prose-reader/shared";
-export type ViewportPosition = {
-    x: number;
-    y: number;
-};
-declare global {
-    interface Window {
-        __PROSE_READER_DEBUG?: boolean;
-    }
-}
-export { Manifest };

package/dist/utils/dom.d.ts

@@ -1,19 +0,0 @@
-export declare const isHtmlElement: (element?: Element | Node | null | EventTarget) => element is HTMLElement;
-type ViewPort = {
-    left: number;
-    right: number;
-    top: number;
-    bottom: number;
-};
-export declare const getFirstVisibleNodeForViewport: ((documentOrElement: Document | Element, viewport: ViewPort) => {
-    node: Node;
-    offset: number;
-} | undefined) | ((documentOrElement: Document | Element, viewport: ViewPort) => {
-    node: Node;
-    offset: number;
-} | undefined);
-export declare const getRangeFromNode: (node: Node, offset: number) => Range | undefined;
-export declare const isPointerEvent: (event: Event) => event is PointerEvent;
-export declare const isMouseEvent: (event: Event) => event is MouseEvent;
-export declare const isTouchEvent: (event: Event) => event is TouchEvent;
-export {};