@prose-reader/core 1.202.0 → 1.204.0

package/dist/createReaderWithEnhancer.d.ts

@@ -128,9 +128,9 @@ 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<(import('./enhancers/pagination/locate').ConsolidatedResource & T)[]>;
     };
+    locateResources: import('./enhancers/pagination/ResourcesLocator').ResourcesLocator["locateMultiple"];
+    locateResource: import('./enhancers/pagination/ResourcesLocator').ResourcesLocator["locate"];
 } & {
     theme: {
         set: (theme: import('.').Theme) => void;

package/dist/enhancers/navigation/navigators/manualNavigator.d.ts

@@ -1,6 +1,7 @@
 import { UserNavigationEntry } from '../../../navigation/types';
 import { Reader } from '../../../reader';
 import { SpinePosition } from '../../../spine/types';
+import { SpineItemReference } from '../../../spineItem/SpineItem';
 export declare class ManualNavigator {
     protected reader: Reader;
     movingLastDelta: {
@@ -20,7 +21,7 @@ export declare class ManualNavigator {
         animate: boolean;
     }): void;
     goToSpineItem({ indexOrId, ...rest }: {
-        indexOrId: number | string;
+        indexOrId: SpineItemReference;
     } & Pick<UserNavigationEntry, "animation">): void;
     goToNextSpineItem(): void;
     goToPreviousSpineItem(): void;

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

@@ -0,0 +1,34 @@
+import { Observable } from 'rxjs';
+import { Reader } from '../../reader';
+import { SpineItem } from '../../spineItem/SpineItem';
+type CfiLocatableResource = {
+    cfi: string;
+    endCfi?: string;
+};
+export type LocatableResource = SpineItem | CfiLocatableResource;
+export type ConsolidatedResource = CfiLocatableResource & {
+    itemIndex?: number;
+    itemPageIndex?: number;
+    absolutePageIndex?: number;
+    startNode?: Node;
+    startOffset?: number;
+    range?: Range;
+};
+export declare const consolidate: (resource: ConsolidatedResource, reader: Reader) => Observable<ConsolidatedResource>;
+export declare class ResourcesLocator {
+    private reader;
+    constructor(reader: Reader);
+    locate: <T extends LocatableResource>(resource: T, options?: {
+        mode?: "shallow" | "load";
+    }) => Observable<{
+        resource: T;
+        meta: ConsolidatedResource;
+    }>;
+    locateMultiple: <T extends LocatableResource>(resources: T[], options?: {
+        mode?: "shallow" | "load";
+    }) => Observable<{
+        resource: T;
+        meta: ConsolidatedResource;
+    }[]>;
+}
+export {};

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

@@ -1,14 +1,4 @@
-import { Observable } from 'rxjs';
-import { PaginationInfo } from '../../pagination/Pagination';
 import { LayoutEnhancerOutput } from '../layout/layoutEnhancer';
 import { EnhancerOutput, RootEnhancer } from '../types/enhancer';
-import { ConsolidatedResource, LocatableResource } from './locate';
-import { ExtraPaginationInfo } from './types';
-export declare const paginationEnhancer: <InheritOptions, InheritOutput extends EnhancerOutput<RootEnhancer> & LayoutEnhancerOutput, 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 & {
-        locate: <T extends LocatableResource>(resources: T[]) => Observable<(ConsolidatedResource & T)[]>;
-    };
-};
+import { PaginationEnhancerAPI } from './types';
+export declare const paginationEnhancer: <InheritOptions, InheritOutput extends EnhancerOutput<RootEnhancer> & LayoutEnhancerOutput, PaginationOutput extends PaginationEnhancerAPI<InheritOutput>>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => PaginationOutput;

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

@@ -1,4 +1,7 @@
+import { Observable } from 'rxjs';
 import { PaginationInfo } from '../../pagination/Pagination';
+import { EnhancerOutput, RootEnhancer } from '../types/enhancer';
+import { ResourcesLocator } from './ResourcesLocator';
 import { ChapterInfo } from './chapters';
 export type ExtraPaginationInfo = {
     beginChapterInfo: ChapterInfo | undefined;
@@ -12,3 +15,11 @@ export type ExtraPaginationInfo = {
     isUsingSpread: boolean;
 };
 export type EnhancerPaginationInto = PaginationInfo & ExtraPaginationInfo;
+export type PaginationEnhancerAPI<InheritOutput extends EnhancerOutput<RootEnhancer>> = Omit<InheritOutput, "pagination"> & {
+    pagination: Omit<InheritOutput["pagination"], "state$" | "state"> & {
+        state$: Observable<PaginationInfo & ExtraPaginationInfo>;
+        state: PaginationInfo & ExtraPaginationInfo;
+    };
+    locateResources: ResourcesLocator["locateMultiple"];
+    locateResource: ResourcesLocator["locate"];
+};

package/dist/index.js

@@ -677,6 +677,17 @@ const observeMutation = (target, options) => {
     return () => observer.disconnect();
   });
 };
+function observeIntersection(element, options) {
+  return new Observable((observer) => {
+    const intersectionObserver = new IntersectionObserver((entries) => {
+      observer.next(entries);
+    }, options);
+    intersectionObserver.observe(element);
+    return () => {
+      intersectionObserver.disconnect();
+    };
+  });
+}
 class SettingsManagerOverload {
   constructor(initialSettings, settingsManager) {
     this.settingsManager = settingsManager;
@@ -934,7 +945,7 @@ class DestroyableClass {
     this.destroySubject.complete();
   }
 }
-class DocumentRenderer extends DestroyableClass {
+const _DocumentRenderer = class _DocumentRenderer extends DestroyableClass {
   constructor(params) {
     super();
     this.triggerSubject = new Subject();
@@ -1024,6 +1035,12 @@ class DocumentRenderer extends DestroyableClass {
     );
     merge(unload$).pipe(takeUntil(this.destroy$)).subscribe();
   }
+  setDocumentContainer(element) {
+    this._documentContainer = element;
+    this._documentContainer.classList.add(
+      _DocumentRenderer.DOCUMENT_CONTAINER_CLASS_NAME
+    );
+  }
   attach() {
     if (this.documentContainer) {
       this.containerElement.appendChild(this.documentContainer);
@@ -1031,8 +1048,8 @@ class DocumentRenderer extends DestroyableClass {
   }
   detach() {
     var _a;
-    (_a = this.documentContainer) == null ? void 0 : _a.remove();
-    this.documentContainer = void 0;
+    (_a = this._documentContainer) == null ? void 0 : _a.remove();
+    this._documentContainer = void 0;
   }
   get state$() {
     return this.stateSubject;
@@ -1070,13 +1087,16 @@ class DocumentRenderer extends DestroyableClass {
     );
   }
   layout(params) {
-    return defer(() => this.onLayout(params)).pipe();
+    return defer(() => this.onLayout(params));
   }
   destroy() {
     this.unload();
     this.stateSubject.complete();
     super.destroy();
   }
+  get documentContainer() {
+    return this._documentContainer;
+  }
   get writingMode() {
     return void 0;
   }
@@ -1094,7 +1114,9 @@ class DocumentRenderer extends DestroyableClass {
     }
     return ((_a = this.context.manifest) == null ? void 0 : _a.renditionLayout) ?? "reflowable";
   }
-}
+};
+_DocumentRenderer.DOCUMENT_CONTAINER_CLASS_NAME = `prose-reader-document-container`;
+let DocumentRenderer = _DocumentRenderer;
 const defaultGetResource = (item) => new URL(item.href);
 class ResourceHandler {
   constructor(item, settings) {
@@ -1887,7 +1909,7 @@ class HtmlRenderer extends DocumentRenderer {
   }
   onCreateDocument() {
     const frameElement = createFrameElement();
-    this.documentContainer = frameElement;
+    this.setDocumentContainer(frameElement);
     return of(frameElement);
   }
   onLoadDocument() {
@@ -2554,7 +2576,7 @@ class ImageRenderer extends DocumentRenderer {
     const imgElement = this.containerElement.ownerDocument.createElement(`img`);
     return from(this.resourcesHandler.getResource()).pipe(
       switchMap((responseOrUrl) => {
-        this.documentContainer = imgElement;
+        this.setDocumentContainer(imgElement);
         imgElement.style.objectFit = `contain`;
         imgElement.style.userSelect = `none`;
         if (responseOrUrl instanceof URL) {
@@ -3040,7 +3062,7 @@ class ManualNavigator {
       return;
     }
     this.reader.navigation.navigate({
-      spineItem: indexOrId,
+      spineItem: spineItem.index,
       ...rest
     });
   }
@@ -3314,91 +3336,118 @@ const navigationEnhancer = (next) => (options) => {
     }
   };
 };
-const NAMESPACE$4 = `paginationEnhancer`;
-const consolidate = (item, reader) => {
-  var _a;
-  let itemPageIndex = (_a = item.meta) == null ? void 0 : _a.itemPageIndex;
-  const { itemIndex } = reader.cfi.parseCfi(item.cfi);
-  const spineItem = reader.spineItemsManager.get(itemIndex);
-  if (!spineItem) return of({ ...item, meta: { ...item.meta, itemIndex } });
-  if (spineItem.renditionLayout === `pre-paginated`) {
-    itemPageIndex = 0;
+const getItemAnchor = (item) => `|[prose~anchor~${encodeURIComponent(item.index)}]`;
+const getRootCfi = (spineItem) => {
+  const itemAnchor = getItemAnchor(spineItem.item);
+  return `epubcfi(/0${itemAnchor})`;
+};
+const toCfiLocatableResource = (reader, resource) => {
+  if ("cfi" in resource) {
+    return resource;
   }
+  const item = reader.spineItemsManager.get(resource);
+  if (!item) {
+    throw new Error(`Spine item not found`);
+  }
+  return {
+    cfi: getRootCfi(item)
+  };
+};
+const consolidate = (resource, reader) => {
+  let itemPageIndex = resource == null ? void 0 : resource.itemPageIndex;
+  const { itemIndex } = reader.cfi.parseCfi(resource.cfi);
+  const spineItem = reader.spineItemsManager.get(itemIndex);
+  if (!spineItem) return of({ ...resource, itemIndex });
   return idle().pipe(
     withLatestFrom(spineItem.isReady$),
     map(([, isSpineItemReady]) => {
-      var _a2, _b, _c;
+      var _a;
       let range = void 0;
-      const { node: startNode, offset: startOffset } = reader.cfi.resolveCfi({ cfi: item.cfi }) ?? {};
-      if (spineItem.renditionLayout !== `pre-paginated` && startNode) {
+      const { node: startNode, offset: startOffset } = reader.cfi.resolveCfi({ cfi: resource.cfi }) ?? {};
+      const reflowableItemWithFoundNode = spineItem.renditionLayout !== `pre-paginated` && startNode;
+      if (reflowableItemWithFoundNode) {
         itemPageIndex = reader.spine.locator.spineItemLocator.getSpineItemPageIndexFromNode(
           startNode,
           startOffset ?? 0,
           spineItem
         ) ?? itemPageIndex;
       }
-      if (startNode && item.endCfi) {
-        const { node: endNode, offset: endOffset } = reader.cfi.resolveCfi({ cfi: item.cfi }) ?? {};
+      if (startNode && resource.endCfi) {
+        const { node: endNode, offset: endOffset } = reader.cfi.resolveCfi({ cfi: resource.cfi }) ?? {};
         if (endNode && isSpineItemReady) {
-          range = (_a2 = startNode == null ? void 0 : startNode.ownerDocument) == null ? void 0 : _a2.createRange();
+          range = (_a = startNode == null ? void 0 : startNode.ownerDocument) == null ? void 0 : _a.createRange();
           range == null ? void 0 : range.setStart(startNode, startOffset ?? 0);
           range == null ? void 0 : range.setEnd(endNode, endOffset ?? 0);
         }
       }
-      let absolutePageIndex = (_b = item.meta) == null ? void 0 : _b.absolutePageIndex;
-      if (itemPageIndex !== void 0) {
-        absolutePageIndex = reader.spine.locator.getAbsolutePageIndexFromPageIndex({
-          pageIndex: itemPageIndex,
-          spineItemOrId: spineItem
-        }) ?? ((_c = item.meta) == null ? void 0 : _c.absolutePageIndex);
+      let absolutePageIndex = resource == null ? void 0 : resource.absolutePageIndex;
+      if (itemPageIndex === void 0) {
+        itemPageIndex = 0;
       }
+      absolutePageIndex = reader.spine.locator.getAbsolutePageIndexFromPageIndex({
+        pageIndex: itemPageIndex,
+        spineItemOrId: spineItem
+      }) ?? (resource == null ? void 0 : resource.absolutePageIndex);
       return {
-        ...item,
-        meta: {
-          ...item.meta,
-          range,
-          itemIndex,
-          startNode,
-          startOffset,
-          absolutePageIndex,
-          itemPageIndex
-        }
+        ...resource,
+        range,
+        itemIndex,
+        startNode,
+        startOffset,
+        absolutePageIndex,
+        itemPageIndex
       };
     })
   );
 };
-const createLocator = (reader) => (resources) => {
-  return deferIdle(() => {
-    if (!resources.length) return of(resources);
-    const consolidate$ = reader.spine.spineLayout.layout$.pipe(
-      debounceTime$1(10),
-      startWith$1(null),
-      switchScan((acc$) => {
-        return forkJoin(
-          acc$.map(
-            (resource) => deferIdle(() => consolidate(resource, reader)).pipe(
-              map((value) => value)
-            )
-          )
+class ResourcesLocator {
+  constructor(reader) {
+    this.reader = reader;
+    this.locate = (resource, options = {}) => {
+      const cfiConsolidatedResource = {
+        resource,
+        meta: toCfiLocatableResource(this.reader, resource)
+      };
+      return deferIdle(() => {
+        var _a;
+        const consolidate$ = this.reader.spine.spineLayout.layout$.pipe(
+          debounceTime$1(10),
+          startWith$1(cfiConsolidatedResource),
+          switchScan((acc) => {
+            return consolidate(acc.meta, this.reader).pipe(
+              map((consolidatedResource) => ({
+                ...acc,
+                meta: consolidatedResource
+              }))
+            );
+          }, cfiConsolidatedResource)
         );
-      }, resources)
-    );
-    const reflowableItemIndexes = resources.map((item) => reader.cfi.parseCfi(item.cfi).itemIndex).filter(isDefined).filter((index) => {
-      var _a;
-      return ((_a = reader.spineItemsManager.get(index)) == null ? void 0 : _a.renditionLayout) === `reflowable`;
-    });
-    const release = reader.spine.spineItemsLoader.forceOpen(
-      reflowableItemIndexes
-    );
-    return consolidate$.pipe(
-      finalize(() => {
-        setTimeout(() => {
-          release();
-        }, 1e3);
-      })
-    );
-  });
-};
+        const itemIndex = (_a = this.reader.cfi.parseCfi(
+          cfiConsolidatedResource.meta.cfi
+        )) == null ? void 0 : _a.itemIndex;
+        const item = this.reader.spineItemsManager.get(itemIndex);
+        const isReflowable = (item == null ? void 0 : item.renditionLayout) === `reflowable`;
+        const release = options.mode === "shallow" || !isReflowable || !item ? () => {
+        } : this.reader.spine.spineItemsLoader.forceOpen([item.index]);
+        return consolidate$.pipe(
+          finalize(() => {
+            setTimeout(() => {
+              release();
+            }, 1e3);
+          })
+        );
+      });
+    };
+    this.locateMultiple = (resources, options = {}) => {
+      return deferIdle(
+        () => combineLatest(
+          resources.map((resource) => this.locate(resource, options))
+        )
+      );
+    };
+  }
+}
+const NAMESPACE$4 = `paginationEnhancer`;
 const buildChaptersInfo = (href, tocItem, manifest) => {
   const spineItemIndex = manifest.spineItems.findIndex(
     (item) => item.href === href
@@ -3674,14 +3723,15 @@ const paginationEnhancer = (next) => (options) => {
   const reader = next(options);
   const { paginationInfo$, getPaginationInfo } = trackPaginationInfo(reader);
   paginationInfo$.pipe(takeUntil(reader.$.destroy$)).subscribe();
-  const locate = createLocator(reader);
+  const resourcesLocator = new ResourcesLocator(reader);
   return {
     ...reader,
+    locateResources: resourcesLocator.locateMultiple,
+    locateResource: resourcesLocator.locate,
     pagination: {
       ...reader.pagination,
       getState: () => getPaginationInfo(),
-      state$: paginationInfo$,
-      locate
+      state$: paginationInfo$
     }
   };
 };
@@ -4391,7 +4441,6 @@ const zoomEnhancer = (next) => (options) => {
     }
   };
 };
-const getItemAnchor = (item) => `|[prose~anchor~${encodeURIComponent(item.index)}]`;
 const ELEMENT_NODE = Node.ELEMENT_NODE;
 const TEXT_NODE = Node.TEXT_NODE;
 const CDATA_SECTION_NODE = Node.CDATA_SECTION_NODE;
@@ -5284,10 +5333,6 @@ const generateCfi = (node, offset, item) => {
     `${getItemAnchor(item)}|${offsetAnchor}`
   );
 };
-const getRootCfi = (spineItem) => {
-  const itemAnchor = getItemAnchor(spineItem.item);
-  return `epubcfi(/0${itemAnchor})`;
-};
 const generateCfiForSpineItemPage = Report.measurePerformance(
   `getCfi`,
   10,
@@ -9293,6 +9338,7 @@ export {
   isHtmlTagElement,
   isShallowEqual2 as isShallowEqual,
   mapKeysTo,
+  observeIntersection,
   observeMutation,
   observeResize,
   removeCSS,