@prose-reader/core 0.0.36

package/dist/spine/viewportNavigator/scrollViewportNavigator.d.ts

@@ -0,0 +1,23 @@
+import { BehaviorSubject, Observable } from "rxjs";
+import { Context } from "../../context";
+import { createNavigationResolver, ViewportNavigationEntry } from "../navigationResolver";
+export declare const createScrollViewportNavigator: ({ context, element, navigator, currentNavigationSubject$ }: {
+    context: Context;
+    element: HTMLElement;
+    navigator: ReturnType<typeof createNavigationResolver>;
+    currentNavigationSubject$: BehaviorSubject<ViewportNavigationEntry>;
+}) => {
+    destroy: () => void;
+    adjustReadingOffset: ({ x, y }: {
+        x: number;
+        y: number;
+    }) => boolean;
+    $: {
+        state$: Observable<string>;
+        navigation$: Observable<{
+            position: ViewportNavigationEntry;
+            animate: boolean;
+            lastUserExpectedNavigation: undefined;
+        }>;
+    };
+};

package/dist/spine/viewportNavigator/viewportNavigator.d.ts

@@ -0,0 +1,85 @@
+import { Context } from "../../context";
+import { Pagination } from "../../pagination";
+import { SpineItemManager } from "../../spineItemManager";
+import { createLocationResolver } from "../locationResolver";
+import { ViewportNavigationEntry } from "../navigationResolver";
+import { Observable } from "rxjs";
+import { SpineItem } from "../../spineItem/createSpineItem";
+import { createCfiLocator } from "../cfiLocator";
+import { Hook } from "../../types/Hook";
+export declare const createViewportNavigator: ({ spineItemManager, context, pagination, element, cfiLocator, locator, hooks$ }: {
+    spineItemManager: SpineItemManager;
+    pagination: Pagination;
+    context: Context;
+    element: HTMLElement;
+    cfiLocator: ReturnType<typeof createCfiLocator>;
+    locator: ReturnType<typeof createLocationResolver>;
+    hooks$: Observable<Hook[]>;
+}) => {
+    destroy: () => void;
+    layout: () => void;
+    getCurrentNavigationPosition: () => ViewportNavigationEntry;
+    getCurrentViewportPosition: (() => {
+        x: number;
+        y: number;
+    }) | (() => {
+        x: number;
+        y: number;
+    });
+    turnLeft: ({ allowSpineItemChange }?: {
+        allowSpineItemChange?: boolean | undefined;
+    }) => void;
+    turnRight: ({ allowSpineItemChange }?: {
+        allowSpineItemChange?: boolean | undefined;
+    }) => void;
+    goToPage: (pageIndex: number) => void;
+    goToSpineItem: (indexOrId: string | number, options?: {
+        animate: boolean;
+    }) => void;
+    goToUrl: (url: string | URL) => void;
+    goToCfi: (cfi: string, options?: {
+        animate: boolean;
+    }) => void;
+    goToPageOfCurrentChapter: (pageIndex: number) => void;
+    adjustNavigation: (spineItem: SpineItem) => Observable<{
+        previousNavigationPosition: ViewportNavigationEntry;
+        adjustedSpinePosition: ViewportNavigationEntry;
+        areDifferent: boolean;
+    }>;
+    moveTo: ((delta: {
+        x: number;
+        y: number;
+    } | undefined, { final, start }?: {
+        start?: boolean | undefined;
+        final?: boolean | undefined;
+    }) => void) | ((args_0: {
+        x: number;
+        y: number;
+    } | undefined, args_1?: {
+        start?: boolean | undefined;
+        final?: boolean | undefined;
+    } | undefined) => void);
+    getLastUserExpectedNavigation: () => {
+        type: `navigate-from-previous-item`;
+    } | {
+        type: `navigate-from-next-item`;
+    } | {
+        type: `navigate-from-cfi`;
+        data: string;
+    } | {
+        type: `navigate-from-anchor`;
+        data: string;
+    } | undefined;
+    $: {
+        state$: Observable<"free" | "busy">;
+        navigation$: Observable<{
+            position: {
+                x: number;
+                y: number;
+                spineItem?: SpineItem;
+            };
+            triggeredBy: `manual` | `adjust` | `scroll`;
+            animation: false | `turn` | `snap`;
+        }>;
+    };
+};

package/dist/spineItem/commonSpineItem.d.ts

@@ -0,0 +1,160 @@
+import { Context } from "../context";
+import { Manifest } from "../types";
+import { BehaviorSubject, Observable } from "rxjs";
+import { Hook } from "../types/Hook";
+import { createFrameManipulator } from "./frameItem/createFrameManipulator";
+export declare const createCommonSpineItem: ({ item, context, parentElement, iframeEventBridgeElement, hooks$, viewportState$ }: {
+    item: Manifest[`spineItems`][number];
+    parentElement: HTMLElement;
+    iframeEventBridgeElement: HTMLElement;
+    context: Context;
+    hooks$: BehaviorSubject<Hook[]>;
+    viewportState$: Observable<`free` | `busy`>;
+}) => {
+    load: () => void;
+    layout: ({ height, width }: {
+        height: number;
+        width: number;
+    }) => void;
+    adjustPositionOfElement: ({ right, left, top }: {
+        right?: number | undefined;
+        left?: number | undefined;
+        top?: number | undefined;
+    }) => void;
+    createLoadingElement: (containerElement: HTMLElement, item: Manifest[`spineItems`][number], context: Context) => 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: Manifest[`spineItems`][number];
+        overlayElement: HTMLDivElement;
+    } & ({
+        frame: HTMLIFrameElement;
+        removeStyle: (id: string) => void;
+        addStyle: (id: string, style: string, prepend?: boolean) => void;
+    } | {
+        frame: undefined;
+        removeStyle: (id: string) => void;
+        addStyle: (id: string, style: string) => void;
+    })) => boolean) => boolean;
+    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>;
+    };
+};