@prose-reader/streamer 1.286.0 → 1.289.0

package/dist/Streamer.d.ts

@@ -9,7 +9,7 @@ type OnManifestSuccess = (params: {
 }) => Observable<Manifest> | Promise<Manifest>;
 type WithArchiveResponse = (archive: Archive) => Observable<Response> | Promise<Response>;
 export declare class Streamer {
-    protected epubLoader: ReturnType<typeof createArchiveLoader>;
+    protected archiveLoader: ReturnType<typeof createArchiveLoader>;
     protected onError: OnError;
     protected onManifestSuccess: OnManifestSuccess;
     protected lastAccessedKey: string | undefined;

package/dist/epubs/getSpineItemFilesFromArchive.d.ts

@@ -1,6 +1,8 @@
 import { Archive } from '../archives/types';
-export declare const getSpineItemFilesFromArchive: ({ archive, }: {
+import { ArchiveOpfParsed } from './readArchiveOpf';
+export declare const getSpineItemFilesFromArchive: ({ archive, archiveOpf, }: {
     archive: Archive;
+    archiveOpf: ArchiveOpfParsed | undefined;
 }) => Promise<({
     dir: false;
     basename: string;

package/dist/epubs/readArchiveOpf.d.ts

@@ -0,0 +1,17 @@
+import { OpfMetadata } from '@prose-reader/archive-parser';
+import { Archive } from '../archives/types';
+export type ArchiveOpfParsed = {
+    opf: OpfMetadata;
+    basePath: string;
+};
+/**
+ * Loads and parses the package OPF from `archive`.
+ *
+ * **Attention — not memoized:** every call re-reads the OPF record and runs
+ * `parseOpf`. Manifest generation already avoids redundant parses by awaiting
+ * this once and passing `archiveOpf` into manifest hooks. The resource pipeline
+ * (`generateResourceFromArchive` → `defaultHook`) invokes this again per
+ * resource unless callers later thread parsed OPF in explicitly (optional
+ * parameter, archive open hook, etc.).
+ */
+export declare function readArchiveOpf(archive: Archive): Promise<ArchiveOpfParsed | undefined>;

package/dist/generators/manifest/hooks/comicInfo.d.ts

@@ -1,10 +1,6 @@
 import { Manifest } from '@prose-reader/shared';
 import { Archive } from '../../../archives/types';
-/**
- * Handle archive which contains ComicInfo.xml. This is a meta file
- * used to define cbz, etc. I believe it comes from some sites or apps.
- */
-export declare const comicInfoHook: ({ archive }: {
+export declare const comicInfo: ({ archive }: {
     archive: Archive;
     baseUrl: string;
 }) => (manifest: Manifest) => Promise<Manifest>;

package/dist/generators/manifest/hooks/epub/epub.d.ts

@@ -1,12 +1,17 @@
 import { Manifest } from '@prose-reader/shared';
-import { XmlDocument, XmlElement } from 'xmldoc';
 import { Archive } from '../../../../archives/types';
-export declare const getItemsFromDoc: (doc: XmlDocument, archive: Archive, getBaseUrl?: (element: XmlElement) => string) => {
+import { ArchiveOpfParsed } from '../../../../epubs/readArchiveOpf';
+export declare const getItemsFromDoc: (manifestItems: ReadonlyArray<{
+    id: string;
+    href: string;
+    mediaType?: string;
+}>, archive: Archive, getBaseUrlForHref?: (href: string) => string) => {
     href: string;
     id: string;
     mediaType: string | undefined;
 }[];
-export declare const epubHook: ({ archive, baseUrl }: {
+export declare const epubHook: ({ archive, baseUrl, archiveOpf, }: {
     archive: Archive;
     baseUrl: string;
+    archiveOpf: ArchiveOpfParsed | undefined;
 }) => (manifest: Manifest) => Promise<Manifest>;

package/dist/generators/manifest/hooks/epubOptimizer.d.ts

@@ -1,6 +1,8 @@
 import { Manifest } from '@prose-reader/shared';
 import { Archive } from '../../../archives/types';
-export declare const epubOptimizerHook: ({ archive }: {
+import { ArchiveOpfParsed } from '../../../epubs/readArchiveOpf';
+export declare const epubOptimizerHook: ({ archive, archiveOpf, }: {
     archive: Archive;
     baseUrl: string;
+    archiveOpf: ArchiveOpfParsed | undefined;
 }) => (manifest: Manifest) => Promise<Manifest>;

package/dist/generators/manifest/hooks/toc.d.ts

@@ -1,10 +1,12 @@
 import { Manifest } from '@prose-reader/shared';
 import { Archive } from '../../../archives/types';
+import { ArchiveOpfParsed } from '../../../epubs/readArchiveOpf';
 /**
  * Resolve the table of contents from a single entry point.
  * Internally handles EPUB nav, NCX, and folder fallback.
  */
-export declare const tocHook: ({ archive, baseUrl }: {
+export declare const tocHook: ({ archive, baseUrl, archiveOpf, }: {
     archive: Archive;
     baseUrl: string;
+    archiveOpf: ArchiveOpfParsed | undefined;
 }) => (manifest: Manifest) => Promise<Manifest>;

package/dist/generators/resources/index.d.ts

@@ -1,4 +1,16 @@
 import { Archive } from '../..';
+/**
+ * Builds one streamed asset from `archive` (hot path: typically once per
+ * fetched file in the reader).
+ *
+ * **OPF limitation:** Unlike manifest generation, this API does not take
+ * `ArchiveOpfParsed`. `defaultHook` calls `readArchiveOpf(archive)` to resolve
+ * `media-type` from the package document, so EPUBs repeat OPF I/O + parse per
+ * resource. Usually fine (small OPF); if profiling shows regressions, address
+ * explicitly—e.g. optional `archiveOpf` (or equivalent) threaded from
+ * `Streamer.fetchResource` / manifest, or an opt-in cache on `Archive` wired at
+ * construction time—rather than hidden process-wide memoization.
+ */
 export declare const generateResourceFromArchive: (archive: Archive, resourcePath: string) => Promise<{
     body: string | Blob;
     params: {