@prose-reader/core 1.117.0 → 1.119.0

package/dist/navigation/Navigator.d.ts

@@ -31,11 +31,11 @@ export declare const createNavigator: ({ spineItemsManager, context, parentEleme
         getNavigationForSpineItemPage: (params: Omit<Parameters<typeof import('./resolvers/getNavigationForSpineItemPage').getNavigationForSpineItemPage>[0], "context" | "spineItemsManager" | "spineItemNavigationResolver" | "spineLocator">) => import('./viewport/ViewportNavigator').ViewportPosition;
         getNavigationFromSpineItemPosition: (params: {
             spineItemPosition: import('../spineItem/types').UnsafeSpineItemPosition;
-            spineItem: import('../spineItem/createSpineItem').SpineItem;
+            spineItem: import('../spineItem/SpineItem').SpineItem;
         }) => import('./viewport/ViewportNavigator').ViewportPosition;
         getNavigationForCfi: (cfi: string) => import('./viewport/ViewportNavigator').ViewportPosition | undefined;
-        getNavigationForLastPage: (spineItem: import('../spineItem/createSpineItem').SpineItem) => import('./viewport/ViewportNavigator').ViewportPosition;
-        getNavigationForSpineIndexOrId: (indexOrId: number | string | import('../spineItem/createSpineItem').SpineItem) => import('./viewport/ViewportNavigator').ViewportPosition;
+        getNavigationForLastPage: (spineItem: import('../spineItem/SpineItem').SpineItem) => import('./viewport/ViewportNavigator').ViewportPosition;
+        getNavigationForSpineIndexOrId: (indexOrId: number | string | import('../spineItem/SpineItem').SpineItem) => import('./viewport/ViewportNavigator').ViewportPosition;
         getNavigationForPosition: (viewportPosition: import('./viewport/ViewportNavigator').ViewportPosition) => import('./viewport/ViewportNavigator').ViewportPosition;
         getMostPredominantNavigationForPosition: (viewportPosition: import('./viewport/ViewportNavigator').ViewportPosition) => import('./viewport/ViewportNavigator').ViewportPosition;
         getAdjustedPositionWithSafeEdge: (position: import('./viewport/ViewportNavigator').ViewportPosition) => {
@@ -53,9 +53,9 @@ export declare const createNavigator: ({ spineItemsManager, context, parentEleme
         }) => boolean;
         getAdjustedPositionForSpread: (position: import('./viewport/ViewportNavigator').ViewportPosition) => import('./viewport/ViewportNavigator').ViewportPosition;
         spineItemNavigator: {
-            getNavigationForLastPage: (spineItem: import('../spineItem/createSpineItem').SpineItem) => import('../spineItem/types').SafeSpineItemPosition;
-            getNavigationForPosition: (spineItem: import('../spineItem/createSpineItem').SpineItem, position: import('../spineItem/types').UnsafeSpineItemPosition) => import('../spineItem/types').SafeSpineItemPosition;
-            getNavigationFromNode: (spineItem: import('../spineItem/createSpineItem').SpineItem, node: Node, offset: number) => import('../spineItem/types').SafeSpineItemPosition;
+            getNavigationForLastPage: (spineItem: import('../spineItem/SpineItem').SpineItem) => import('../spineItem/types').SafeSpineItemPosition;
+            getNavigationForPosition: (spineItem: import('../spineItem/SpineItem').SpineItem, position: import('../spineItem/types').UnsafeSpineItemPosition) => import('../spineItem/types').SafeSpineItemPosition;
+            getNavigationFromNode: (spineItem: import('../spineItem/SpineItem').SpineItem, node: Node, offset: number) => import('../spineItem/types').SafeSpineItemPosition;
         };
     };
     navigation$: import('rxjs').Observable<{

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

@@ -1,12 +1,12 @@
 import { Context } from '../../context/Context';
 import { SpineItemsManager } from '../../spine/SpineItemsManager';
-import { SpineItem } from '../../spineItem/createSpineItem';
 import { SpineLocator } from '../../spine/locator/SpineLocator';
 import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
 import { ViewportPosition } from '../viewport/ViewportNavigator';
 import { SafeSpineItemPosition, UnsafeSpineItemPosition } from '../../spineItem/types';
 import { getNavigationForSpineItemPage } from './getNavigationForSpineItemPage';
 import { SpineLayout } from '../../spine/SpineLayout';
+import { SpineItem } from '../../spineItem/SpineItem';
 export declare const NAMESPACE = "spineNavigator";
 export type NavigationResolver = ReturnType<typeof createNavigationResolver>;
 export declare const createNavigationResolver: ({ context, spineItemsManager, locator, settings, spineLayout, }: {

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

@@ -1,6 +1,6 @@
 import { Context } from '../../context/Context';
 import { SpineLocator } from '../../spine/locator/SpineLocator';
-import { SpineItem } from '../../spineItem/createSpineItem';
+import { SpineItem } from '../../spineItem/SpineItem';
 import { SpineItemNavigationResolver } from '../../spineItem/navigationResolver';
 import { SpineItemsManager } from '../../spine/SpineItemsManager';
 import { ViewportPosition } from '../viewport/ViewportNavigator';

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

@@ -1,6 +1,6 @@
 import { Context } from '../../context/Context';
 import { SpineLocator } from '../../spine/locator/SpineLocator';
-import { SpineItem } from '../../spineItem/createSpineItem';
+import { SpineItem } from '../../spineItem/SpineItem';
 import { SpineItemLocator } from '../../spineItem/locationResolver';
 import { UnsafeSpineItemPosition } from '../../spineItem/types';
 export declare const getNavigationFromSpineItemPosition: ({ spineItem, spineItemPosition, spineLocator, spineItemLocator, context, }: {

package/dist/reader.d.ts

@@ -6,7 +6,7 @@ import { resolveCfi } from './cfi/lookup/resolveCfi';
 import { SpineItemsManager } from './spine/SpineItemsManager';
 import { SettingsInterface } from './settings/SettingsInterface';
 import { Spine } from './spine/Spine';
-import { SpineItem } from './spineItem/createSpineItem';
+import { SpineItem } from './spineItem/SpineItem';
 export type CreateReaderOptions = Partial<CoreInputSettings>;
 export type CreateReaderParameters = CreateReaderOptions;
 export type ContextSettings = Partial<CoreInputSettings>;
@@ -33,244 +33,10 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
             node: Node | undefined;
             offset: number | undefined;
             spineItemIndex: number;
-            spineItem: {
-                layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
-                    blankPagePosition: `before` | `after` | `none`;
-                    minimumWidth: number;
-                    spreadPosition: `none` | `left` | `right`;
-                }) => {
-                    width: number;
-                    height: number;
-                };
-                item: {
-                    id: string;
-                    href: string;
-                    renditionLayout?: `reflowable` | `pre-paginated`;
-                    progressionWeight?: number;
-                    pageSpreadLeft?: true | undefined;
-                    pageSpreadRight?: true | undefined;
-                    mediaType?: string;
-                };
-                overlayElement: HTMLDivElement;
-                adjustPositionOfElement: ({ right, left, top, }: {
-                    right?: number;
-                    left?: number;
-                    top?: number;
-                }) => void;
-                getElementDimensions: () => {
-                    width: number;
-                    height: number;
-                    x: number;
-                    y: number;
-                    bottom: number;
-                    left: number;
-                    right: number;
-                    top: number;
-                    toJSON(): any;
-                };
-                getHtmlFromResource: (response: Response) => Promise<string>;
-                getResource: () => Promise<Response>;
-                translateFramePositionIntoPage: (position: {
-                    clientX: number;
-                    clientY: number;
-                }) => {
-                    clientX: number;
-                    clientY: number;
-                };
-                injectStyle: (cssText: string) => void;
-                load: () => void;
-                unload: () => void;
-                frame: import('./spineItem/frame/FrameItem').FrameItem;
-                element: HTMLElement;
-                getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
-                getViewPortInformation: () => {
-                    computedScale: number;
-                    computedWidthScale: number;
-                    viewportDimensions: {
-                        width: number;
-                        height: number;
-                    };
-                } | undefined;
-                isImageType: () => boolean;
-                isReady: () => boolean;
-                destroy: () => void;
-                readingDirection: "ltr" | "rtl" | undefined;
-                isUsingVerticalWriting: () => boolean | undefined;
-                executeOnLayoutBeforeMeasurementHook: (options: {
-                    minimumWidth: number;
-                }) => void[];
-                selectionTracker: {
-                    track: (frameToTrack: HTMLIFrameElement) => void;
-                    destroy: () => void;
-                    isSelecting: () => boolean;
-                    getSelection: () => Selection | undefined;
-                    $: import('rxjs').Observable<{
-                        event: `selectionchange`;
-                        data: Selection | null;
-                    } | {
-                        event: `selectstart`;
-                        data: Selection | null;
-                    } | {
-                        event: `selectend`;
-                        data: Selection | null;
-                    }>;
-                };
-                fingerTracker: {
-                    track: (frame: HTMLIFrameElement) => void;
-                    getFingerPositionInIframe(): {
-                        x: number | undefined;
-                        y: number | undefined;
-                    } | undefined;
-                    destroy: () => void;
-                    $: import('rxjs').Observable<{
-                        event: `fingermove`;
-                        data: {
-                            x: number;
-                            y: number;
-                        };
-                    } | {
-                        event: `fingerout`;
-                        data: undefined;
-                    }>;
-                };
-                getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
-                    columnHeight: number;
-                    columnWidth: number;
-                    width: number;
-                };
-                getDimensionsForPaginatedContent: () => {
-                    columnHeight: number;
-                    columnWidth: number;
-                };
-                $: {
-                    contentLayout$: import('rxjs').Observable<{
-                        isFirstLayout: boolean;
-                        isReady: boolean;
-                    }>;
-                    loaded$: import('rxjs').Observable<HTMLIFrameElement>;
-                    isReady$: import('rxjs').Observable<boolean>;
-                };
-            };
+            spineItem: SpineItem;
         } | {
             spineItemIndex: number;
-            spineItem: {
-                layout: ({ blankPagePosition, minimumWidth, spreadPosition, }: {
-                    blankPagePosition: `before` | `after` | `none`;
-                    minimumWidth: number;
-                    spreadPosition: `none` | `left` | `right`;
-                }) => {
-                    width: number;
-                    height: number;
-                };
-                item: {
-                    id: string;
-                    href: string;
-                    renditionLayout?: `reflowable` | `pre-paginated`;
-                    progressionWeight?: number;
-                    pageSpreadLeft?: true | undefined;
-                    pageSpreadRight?: true | undefined;
-                    mediaType?: string;
-                };
-                overlayElement: HTMLDivElement;
-                adjustPositionOfElement: ({ right, left, top, }: {
-                    right?: number;
-                    left?: number;
-                    top?: number;
-                }) => void;
-                getElementDimensions: () => {
-                    width: number;
-                    height: number;
-                    x: number;
-                    y: number;
-                    bottom: number;
-                    left: number;
-                    right: number;
-                    top: number;
-                    toJSON(): any;
-                };
-                getHtmlFromResource: (response: Response) => Promise<string>;
-                getResource: () => Promise<Response>;
-                translateFramePositionIntoPage: (position: {
-                    clientX: number;
-                    clientY: number;
-                }) => {
-                    clientX: number;
-                    clientY: number;
-                };
-                injectStyle: (cssText: string) => void;
-                load: () => void;
-                unload: () => void;
-                frame: import('./spineItem/frame/FrameItem').FrameItem;
-                element: HTMLElement;
-                getBoundingRectOfElementFromSelector: (selector: string) => DOMRect | undefined;
-                getViewPortInformation: () => {
-                    computedScale: number;
-                    computedWidthScale: number;
-                    viewportDimensions: {
-                        width: number;
-                        height: number;
-                    };
-                } | undefined;
-                isImageType: () => boolean;
-                isReady: () => boolean;
-                destroy: () => void;
-                readingDirection: "ltr" | "rtl" | undefined;
-                isUsingVerticalWriting: () => boolean | undefined;
-                executeOnLayoutBeforeMeasurementHook: (options: {
-                    minimumWidth: number;
-                }) => void[];
-                selectionTracker: {
-                    track: (frameToTrack: HTMLIFrameElement) => void;
-                    destroy: () => void;
-                    isSelecting: () => boolean;
-                    getSelection: () => Selection | undefined;
-                    $: import('rxjs').Observable<{
-                        event: `selectionchange`;
-                        data: Selection | null;
-                    } | {
-                        event: `selectstart`;
-                        data: Selection | null;
-                    } | {
-                        event: `selectend`;
-                        data: Selection | null;
-                    }>;
-                };
-                fingerTracker: {
-                    track: (frame: HTMLIFrameElement) => void;
-                    getFingerPositionInIframe(): {
-                        x: number | undefined;
-                        y: number | undefined;
-                    } | undefined;
-                    destroy: () => void;
-                    $: import('rxjs').Observable<{
-                        event: `fingermove`;
-                        data: {
-                            x: number;
-                            y: number;
-                        };
-                    } | {
-                        event: `fingerout`;
-                        data: undefined;
-                    }>;
-                };
-                getDimensionsForReflowableContent: (isUsingVerticalWriting: boolean, minimumWidth: number) => {
-                    columnHeight: number;
-                    columnWidth: number;
-                    width: number;
-                };
-                getDimensionsForPaginatedContent: () => {
-                    columnHeight: number;
-                    columnWidth: number;
-                };
-                $: {
-                    contentLayout$: import('rxjs').Observable<{
-                        isFirstLayout: boolean;
-                        isReady: boolean;
-                    }>;
-                    loaded$: import('rxjs').Observable<HTMLIFrameElement>;
-                    isReady$: import('rxjs').Observable<boolean>;
-                };
-            };
+            spineItem: SpineItem;
             node?: undefined;
             offset?: undefined;
         } | undefined;

package/dist/settings/SettingsManager.d.ts

@@ -1,6 +1,7 @@
 import { Observable, Subject } from 'rxjs';
 import { SettingsInterface } from './SettingsInterface';
-export declare abstract class SettingsManager<InputSettings, OutputSettings> implements SettingsInterface<InputSettings, OutputSettings> {
+import { DestroyableClass } from '../utils/DestroyableClass';
+export declare abstract class SettingsManager<InputSettings, OutputSettings> extends DestroyableClass implements SettingsInterface<InputSettings, OutputSettings> {
     protected inputSettings: InputSettings;
     protected outputSettings?: OutputSettings;
     protected outputSettingsUpdateSubject: Subject<OutputSettings>;

package/dist/settings/types.d.ts

@@ -1,4 +1,6 @@
 import { Manifest } from '@prose-reader/shared';
+import { DocumentRenderer } from '../spineItem/DocumentRenderer';
+import { Observable } from 'rxjs';
 export type CoreInputSettings = {
     forceSinglePageMode: boolean;
     pageTurnAnimation: `none` | `fade` | `slide`;
@@ -8,7 +10,13 @@ export type CoreInputSettings = {
     snapAnimationDuration: number;
     navigationSnapThreshold: number;
     numberOfAdjacentSpineItemToPreLoad: number;
-    fetchResource?: (item: Manifest[`spineItems`][number]) => Promise<Response>;
+    getResource?: (item: Manifest["spineItems"][number]) => Observable<URL | Response | {
+        custom: true;
+        data: unknown;
+    } | undefined> | undefined;
+    getRenderer?: (item: Manifest["spineItems"][number]) => {
+        new (...args: any[]): DocumentRenderer;
+    };
 };
 export type ComputedCoreSettings = {
     computedPageTurnMode: CoreInputSettings[`pageTurnMode`];