@prose-reader/core 1.296.0 → 1.298.0

package/dist/navigation/InternalNavigator.d.ts

@@ -1,4 +1,5 @@
 import { BehaviorSubject, Observable } from 'rxjs';
+import { CfiManager } from '../cfi';
 import { Context } from '../context/Context';
 import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
 import { Spine } from '../spine/Spine';
@@ -16,12 +17,13 @@ export declare class InternalNavigator extends DestroyableClass {
     protected navigationResolver: ReturnType<typeof createNavigationResolver>;
     protected spine: Spine;
     protected viewport: Viewport;
+    protected cfiManager: CfiManager;
     protected isUserInteractionLocked$: Observable<boolean>;
     navigationSubject: BehaviorSubject<InternalNavigationEntry>;
     navigation$: Observable<Pick<InternalNavigationEntry, "id" | "position" | "requestedPosition" | "requestedVisibleArea"> & {
         triggeredBy: InternalNavigationEntry["meta"]["triggeredBy"];
     }>;
     locker: Locker;
-    constructor(settings: ReaderSettingsManager, context: Context, userNavigation$: Observable<UserNavigationEntry>, getActiveNavigationModeController: () => NavigationModeController, navigationModeLayout$: Observable<unknown>, navigationResolver: ReturnType<typeof createNavigationResolver>, spine: Spine, viewport: Viewport, isUserInteractionLocked$: Observable<boolean>);
+    constructor(settings: ReaderSettingsManager, context: Context, userNavigation$: Observable<UserNavigationEntry>, getActiveNavigationModeController: () => NavigationModeController, navigationModeLayout$: Observable<unknown>, navigationResolver: ReturnType<typeof createNavigationResolver>, spine: Spine, viewport: Viewport, cfiManager: CfiManager, isUserInteractionLocked$: Observable<boolean>);
     get navigation(): InternalNavigationEntry;
 }

package/dist/navigation/Navigator.d.ts

@@ -1,3 +1,4 @@
+import { CfiManager } from '../cfi';
 import { Context } from '../context/Context';
 import { HookManager } from '../hooks/HookManager';
 import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
