@prose-reader/core 1.295.0 → 1.297.0

package/dist/cfi/CfiManager.d.ts

@@ -0,0 +1,43 @@
+import { Manifest } from '@prose-reader/shared';
+import { HookManager } from '../hooks/HookManager';
+import { PageEntry } from '../spine/Pages';
+import { SpineItemsManager } from '../spine/SpineItemsManager';
+import { ProseParsedCfi } from './parse';
+import { resolveCfi as resolveBaseCfi } from './resolve';
+import { SpineItem } from '..';
+export type CfiGenerateHookParams = {
+    cfi: string;
+    spineItem: Manifest["spineItems"][number];
+};
+export type CfiResolveHookParams = {
+    cfi: string;
+};
+export type CfiTransformHook<Params extends {
+    cfi: string;
+}> = (params: Params) => string | undefined;
+export declare class CfiManager {
+    private hookManager;
+    private spineItemsManager;
+    constructor(hookManager: HookManager, spineItemsManager: SpineItemsManager);
+    transformForResolve: (cfi: string) => string;
+    parseCfi: (cfi: string) => ProseParsedCfi & {
+        offset: number;
+    };
+    getSpineItemFromCfi: (cfi: string) => SpineItem | undefined;
+    isRootCfi: (cfi: string) => boolean;
+    generateRootCfi: (item: Manifest["spineItems"][number]) => string;
+    generateCfiForSpineItemPage: ({ spineItem, pageNode, }: {
+        spineItem: Manifest["spineItems"][number];
+        pageNode: NonNullable<PageEntry["firstVisibleNode"]>;
+    }) => string;
+    generateCfiFromRange: (range: Range, item: Manifest[`spineItems`][number]) => string;
+    resolveCfi: (params: Omit<Parameters<typeof resolveBaseCfi>[0], "spineItemsManager">) => Omit<ProseParsedCfi & {
+        offset: number;
+    }, "offset"> & {
+        offset?: number | undefined;
+        node: Node | null;
+        range?: Range | null;
+        spineItem?: SpineItem;
+    };
+    private transformGeneratedCfi;
+}

package/dist/cfi/index.d.ts

@@ -1,3 +1,4 @@
+export * from './CfiManager';
 export * from './generate';
 export * from './parse';
 export * from './resolve';

package/dist/createReaderWithEnhancer.d.ts

@@ -1,7 +1,6 @@
-import { CoreInputSettings, Theme, EnhancerLayoutInputSettings, EnhancerFontsInputSettings, Context, Spine, PageEntry, SpineItem, InternalNavigationEntry, InternalNavigator, ScrollNavigationController, ControlledNavigationController, UserNavigationEntry, SpinePosition, SpineItemPosition, UnboundSpinePosition, NavigationVisibleArea, SpineBoundary, SpineItemsObserver, SpineItemsManager, ContextState, SettingsInterface, CoreOutputSettings, SpineItemReference, Viewport, Features, LayoutEnhancerOutput, ComputedCoreSettings, ExtraPaginationInfo, ResourcesLocator, NavigationEnhancerOutput, ZoomEnhancerOutput } from '.';
+import { CoreInputSettings, Theme, EnhancerLayoutInputSettings, EnhancerFontsInputSettings, Context, Spine, InternalNavigationEntry, InternalNavigator, ScrollNavigationController, ControlledNavigationController, UserNavigationEntry, SpinePosition, SpineItemPosition, SpineItem, UnboundSpinePosition, NavigationVisibleArea, SpineBoundary, SpineItemsObserver, SpineItemsManager, ContextState, SettingsInterface, CoreOutputSettings, SpineItemReference, Viewport, Features, LayoutEnhancerOutput, ComputedCoreSettings, ExtraPaginationInfo, ResourcesLocator, NavigationEnhancerOutput, ZoomEnhancerOutput } from '.';
 import { HookManager, CoreHook } from './hooks';
-import { Manifest } from '@prose-reader/shared';
-import { ProseParsedCfi, resolveCfi } from './cfi';
+import { CfiManager } from './cfi';
 import { Observable, ObservedValueOf, Subject } from 'rxjs';
 import { getNavigationForSpineItemPage } from './navigation/resolvers/getNavigationForSpineItemPage';
 import { PaginationInfo, Pagination } from './pagination';
