@prose-reader/core 1.270.0 → 1.272.0

package/dist/reader.d.ts

@@ -8,12 +8,12 @@ import { SettingsInterface } from './settings/SettingsInterface';
 import { CoreInputSettings } from './settings/types';
 import { Spine } from './spine/Spine';
 import { SpineItemsManager } from './spine/SpineItemsManager';
-import { SpineItem, SpineItemReference } from './spineItem/SpineItem';
+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 { InternalNavigationEntry, InternalNavigator, ScrollNavigationController, ControlledNavigationController, Locker, UserNavigationEntry, SpinePosition, SpineItemPosition, UnboundSpinePosition, SpineItemsObserver, CoreOutputSettings } from '.';
+import { PageEntry, SpineItem, InternalNavigationEntry, InternalNavigator, ScrollNavigationController, ControlledNavigationController, Locker, UserNavigationEntry, SpinePosition, SpineItemPosition, UnboundSpinePosition, SpineItemsObserver, CoreOutputSettings } from '.';
 import { getNavigationForSpineItemPage } from './navigation/resolvers/getNavigationForSpineItemPage';
 import { PaginationInfo } from './pagination';
 export type CreateReaderOptions = Partial<CoreInputSettings>;
@@ -30,9 +30,9 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
         parseCfi: (cfi: string) => ProseParsedCfi & {
             offset: number;
         };
