@prose-reader/core 1.228.0 → 1.230.0

package/dist/reader.d.ts

@@ -97,7 +97,9 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
     spineItemsObserver: SpineItemsObserver;
     spineItemsManager: SpineItemsManager;
     layout: () => void;
-    load: (options: Required<Pick<ContextState, "manifest" | "containerElement">>) => void;
+    load: (options: Required<Pick<ContextState, "manifest"> & {
+        containerElement: HTMLElement;
+    }>) => void;
     destroy: () => void;
     pagination: {
         readonly state: PaginationInfo;
@@ -105,7 +107,7 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
     };
     settings: SettingsInterface<NonNullable<CoreInputSettings>, NonNullable< CoreOutputSettings | undefined>>;
     viewport: Viewport;
-    element$: Observable<HTMLElement>;
+    element$: Observable<HTMLElement | undefined>;
     viewportState$: Observable<"free" | "busy">;
     viewportFree$: Observable<"free">;
     state$: Observable<"idle" | "ready">;

package/dist/spine/Pages.d.ts

@@ -1,5 +1,6 @@
 import { Observable } from 'rxjs';
 import { Context } from '../context/Context';
+import { SpineItem } from '../spineItem/SpineItem';
 import { SpineItemLocator } from '../spineItem/locationResolver';
 import { SpineItemPageLayout } from '../spineItem/types';
 import { ReactiveEntity } from '../utils/ReactiveEntity';
@@ -38,5 +39,6 @@ export declare class Pages extends ReactiveEntity<State> {
     readonly viewport: Viewport;
     readonly layout$: Observable<State>;
     constructor(spineLayout: SpineLayout, spineItemsManager: SpineItemsManager, spineItemLocator: SpineItemLocator, context: Context, locator: SpineLocator, viewport: Viewport);
+    fromSpineItemPageIndex: (spineItem: SpineItem, pageIndex: number) => PageEntry | undefined;
 }
 export {};

package/dist/spine/Spine.d.ts

