@prose-reader/core 1.24.0 → 1.25.0

package/dist/types/Hook.d.ts

@@ -1,73 +1,117 @@
-import { Manifest } from "@prose-reader/shared";
-import { Observable } from "rxjs";
+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: {
+  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;
-};
+          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;
+  (
+    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 {};
+export {}

package/dist/types/Spine.d.ts

@@ -1,39 +1,43 @@
-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>;
+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;
-};
+  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 {};
+  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 +1,11 @@
-import type { Manifest } from "@prose-reader/shared";
+import type { Manifest } from "@prose-reader/shared"
 export type ViewportPosition = {
-    x: number;
-    y: number;
-};
+  x: number
+  y: number
+}
 declare global {
-    interface Window {
-        __PROSE_READER_DEBUG?: boolean;
-    }
+  interface Window {
+    __PROSE_READER_DEBUG?: boolean
+  }
 }
-export { Manifest };
+export { Manifest }

package/dist/utils/dom.d.ts

@@ -1,19 +1,31 @@
-export declare const isHtmlElement: (element?: Element | Node | null | EventTarget) => element is HTMLElement;
+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 {};
+  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 {}

package/dist/utils/layout.d.ts

@@ -1,7 +1,12 @@
-export declare const getNewScaledOffset: ({ newScale, oldScale, screenSize, scrollOffset, }: {
-    screenSize: number;
-    pageSize: number;
-    scrollOffset: number;
-    newScale: number;
-    oldScale: number;
-}) => number;
+export declare const getNewScaledOffset: ({
+  newScale,
+  oldScale,
+  screenSize,
+  scrollOffset,
+}: {
+  screenSize: number
+  pageSize: number
+  scrollOffset: number
+  newScale: number
+  oldScale: number
+}) => number

package/dist/utils/manifest.d.ts

@@ -1,2 +1,2 @@
-import { Manifest } from "@prose-reader/shared";
-export declare const getCoverItem: (manifest: Manifest) => number;
+import { Manifest } from "@prose-reader/shared"
+export declare const getCoverItem: (manifest: Manifest) => number

package/dist/utils/objects.d.ts

@@ -1,6 +1,12 @@
-export declare const is: (x: any, y: any) => boolean;
-export declare const isShallowEqual: <T = any, R = any>(objectA: T, objectB: R, options?: {
-    customEqual?: (<T_1>(a: T_1, b: T_1) => boolean) | undefined;
-} | undefined) => boolean;
-export declare const groupBy: <T, K extends string | number | symbol>(list: T[], getKey: (item: T) => K) => Record<K, T[]>;
-export declare const getBase64FromBlob: (data: Blob) => Promise<string>;
+export declare const is: (x: any, y: any) => boolean
+export declare const isShallowEqual: <T = any, R = any>(
+  objectA: T,
+  objectB: R,
+  options?:
+    | {
+        customEqual?: (<T_1>(a: T_1, b: T_1) => boolean) | undefined
+      }
+    | undefined
+) => boolean
+export declare const groupBy: <T, K extends string | number | symbol>(list: T[], getKey: (item: T) => K) => Record<K, T[]>
+export declare const getBase64FromBlob: (data: Blob) => Promise<string>

package/dist/utils/rxjs.d.ts

@@ -1,4 +1,9 @@
-import { OperatorFunction } from "rxjs";
-export declare const mapKeysTo: <R extends {
-    [key: string]: any;
-}, K extends keyof R>(keys: K[]) => OperatorFunction<R, Pick<R, K>>;
+import { OperatorFunction } from "rxjs"
+export declare const mapKeysTo: <
+  R extends {
+    [key: string]: any
+  },
+  K extends keyof R
+>(
+  keys: K[]
+) => OperatorFunction<R, Pick<R, K>>