@prose-reader/core 1.197.0 → 1.198.0

package/dist/createReaderWithEnhancer.d.ts

@@ -1,6 +1,6 @@
-export declare const createReaderWithEnhancers: (options: Partial<import('./settings/types').CoreInputSettings> & {
+export declare const createReaderWithEnhancers: (options: Partial<import('./settings/types').CoreInputSettings> & Partial<import('./enhancers/layoutEnhancer/types').InputSettings> & {
     theme?: import('./enhancers/theme').Theme;
-} & Partial<import('./enhancers/layoutEnhancer/types').InputSettings> & Partial<import('./enhancers/fonts/types').InputSettings> & {
+} & Partial<import('./enhancers/fonts/types').InputSettings> & {
     loadingElementCreate?: (options: {
         container: HTMLElement;
         item: {
@@ -66,15 +66,15 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
             } | undefined;
             getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./navigation/resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
             getNavigationFromSpineItemPosition: (params: {
-                spineItemPosition: import('./spineItem/types').UnsafeSpineItemPosition;
+                spineItemPosition: import('./spineItem/types').SpineItemPosition;
                 spineItem: import('.').SpineItem;
             }) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
             getNavigationForCfi: (cfi: string) => import('./navigation/viewport/ViewportNavigator').ViewportPosition | undefined;
             getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
             getNavigationForSpineIndexOrId: (indexOrId: number | string | import('.').SpineItem) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
-            getNavigationForPosition: (viewportPosition: import('./navigation/viewport/ViewportNavigator').ViewportPosition) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
+            getNavigationForPosition: (viewportPosition: import('./navigation/viewport/ViewportNavigator').ViewportPosition | import('./spine/types').SpinePosition) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
             getMostPredominantNavigationForPosition: (viewportPosition: import('./navigation/viewport/ViewportNavigator').ViewportPosition) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
-            getAdjustedPositionWithSafeEdge: (position: import('./navigation/viewport/ViewportNavigator').ViewportPosition) => {
+            getAdjustedPositionWithSafeEdge: (position: import('./navigation/viewport/ViewportNavigator').ViewportPosition | import('./spine/types').SpinePosition) => {
                 x: number;
                 y: number;
             };
@@ -87,11 +87,11 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
                 x: number;
                 y: number;
             }) => boolean;
-            getAdjustedPositionForSpread: (position: import('./navigation/viewport/ViewportNavigator').ViewportPosition) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
+            getAdjustedPositionForSpread: (position: import('./navigation/viewport/ViewportNavigator').ViewportPosition | import('./spine/types').SpinePosition) => import('./navigation/viewport/ViewportNavigator').ViewportPosition;
             spineItemNavigator: {
-                getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./spineItem/types').SafeSpineItemPosition;
-                getNavigationForPosition: (spineItem: import('.').SpineItem, position: import('./spineItem/types').UnsafeSpineItemPosition) => import('./spineItem/types').SafeSpineItemPosition;
-                getNavigationFromNode: (spineItem: import('.').SpineItem, node: Node, offset: number) => import('./spineItem/types').SafeSpineItemPosition;
+                getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./spineItem/types').SpineItemPosition;
+                getNavigationForPosition: (spineItem: import('.').SpineItem, position: import('./spineItem/types').SpineItemPosition) => import('./spineItem/types').SpineItemPosition;
+                getNavigationFromNode: (spineItem: import('.').SpineItem, node: Node, offset: number) => import('./spineItem/types').SpineItemPosition;
             };
         };
     };
@@ -106,8 +106,6 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
     };
     settings: import('./settings/SettingsInterface').SettingsInterface<NonNullable<import('./settings/types').CoreInputSettings>, NonNullable<import('./settings/types').CoreOutputSettings | undefined>>;
     element$: import('rxjs').Observable<HTMLElement>;
-    layout$: import('rxjs').Observable<import('./spine/SpineLayout').LayoutInfo>;
-    layoutInfo$: import('rxjs').Observable<import('./spine/SpineLayout').LayoutInfo>;
     viewportState$: import('rxjs').Observable<"free" | "busy">;
     viewportFree$: import('rxjs').Observable<"free">;
     state$: import('rxjs').Observable<"idle" | "ready">;
@@ -120,6 +118,8 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
         }>;
         destroy$: import('rxjs').Subject<void>;
     };