@@ -16,7 +16,7 @@ import { SpineLocator } from './locator/SpineLocator';
 import { SpineItemSpineLayout, SpineItemPageSpineLayout } from './types';
 import { SpineItemPageLayout } from '..';
 export declare class Spine extends DestroyableClass {
-    protected parentElement$: Observable<HTMLElement>;
+    protected parentElement$: Observable<HTMLElement | undefined>;
     protected context: Context;
     protected pagination: Pagination;
     spineItemsManager: SpineItemsManager;
@@ -24,15 +24,15 @@ export declare class Spine extends DestroyableClass {
     protected settings: ReaderSettingsManager;
     protected hookManager: HookManager;
     protected viewport: Viewport;
-    protected elementSubject: BehaviorSubject<HTMLElement>;
+    protected elementSubject: BehaviorSubject<HTMLElement | undefined>;
     protected spineLayout: SpineLayout;
     readonly spineItemsLoader: SpineItemsLoader;
     locator: SpineLocator;
     spineItemsObserver: SpineItemsObserver;
     pages: Pages;
-    element$: Observable<HTMLElement>;
-    constructor(parentElement$: Observable<HTMLElement>, context: Context, pagination: Pagination, spineItemsManager: SpineItemsManager, spineItemLocator: ReturnType<typeof createSpineItemLocationResolver>, settings: ReaderSettingsManager, hookManager: HookManager, viewport: Viewport);
-    get element(): HTMLElement;
+    element$: Observable<HTMLElement | undefined>;
+    constructor(parentElement$: Observable<HTMLElement | undefined>, context: Context, pagination: Pagination, spineItemsManager: SpineItemsManager, spineItemLocator: ReturnType<typeof createSpineItemLocationResolver>, settings: ReaderSettingsManager, hookManager: HookManager, viewport: Viewport);
+    get element(): HTMLElement | undefined;
     layout(): void;
     getSpineItemSpineLayoutInfo(spineItemOrIndex: SpineItem | number | string | undefined): SpineItemSpineLayout;
     get layout$(): Observable<{

package/dist/spine/locator/SpineLocator.d.ts

@@ -7,10 +7,11 @@ import { Viewport } from '../../viewport/Viewport';
 import { ViewportSlicePosition } from '../../viewport/types';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
-import { SpinePosition } from '../types';
+import { SpinePosition, UnsafeSpinePosition } from '../types';
 import { getAbsolutePageIndexFromPageIndex } from './getAbsolutePageIndexFromPageIndex';
 import { getSpineInfoFromAbsolutePageIndex } from './getSpineInfoFromAbsolutePageIndex';
 import { getVisibleSpineItemsFromPosition } from './getVisibleSpineItemsFromPosition';
+import { UnsafeSpineItemPagePosition } from '../..';
 export type SpineLocator = ReturnType<typeof createSpineLocator>;
 export declare const createSpineLocator: ({ spineItemsManager, context, spineItemLocator, settings, spineLayout, viewport, }: {
     spineItemsManager: SpineItemsManager;
@@ -24,15 +25,24 @@ export declare const createSpineLocator: ({ spineItemsManager, context, spineIte
         spineItemPosition: SpineItemPosition;
         spineItem: SpineItem;
     }) => SpinePosition;
-    getAbsolutePageIndexFromPageIndex: (params: Omit<Parameters<typeof getAbsolutePageIndexFromPageIndex>[0], "context" | "settings" | "spineLayout" | "spineItemsManager">) => number | undefined;
+    _getAbsolutePageIndexFromPageIndex: (params: Omit<Parameters<typeof getAbsolutePageIndexFromPageIndex>[0], "context" | "settings" | "spineLayout" | "spineItemsManager">) => number | undefined;
     getSpineInfoFromAbsolutePageIndex: (params: Omit<Parameters<typeof getSpineInfoFromAbsolutePageIndex>[0], "context" | "settings" | "spineLayout" | "spineItemsManager">) => {
         spineItem: SpineItem;
         pageIndex: number;
         itemIndex: number;
         currentAbsolutePage: number;
     } | undefined;
+    getSpineItemPagePositionFromSpinePosition: (spinePosition: UnsafeSpinePosition | SpinePosition) => {
+        spineItem: SpineItem;
+        spineItemPageIndex: number;
+        spineItemPagePosition: UnsafeSpineItemPagePosition;
+        pageSize: {
+            width: number;
+            height: number;
+        };
+    } | undefined;
     getSpinePositionFromSpineItem: (spineItem: SpineItem) => SpinePosition;
-    getSpineItemPositionFromSpinePosition: (position: SpinePosition, spineItem: SpineItem) => SpineItemPosition;
+    getSpineItemPositionFromSpinePosition: (position: SpinePosition | UnsafeSpinePosition, spineItem: SpineItem) => SpineItemPosition;
     getSpineItemFromPosition: (position: SpinePosition) => SpineItem | undefined;
     getSpineItemFromIframe: (iframe: Element) => SpineItem | undefined;
     getSpineItemPageIndexFromNode: (node: Node, offset: number | undefined, spineItemOrIndex: SpineItem | number) => number | undefined;
@@ -67,14 +77,15 @@ export declare const createSpineLocator: ({ spineItemsManager, context, spineIte
             pageIndex: number;
             spineItem: SpineItem;
         }) => SpineItemPosition;
-        getSpineItemPageIndexFromPosition: ({ itemWidth, itemHeight, position, isUsingVerticalWriting, }: {
-            itemWidth: number;
-            itemHeight: number;
+        getSpineItemPageIndexFromPosition: (params: {
             position: SpineItemPosition;
             isUsingVerticalWriting: boolean;
+            itemWidth: number;
+            itemHeight: number;
         }) => number;
         getSpineItemPageIndexFromNode: (node: Node, offset: number, spineItem: SpineItem) => number | undefined;
         getSpineItemClosestPositionFromUnsafePosition: (unsafePosition: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
+        getSpineItemPagePositionFromSpineItemPosition: (position: SpineItemPosition, pageIndex: number, spineItem: SpineItem) => UnsafeSpineItemPagePosition;
     };
     getSafeSpineItemPositionFromUnsafeSpineItemPosition: (unsafePosition: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
 };

package/dist/spine/locator/getSpineItemFromPosition.d.ts

@@ -1,12 +1,10 @@
 import { DeprecatedViewportPosition } from '../../navigation/types';
-import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
-import { SpinePosition } from '../types';
+import { SpinePosition, UnsafeSpinePosition } from '../types';
 import { SpineItem } from '../..';
-export declare const getSpineItemFromPosition: ({ position, spineItemsManager, spineLayout, settings, }: {
-    position: DeprecatedViewportPosition | SpinePosition;
+export declare const getSpineItemFromPosition: ({ position, spineItemsManager, spineLayout, }: {
+    position: DeprecatedViewportPosition | SpinePosition | UnsafeSpinePosition;
     spineItemsManager: SpineItemsManager;
     spineLayout: SpineLayout;
-    settings: ReaderSettingsManager;
 }) => SpineItem | undefined;

package/dist/spine/locator/getVisibleSpineItemsFromPosition.d.ts

@@ -4,7 +4,7 @@ import { Viewport } from '../../viewport/Viewport';
 import { SpineItemsManager } from '../SpineItemsManager';
 import { SpineLayout } from '../SpineLayout';
 import { SpinePosition } from '../types';
-export declare const getVisibleSpineItemsFromPosition: ({ position, threshold, restrictToScreen, spineItemsManager, settings, spineLayout, useAbsoluteViewport, viewport, }: {
+export declare const getVisibleSpineItemsFromPosition: ({ position, threshold, restrictToScreen, spineItemsManager, spineLayout, useAbsoluteViewport, viewport, }: {
     position: DeprecatedViewportPosition | SpinePosition;
     threshold: {
         type: "percentage";

package/dist/spine/types.d.ts

@@ -5,22 +5,18 @@ export declare class SpineItemSpineLayout extends LayoutEntry {
 export declare class SpineItemPageSpineLayout extends LayoutEntry {
     readonly __symbol = "SpineItemPageSpineLayout";
 }
-export declare class SpinePosition {
+export declare class AbstractSpinePosition {
     readonly x: number;
     readonly y: number;
-    readonly __symbol = "SpinePosition";
     constructor(position: {
         x: number;
         y: number;
     });
 }
-export declare class UnsafeSpinePosition {
-    readonly x: number;
-    readonly y: number;
+export declare class SpinePosition extends AbstractSpinePosition {
+    readonly __symbol = "SpinePosition";
+}
+export declare class UnsafeSpinePosition extends AbstractSpinePosition {
     readonly __symbol = "UnsafeSpinePosition";
-    constructor(position: {
-        x: number;
-        y: number;
-    });
     static from(position: SpinePosition): UnsafeSpinePosition;
 }

package/dist/spineItem/layout/getPageFromOffset.d.ts

@@ -0,0 +1 @@
+export declare const getPageFromOffset: (offset: number, pageWidth: number, numberOfPages: number) => number;

package/dist/spineItem/layout/getPageFromOffset.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/spineItem/layout/getSafePosition.d.ts

@@ -0,0 +1,6 @@
+import { SpineItemPosition } from '../types';
+export declare const getSafePosition: ({ itemWidth, itemHeight, spineItemPosition, }: {
+    spineItemPosition: SpineItemPosition;
+    itemWidth: number;
+    itemHeight: number;
+}) => SpineItemPosition;

package/dist/spineItem/layout/getSpineItemNumberOfPages.d.ts

@@ -1,9 +1,9 @@
-import { Context } from '../../context/Context';
-import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
-export declare const getSpineItemNumberOfPages: ({ itemHeight, itemWidth, isUsingVerticalWriting, settings, context, }: {
+export declare const getSpineItemNumberOfPages: ({ itemHeight, itemWidth, isUsingVerticalWriting, pageWidth, pageHeight, pageTurnDirection, pageTurnMode, }: {
     itemWidth: number;
     itemHeight: number;
     isUsingVerticalWriting: boolean;
-    settings: ReaderSettingsManager;
-    context: Context;
+    pageWidth: number;
+    pageHeight: number;
+    pageTurnDirection: "vertical" | "horizontal";
+    pageTurnMode: "scrollable" | "controlled";
 }) => number;

package/dist/spineItem/layout/getSpineItemPageIndexFromSpineItemPosition.d.ts

@@ -0,0 +1,12 @@
+import { SpineItemPosition } from '../types';
+export declare const getSpineItemPageIndexFromSpineItemPosition: ({ itemWidth, itemHeight, position, isUsingVerticalWriting, pageWidth, pageHeight, pageTurnDirection, pageTurnMode, isRTL, }: {
+    itemWidth: number;
+    itemHeight: number;
+    position: SpineItemPosition;
+    isUsingVerticalWriting: boolean;
+    pageWidth: number;
+    pageHeight: number;
+    pageTurnDirection: "vertical" | "horizontal";
+    pageTurnMode: "scrollable" | "controlled";
+    isRTL: boolean;
+}) => number;

package/dist/spineItem/layout/getSpineItemPageIndexFromSpineItemPosition.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/spineItem/locationResolver.d.ts

@@ -1,7 +1,7 @@
 import { Context } from '../context/Context';
 import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
 import { SpineItem } from './SpineItem';
-import { SpineItemPosition } from './types';
+import { SpineItemPosition, UnsafeSpineItemPagePosition } from './types';
 export type SpineItemLocator = ReturnType<typeof createSpineItemLocator>;
 export declare const createSpineItemLocator: ({ context, settings, }: {
     context: Context;
@@ -12,12 +12,13 @@ export declare const createSpineItemLocator: ({ context, settings, }: {
         pageIndex: number;
         spineItem: SpineItem;
     }) => SpineItemPosition;
-    getSpineItemPageIndexFromPosition: ({ itemWidth, itemHeight, position, isUsingVerticalWriting, }: {
-        itemWidth: number;
-        itemHeight: number;
+    getSpineItemPageIndexFromPosition: (params: {
         position: SpineItemPosition;
         isUsingVerticalWriting: boolean;
+        itemWidth: number;
+        itemHeight: number;
     }) => number;
     getSpineItemPageIndexFromNode: (node: Node, offset: number, spineItem: SpineItem) => number | undefined;
     getSpineItemClosestPositionFromUnsafePosition: (unsafePosition: SpineItemPosition, spineItem: SpineItem) => SpineItemPosition;
+    getSpineItemPagePositionFromSpineItemPosition: (position: SpineItemPosition, pageIndex: number, spineItem: SpineItem) => UnsafeSpineItemPagePosition;
 };

package/dist/spineItem/types.d.ts

@@ -27,6 +27,15 @@ export declare class SpineItemPosition {
         y: number;
     });
 }
+export declare class UnsafeSpineItemPagePosition {
+    readonly x: number;
+    readonly y: number;
+    readonly __symbol: symbol;
+    constructor(position: {
+        x: number;
+        y: number;
+    });
+}
 export declare class SpineItemPageLayout extends LayoutEntry {
     readonly __symbol = "SpineItemPageLayout";
 }

package/dist/utils/coordinates.d.ts

@@ -0,0 +1,7 @@
+export declare const getPositionRelativeToNonTransformedElement: (position: {
+    x: number;
+    y: number;
+}, element: HTMLElement) => {
+    x: number;
+    y: number;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/core",
-  "version": "1.228.0",
+  "version": "1.230.0",
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",
@@ -23,8 +23,8 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@prose-reader/cfi": "^1.228.0",
-    "@prose-reader/shared": "^1.228.0"
+    "@prose-reader/cfi": "^1.230.0",
+    "@prose-reader/shared": "^1.230.0"
   },
   "peerDependencies": {
     "rxjs": "*"
@@ -39,5 +39,5 @@
       }
     }
   },
-  "gitHead": "f38af897428bb229420eab2bfa2e396d2a13e807"
+  "gitHead": "7480c7ac7f90c58487609f1f8b31f47ee44f237a"
 }