@prose-reader/streamer 1.290.0 → 1.292.0

package/dist/cbz/detectPageSpreadFromBasename.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This detector intentionally stays filename-only and conservative.
+ *
+ * Future improvements should consider archive sequence context before widening
+ * detection. For example, a spread such as `p002-003.jpg` is safer to split
+ * when neighboring resources make the sequence plausible, like `p001.jpg` and
+ * `p004.jpg`.
+ */
+export type DetectedPageSpread = {
+    firstPageLabel: string;
+    secondPageLabel: string;
+};
+export declare const detectPageSpreadFromBasename: (basename: string) => DetectedPageSpread | undefined;

package/dist/cbz/detectPageSpreadFromBasename.test.d.ts

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

package/dist/cbz/pageSpreadSplitManifest.d.ts

@@ -0,0 +1,48 @@
+import { Manifest } from '@prose-reader/shared';
+import { Archive } from '../archives/types';
+export { type DetectedPageSpread, detectPageSpreadFromBasename, } from './detectPageSpreadFromBasename';
+export type PageSpreadCropSide = "left" | "right";
+export type VirtualPageSpreadResource = {
+    originalUri: string;
+    cropSide: PageSpreadCropSide;
+};
+export declare const PAGE_SPREAD_RESOURCE_PREFIX = "__prose-reader__/page-spread";
+export declare const PAGE_SPREAD_SPLIT_DOCUMENT_MEDIA_TYPE = "application/xhtml+xml";
+export declare const isPageSpreadSplitSupportedImage: (mimeType: string | undefined) => boolean;
+type ArchiveRecord = Archive["records"][number];
+type ArchiveFileRecord = Extract<ArchiveRecord, {
+    dir: false;
+}>;
+export declare const buildVirtualPageSpreadResourcePath: ({ cropSide, originalUri, }: {
+    originalUri: string;
+    cropSide: PageSpreadCropSide;
+}) => string;
+export declare const getArchiveRecordForManifestItem: ({ archive, baseUrl, spineItem, }: {
+    archive: Archive;
+    baseUrl: string;
+    spineItem: Manifest["spineItems"][number];
+}) => {
+    dir: false;
+    basename: string;
+    uri: string;
+    blob: () => Promise<Blob>;
+    string: () => Promise<string>;
+    stream?: () => import('../archives/types').StreamResult;
+    size: number;
+    encodingFormat?: string;
+} | {
+    dir: true;
+    basename: string;
+    uri: string;
+    size: number;
+    encodingFormat?: undefined;
+} | undefined;
+export declare const mediaTypeFromArchiveRecord: (record: {
+    basename: string;
+    encodingFormat?: string;
+} | undefined) => string | undefined;
+export declare const isPageSpreadSplitSupportedArchiveRecord: (record: ArchiveRecord | undefined) => record is ArchiveFileRecord;
+export declare const pageSpreadSplit: ({ archive, baseUrl }: {
+    archive: Archive;
+    baseUrl: string;
+}) => (manifest: Manifest) => Promise<Manifest>;

package/dist/cbz/pageSpreadSplitManifest.test.d.ts

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

package/dist/cbz/pageSpreadSplitResource.d.ts

@@ -0,0 +1,18 @@
+import { Archive } from '../archives/types';
+import { HookResource } from '../generators/resources/hooks/types';
+import { PageSpreadCropSide, VirtualPageSpreadResource } from './pageSpreadSplitManifest';
+type ImageDimensions = {
+    width: number;
+    height: number;
+};
+export declare const parseVirtualPageSpreadResourcePath: (resourcePath: string) => VirtualPageSpreadResource | undefined;
+export declare const createPageSpreadSplitXhtml: ({ cropSide, imageDimensions, originalUri, }: {
+    cropSide: PageSpreadCropSide;
+    imageDimensions: ImageDimensions;
+    originalUri: string;
+}) => string;
+export declare const pageSpreadSplitResourceHook: ({ archive, resourcePath }: {
+    archive: Archive;
+    resourcePath: string;
+}) => (resource: HookResource) => Promise<HookResource>;
+export {};

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

@@ -0,0 +1,4 @@
+export declare const createManifestResourceHref: ({ baseUrl, resourcePath, }: {
+    baseUrl?: string;
+    resourcePath: string;
+}) => string;

package/dist/generators/manifest/createManifestResourceHref.test.d.ts

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

package/dist/generators/resources/hooks/types.d.ts

@@ -1,5 +1,5 @@
 export type HookResource = {
-    body?: string;
+    body?: Blob | string;
     params: {
         contentType?: string;
     };

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

@@ -1,4 +1,5 @@
 import { Archive } from '../..';
+import { HookResource } from './hooks/types';
 /**
  * Builds one streamed asset from `archive` (hot path: typically once per
  * fetched file in the reader).
@@ -11,9 +12,4 @@ import { Archive } 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: {
-        contentType?: string;
-    };
-}>;
+export declare const generateResourceFromArchive: (archive: Archive, resourcePath: string) => Promise<HookResource>;

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

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