+}, "settings"> & import('./enhancers/layoutEnhancer/layoutEnhancer').LayoutEnhancerOutput & {
+    settings: import('./settings/SettingsInterface').SettingsInterface<import('./settings/types').CoreInputSettings & import('./enhancers/layoutEnhancer/types').InputSettings, import('./enhancers/layoutEnhancer/types').InputSettings & import('./settings/types').CoreInputSettings & import('./settings/types').ComputedCoreSettings>;
 }, "pagination"> & {
     pagination: Omit<{
         getState: () => import('./pagination/Pagination').PaginationInfo;
@@ -140,9 +140,7 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
     };
 } & {
     links$: ReturnType<typeof import('./enhancers/html/links').handleLinks>;
-}, "load"> & import('./enhancers/navigation/types').NavigationEnhancerOutput & import('./enhancers/zoom/types').ZoomEnhancerOutput, "settings"> & {
-    settings: import('./settings/SettingsInterface').SettingsInterface<import('./settings/types').CoreInputSettings & import('./enhancers/layoutEnhancer/types').InputSettings, import('./enhancers/layoutEnhancer/types').InputSettings & import('./settings/types').CoreInputSettings & import('./settings/types').ComputedCoreSettings>;
-} & {
+}, "load"> & import('./enhancers/navigation/types').NavigationEnhancerOutput & import('./enhancers/zoom/types').ZoomEnhancerOutput & {
     utils: {
         isOrIsWithinValidLink: (target: Event[`target`]) => boolean;
     };

package/dist/enhancers/layoutEnhancer/layoutEnhancer.d.ts

@@ -1,6 +1,12 @@
+import { Observable } from 'rxjs';
 import { SettingsInterface } from '../../settings/SettingsInterface';
 import { EnhancerOptions, EnhancerOutput, RootEnhancer } from '../types/enhancer';
+import { LayoutInfo } from './layoutInfo';
 import { InputSettings, OutputSettings } from './types';
-export declare const layoutEnhancer: <InheritOptions extends EnhancerOptions<RootEnhancer>, InheritOutput extends EnhancerOutput<RootEnhancer>, InheritSettings extends NonNullable<InheritOutput["settings"]["_inputSettings"]>, InheritComputedSettings extends NonNullable<InheritOutput["settings"]["_outputSettings"]>, Output extends Omit<InheritOutput, "settings"> & {
+export type LayoutEnhancerOutput = {
+    layout$: Observable<LayoutInfo>;
+    layoutInfo$: Observable<LayoutInfo>;
+};
+export declare const layoutEnhancer: <InheritOptions extends EnhancerOptions<RootEnhancer>, InheritOutput extends EnhancerOutput<RootEnhancer>, InheritSettings extends NonNullable<InheritOutput["settings"]["_inputSettings"]>, InheritComputedSettings extends NonNullable<InheritOutput["settings"]["_outputSettings"]>, Output extends Omit<InheritOutput, "settings"> & LayoutEnhancerOutput & {
     settings: SettingsInterface<InheritSettings & InputSettings, OutputSettings & InheritComputedSettings>;
 }>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions & Partial<InputSettings>) => Output;

package/dist/enhancers/layoutEnhancer/layoutInfo.d.ts

@@ -0,0 +1,25 @@
+import { Reader } from '../../reader';
+import { SpineItemPageSpineLayout, SpineItemSpineLayout, SpinePosition } from '../../spine/types';
+export type PageLayoutInformation = {
+    absolutePageIndex: number;
+    itemIndex: number;
+    absolutePosition: SpineItemSpineLayout;
+};
+export type LayoutInfo = {
+    pages: PageLayoutInformation[];
+};
+export declare const spinePositionToSpineItemSpineLayout: ({ position, pageSize, }: {
+    position: SpinePosition;
+    pageSize: {
+        height: number;
+        width: number;
+    };
+}) => SpineItemPageSpineLayout;
+export declare const createLayoutInfo: (reader: Reader) => {
+    layout$: import('rxjs').Observable<{
+        pages: PageLayoutInformation[];
+    }>;
+    info$: import('rxjs').Observable<{
+        pages: PageLayoutInformation[];
+    }>;
+};

package/dist/enhancers/loading/loadingEnhancer.d.ts

@@ -1,7 +1,7 @@
 import { Observable } from 'rxjs';
 import { Manifest } from '../..';
-import { EnhancerOutput } from '../types/enhancer';
 import { themeEnhancer } from '../theme';
+import { EnhancerOutput } from '../types/enhancer';
 type Entries = {
     [key: string]: HTMLElement;
 };

package/dist/enhancers/navigation/resolvers/getNavigationForLeftOrTopPage.d.ts

@@ -1,11 +1,12 @@
 import { Context } from '../../../context/Context';
 import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
 import { ViewportPosition } from '../../../navigation/viewport/ViewportNavigator';
+import { SpineItemsManager } from '../../../spine/SpineItemsManager';
 import { SpineLocator } from '../../../spine/locator/SpineLocator';
+import { SpinePosition } from '../../../spine/types';
 import { SpineItem } from '../../../spineItem/SpineItem';
-import { SpineItemsManager } from '../../../spine/SpineItemsManager';
 export declare const getNavigationForLeftOrTopPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, }: {
-    position: ViewportPosition;
+    position: ViewportPosition | SpinePosition;
     spineItem: SpineItem;
     context: Context;
     spineItemsManager: SpineItemsManager;

package/dist/enhancers/navigation/resolvers/getNavigationForLeftSinglePage.d.ts

@@ -1,13 +1,14 @@
 import { Context } from '../../../context/Context';
 import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
 import { ViewportPosition } from '../../../navigation/viewport/ViewportNavigator';
-import { SpineLocator } from '../../../spine/locator/SpineLocator';
 import { SpineItemsManager } from '../../../spine/SpineItemsManager';
+import { SpineLocator } from '../../../spine/locator/SpineLocator';
+import { SpinePosition } from '../../../spine/types';
 export declare const getNavigationForLeftSinglePage: ({ position, navigationResolver, computedPageTurnDirection, spineItemsManager, spineLocator, context, }: {
-    position: ViewportPosition;
+    position: ViewportPosition | SpinePosition;
     navigationResolver: NavigationResolver;
     computedPageTurnDirection: "horizontal" | "vertical";
     spineItemsManager: SpineItemsManager;
     spineLocator: SpineLocator;
     context: Context;
-}) => ViewportPosition;
+}) => ViewportPosition | SpinePosition;

