@prose-reader/core 1.275.0 → 1.276.0

package/dist/enhancers/layout/createPlaceholderPages.d.ts

@@ -1,7 +1,7 @@
 import { Observable } from 'rxjs';
 import { Reader } from '../../reader';
 import { Theme } from '../theme';
-import { SpineItemState, PageEntry } from '../..';
+import { SpineItemState, PagesState } from '../..';
 export declare const HTML_PREFIX = "prose-reader-enhancer-loading";
 export declare const CONTAINER_HTML_PREFIX = "prose-reader-enhancer-loading-container";
 export declare const createPlaceholderPages: (reader: Reader & {
@@ -10,6 +10,4 @@ export declare const createPlaceholderPages: (reader: Reader & {
             theme$: Observable<Theme>;
         };
     };
-}) => Observable< SpineItemState | [{
-    pages: PageEntry[];
-}, Theme]>;
+}) => Observable< SpineItemState | [ PagesState, Theme]>;

package/dist/enhancers/pagination/chapters/index.d.ts

@@ -0,0 +1,4 @@
+export { resolveChapterInfoFromVisibleNode } from './node';
+export { buildTocCandidatesBySpineHref, buildTocIndex } from './shared';
+export { buildChaptersInfo, buildStaticChaptersInfo } from './static';
+export type { ChapterInfo, TocCandidatesBySpineHref, TocIndex } from './types';

package/dist/enhancers/pagination/chapters/node.d.ts

@@ -0,0 +1,10 @@
+import { PageEntry } from '../../../spine/Pages';
+import { SpineItem } from '../../../spineItem/SpineItem';
+import { ChapterInfo, FlatTocEntry } from './types';
+export declare const resolveChapterInfoFromVisibleNode: ({ node, offset, candidates, spineItem, nextPageEntry, }: {
+    candidates: FlatTocEntry[];
+    node: Node | undefined;
+    offset: number | undefined;
+    spineItem: SpineItem;
+    nextPageEntry: PageEntry | undefined;
+}) => ChapterInfo | undefined;

package/dist/enhancers/pagination/chapters/shared.d.ts

@@ -0,0 +1,14 @@
+import { Manifest } from '@prose-reader/shared';
+import { ChapterInfo, FlatTocEntry, TocCandidatesBySpineHref, TocPathEntry } from './types';
+type Toc = NonNullable<Manifest["nav"]>["toc"];
+export declare const stripAnchor: (value: string) => string;
+export declare const safeDecode: (value: string) => string;
+export declare const buildTocIndex: (toc: Toc, manifest: Manifest) => FlatTocEntry[];
+export declare const buildTocCandidatesBySpineHref: ({ manifest, tocIndex, }: {
+    manifest: Manifest;
+    tocIndex: FlatTocEntry[];
+}) => TocCandidatesBySpineHref;
+export declare const hrefMatches: (a: string, b: string) => boolean;
+export declare const isPossibleTocItemCandidateForHref: (hrefWithoutAnchor: string, tocItemHrefWithoutAnchor: string) => boolean;
+export declare const buildChapterInfoFromChain: (chain: TocPathEntry[]) => ChapterInfo | undefined;
+export {};

package/dist/enhancers/pagination/chapters/static.d.ts

@@ -0,0 +1,6 @@
+import { Manifest } from '@prose-reader/shared';
+import { ChapterInfo, TocIndex } from './types';
+export declare const buildChaptersInfo: (href: string, tocItem: NonNullable<Manifest["nav"]>["toc"], manifest: Manifest) => ChapterInfo | undefined;
+export declare const buildStaticChaptersInfo: (manifest: Manifest, tocIndex: TocIndex) => {
+    [key: string]: ChapterInfo | undefined;
+};

package/dist/enhancers/pagination/chapters/types.d.ts

@@ -0,0 +1,29 @@
+export type ChapterInfo = {
+    title: string;
+    subChapter?: {
+        title: string;
+        subChapter?: {
+            title: string;
+            subChapter?: {
+                title: string;
+                path: string;
+            };
+            path: string;
+        };
+        path: string;
+    };
+    path: string;
+};
+export type TocPathEntry = {
+    title: string;
+    path: string;
+};
+export type FlatTocEntry = {
+    chain: TocPathEntry[];
+    href: string;
+    hrefWithoutAnchor: string;
+    anchorId: string | undefined;
+    spineItemIndex: number;
+};
+export type TocIndex = FlatTocEntry[];
+export type TocCandidatesBySpineHref = Map<string, FlatTocEntry[]>;

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

@@ -1,3 +1,4 @@
+import { Manifest } from '@prose-reader/shared';
 import { Reader } from '../../reader';
 import { SpineItem } from '../../spineItem/SpineItem';
 import { LayoutEnhancerOutput } from '../layout/layoutEnhancer';
@@ -5,4 +6,4 @@ import { Observable } from 'rxjs';
 export declare const getPercentageEstimate: (reader: Reader & LayoutEnhancerOutput, currentSpineIndex: number, pageIndex: number, currentPosition: {
     x: number;
     y: number;
-}, currentItem: SpineItem) => Observable<number>;
+}, currentItem: SpineItem, manifest: Manifest) => Observable<number>;

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

@@ -0,0 +1,25 @@
+import { Reader } from '../../reader';
+import { LayoutEnhancerOutput } from '../layout/layoutEnhancer';
+import { Observable } from 'rxjs';
+import { ChapterInfo } from './chapters';
+export declare const trackPaginationInfo: (reader: Reader & LayoutEnhancerOutput) => Observable<{
+    percentageEstimateOfBook: number;
+    numberOfPagesPerItems: number[];
+    numberOfTotalPages: number;
+    isUsingSpread: boolean;
+    beginChapterInfo: ChapterInfo | undefined;
+    beginSpineItemReadingDirection: "ltr" | "rtl" | undefined;
+    beginAbsolutePageIndex: number | undefined;
+    endChapterInfo: ChapterInfo | undefined;
+    endSpineItemReadingDirection: "ltr" | "rtl" | undefined;
+    endAbsolutePageIndex: number | undefined;
+    beginPageIndexInSpineItem: number | undefined;
+    beginNumberOfPagesInSpineItem: number;
+    beginCfi: string | undefined;
+    beginSpineItemIndex: number | undefined;
+    endPageIndexInSpineItem: number | undefined;
+    endNumberOfPagesInSpineItem: number;
+    endCfi: string | undefined;
+    endSpineItemIndex: number | undefined;
+    navigationId?: symbol;
+}>;

package/dist/enhancers/pagination/trackPaginationInfo.test.d.ts

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