@prose-reader/core 1.130.0 → 1.132.0

package/dist/cfi/generate/generateCfiFromRange.d.ts

@@ -1,10 +1,5 @@
 import { Manifest } from '@prose-reader/shared';
-export declare const generateCfiFromRange: ({ startNode, start, end, endNode, }: {
-    startNode: Node;
-    start: number;
-    endNode: Node;
-    end: number;
-}, item: Manifest[`spineItems`][number]) => {
+export declare const generateCfiFromRange: (range: Range, item: Manifest[`spineItems`][number]) => {
     start: string;
     end: string;
 };

package/dist/createReaderWithEnhancer.d.ts

@@ -19,12 +19,7 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
     spine: import('./spine/Spine').Spine;
     hookManager: import('.').HookManager<import('./hooks/types').CoreHook>;
     cfi: {
-        generateCfiFromRange: ({ startNode, start, end, endNode, }: {
-            startNode: Node;
-            start: number;
-            endNode: Node;
-            end: number;
-        }, item: import('@prose-reader/shared').Manifest[`spineItems`][number]) => {
+        generateCfiFromRange: (range: Range, item: import('@prose-reader/shared').Manifest[`spineItems`][number]) => {
             start: string;
             end: string;
         };
@@ -142,6 +137,11 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
     }, "state" | "state$"> & {
         state$: import('rxjs').Observable<import('./pagination/Pagination').PaginationInfo & import('./enhancers/pagination/types').ExtraPaginationInfo>;
         state: import('./pagination/Pagination').PaginationInfo & import('./enhancers/pagination/types').ExtraPaginationInfo;
+    } & {
+        locate: <T extends import('./enhancers/pagination/locate').LocatableResource>(resources: T[]) => import('rxjs').Observable<{
+            isStale: boolean;
+            data: (import('./enhancers/pagination/locate').ConsolidatedResource & T)[];
+        }>;
     };
 } & {
     theme: {
@@ -199,11 +199,11 @@ export declare const createReaderWithEnhancers: (options: Partial<import('./sett
             selection: Selection;
             itemIndex: number;
         } | undefined) | undefined;
-        createRangeFromSelection: (params: {
+        createOrderedRangeFromSelection: (params: {
             selection: {
-                anchorNode?: Node;
+                anchorNode?: Node | null;
                 anchorOffset?: number;
-                focusNode?: Node;
+                focusNode?: Node | null;
                 focusOffset?: number;
             };
             spineItem: import('.').SpineItem;

package/dist/enhancers/html/renderer/HtmlRenderer.d.ts

@@ -12,6 +12,7 @@ export declare class HtmlRenderer extends DocumentRenderer {
         width: number;
         height: number;
     }>;
+    onRenderHeadless(): import('rxjs').Observable<Document | undefined>;
     private isImageType;
     private getFrameElement;
     getComputedStyleAfterLoad(): CSSStyleDeclaration | undefined;

package/dist/enhancers/html/renderer/attachFrameSrc.d.ts

@@ -1,7 +1,7 @@
 import { Observable } from 'rxjs';
 import { Manifest } from '@prose-reader/shared';
 import { ReaderSettingsManager } from '../../../settings/ReaderSettingsManager';
-import { ResourceHandler } from '../../../spineItem/ResourceHandler';
+import { ResourceHandler } from '../../../spineItem/resources/ResourceHandler';
 export declare const attachFrameSrc: ({ item, resourcesHandler, }: {
     settings: ReaderSettingsManager;
     item: Manifest[`spineItems`][number];

package/dist/enhancers/html/renderer/medias.d.ts

@@ -0,0 +1,10 @@
+import { Observable } from 'rxjs';
+import { ReaderSettingsManager } from '../../../settings/ReaderSettingsManager';
+import { Manifest } from '@prose-reader/shared';
+import { Context } from '../../../context/Context';
+export declare const loadMedias: ({ settings, item, context, }: {
+    settings: ReaderSettingsManager;
+    item: Manifest["items"][number];
+    context: Context;
+}) => (stream: Observable<HTMLIFrameElement>) => Observable<HTMLIFrameElement>;
+export declare const unloadMedias: (frameElement?: HTMLIFrameElement) => void;

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

@@ -2,5 +2,6 @@ export type InputSettings = {
     pageHorizontalMargin: number;
     pageVerticalMargin: number;
     layoutAutoResize: `container` | false;
+    layoutLayerTransition: boolean;
 };
 export type OutputSettings = InputSettings;

package/dist/enhancers/media/ImageRenderer.d.ts

@@ -12,4 +12,5 @@ export declare class ImageRenderer extends DocumentRenderer {
         width: number;
         height: number;
     }>;
+    onRenderHeadless(): import('rxjs').Observable<never>;
 }

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

@@ -3,11 +3,17 @@ import { progressionEnhancer } from '../progression';
 import { EnhancerOutput } from '../types/enhancer';
 import { PaginationInfo } from '../../pagination/Pagination';
 import { ExtraPaginationInfo } from './types';
+import { ConsolidatedResource, LocatableResource } from './locate';
 type ProgressionEnhancer = typeof progressionEnhancer;
 export declare const paginationEnhancer: <InheritOptions, InheritOutput extends EnhancerOutput<ProgressionEnhancer>, PaginationOutput extends Omit<InheritOutput["pagination"], "state$" | "state"> & {
     state$: Observable<PaginationInfo & ExtraPaginationInfo>;
     state: PaginationInfo & ExtraPaginationInfo;
 }>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => Omit<InheritOutput, "pagination"> & {
-    pagination: PaginationOutput;
+    pagination: PaginationOutput & {
+        locate: <T extends LocatableResource>(resources: T[]) => Observable<{
+            isStale: boolean;
+            data: (ConsolidatedResource & T)[];
+        }>;
+    };
 };
 export {};

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

@@ -0,0 +1,32 @@
+import { Observable } from 'rxjs';
+import { Reader } from '../../reader';
+export type LocatableResource = {
+    cfi: string;
+    endCfi?: string;
+};
+export type ConsolidatedResource = LocatableResource & {
+    meta?: {
+        itemIndex?: number;
+        itemPageIndex?: number;
+        absolutePageIndex?: number;
+        startNode?: Node;
+        startOffset?: number;
+        range?: Range;
+    };
+};
+export declare const consolidate: (item: ConsolidatedResource, reader: Reader) => Observable<{
+    meta: {
+        itemIndex: number | undefined;
+        itemPageIndex?: number;
+        absolutePageIndex?: number;
+        startNode?: Node;
+        startOffset?: number;
+        range?: Range;
+    };
+    cfi: string;
+    endCfi?: string;
+}>;
+export declare const createLocator: (reader: Reader) => <T extends LocatableResource>(resources: T[]) => Observable<{
+    isStale: boolean;
+    data: T[];
+}>;

package/dist/enhancers/selection/selection.d.ts

@@ -6,11 +6,11 @@ export declare const getRangeFromSelection: (anchor: {
     node: Node;
     offset?: number;
 }) => Range | undefined;
-export declare const createRangeFromSelection: ({ selection, spineItem, }: {
+export declare const createOrderedRangeFromSelection: ({ selection, spineItem, }: {
     selection: {
-        anchorNode?: Node;
+        anchorNode?: Node | null;
         anchorOffset?: number;
-        focusNode?: Node;
+        focusNode?: Node | null;
         focusOffset?: number;
     };
     spineItem: SpineItem;

package/dist/enhancers/selection/selectionEnhancer.d.ts

@@ -14,11 +14,11 @@ export declare const selectionEnhancer: <InheritOptions, InheritOutput extends E
         selectionAfterPointerUp$: Observable<[Event, SelectionValue]>;
         lastSelectionOnPointerdown$: Observable<SelectionValue | undefined>;
         getSelection: () => SelectionValue | undefined;
-        createRangeFromSelection: (params: {
+        createOrderedRangeFromSelection: (params: {
             selection: {
-                anchorNode?: Node;
+                anchorNode?: Node | null;
                 anchorOffset?: number;
-                focusNode?: Node;
+                focusNode?: Node | null;
                 focusOffset?: number;
             };
             spineItem: SpineItem;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { createReaderWithEnhancers as createReader } from './createReaderWithEnhancer';
 export type { Manifest } from '@prose-reader/shared';
 export { DocumentRenderer } from './spineItem/renderer/DocumentRenderer';
-export { ResourceHandler } from './spineItem/ResourceHandler';
+export { ResourceHandler } from './spineItem/resources/ResourceHandler';
 export { HookManager } from './hooks/HookManager';
 export { SettingsManager } from './settings/SettingsManager';
 export type Reader = ReturnType<typeof createReader>;
@@ -13,3 +13,4 @@ export { waitForSwitch } from './utils/rxjs';
 export { SpineItem } from './spineItem/SpineItem';
 export * from './utils/DestroyableClass';
 export * from './utils/frames';
+export * from './utils/rxjs';