package/dist/enhancers/navigation/resolvers/getNavigationForRightOrBottomPage.d.ts

@@ -1,11 +1,12 @@
 import { Context } from '../../../context/Context';
 import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
 import { ViewportPosition } from '../../../navigation/viewport/ViewportNavigator';
-import { SpineLocator } from '../../../spine/locator/SpineLocator';
 import { SpineItemsManager } from '../../../spine/SpineItemsManager';
+import { SpineLocator } from '../../../spine/locator/SpineLocator';
+import { SpinePosition } from '../../../spine/types';
 import { SpineItem } from '../../../spineItem/SpineItem';
 export declare const getNavigationForRightOrBottomPage: ({ position, spineItem, context, navigationResolver, spineItemsManager, spineLocator, computedPageTurnDirection, }: {
-    position: ViewportPosition;
+    position: ViewportPosition | SpinePosition;
     spineItem: SpineItem;
     context: Context;
     spineItemsManager: SpineItemsManager;

package/dist/enhancers/navigation/resolvers/getNavigationForRightSinglePage.d.ts

@@ -1,13 +1,14 @@
 import { Context } from '../../../context/Context';
 import { NavigationResolver } from '../../../navigation/resolvers/NavigationResolver';
 import { ViewportPosition } from '../../../navigation/viewport/ViewportNavigator';
-import { SpineLocator } from '../../../spine/locator/SpineLocator';
 import { SpineItemsManager } from '../../../spine/SpineItemsManager';
+import { SpineLocator } from '../../../spine/locator/SpineLocator';
+import { SpinePosition } from '../../../spine/types';
 export declare const getNavigationForRightSinglePage: ({ position, navigationResolver, computedPageTurnDirection, spineItemsManager, spineLocator, context, }: {
-    position: ViewportPosition;
+    position: ViewportPosition | SpinePosition;
     navigationResolver: NavigationResolver;
     computedPageTurnDirection: "horizontal" | "vertical";
     spineItemsManager: SpineItemsManager;
     spineLocator: SpineLocator;
     context: Context;
-}) => ViewportPosition;
+}) => ViewportPosition | SpinePosition;

package/dist/enhancers/navigation/resolvers/getSpineItemPositionForLeftPage.d.ts

@@ -1,10 +1,10 @@
-import { SpineItemLocator } from '../../../spineItem/locationResolver';
 import { SpineItem } from '../../../spineItem/SpineItem';
