@prose-reader/core 1.21.0 → 1.23.0

package/dist/spineItemManager.d.ts

@@ -1,6 +1,5 @@
 import { Context } from "./context";
 import { SpineItem } from "./spineItem/createSpineItem";
-import { ViewportPosition } from "./types";
 export declare const createSpineItemManager: ({ context }: {
     context: Context;
 }) => {
@@ -349,526 +348,14 @@ export declare const createSpineItemManager: ({ context }: {
     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) => {
-        leftStart: number;
-        leftEnd: number;
-        topStart: number;
-        topEnd: number;
+    getAbsolutePositionOf: (spineItemOrIndex: SpineItem | number) => {
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
         width: number;
         height: number;
-    }) | ((spineItemOrIndex: number | {
-        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>;
-        };
-    }) => {
-        leftStart: number;
-        leftEnd: number;
-        topStart: number;
-        topEnd: number;
-        width: number;
-        height: number;
-    });
-    getSpineItemAtPosition: ((position: ViewportPosition) => {
-        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: ViewportPosition) => {
-        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);
+    };
     getFocusedSpineItem: () => {
         layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
             blankPagePosition: "after" | "before" | "none";

package/dist/types/Hook.d.ts

@@ -1,14 +1,15 @@
 import { Manifest } from "@prose-reader/shared";
 import { Observable } from "rxjs";
-export type Hook = {
+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<any> | void;
-} | {
+    }) => (() => void) | Observable<unknown> | void;
+};
+export type Hook = ItemOnLoadHook | {
     name: `item.onBeforeContainerCreated`;
     fn: (payload: HTMLElement) => HTMLElement;
 } | {
@@ -52,9 +53,6 @@ export type Hook = {
     fn: () => void;
 };
 export interface RegisterHook {
-    (name: `item.onLoad`, fn: Extract<Hook, {
-        name: `item.onLoad`;
-    }>[`fn`]): void;
     (name: `item.onBeforeContainerCreated`, fn: Extract<Hook, {
         name: `item.onBeforeContainerCreated`;
     }>[`fn`]): void;
@@ -70,4 +68,6 @@ export interface RegisterHook {
     (name: `onViewportOffsetAdjust`, fn: Extract<Hook, {
         name: `onViewportOffsetAdjust`;
     }>[`fn`]): void;
+    (name: `item.onLoad`, fn: ItemOnLoadHook["fn"]): void;
 }
+export {};

package/dist/types/Spine.d.ts

@@ -1,5 +1,4 @@
 import { Observable } from "rxjs";
-import { Manifest } from "@prose-reader/shared";
 import { SpineItem } from "../spineItem/createSpineItem";
 import { createSelection } from "../selection";
 import { createCfiLocator } from "../spine/cfiLocator";
@@ -33,10 +32,7 @@ export type Spine = {
     $: {
         $: Observable<Event>;
         layout$: Observable<boolean>;
-        itemsCreated$: Observable<{
-            item: Manifest[`spineItems`][number];
-            element: HTMLElement;
-        }[]>;
+        spineItems$: Observable<SpineItem[]>;
         itemsBeforeDestroy$: Observable<void>;
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/core",
-  "version": "1.21.0",
+  "version": "1.23.0",
   "type": "module",
   "main": "./dist/prose.umd.cjs",
   "module": "./dist/prose.js",
@@ -25,7 +25,7 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@prose-reader/shared": "^1.21.0"
+    "@prose-reader/shared": "^1.23.0"
   },
   "peerDependencies": {
     "rxjs": "*"
@@ -33,5 +33,5 @@
   "devDependencies": {
     "jsdom": "^21.1.0"
   },
-  "gitHead": "5c8bc17cca9a4fe4e06997c4155c50b1cc70790c"
+  "gitHead": "3dfe1d5c5a9e3226235f8b4cc0b978f390a6e98b"
 }