@prose-reader/streamer 1.296.0 → 1.298.0

package/dist/Streamer.d.ts

@@ -2,6 +2,7 @@ import { Manifest } from '@prose-reader/shared';
 import { Observable } from 'rxjs';
 import { createArchiveLoader } from './archives/archiveLoader';
 import { Archive } from './archives/types';
+import { StreamerHooks } from './hooks';
 type OnError = (error: unknown) => Response;
 type OnManifestSuccess = (params: {
     manifest: Manifest;
@@ -11,9 +12,11 @@ type WithArchiveResponse = (archive: Archive) => Observable<Response> | Promise<
 export declare class Streamer {
     protected archiveLoader: ReturnType<typeof createArchiveLoader>;
     protected onError: OnError;
+    protected hooks: StreamerHooks;
     protected onManifestSuccess: OnManifestSuccess;
     protected lastAccessedKey: string | undefined;
-    constructor({ onError, onManifestSuccess, ...rest }: Parameters<typeof createArchiveLoader>[0] & {
+    constructor({ hooks, onError, onManifestSuccess, ...rest }: Parameters<typeof createArchiveLoader>[0] & {
+        hooks?: StreamerHooks;
         onError?: OnError;
         onManifestSuccess?: OnManifestSuccess;
     });

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

@@ -1,4 +1,6 @@
 import { Archive } from '../../archives/types';
-export declare const generateManifestFromArchive: (archive: Archive, { baseUrl }?: {
+import { StreamerManifestHooks } from '../../hooks';
+export declare const generateManifestFromArchive: (archive: Archive, { baseUrl, hooks, }?: {
     baseUrl?: string;
+    hooks?: StreamerManifestHooks;
 }) => Promise<import('@prose-reader/shared').Manifest>;

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

@@ -1,4 +1,5 @@
 import { Archive } from '../..';
+import { StreamerResourceHookFactory } from '../../hooks';
 import { HookResource } from './hooks/types';
 /**
  * Builds one streamed asset from `archive` (hot path: typically once per
@@ -12,4 +13,6 @@ import { HookResource } from './hooks/types';
  * `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<HookResource>;
+export declare const generateResourceFromArchive: (archive: Archive, resourcePath: string, { hooks }?: {
+    hooks?: StreamerResourceHookFactory[];
+}) => Promise<HookResource>;

package/dist/hooks.d.ts

@@ -0,0 +1,30 @@
+import { Manifest } from '@prose-reader/shared';
+import { Archive } from './archives/types';
+import { HookResource } from './generators/resources/hooks/types';
+export type { HookResource };
+export type StreamerManifestHookContext = {
+    archive: Archive;
+    baseUrl: string;
+};
+export type StreamerManifestHook = (manifest: Manifest) => Manifest | Promise<Manifest>;
+export type StreamerManifestHookFactory = (context: StreamerManifestHookContext) => StreamerManifestHook;
+export type StreamerManifestHooks = {
+    /** Additional source/content metadata normalization. */
+    content?: StreamerManifestHookFactory[];
+    /** Structural manifest transforms that may change `spineItems` and `items`. */
+    spine?: StreamerManifestHookFactory[];
+    /** Layout and presentation metadata derived from the normalized manifest. */
+    presentation?: StreamerManifestHookFactory[];
+    /** Navigation derivation such as TOC data. */
+    navigation?: StreamerManifestHookFactory[];
+};
+export type StreamerResourceHookContext = {
+    archive: Archive;
+    resourcePath: string;
+};
+export type StreamerResourceHook = (resource: HookResource) => HookResource | Promise<HookResource>;
+export type StreamerResourceHookFactory = (context: StreamerResourceHookContext) => StreamerResourceHook;
+export type StreamerHooks = {
+    manifest?: StreamerManifestHooks;
+    resource?: StreamerResourceHookFactory[];
+};

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export { configure } from './configure';
 export { getArchiveOpfInfo } from './epubs/getArchiveOpfInfo';
 export { generateManifestFromArchive } from './generators/manifest';
 export { generateResourceFromArchive } from './generators/resources';
+export type { HookResource, StreamerHooks, StreamerManifestHook, StreamerManifestHookContext, StreamerManifestHookFactory, StreamerManifestHooks, StreamerResourceHook, StreamerResourceHookContext, StreamerResourceHookFactory, } from './hooks';
 export { ServiceWorkerStreamer } from './ServiceWorkerStreamer';
 export { Streamer } from './Streamer';
 export * from './utils/sortByTitleComparator';