@@ -11,7 +12,8 @@ import { UserNavigationEntry, InternalNavigationEntry, NavigationVisibleArea, Sp
 import { Observable } from 'rxjs';
 import { SpinePosition, SpineItemPosition, SpineItem, UnboundSpinePosition } from '..';
 import { getNavigationForSpineItemPage } from './resolvers/getNavigationForSpineItemPage';
-export declare const createNavigator: ({ spineItemsManager, context, hookManager, spine, settings, viewport, }: {
+export declare const createNavigator: ({ spineItemsManager, context, hookManager, spine, settings, viewport, cfi, }: {
+    cfi: CfiManager;
     spineItemsManager: SpineItemsManager;
     context: Context;
     hookManager: HookManager;

package/dist/navigation/consolidation/withSpineItem.d.ts

@@ -1,4 +1,5 @@
 import { Observable } from 'rxjs';
+import { CfiManager } from '../../cfi';
 import { Context } from '../../context/Context';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { SpineLocator } from '../../spine/locator/SpineLocator';
@@ -8,7 +9,8 @@ import { InternalNavigationInput } from '../types';
 type Navigation = {
     navigation: InternalNavigationInput;
 };
-export declare const withSpineItem: ({ settings, spineItemsManager, navigationResolver, spineLocator, }: {
+export declare const withSpineItem: ({ settings, spineItemsManager, navigationResolver, spineLocator, cfi: cfiManager, }: {
+    cfi: CfiManager;
     context: Context;
     settings: ReaderSettingsManager;
     spineItemsManager: SpineItemsManager;

package/dist/navigation/resolvers/NavigationResolver.d.ts

@@ -1,3 +1,4 @@
+import { CfiManager } from '../../cfi';
 import { Context } from '../../context/Context';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { SpineLocator } from '../../spine/locator/SpineLocator';
@@ -11,7 +12,8 @@ import { NavigationVisibleArea, SpineBoundary } from '../types';
 import { getNavigationForSpineItemPage } from './getNavigationForSpineItemPage';
 export declare const NAMESPACE = "spineNavigator";
 export type NavigationResolver = ReturnType<typeof createNavigationResolver>;
-export declare const createNavigationResolver: ({ context, spineItemsManager, locator, settings, spine, viewport, }: {
+export declare const createNavigationResolver: ({ context, spineItemsManager, locator, settings, spine, viewport, cfi: cfiManager, }: {
+    cfi: CfiManager;
     context: Context;
     spineItemsManager: SpineItemsManager;
     locator: SpineLocator;

package/dist/navigation/restoration/restoreNavigationForControlledPageTurnMode.d.ts

@@ -1,14 +1,16 @@
 import { Observable } from 'rxjs';
+import { CfiManager } from '../../cfi';
+import { SpineLocator } from '../../spine/locator/SpineLocator';
 import { Spine } from '../../spine/Spine';
 import { SpineItemsManager } from '../../spine/SpineItemsManager';
-import { SpineLocator } from '../../spine/locator/SpineLocator';
 import { SpinePosition } from '../../spine/types';
 import { NavigationResolver } from '../resolvers/NavigationResolver';
 import { InternalNavigationEntry } from '../types';
-export declare const restoreNavigationForControlledPageTurnMode: ({ spineLocator, navigation, navigationResolver, spineItemsManager, spine, }: {
+export declare const restoreNavigationForControlledPageTurnMode: ({ spineLocator, navigation, navigationResolver, spineItemsManager, spine, cfiManager, }: {
     navigation: InternalNavigationEntry;
     spineLocator: SpineLocator;
     navigationResolver: NavigationResolver;
     spineItemsManager: SpineItemsManager;
     spine: Spine;
+    cfiManager: CfiManager;
 }) => Observable<SpinePosition>;

package/dist/navigation/restoration/restorePosition.d.ts

@@ -1,4 +1,5 @@
 import { Observable } from 'rxjs';
+import { CfiManager } from '../../cfi';
 import { Context } from '../../context/Context';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { SpineLocator } from '../../spine/locator/SpineLocator';
@@ -8,7 +9,7 @@ import { SpinePosition, UnboundSpinePosition } from '../../spine/types';
 import { SpineItemLocator } from '../../spineItem/locationResolver';
 import { NavigationResolver } from '../resolvers/NavigationResolver';
 import { InternalNavigationEntry } from '../types';
-export declare const restorePosition: ({ navigation, spineItemsManager, settings, spineLocator, navigationResolver, spine, }: {
+export declare const restorePosition: ({ navigation, spineItemsManager, settings, spineLocator, navigationResolver, spine, cfiManager, }: {
     spineLocator: SpineLocator;
     settings: ReaderSettingsManager;
     navigationResolver: NavigationResolver;
@@ -17,4 +18,5 @@ export declare const restorePosition: ({ navigation, spineItemsManager, settings
     spineItemLocator: SpineItemLocator;
     context: Context;
     spine: Spine;
+    cfiManager: CfiManager;
 }) => Observable<SpinePosition | UnboundSpinePosition>;

package/dist/navigation/restoration/withRestoredPosition.d.ts

@@ -1,4 +1,5 @@
 import { Observable } from 'rxjs';
+import { CfiManager } from '../../cfi';
 import { Context } from '../../context/Context';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { Spine } from '../../spine/Spine';
@@ -7,10 +8,11 @@ import { InternalNavigationEntry } from '../types';
 type Navigation = {
     navigation: InternalNavigationEntry;
 };
-export declare const withRestoredPosition: ({ settings, navigationResolver, context, spine, }: {
+export declare const withRestoredPosition: ({ settings, navigationResolver, context, spine, cfiManager, }: {
     navigationResolver: NavigationResolver;
     settings: ReaderSettingsManager;
     context: Context;
     spine: Spine;
+    cfiManager: CfiManager;
 }) => <N extends Navigation>(stream: Observable<N>) => Observable<N>;
 export {};

package/dist/pagination/PaginationController.d.ts

@@ -1,4 +1,5 @@
 import { Observable } from 'rxjs';
+import { CfiManager } from '../cfi';
 import { Context } from '../context/Context';
 import { Spine } from '../spine/Spine';
 import { SpineItemsManager } from '../spine/SpineItemsManager';
@@ -12,5 +13,6 @@ export declare class PaginationController extends DestroyableClass {
     protected spine: Spine;
     protected spineItemLocator: ReturnType<typeof createSpineItemLocator>;
     protected isNavigationLocked$: Observable<boolean>;
-    constructor(context: Context, pagination: Pagination, spineItemsManager: SpineItemsManager, spine: Spine, spineItemLocator: ReturnType<typeof createSpineItemLocator>, isNavigationLocked$: Observable<boolean>);
+    protected cfi: CfiManager;
+    constructor(context: Context, pagination: Pagination, spineItemsManager: SpineItemsManager, spine: Spine, spineItemLocator: ReturnType<typeof createSpineItemLocator>, isNavigationLocked$: Observable<boolean>, cfi: CfiManager);
 }

package/dist/reader.d.ts

@@ -1,5 +1,5 @@
 import { Observable, ObservedValueOf, Subject } from 'rxjs';
-import { resolveCfi } from './cfi/resolve';
+import { CfiManager } from './cfi';
 import { Context, ContextState } from './context/Context';
 import { Features } from './features/Features';
 import { HookManager } from './hooks/HookManager';
@@ -11,38 +11,22 @@ import { SpineItemsManager } from './spine/SpineItemsManager';
 import { SpineItemReference } from './spineItem/SpineItem';
 import { Viewport } from './viewport/Viewport';
 import { CoreHook } from './hooks';
-import { Manifest } from '@prose-reader/shared';
-import { ProseParsedCfi } from './cfi';
-import { PageEntry, SpineItem, InternalNavigationEntry, InternalNavigator, ScrollNavigationController, ControlledNavigationController, UserNavigationEntry, SpinePosition, SpineItemPosition, UnboundSpinePosition, NavigationVisibleArea, SpineBoundary, SpineItemsObserver, CoreOutputSettings } from '.';
+import { InternalNavigationEntry, InternalNavigator, ScrollNavigationController, ControlledNavigationController, UserNavigationEntry, SpinePosition, SpineItemPosition, SpineItem, UnboundSpinePosition, NavigationVisibleArea, SpineBoundary, SpineItemsObserver, CoreOutputSettings } from '.';
 import { getNavigationForSpineItemPage } from './navigation/resolvers/getNavigationForSpineItemPage';
 import { PaginationInfo } from './pagination';
 export type CreateReaderOptions = Partial<CoreInputSettings>;
 export type CreateReaderParameters = CreateReaderOptions;
 export type ContextSettings = Partial<CoreInputSettings>;
 export type ReaderInternal = ReturnType<typeof createReader>;
+type ReaderLayoutOptions = {
+    immediate?: boolean;
+};
 export declare const createReader: (inputSettings: CreateReaderOptions) => {
     id: `${string}-${string}-${string}-${string}-${string}`;
     context: Context;
     spine: Spine;
     hookManager: HookManager< CoreHook>;
-    cfi: {
-        generateCfiFromRange: (range: Range, item: Manifest[`spineItems`][number]) => string;
-        parseCfi: (cfi: string) => ProseParsedCfi & {
-            offset: number;
-        };
-        generateCfiForSpineItemPage: ({ spineItem, pageNode, }: {
-            spineItem: Manifest["spineItems"][number];
-            pageNode: NonNullable< PageEntry["firstVisibleNode"]>;
-        }) => string;
-        resolveCfi: (params: Omit<Parameters<typeof resolveCfi>[0], "spineItemsManager">) => Omit< ProseParsedCfi & {
-            offset: number;
-        }, "offset"> & {
-            offset?: number | undefined;
-            node: Node | null;
-            range?: Range | null;
-            spineItem?: SpineItem;
-        };
-    };
+    cfi: CfiManager;
     navigation: {
         destroy: () => void;
         getNavigation: () => InternalNavigationEntry;
@@ -92,7 +76,7 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
     };
     spineItemsObserver: SpineItemsObserver;
     spineItemsManager: SpineItemsManager;
-    layout: () => void;
+    layout: (options?: ReaderLayoutOptions) => void;
     load: (options: Required<Pick<ContextState, "manifest"> & {
         containerElement: HTMLElement;
     }>) => void;

package/dist/spine/Spine.d.ts

@@ -12,7 +12,7 @@ import { SpineLocator } from './locator/SpineLocator';
 import { Pages, PagesState } from './Pages';
 import { SpineItemsManager } from './SpineItemsManager';
 import { SpineItemsObserver } from './SpineItemsObserver';
-import { SpineLayout } from './SpineLayout';
+import { SpineLayout, SpineLayoutOptions } from './SpineLayout';
 import { SpineItemSpineLayout } from './types';
 export declare class Spine extends DestroyableClass {
     protected context: Context;
@@ -31,7 +31,7 @@ export declare class Spine extends DestroyableClass {
     element$: Observable<HTMLElement | undefined>;
     constructor(context: Context, pagination: Pagination, spineItemsManager: SpineItemsManager, spineItemLocator: ReturnType<typeof createSpineItemLocationResolver>, settings: ReaderSettingsManager, hookManager: HookManager, viewport: Viewport);
     get element(): HTMLElement | undefined;
-    layout(): void;
+    layout(options?: SpineLayoutOptions): void;
     getSpineItemSpineLayoutInfo(spineItemOrIndex: SpineItem | number | string | undefined): SpineItemSpineLayout;
     get layout$(): Observable<PagesState>;
     destroy(): void;

package/dist/spine/SpineItemsManager.d.ts

@@ -13,7 +13,6 @@ export declare class SpineItemsManager extends DestroyableClass {
     comparePositionOf(toCompare: SpineItem, withItem: SpineItem): "before" | "after" | "same";
     getSpineItemIndex(spineItemOrId: SpineItem | string | number | undefined): number | undefined;
     addMany(spineItems: SpineItem[]): void;
-    getSpineItemFromCfi(cfi: string): SpineItem | undefined;
     get items(): SpineItem[];
     destroyItems(): void;
 }

package/dist/spine/SpineLayout.d.ts

@@ -15,18 +15,21 @@ export type PageLayoutInformation = {
 export type LayoutInfo = {
     pages: PageLayoutInformation[];
 };
+export type SpineLayoutOptions = {
+    immediate?: boolean;
+};
 export declare class SpineLayout extends DestroyableClass {
     protected spineItemsManager: SpineItemsManager;
     protected spineItemsObserver: SpineItemsObserver;
     protected context: Context;
     protected settings: ReaderSettingsManager;
     protected viewport: Viewport;
-    protected externalLayoutTrigger: Subject<unknown>;
+    protected externalLayoutTrigger: Subject<SpineLayoutOptions>;
     protected spineItemsRelativeLayouts: SpineItemSpineLayout[];
     readonly layout$: Observable<unknown>;
     constructor(spineItemsManager: SpineItemsManager, spineItemsObserver: SpineItemsObserver, context: Context, settings: ReaderSettingsManager, viewport: Viewport);
     private watchForVerticalWritingUpdate;
-    layout(): void;
+    layout(options?: SpineLayoutOptions): void;
     getSpineItemSpineLayoutInfo(spineItemOrIndex: SpineItem | number | string | undefined): SpineItemSpineLayout;
     get numberOfPages(): number;
     destroy(): void;

package/dist/spine/SpineLayout.test.d.ts

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

package/dist/spineItem/renderer/DocumentRenderer.test.d.ts

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

package/dist/utilities.d.ts

@@ -1,4 +1,4 @@
 export type { BookBoundaryReachedEvent, BookBoundaryReachedOptions, } from './enhancers/navigation/bookBoundary';
 export { observeBookBoundaryReached } from './enhancers/navigation/bookBoundary';
 export * from './navigation/operators';
-export { isHtmlElement, isHtmlTagElement } from './utils/dom';
+export { injectCSS, isHtmlElement, isHtmlTagElement, removeAttributeIfPresent, removeStylePropertyIfPresent, setAttributeIfChanged, setPropertyIfChanged, setStylePropertyIfChanged, } from './utils/dom';

package/dist/utils/dom.d.ts

@@ -1,3 +1,8 @@
+export declare function setAttributeIfChanged(element: Element, name: string, value: string | number | boolean): void;
+export declare function removeAttributeIfPresent(element: Element, name: string): void;
+export declare function setPropertyIfChanged<T, K extends keyof T>(object: T, key: K, value: T[K]): void;
+export declare function setStylePropertyIfChanged(style: CSSStyleDeclaration, property: string, value: string): void;
+export declare function removeStylePropertyIfPresent(style: CSSStyleDeclaration, property: string): void;
 type ViewPort = {
     left: number;
     right: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/core",
-  "version": "1.296.0",
+  "version": "1.298.0",
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",
@@ -23,8 +23,8 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@prose-reader/cfi": "^1.296.0",
-    "@prose-reader/shared": "^1.296.0"
+    "@prose-reader/cfi": "^1.298.0",
+    "@prose-reader/shared": "^1.298.0"
   },
   "peerDependencies": {
     "rxjs": "*"
@@ -40,5 +40,5 @@
       }
     }
   },
-  "gitHead": "c0d44e365c1456f94d2ece521af3546b97dc86b9"
+  "gitHead": "70dc850174a2782f66b31c5eebadd0950a8c7be1"
 }