-import { SafeSpineItemPosition, UnsafeSpineItemPosition } from '../../../spineItem/types';
+import { SpineItemLocator } from '../../../spineItem/locationResolver';
+import { SpineItemPosition } from '../../../spineItem/types';
 export declare const getSpineItemPositionForLeftPage: ({ position, spineItem, pageHeight, pageWidth, spineItemLocator, }: {
-    position: UnsafeSpineItemPosition;
+    position: SpineItemPosition;
     spineItem: SpineItem;
     pageWidth: number;
     pageHeight: number;
     spineItemLocator: SpineItemLocator;
-}) => SafeSpineItemPosition;
+}) => SpineItemPosition;

package/dist/enhancers/navigation/resolvers/getSpineItemPositionForRightPage.d.ts

@@ -1,10 +1,10 @@
-import { SpineItemLocator } from '../../../spineItem/locationResolver';
 import { SpineItem } from '../../../spineItem/SpineItem';
-import { SafeSpineItemPosition, UnsafeSpineItemPosition } from '../../../spineItem/types';
+import { SpineItemLocator } from '../../../spineItem/locationResolver';
+import { SpineItemPosition } from '../../../spineItem/types';
 export declare const getSpineItemPositionForRightPage: ({ position, spineItem, pageHeight, pageWidth, spineItemLocator, }: {
-    position: UnsafeSpineItemPosition;
+    position: SpineItemPosition;
     spineItem: SpineItem;
     pageWidth: number;
     pageHeight: number;
     spineItemLocator: SpineItemLocator;
-}) => SafeSpineItemPosition;
+}) => SpineItemPosition;

package/dist/enhancers/pagination/enhancer.d.ts

@@ -1,9 +1,10 @@
 import { Observable } from 'rxjs';
 import { PaginationInfo } from '../../pagination/Pagination';
+import { LayoutEnhancerOutput } from '../layoutEnhancer/layoutEnhancer';
 import { EnhancerOutput, RootEnhancer } from '../types/enhancer';
 import { ConsolidatedResource, LocatableResource } from './locate';
 import { ExtraPaginationInfo } from './types';
-export declare const paginationEnhancer: <InheritOptions, InheritOutput extends EnhancerOutput<RootEnhancer>, PaginationOutput extends Omit<InheritOutput["pagination"], "state$" | "state"> & {
+export declare const paginationEnhancer: <InheritOptions, InheritOutput extends EnhancerOutput<RootEnhancer> & LayoutEnhancerOutput, PaginationOutput extends Omit<InheritOutput["pagination"], "state$" | "state"> & {
     state$: Observable<PaginationInfo & ExtraPaginationInfo>;
     state: PaginationInfo & ExtraPaginationInfo;
 }>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => Omit<InheritOutput, "pagination"> & {

package/dist/enhancers/pagination/pagination.d.ts

@@ -1,10 +1,11 @@
 import { Observable, ObservedValueOf } from 'rxjs';
 import { PaginationInfo } from '../../pagination/Pagination';
 import { Reader } from '../../reader';
+import { LayoutEnhancerOutput } from '../layoutEnhancer/layoutEnhancer';
 import { trackChapterInfo } from './chapters';
 import { EnhancerPaginationInto, ExtraPaginationInfo } from './types';
 export declare const mapPaginationInfoToExtendedInfo: (reader: Reader, paginationInfo: PaginationInfo, chaptersInfo: ObservedValueOf<ReturnType<typeof trackChapterInfo>>, percentageEstimateOfBook: number) => Observable<Omit<ExtraPaginationInfo, "beginAbsolutePageIndex" | "endAbsolutePageIndex" | "beginAbsolutePageIndex" | "numberOfTotalPages">>;
-export declare const trackPaginationInfo: (reader: Reader) => {
+export declare const trackPaginationInfo: (reader: Reader & LayoutEnhancerOutput) => {
     paginationInfo$: Observable<EnhancerPaginationInto>;
     getPaginationInfo: () => EnhancerPaginationInto;
 };

package/dist/enhancers/pagination/progression.d.ts

@@ -1,6 +1,7 @@
 import { Reader } from '../../reader';
 import { SpineItem } from '../../spineItem/SpineItem';
-export declare const getPercentageEstimate: (reader: Reader, currentSpineIndex: number, pageIndex: number, currentPosition: {
+import { LayoutEnhancerOutput } from '../layoutEnhancer/layoutEnhancer';
+export declare const getPercentageEstimate: (reader: Reader & LayoutEnhancerOutput, currentSpineIndex: number, pageIndex: number, currentPosition: {
     x: number;
     y: number;
 }, currentItem: SpineItem) => import('rxjs').Observable<number>;