@prose-reader/core 1.217.0 → 1.219.0

package/dist/createReaderWithEnhancer.d.ts

@@ -1,6 +1,6 @@
-export declare const createReaderWithEnhancers: (options: Partial<import('./settings/types').CoreInputSettings> & Partial<import('./enhancers/layout/types').InputSettings> & {
+export declare const createReaderWithEnhancers: (options: Partial<import('.').CoreInputSettings> & Partial<import('.').EnhancerLayoutInputSettings> & {
     theme?: import('.').Theme;
-} & Partial<import('./enhancers/fonts/types').InputSettings> & {
+} & Partial<import('.').EnhancerFontsInputSettings> & {
     loadingElementCreate?: (options: {
         container: HTMLElement;
         item: {
@@ -15,9 +15,9 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
         };
     }) => HTMLElement;
 }) => Omit<Omit<Omit<Omit<{
-    context: import('./context/Context').Context;
-    spine: import('./spine/Spine').Spine;
-    hookManager: import('.').HookManager<import('./hooks/types').CoreHook>;
+    context: import('.').Context;
+    spine: import('.').Spine;
+    hookManager: import('.').HookManager<import('.').CoreHook>;
     cfi: {
         generateCfiFromRange: (range: Range, item: import('@prose-reader/shared').Manifest[`spineItems`][number]) => {
             start: string;
@@ -51,31 +51,31 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
     };
     navigation: {
         destroy: () => void;
-        getNavigation: () => import('./navigation/types').InternalNavigationEntry;
-        internalNavigator: import('./navigation/InternalNavigator').InternalNavigator;
-        scrollNavigationController: import('./navigation/controllers/ScrollNavigationController').ScrollNavigationController;
-        controlledNavigationController: import('./navigation/controllers/ControlledNavigationController').ControlledNavigationController;
-        locker: import('./navigation/Locker').Locker;
+        getNavigation: () => import('.').InternalNavigationEntry;
+        internalNavigator: import('.').InternalNavigator;
+        scrollNavigationController: import('.').ScrollNavigationController;
+        controlledNavigationController: import('.').ControlledNavigationController;
+        locker: import('.').Locker;
         viewportState$: import('rxjs').Observable<"free" | "busy">;
-        navigate: (to: import('./navigation/types').UserNavigationEntry) => void;
+        navigate: (to: import('.').UserNavigationEntry) => void;
         lock(): () => void;
         navigationResolver: {
             getNavigationForUrl: (url: string | URL) => {
-                position: import('./navigation/types').DeprecatedViewportPosition;
+                position: import('.').DeprecatedViewportPosition;
                 spineItemId: string;
             } | undefined;
-            getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./navigation/resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('./spine/types').SpinePosition;
+            getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./navigation/resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('.').SpinePosition;
             getNavigationFromSpineItemPosition: (params: {
                 spineItemPosition: import('./spineItem/types').SpineItemPosition;
                 spineItem: import('.').SpineItem;
-            }) => import('./spine/types').SpinePosition;
-            getNavigationForCfi: (cfi: string) => import('./navigation/types').DeprecatedViewportPosition | undefined;
-            getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./navigation/types').DeprecatedViewportPosition;
-            getNavigationForSpineIndexOrId: (indexOrId: number | string | import('.').SpineItem) => import('./navigation/types').DeprecatedViewportPosition;
-            getNavigationForPosition: (viewportPosition: import('./navigation/types').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
-            getMostPredominantNavigationForPosition: (viewportPosition: import('./navigation/types').DeprecatedViewportPosition) => import('./navigation/types').DeprecatedViewportPosition;
-            getAdjustedPositionWithSafeEdge: (position: import('./navigation/types').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
-            isNavigationGoingForwardFrom: (to: import('./navigation/types').DeprecatedViewportPosition, from: import('./navigation/types').DeprecatedViewportPosition) => boolean;
+            }) => import('.').SpinePosition;
+            getNavigationForCfi: (cfi: string) => import('.').DeprecatedViewportPosition | undefined;
+            getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('.').DeprecatedViewportPosition;
+            getNavigationForSpineIndexOrId: (indexOrId: number | string | import('.').SpineItem) => import('.').DeprecatedViewportPosition;
+            getNavigationForPosition: (viewportPosition: import('.').DeprecatedViewportPosition | import('.').SpinePosition) => import('.').SpinePosition;
+            getMostPredominantNavigationForPosition: (viewportPosition: import('.').DeprecatedViewportPosition) => import('.').DeprecatedViewportPosition;
+            getAdjustedPositionWithSafeEdge: (position: import('.').DeprecatedViewportPosition | import('.').SpinePosition) => import('.').SpinePosition;
+            isNavigationGoingForwardFrom: (to: import('.').DeprecatedViewportPosition, from: import('.').DeprecatedViewportPosition) => boolean;
             arePositionsDifferent: (a: {
                 x: number;
                 y: number;
@@ -83,7 +83,7 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
                 x: number;
                 y: number;
             }) => boolean;
-            getAdjustedPositionForSpread: (position: import('./navigation/types').DeprecatedViewportPosition | import('./spine/types').SpinePosition) => import('./spine/types').SpinePosition;
+            getAdjustedPositionForSpread: (position: import('.').DeprecatedViewportPosition | import('.').SpinePosition) => import('.').SpinePosition;
             spineItemNavigator: {
                 getNavigationForLastPage: (spineItem: import('.').SpineItem) => import('./spineItem/types').SpineItemPosition;
                 getNavigationForPosition: (spineItem: import('.').SpineItem, position: import('./spineItem/types').SpineItemPosition) => import('./spineItem/types').SpineItemPosition;
@@ -91,20 +91,20 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
             };
         };
         navigation$: import('rxjs').Observable<{
-            position: import('./spine/types').SpinePosition;
+            position: import('.').SpinePosition;
             id: symbol;
         }>;
     };
     spineItemsObserver: import('./spine/SpineItemsObserver').SpineItemsObserver;
-    spineItemsManager: import('./spine/SpineItemsManager').SpineItemsManager;
+    spineItemsManager: import('.').SpineItemsManager;
     layout: () => void;
-    load: (options: Required<Pick<import('./context/Context').ContextState, "manifest" | "containerElement">>) => void;
+    load: (options: Required<Pick<import('.').ContextState, "manifest" | "containerElement">>) => void;
     destroy: () => void;
     pagination: {
         readonly state: import('./pagination').PaginationInfo;
         readonly state$: import('rxjs').Observable<import('rxjs').ObservedValueOf<import('./pagination').Pagination>>;
     };
-    settings: import('./settings/SettingsInterface').SettingsInterface<NonNullable<import('./settings/types').CoreInputSettings>, NonNullable<import('./settings/types').CoreOutputSettings | undefined>>;
+    settings: import('./settings/SettingsInterface').SettingsInterface<NonNullable<import('.').CoreInputSettings>, NonNullable<import('.').CoreOutputSettings | undefined>>;
     viewport: import('./viewport/Viewport').Viewport;
     element$: import('rxjs').Observable<HTMLElement>;
     viewportState$: import('rxjs').Observable<"free" | "busy">;
@@ -114,8 +114,8 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
     $: {
         destroy$: import('rxjs').Subject<void>;
     };
-}, "settings"> & import('./enhancers/layout/layoutEnhancer').LayoutEnhancerOutput & {
-    settings: import('./settings/SettingsInterface').SettingsInterface<import('./settings/types').CoreInputSettings & import('./enhancers/layout/types').InputSettings, import('./enhancers/layout/types').InputSettings & import('./settings/types').CoreInputSettings & import('./settings/types').ComputedCoreSettings>;
+}, "settings"> & import('.').LayoutEnhancerOutput & {
+    settings: import('./settings/SettingsInterface').SettingsInterface<import('.').CoreInputSettings & import('.').EnhancerLayoutInputSettings, import('.').EnhancerLayoutInputSettings & import('.').CoreInputSettings & import('.').ComputedCoreSettings>;
 }, "pagination"> & {
     pagination: Omit<{
         readonly state: import('./pagination').PaginationInfo;
@@ -135,12 +135,12 @@ 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 & {
+}, "load"> & import('.').NavigationEnhancerOutput & import('.').ZoomEnhancerOutput & {
     utils: {
         isOrIsWithinValidLink: (target: Event[`target`]) => boolean;
     };
 }, "settings"> & {
-    settings: import('./settings/SettingsInterface').SettingsInterface<import('./settings/types').CoreInputSettings & import('./enhancers/layout/types').InputSettings & import('./enhancers/fonts/types').InputSettings, import('./enhancers/fonts/types').InputSettings & import('./enhancers/layout/types').InputSettings & import('./settings/types').CoreInputSettings & import('./settings/types').ComputedCoreSettings>;
+    settings: import('./settings/SettingsInterface').SettingsInterface<import('.').CoreInputSettings & import('.').EnhancerLayoutInputSettings & import('.').EnhancerFontsInputSettings, import('.').EnhancerFontsInputSettings & import('.').EnhancerLayoutInputSettings & import('.').CoreInputSettings & import('.').ComputedCoreSettings>;
 } & {
     loading: {
         $: {

package/dist/enhancers/fonts/SettingsManager.d.ts

@@ -1,9 +1,9 @@
-import { InputSettings } from './types';
 import { SettingsManagerOverload } from '../../settings/SettingsManagerOverload';
 import { CoreInputSettings, CoreOutputSettings } from '../../settings/types';
-export declare class SettingsManager<ParentInputSettings extends CoreInputSettings, ParentOutputSettings extends CoreOutputSettings> extends SettingsManagerOverload<InputSettings, InputSettings, ParentInputSettings, ParentOutputSettings> {
-    computeOutputSettings(settings: InputSettings): InputSettings;
-    hasSettingsChanged(newOutputSettings: InputSettings): boolean;
-    getCleanedParentInputSettings(settings: Partial<InputSettings & ParentInputSettings>): ParentInputSettings;
-    getDefaultSettings(): InputSettings;
+import { EnhancerFontsInputSettings } from './types';
+export declare class SettingsManager<ParentInputSettings extends CoreInputSettings, ParentOutputSettings extends CoreOutputSettings> extends SettingsManagerOverload<EnhancerFontsInputSettings, EnhancerFontsInputSettings, ParentInputSettings, ParentOutputSettings> {
+    computeOutputSettings(settings: EnhancerFontsInputSettings): EnhancerFontsInputSettings;
+    hasSettingsChanged(newOutputSettings: EnhancerFontsInputSettings): boolean;
+    getCleanedParentInputSettings(settings: Partial<EnhancerFontsInputSettings & ParentInputSettings>): ParentInputSettings;
+    getDefaultSettings(): EnhancerFontsInputSettings;
 }

package/dist/enhancers/fonts/fonts.d.ts

@@ -1,6 +1,6 @@
-import { EnhancerOptions, EnhancerOutput, RootEnhancer } from '../types/enhancer';
-import { InputSettings } from './types';
 import { SettingsInterface } from '../../settings/SettingsInterface';
+import { EnhancerOptions, EnhancerOutput, RootEnhancer } from '../types/enhancer';
+import { EnhancerFontsInputSettings } from './types';
 export declare const fontsEnhancer: <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"> & {
-    settings: SettingsInterface<InheritSettings & InputSettings, InputSettings & InheritComputedSettings>;
-}>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions & Partial<InputSettings>) => Output;
+    settings: SettingsInterface<InheritSettings & EnhancerFontsInputSettings, EnhancerFontsInputSettings & InheritComputedSettings>;
+}>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions & Partial<EnhancerFontsInputSettings>) => Output;

package/dist/enhancers/fonts/index.d.ts

@@ -0,0 +1,2 @@
+export * from './fonts';
+export * from './types';

package/dist/enhancers/fonts/types.d.ts

@@ -1,6 +1,6 @@
 declare const FONT_WEIGHT: readonly [100, 200, 300, 400, 500, 600, 700, 800, 900];
 declare const FONT_JUSTIFICATION: readonly ["center", "left", "right", "justify"];
-export type InputSettings = {
+export type EnhancerFontsInputSettings = {
     fontScale: number;
     lineHeight: number | `publisher`;
     fontWeight: (typeof FONT_WEIGHT)[number] | `publisher`;

package/dist/enhancers/layout/SettingsManager.d.ts

@@ -1,9 +1,9 @@
 import { SettingsManagerOverload } from '../../settings/SettingsManagerOverload';
 import { CoreInputSettings, CoreOutputSettings } from '../../settings/types';
-import { InputSettings, OutputSettings } from './types';
-export declare class SettingsManager<ParentInputSettings extends CoreInputSettings, ParentOutputSettings extends CoreOutputSettings> extends SettingsManagerOverload<InputSettings, OutputSettings, ParentInputSettings, ParentOutputSettings> {
-    computeOutputSettings(inputSettings: InputSettings): InputSettings;
-    hasSettingsChanged(newOutputSettings: InputSettings): boolean;
-    getCleanedParentInputSettings(settings: Partial<InputSettings & ParentInputSettings>): ParentInputSettings;
-    getDefaultSettings(): InputSettings;
+import { EnhancerLayoutInputSettings, OutputSettings } from './types';
+export declare class SettingsManager<ParentInputSettings extends CoreInputSettings, ParentOutputSettings extends CoreOutputSettings> extends SettingsManagerOverload<EnhancerLayoutInputSettings, OutputSettings, ParentInputSettings, ParentOutputSettings> {
+    computeOutputSettings(inputSettings: EnhancerLayoutInputSettings): EnhancerLayoutInputSettings;
+    hasSettingsChanged(newOutputSettings: EnhancerLayoutInputSettings): boolean;
+    getCleanedParentInputSettings(settings: Partial<EnhancerLayoutInputSettings & ParentInputSettings>): ParentInputSettings;
+    getDefaultSettings(): EnhancerLayoutInputSettings;
 }

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

@@ -2,11 +2,11 @@ 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';
+import { EnhancerLayoutInputSettings, OutputSettings } from './types';
 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;
+    settings: SettingsInterface<InheritSettings & EnhancerLayoutInputSettings, OutputSettings & InheritComputedSettings>;
+}>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions & Partial<EnhancerLayoutInputSettings>) => Output;

package/dist/enhancers/layout/types.d.ts

@@ -1,8 +1,8 @@
-export type InputSettings = {
+export type EnhancerLayoutInputSettings = {
     pageHorizontalMargin: number;
     pageVerticalMargin: number;
     layoutAutoResize: `container` | false;
     layoutLayerTransition: boolean;
     viewportMode: `normal` | `thumbnails`;
 };
-export type OutputSettings = InputSettings;
+export type OutputSettings = EnhancerLayoutInputSettings;

package/dist/index.d.ts

@@ -6,11 +6,30 @@ export type { Theme } from './enhancers/theme';
 export { HookManager } from './hooks/HookManager';
 export { SettingsManager } from './settings/SettingsManager';
 export type Reader = ReturnType<typeof createReader>;
+export type CreateReaderOptions = Parameters<typeof createReader>[0];
 export { createReader };
 export { isHtmlElement, isHtmlTagElement } from './utils/dom';
 export { isShallowEqual } from './utils/objects';
 export { waitForSwitch } from './utils/rxjs';
 export { SpineItem } from './spineItem/SpineItem';
+export type { PaginationInfo } from './pagination/types';
 export * from './utils/DestroyableClass';
 export * from './utils/frames';
 export * from './utils/rxjs';
+export type PaginationState = ReturnType<typeof createReader>["pagination"]["state"];
+export type { EnhancerFontsInputSettings } from './enhancers/fonts';
+export type { EnhancerLayoutInputSettings } from './enhancers/layout/types';
+export * from './settings/types';
+export * from './context/Context';
+export * from './enhancers/layout/layoutEnhancer';
+export * from './enhancers/navigation/types';
+export * from './enhancers/zoom/types';
+export * from './hooks/types';
+export * from './navigation/InternalNavigator';
+export * from './navigation/Locker';
+export * from './navigation/controllers/ControlledNavigationController';
+export * from './navigation/controllers/ScrollNavigationController';
+export * from './navigation/types';
+export * from './spine/types';
+export * from './spine/SpineItemsManager';
+export * from './spine/Spine';

package/dist/index.js

@@ -6443,12 +6443,24 @@ const hs = (e) => {
   )
 );
 export {
+  go as Context,
+  Oo as ControlledNavigationController,
   Y as DestroyableClass,
   ht as DocumentRenderer,
   po as HookManager,
+  Fo as InternalNavigator,
+  ke as Locker,
   qt as ResourceHandler,
+  Do as ScrollNavigationController,
   Yo as SettingsManager,
+  gs as Spine,
+  Ae as SpineElementLayout,
   Ue as SpineItem,
+  dn as SpineItemPageSpineLayout,
+  kt as SpineItemSpineLayout,
+  ls as SpineItemsManager,
+  M as SpinePosition,
+  Yt as UnsafeSpinePosition,
   vs as createReader,
   ie as deferIdle,
   Di as deferNextResult,
@@ -6459,6 +6471,7 @@ export {
   Pe as isHtmlElement,
   Mi as isHtmlTagElement,
   Ts as isShallowEqual,
+  hn as layoutEnhancer,
   $e as mapKeysTo,
   Is as observeIntersection,
   ne as observeMutation,