-        generateCfiForSpineItemPage: (params: {
-            pageIndex: number;
-            spineItem: SpineItem;
+        generateCfiForSpineItemPage: ({ spineItem, pageNode, }: {
+            spineItem: Manifest["spineItems"][number];
+            pageNode: NonNullable< PageEntry["firstVisibleNode"]>;
         }) => string;
         resolveCfi: (params: Omit<Parameters<typeof resolveCfi>[0], "spineItemsManager">) => Omit< ProseParsedCfi & {
             offset: number;

package/dist/spine/Pages.d.ts

@@ -16,7 +16,7 @@ export declare const spinePositionToSpineItemSpineLayout: ({ position, pageSize,
         width: number;
     };
 }) => SpineItemPageSpineLayout;
-type PageEntry = {
+export type PageEntry = {
     absoluteLayout: SpineItemPageSpineLayout;
     layout: SpineItemPageLayout;
     itemIndex: number;

package/dist/spine/Spine.d.ts

@@ -9,12 +9,11 @@ import { DestroyableClass } from '../utils/DestroyableClass';
 import { Viewport } from '../viewport/Viewport';
 import { SpineItemsLoader } from './loader/SpineItemsLoader';
 import { SpineLocator } from './locator/SpineLocator';
-import { Pages } from './Pages';
+import { Pages, PageEntry } from './Pages';
 import { SpineItemsManager } from './SpineItemsManager';
 import { SpineItemsObserver } from './SpineItemsObserver';
 import { SpineLayout } from './SpineLayout';
-import { SpineItemSpineLayout, SpineItemPageSpineLayout } from './types';
-import { SpineItemPageLayout } from '..';
+import { SpineItemSpineLayout } from './types';
 export declare class Spine extends DestroyableClass {
     protected context: Context;
     protected pagination: Pagination;
@@ -35,17 +34,7 @@ export declare class Spine extends DestroyableClass {
     layout(): void;
     getSpineItemSpineLayoutInfo(spineItemOrIndex: SpineItem | number | string | undefined): SpineItemSpineLayout;
     get layout$(): Observable<{
-        pages: {
-            absoluteLayout: SpineItemPageSpineLayout;
-            layout: SpineItemPageLayout;
-            itemIndex: number;
-            absolutePageIndex: number;
-            pageIndex: number;
-            firstVisibleNode: {
-                node: Node;
-                offset: number;
-            } | undefined;
-        }[];
+        pages: PageEntry[];
     }>;
     destroy(): void;
 }

package/dist/spine/SpineItemsObserver.d.ts

@@ -1,18 +1,17 @@
 import { Observable } from 'rxjs';
-import { SpineItem } from '../spineItem/SpineItem';
+import { SpineItem, SpineItemState } from '../spineItem/SpineItem';
 import { DestroyableClass } from '../utils/DestroyableClass';
-import { SpineLocator } from './locator/SpineLocator';
 import { SpineItemsManager } from './SpineItemsManager';
 export declare class SpineItemsObserver extends DestroyableClass {
     protected spineItemsManager: SpineItemsManager;
-    protected spineLocator: SpineLocator;
-    itemIsReady$: Observable<{
+    states$: Observable<{
         item: SpineItem;
-        isReady: boolean;
-    }>;
+    } & SpineItemState>;
     itemResize$: Observable<{
         item: SpineItem;
         entries: ResizeObserverEntry[];
     }>;
-    constructor(spineItemsManager: SpineItemsManager, spineLocator: SpineLocator);
+    itemLoad$: Observable<SpineItem>;
+    itemUnload$: Observable<SpineItem>;
+    constructor(spineItemsManager: SpineItemsManager);
 }

package/dist/spine/SpineLayout.d.ts

@@ -5,6 +5,7 @@ import { SpineItem } from '../spineItem/SpineItem';
 import { DestroyableClass } from '../utils/DestroyableClass';
 import { Viewport } from '../viewport/Viewport';
 import { SpineItemsManager } from './SpineItemsManager';
+import { SpineItemsObserver } from './SpineItemsObserver';
 import { SpineItemSpineLayout } from './types';
 export type PageLayoutInformation = {
     absolutePageIndex: number;
@@ -16,15 +17,20 @@ export type LayoutInfo = {
 };
 export declare class SpineLayout extends DestroyableClass {
     protected spineItemsManager: SpineItemsManager;
+    protected spineItemsObserver: SpineItemsObserver;
     protected context: Context;
     protected settings: ReaderSettingsManager;
     protected viewport: Viewport;
-    protected layoutSubject: Subject<unknown>;
+    protected externalLayoutTrigger: Subject<unknown>;
     protected spineItemsRelativeLayouts: SpineItemSpineLayout[];
     readonly layout$: Observable<unknown>;
-    constructor(spineItemsManager: SpineItemsManager, context: Context, settings: ReaderSettingsManager, viewport: Viewport);
+    constructor(spineItemsManager: SpineItemsManager, spineItemsObserver: SpineItemsObserver, context: Context, settings: ReaderSettingsManager, viewport: Viewport);
+    private watchForVerticalWritingUpdate;
     layout(): void;
     getSpineItemSpineLayoutInfo(spineItemOrIndex: SpineItem | number | string | undefined): SpineItemSpineLayout;
     get numberOfPages(): number;
     destroy(): void;
+    private getSpreadPosition;
+    private getStartEdges;
+    private createSpineItemLayout;
 }

package/dist/spineItem/SpineItem.d.ts

@@ -1,4 +1,3 @@
-import { Observable } from 'rxjs';
 import { Manifest } from '..';
 import { Context } from '../context/Context';
 import { HookManager } from '../hooks/HookManager';
@@ -8,13 +7,14 @@ import { Viewport } from '../viewport/Viewport';
 import { DocumentRenderer } from './renderer/DocumentRenderer';
 import { ResourceHandler } from './resources/ResourceHandler';
 import { SpineItemLayout } from './SpineItemLayout';
+import { Observable } from 'rxjs';
 export type SpineItemReference = string | SpineItem | number;
-type SpineItemState = {
+export type SpineItemState = {
     isLoaded: boolean;
     isReady: boolean;
     isError: boolean;
     error: unknown | undefined;
-    iDirty: boolean;
+    isDirty: boolean;
 };
 export declare class SpineItem extends ReactiveEntity<SpineItemState> {
     item: Manifest[`spineItems`][number];
@@ -25,10 +25,10 @@ export declare class SpineItem extends ReactiveEntity<SpineItemState> {
     index: number;
     viewport: Viewport;
     readonly containerElement: HTMLElement;
-    readonly needsLayout$: Observable<unknown>;
     readonly renderer: DocumentRenderer;
     readonly resourcesHandler: ResourceHandler;
-    readonly layout: SpineItemLayout;
+    readonly didLayout$: SpineItemLayout["didLayout$"];
+    private readonly _layout;
     constructor(item: Manifest[`spineItems`][number], parentElement: HTMLElement, context: Context, settings: ReaderSettingsManager, hookManager: HookManager, index: number, viewport: Viewport);
     load: () => void;
     unload: () => void;
@@ -39,14 +39,12 @@ export declare class SpineItem extends ReactiveEntity<SpineItemState> {
     get readingDirection(): "ltr" | "rtl" | undefined;
     isUsingVerticalWriting: () => boolean;
     get loaded$(): Observable<void>;
-    get unloaded$(): Observable<{
-        state: `error`;
-        error: unknown;
-    } | {
-        state: `idle` | `loading` | `loaded` | `unloading`;
-        error: undefined;
-    }>;
+    get unloaded$(): Observable<void>;
     get renditionLayout(): "reflowable" | "pre-paginated";
+    get layoutInfo(): {
+        width: number;
+        height: number;
+    };
     get numberOfPages(): number;
+    layout: SpineItemLayout["layout"];
 }
-export {};

package/dist/spineItem/SpineItemLayout.d.ts

@@ -16,31 +16,19 @@ export declare class SpineItemLayout extends DestroyableClass {
     viewport: Viewport;
     private layoutTriggerSubject;
     private lastLayout;
-    readonly layout$: Observable<{
+    readonly didLayout$: Observable<{
         width: number;
         height: number;
     }>;
-    readonly layoutProcess$: Observable<{
-        readonly type: "start";
-    } | {
-        readonly type: "end";
-        readonly data: {
-            width: number;
-            height: number;
-        };
-    }>;
     constructor(item: Manifest[`spineItems`][number], containerElement: HTMLElement, context: Context, hookManager: HookManager, renderer: DocumentRenderer, settings: ReaderSettingsManager, viewport: Viewport);
     private validateDimension;
-    private applyDimsAfterLayout;
+    private computeLayoutInformation;
+    private adjustPositionOfElement;
+    private updateContainerLayout;
     layout: (params: ObservedValueOf<typeof this.layoutTriggerSubject>) => Observable<{
         width: number;
         height: number;
     }>;
-    adjustPositionOfElement: ({ right, left, top, }: {
-        right?: number;
-        left?: number;
-        top?: number;
-    }) => void;
     get layoutInfo(): {
         width: number;
         height: number;

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

@@ -39,6 +39,7 @@ export declare abstract class DocumentRenderer extends ReactiveEntity<DocumentRe
     protected containerElement: HTMLElement;
     protected resourcesHandler: ResourceHandler;
     loaded$: Observable<void>;
+    unloaded$: Observable<void>;
     private _documentContainer;
     constructor(params: {
         context: Context;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/core",
-  "version": "1.270.0",
+  "version": "1.272.0",
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.js",
@@ -23,8 +23,8 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@prose-reader/cfi": "^1.270.0",
-    "@prose-reader/shared": "^1.270.0"
+    "@prose-reader/cfi": "^1.272.0",
+    "@prose-reader/shared": "^1.272.0"
   },
   "peerDependencies": {
     "rxjs": "*"
@@ -40,5 +40,5 @@
       }
     }
   },
-  "gitHead": "846e0d9f7783840e6801d0bb0e2e69633d487a99"
+  "gitHead": "15e071db18742b2ac15c61513ce847ceadc7a2a0"
 }

package/dist/spine/layout/layoutItem.d.ts

@@ -1,22 +0,0 @@
-import { Observable } from 'rxjs';
-import { SpineItem } from '../..';
-import { Context } from '../../context/Context';
-import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
-import { Viewport } from '../../viewport/Viewport';
-import { SpineItemsManager } from '../SpineItemsManager';
-import { SpineItemSpineLayout } from '../types';
-export declare const layoutItem: ({ horizontalOffset, verticalOffset, context, spineItemsManager, isGloballyPrePaginated, settings, index, item, viewport, }: {
-    horizontalOffset: number;
-    verticalOffset: number;
-    context: Context;
-    spineItemsManager: SpineItemsManager;
-    isGloballyPrePaginated: boolean;
-    settings: ReaderSettingsManager;
-    item: SpineItem;
-    index: number;
-    viewport: Viewport;
-}) => Observable<{
-    horizontalOffset: number;
-    verticalOffset: number;
-    layoutPosition: SpineItemSpineLayout;
-}>;