@@ -12,24 +11,7 @@ export declare const createReaderWithEnhancers: (options: Partial< CoreInputSett
     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< 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;

package/dist/enhancers/html/renderer/createHtmlPageFromResource.test.d.ts

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

package/dist/enhancers/html/renderer/reflowable/renderReflowable.d.ts

@@ -1,10 +1,11 @@
 import { Manifest } from '@prose-reader/shared';
-export declare const renderReflowable: ({ pageHeight: pageSizeHeight, pageWidth, frameElement, manifest, minPageSpread, isRTL, blankPagePosition, isImageType, enableTouch, isUsingVerticalWriting, }: {
+export declare const renderReflowable: ({ pageHeight: pageSizeHeight, pageWidth, frameElement, manifest, renditionFlow, minPageSpread, isRTL, blankPagePosition, isImageType, enableTouch, isUsingVerticalWriting, }: {
     blankPagePosition: `before` | `after` | `none`;
     pageWidth: number;
     pageHeight: number;
     frameElement: HTMLIFrameElement;
     manifest?: Manifest;
+    renditionFlow?: Manifest["renditionFlow"];
     minPageSpread: number;
     isRTL: boolean;
     isImageType: boolean;

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

@@ -1,12 +1,12 @@
 import { Observable } from 'rxjs';
-import { ProseParsedCfi, resolveCfi } from '../../cfi';
+import { ProseParsedCfi } from '../../cfi';
 import { Reader } from '../../reader';
 import { SpineItem } from '../../spineItem/SpineItem';
 type CfiLocatableResource = {
     cfi: string;
 };
 export type LocatableResource = SpineItem | CfiLocatableResource;
-export type ConsolidatedResource = ReturnType<typeof resolveCfi> & ProseParsedCfi & CfiLocatableResource & {
+export type ConsolidatedResource = ReturnType<Reader["cfi"]["resolveCfi"]> & ProseParsedCfi & CfiLocatableResource & {
     itemPageIndex?: number;
     absolutePageIndex?: number;
     startOffset?: number;

package/dist/hooks/HookManager.d.ts

@@ -1,10 +1,17 @@
-import { CoreHook, Hook, HookExecution, HookFrom } from './types';
 import { Observable } from 'rxjs';
+import { AsyncHookName, AsyncHookParams, CoreHook, Hook, HookExecution, HookFrom, HookParams, HookResult, SyncHookName } from './types';
 export declare class HookManager<H extends Hook<any, any, any> = CoreHook> {
     _hooks: Array<H>;
     _hookExecutions: Array<HookExecution<H>>;
+    private getHooks;
     protected deregister(hookToDeregister: H): Observable<unknown[]>;
     register<Name extends H["name"]>(name: Name, fn: HookFrom<H, Name>["runFn"]): () => void;
-    execute<Name extends H["name"]>(name: Name, id: string | undefined, params: Omit<Parameters<HookFrom<H, Name>["runFn"]>[0], "destroy" | "destroy$">): ReturnType<HookFrom<H, Name>["runFn"]>[];
+    execute<Name extends SyncHookName<H>>(name: Name, params: HookParams<H, Name>): HookResult<H, Name>[];
+    executeAsync<Name extends AsyncHookName<H>>(name: Name, id: string | undefined, params: Omit<HookParams<H, Name>, keyof AsyncHookParams>, signal?: AbortSignal): Promise<Awaited<HookResult<H, Name>>[]>;
+    fromExecuteAsync<Name extends AsyncHookName<H>>(name: Name, id: string | undefined, params: Omit<HookParams<H, Name>, keyof AsyncHookParams>): Observable<Awaited<HookResult<H, Name>>[]>;
+    executeSequential<Name extends SyncHookName<H>>(name: Name, params: HookParams<H, Name>, getNextParams: (params: HookParams<H, Name>, result: HookResult<H, Name>) => HookParams<H, Name>): {
+        finalParams: HookParams<H, Name>;
+        results: HookResult<H, Name>[];
+    };
     destroy<Name extends H["name"]>(name: Name, id?: string, ref?: H): Observable<unknown[]>;
 }

package/dist/hooks/HookManager.test.d.ts

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

package/dist/hooks/types.d.ts

@@ -1,24 +1,46 @@
 import { Manifest } from '@prose-reader/shared';
 import { Observable } from 'rxjs';
-export type UserDestroyFn = () => void | Observable<unknown>;
-export interface Hook<Name, Params, Result> {
+export type AsyncHookParams = {
+    signal: AbortSignal;
+};
+export interface SyncHook<Name, Params, Result> {
     name: Name;
     runFn: (params: Params) => Result;
 }
+export interface AsyncHook<Name, Params, Result> {
+    name: Name;
+    runFn: (params: AsyncHookParams & Params) => Promise<Result>;
+}
+export type Hook<Name, Params, Result> = SyncHook<Name, Params, Result> | AsyncHook<Name, Params, Result>;
 export type CoreHook = {
     name: `item.onDocumentCreated`;
     runFn: (params: {
         itemId: string;
         documentContainer: HTMLElement;
-    }) => Observable<void> | void;
+    }) => void;
 } | {
-    name: `item.onDocumentLoad`;
+    name: "cfi.afterGenerate";
+    runFn: (params: {
+        cfi: string;
+        spineItem: Manifest["spineItems"][number];
+    }) => string | undefined;
+} | {
+    name: "cfi.beforeResolve";
     runFn: (params: {
-        destroy$: Observable<void>;
-        destroy: (fn: UserDestroyFn) => void;
+        cfi: string;
+    }) => string | undefined;
+} | {
+    name: `item.onDocumentLoad`;
+    runFn: (params: AsyncHookParams & {
+        itemId: string;
+        documentContainer: HTMLElement;
+    }) => Promise<void>;
+} | {
+    name: `item.onDocumentUnload`;
+    runFn: (params: AsyncHookParams & {
         itemId: string;
         documentContainer: HTMLElement;
-    }) => Observable<void> | void;
+    }) => Promise<void>;
 } | {
     name: "item.onBeforeLayout";
     runFn: (params: {
@@ -49,3 +71,7 @@ export type HookExecution<H extends Hook<any, any, any>> = {
     ref: H;
 };
 export type HookFrom<H extends Hook<any, any, any>, Name extends H["name"]> = H extends infer HK ? HK extends H ? HK["name"] extends Name ? HK : never : never : never;
+export type HookParams<H extends Hook<any, any, any>, Name extends H["name"]> = Parameters<HookFrom<H, Name>["runFn"]>[0];
+export type HookResult<H extends Hook<any, any, any>, Name extends H["name"]> = ReturnType<HookFrom<H, Name>["runFn"]>;
+export type AsyncHookName<H extends Hook<any, any, any>> = H extends infer HK ? HK extends H ? ReturnType<HK["runFn"]> extends Promise<unknown> ? HK["name"] : never : never : never;
+export type SyncHookName<H extends Hook<any, any, any>> = H extends infer HK ? HK extends H ? ReturnType<HK["runFn"]> extends Promise<unknown> ? never : HK["name"] : never : never;