@prose-reader/core 0.0.36

package/dist/spineItem/index.d.ts

@@ -0,0 +1,458 @@
+import { BehaviorSubject, Observable } from "rxjs";
+import { Context } from "../context";
+import { Manifest } from "../types";
+import { Hook } from "../types/Hook";
+import { createPrePaginatedSpineItem } from "./prePaginatedSpineItem";
+import { createReflowableSpineItem } from "./reflowableSpineItem";
+export declare type SpineItem = {
+    item: Manifest[`spineItems`][number];
+} & (ReturnType<typeof createPrePaginatedSpineItem> | ReturnType<typeof createReflowableSpineItem>);
+export declare const createSpineItem: ({ item, context, containerElement, iframeEventBridgeElement, hooks$, viewportState$ }: {
+    item: Manifest[`spineItems`][number];
+    containerElement: HTMLElement;
+    iframeEventBridgeElement: HTMLElement;
+    context: Context;
+    hooks$: BehaviorSubject<Hook[]>;
+    viewportState$: Observable<`free` | `busy`>;
+}) => {
+    layout: (layoutInformation: {
+        blankPagePosition: "none" | "before" | "after";
+        minimumWidth: number;
+        spreadPosition: "none" | "right" | "left";
+    }) => {
+        width: number;
+        height: number;
+    };
+    load: () => void;
+    adjustPositionOfElement: ({ right, left, top }: {
+        right?: number | undefined;
+        left?: number | undefined;
+        top?: number | undefined;
+    }) => void;
+    createLoadingElement: (containerElement: HTMLElement, item: {
+        id: string;
+        href: string;
+        path: string;
+        renditionLayout: "reflowable" | "pre-paginated";
+        progressionWeight: number;
+        pageSpreadLeft: true | undefined;
+        pageSpreadRight: true | undefined;
+        mediaType?: string | undefined;
+    }, context: {
+        load: (newManifest: Manifest, newLoadOptions: import("../types").LoadOptions) => void;
+        isRTL: () => boolean;
+        areAllItemsPrePaginated: () => boolean;
+        destroy: () => void;
+        getLoadOptions: () => import("../types").LoadOptions | undefined;
+        getCalculatedInnerMargin: () => number;
+        getVisibleAreaRect: () => {
+            width: number;
+            height: number;
+            x: number;
+            y: number;
+        };
+        shouldDisplaySpread: () => boolean;
+        setHasVerticalWriting: () => void;
+        setVisibleAreaRect: (x: number, y: number, width: number, height: number) => void;
+        getManifest: () => Manifest | undefined;
+        getReadingDirection: () => "ltr" | "rtl" | undefined;
+        getPageSize: () => {
+            width: number;
+            height: number;
+        };
+        getSettings: () => import("../settings").PublicSettings & {
+            computedPageTurnMode: "controlled" | "scrollable";
+            computedPageTurnDirection: "vertical" | "horizontal";
+            computedPageTurnAnimation: "none" | "fade" | "slide";
+            computedPageTurnAnimationDuration: number;
+            computedSnapAnimationDuration: number;
+        };
+        setSettings: (data: Partial<import("../settings").PublicSettings>) => void;
+        $: {
+            hasVerticalWriting$: Observable<boolean>;
+            destroy$: Observable<void>;
+            settings$: Observable<import("../settings").PublicSettings & {
+                computedPageTurnMode: "controlled" | "scrollable";
+                computedPageTurnDirection: "vertical" | "horizontal";
+                computedPageTurnAnimation: "none" | "fade" | "slide";
+                computedPageTurnAnimationDuration: number;
+                computedSnapAnimationDuration: number;
+            }>;
+            load$: Observable<Manifest>;
+        };
+    }) => HTMLDivElement;
+    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;
+    loadingElement: HTMLDivElement;
+    isReflowable: boolean;
+    getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
+    getViewPortInformation: () => {
+        computedScale: number;
+        computedWidthScale: number;
+        viewportDimensions: {
+            width: number;
+            height: number;
+        };
+    } | {
+        width?: number | undefined;
+        height?: number | undefined;
+        computedScale: number;
+        computedWidthScale: number;
+        viewportDimensions?: undefined;
+    };
+    isImageType: () => boolean | undefined;
+    isReady: () => boolean;
+    destroy: () => void;
+    isUsingVerticalWriting: () => boolean | undefined;
+    getReadingDirection: () => "ltr" | "rtl" | undefined;
+    manipulateSpineItem: (cb: (options: {
+        container: HTMLElement;
+        loadingElement: HTMLElement;
+        item: {
+            id: string;
+            href: string;
+            path: 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;
+    executeOnLayoutBeforeMeasurmentHook: (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;
+        }>;
+    };
+    $: {
+        contentLayoutChangeSubject$: Observable<{
+            isFirstLayout: boolean;
+            isReady: boolean;
+        }>;
+        loaded$: Observable<HTMLIFrameElement>;
+    };
+    item: {
+        id: string;
+        href: string;
+        path: string;
+        renditionLayout: "reflowable" | "pre-paginated";
+        progressionWeight: number;
+        pageSpreadLeft: true | undefined;
+        pageSpreadRight: true | undefined;
+        mediaType?: string | undefined;
+    };
+} | {
+    isReflowable: boolean;
+    layout: ({ blankPagePosition, minimumWidth }: {
+        blankPagePosition: "none" | "before" | "after";
+        minimumWidth: number;
+    }) => {
+        width: number;
+        height: number;
+    };
+    load: () => void;
+    adjustPositionOfElement: ({ right, left, top }: {
+        right?: number | undefined;
+        left?: number | undefined;
+        top?: number | undefined;
+    }) => void;
+    createLoadingElement: (containerElement: HTMLElement, item: {
+        id: string;
+        href: string;
+        path: string;
+        renditionLayout: "reflowable" | "pre-paginated";
+        progressionWeight: number;
+        pageSpreadLeft: true | undefined;
+        pageSpreadRight: true | undefined;
+        mediaType?: string | undefined;
+    }, context: {
+        load: (newManifest: Manifest, newLoadOptions: import("../types").LoadOptions) => void;
+        isRTL: () => boolean;
+        areAllItemsPrePaginated: () => boolean;
+        destroy: () => void;
+        getLoadOptions: () => import("../types").LoadOptions | undefined;
+        getCalculatedInnerMargin: () => number;
+        getVisibleAreaRect: () => {
+            width: number;
+            height: number;
+            x: number;
+            y: number;
+        };
+        shouldDisplaySpread: () => boolean;
+        setHasVerticalWriting: () => void;
+        setVisibleAreaRect: (x: number, y: number, width: number, height: number) => void;
+        getManifest: () => Manifest | undefined;
+        getReadingDirection: () => "ltr" | "rtl" | undefined;
+        getPageSize: () => {
+            width: number;
+            height: number;
+        };
+        getSettings: () => import("../settings").PublicSettings & {
+            computedPageTurnMode: "controlled" | "scrollable";
+            computedPageTurnDirection: "vertical" | "horizontal";
+            computedPageTurnAnimation: "none" | "fade" | "slide";
+            computedPageTurnAnimationDuration: number;
+            computedSnapAnimationDuration: number;
+        };
+        setSettings: (data: Partial<import("../settings").PublicSettings>) => void;
+        $: {
+            hasVerticalWriting$: Observable<boolean>;
+            destroy$: Observable<void>;
+            settings$: Observable<import("../settings").PublicSettings & {
+                computedPageTurnMode: "controlled" | "scrollable";
+                computedPageTurnDirection: "vertical" | "horizontal";
+                computedPageTurnAnimation: "none" | "fade" | "slide";
+                computedPageTurnAnimationDuration: number;
+                computedSnapAnimationDuration: number;
+            }>;
+            load$: Observable<Manifest>;
+        };
+    }) => HTMLDivElement;
+    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;
+    loadingElement: HTMLDivElement;
+    getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
+    getViewPortInformation: () => {
+        computedScale: number;
+        computedWidthScale: number;
+        viewportDimensions: {
+            width: number;
+            height: number;
+        };
+    } | {
+        width?: number | undefined;
+        height?: number | undefined;
+        computedScale: number;
+        computedWidthScale: number;
+        viewportDimensions?: undefined;
+    };
+    isImageType: () => boolean | undefined;
+    isReady: () => boolean;
+    destroy: () => void;
+    isUsingVerticalWriting: () => boolean | undefined;
+    getReadingDirection: () => "ltr" | "rtl" | undefined;
+    manipulateSpineItem: (cb: (options: {
+        container: HTMLElement;
+        loadingElement: HTMLElement;
+        item: {
+            id: string;
+            href: string;
+            path: 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;
+    executeOnLayoutBeforeMeasurmentHook: (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;
+        }>;
+    };
+    $: {
+        contentLayoutChangeSubject$: Observable<{
+            isFirstLayout: boolean;
+            isReady: boolean;
+        }>;
+        loaded$: Observable<HTMLIFrameElement>;
+    };
+    item: {
+        id: string;
+        href: string;
+        path: string;
+        renditionLayout: "reflowable" | "pre-paginated";
+        progressionWeight: number;
+        pageSpreadLeft: true | undefined;
+        pageSpreadRight: true | undefined;
+        mediaType?: string | undefined;
+    };
+};

package/dist/spineItem/locationResolver.d.ts

@@ -0,0 +1,27 @@
+import { Context } from "../context";
+import { SpineItem } from "./createSpineItem";
+declare type SpineItemPosition = {
+    x: number;
+    y: number;
+};
+export declare const createLocationResolver: ({ context }: {
+    context: Context;
+}) => {
+    getSpineItemPositionFromNode: (node: Node, offset: number, spineItem: SpineItem) => {
+        x: number;
+        y: number;
+    } | undefined;
+    getSpineItemPositionFromPageIndex: (pageIndex: number, spineItem: SpineItem) => SpineItemPosition;
+    getSpineItemOffsetFromAnchor: (anchor: string, spineItem: SpineItem) => number;
+    getSpineItemPageIndexFromPosition: (position: SpineItemPosition, spineItem: SpineItem) => number;
+    getSpineItemPageIndexFromNode: (node: Node, offset: number, spineItem: SpineItem) => number | undefined;
+    getSpineItemClosestPositionFromUnsafePosition: (unsafePosition: SpineItemPosition, spineItem: SpineItem) => {
+        x: number;
+        y: number;
+    };
+    getFirstNodeOrRangeAtPage: (pageIndex: number, spineItem: SpineItem) => {
+        node: Node;
+        offset: number;
+    } | undefined;
+};
+export {};

package/dist/spineItem/navigationResolver.d.ts

@@ -0,0 +1,23 @@
+import { SpineItem } from "./createSpineItem";
+import { Context } from "../context";
+declare type SpineItemPosition = {
+    x: number;
+    y: number;
+};
+export declare const createNavigationResolver: ({ context }: {
+    context: Context;
+}) => {
+    getNavigationForLeftPage: (position: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
+    getNavigationForRightPage: (position: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
+    getNavigationForLastPage: (spineItem: SpineItem) => SpineItemPosition;
+    getNavigationForPage: (pageIndex: number, spineItem: SpineItem) => SpineItemPosition;
+    getNavigationForPosition: (spineItem: SpineItem, position: SpineItemPosition) => {
+        x: number;
+        y: number;
+    };
+    getNavigationFromNode: (spineItem: SpineItem, node: Node, offset: number) => {
+        x: number;
+        y: number;
+    };
+};
+export {};