@prose-reader/streamer 1.27.0 → 1.29.0

package/dist/archives/createArchiveFromArrayBufferList.d.ts

@@ -1,16 +1,10 @@
-import { Archive } from "./types"
-export declare const createArchiveFromArrayBufferList: (
-  list: {
-    isDir: boolean
-    name: string
-    size: number
-    data: () => Promise<ArrayBuffer>
-  }[],
-  {
-    orderByAlpha,
-    name,
-  }?: {
-    orderByAlpha?: boolean | undefined
-    name?: string | undefined
-  }
-) => Promise<Archive>
+import { Archive } from "./types";
+export declare const createArchiveFromArrayBufferList: (list: {
+    isDir: boolean;
+    name: string;
+    size: number;
+    data: () => Promise<ArrayBuffer>;
+}[], { orderByAlpha, name }?: {
+    orderByAlpha?: boolean | undefined;
+    name?: string | undefined;
+}) => Promise<Archive>;

package/dist/archives/createArchiveFromJszip.d.ts

@@ -1,40 +1,34 @@
 /// <reference types="node" />
-import { Archive, StreamResult } from "./types"
+import { Archive, StreamResult } from "./types";
 interface OutputByType {
-  base64: string
-  string: string
-  text: string
-  binarystring: string
-  array: number[]
-  uint8array: Uint8Array
-  arraybuffer: ArrayBuffer
-  blob: Blob
-  nodebuffer: Buffer
+    base64: string;
+    string: string;
+    text: string;
+    binarystring: string;
+    array: number[];
+    uint8array: Uint8Array;
+    arraybuffer: ArrayBuffer;
+    blob: Blob;
+    nodebuffer: Buffer;
 }
-type OutputType = keyof OutputByType
+type OutputType = keyof OutputByType;
 interface JSZipObject {
-  name: string
-  dir: boolean
-  date: Date
-  comment: string
-  unixPermissions: number | string | null
-  dosPermissions: number | null
-  async<T extends OutputType>(type: T): Promise<OutputByType[T]>
-  internalStream?: (type?: `uint8array`) => StreamResult
+    name: string;
+    dir: boolean;
+    date: Date;
+    comment: string;
+    unixPermissions: number | string | null;
+    dosPermissions: number | null;
+    async<T extends OutputType>(type: T): Promise<OutputByType[T]>;
+    internalStream?: (type?: `uint8array`) => StreamResult;
 }
 interface JSZip {
-  files: {
-    [key: string]: JSZipObject
-  }
+    files: {
+        [key: string]: JSZipObject;
+    };
 }
-export declare const createArchiveFromJszip: (
-  jszip: JSZip,
-  {
-    orderByAlpha,
-    name,
-  }?: {
-    orderByAlpha?: boolean | undefined
-    name?: string | undefined
-  }
-) => Promise<Archive>
-export {}
+export declare const createArchiveFromJszip: (jszip: JSZip, { orderByAlpha, name }?: {
+    orderByAlpha?: boolean | undefined;
+    name?: string | undefined;
+}) => Promise<Archive>;
+export {};

package/dist/archives/createArchiveFromText.d.ts

@@ -1,14 +1,8 @@
-import { Archive } from "./types"
+import { Archive } from "./types";
 /**
  * Useful to create archive from txt content
  */
-export declare const createArchiveFromText: (
-  content: string | Blob,
-  {
-    mimeType,
-    direction,
-  }?: {
-    direction?: "ltr" | "rtl" | undefined
-    mimeType?: string | undefined
-  }
-) => Promise<Archive>
+export declare const createArchiveFromText: (content: string | Blob, { mimeType, direction, }?: {
+    direction?: "ltr" | "rtl" | undefined;
+    mimeType?: string | undefined;
+}) => Promise<Archive>;

package/dist/archives/createArchiveFromUrls.d.ts

@@ -1,12 +1,9 @@
-import { Archive } from "./types"
+import { Archive } from "./types";
 /**
  * @important
  * Make sure the urls are on the same origin or the cors header is set otherwise
  * the resource cannot be consumed as it is on the web.
  */
-export declare const createArchiveFromUrls: (
-  urls: string[],
-  options?: {
-    useRenditionFlow: boolean
-  }
-) => Promise<Archive>
+export declare const createArchiveFromUrls: (urls: string[], options?: {
+    useRenditionFlow: boolean;
+}) => Promise<Archive>;

package/dist/archives/getArchiveOpfInfo.d.ts

@@ -1,17 +1,15 @@
-import { Archive } from "./types"
+import { Archive } from "./types";
 export declare const getArchiveOpfInfo: (archive: Archive) => {
-  data:
-    | {
-        dir: boolean
-        basename: string
-        uri: string
-        blob: () => Promise<Blob>
-        string: () => Promise<string>
-        base64: () => Promise<string>
-        stream?: (() => import("./types").StreamResult) | undefined
-        size: number
-        encodingFormat?: string | undefined
-      }
-    | undefined
-  basePath: string
-}
+    data: {
+        dir: boolean;
+        basename: string;
+        uri: string;
+        blob: () => Promise<Blob>;
+        string: () => Promise<string>;
+        base64: () => Promise<string>;
+        stream?: (() => import("./types").StreamResult) | undefined;
+        size: number;
+        encodingFormat?: string | undefined;
+    } | undefined;
+    basePath: string;
+};

package/dist/archives/types.d.ts

@@ -1,20 +1,20 @@
 export interface StreamResult {
-  on(e: `data`, cb: (data: Uint8Array) => void): void
-  on(e: `error`, cb: (error: Error) => void): void
-  on(e: `end`, cb: () => void): void
-  resume(): void
+    on(e: `data`, cb: (data: Uint8Array) => void): void;
+    on(e: `error`, cb: (error: Error) => void): void;
+    on(e: `end`, cb: () => void): void;
+    resume(): void;
 }
 export type Archive = {
-  filename: string
-  files: {
-    dir: boolean
-    basename: string
-    uri: string
-    blob: () => Promise<Blob>
-    string: () => Promise<string>
-    base64: () => Promise<string>
-    stream?: () => StreamResult
-    size: number
-    encodingFormat?: string
-  }[]
-}
+    filename: string;
+    files: {
+        dir: boolean;
+        basename: string;
+        uri: string;
+        blob: () => Promise<Blob>;
+        string: () => Promise<string>;
+        base64: () => Promise<string>;
+        stream?: () => StreamResult;
+        size: number;
+        encodingFormat?: string;
+    }[];
+};

package/dist/configure.d.ts

@@ -1 +1,3 @@
-export declare const configure: ({ enableReport }?: { enableReport?: boolean | undefined }) => void
+export declare const configure: ({ enableReport }?: {
+    enableReport?: boolean | undefined;
+}) => void;

package/dist/epub/getSpineItemFilesFromArchive.d.ts

@@ -1,14 +1,14 @@
-import { Archive } from "../archives/types"
-export declare const getSpineItemFilesFromArchive: ({ archive }: { archive: Archive }) => Promise<
-  {
-    dir: boolean
-    basename: string
-    uri: string
-    blob: () => Promise<Blob>
-    string: () => Promise<string>
-    base64: () => Promise<string>
-    stream?: (() => import("../archives/types").StreamResult) | undefined
-    size: number
-    encodingFormat?: string | undefined
-  }[]
->
+import { Archive } from "../archives/types";
+export declare const getSpineItemFilesFromArchive: ({ archive }: {
+    archive: Archive;
+}) => Promise<{
+    dir: boolean;
+    basename: string;
+    uri: string;
+    blob: () => Promise<Blob>;
+    string: () => Promise<string>;
+    base64: () => Promise<string>;
+    stream?: (() => import("../archives/types").StreamResult) | undefined;
+    size: number;
+    encodingFormat?: string | undefined;
+}[]>;

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

@@ -1,13 +1,10 @@
-import { Manifest } from "@prose-reader/shared"
-import { Archive } from "../../../archives/types"
+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,
-  baseUrl,
-}: {
-  archive: Archive
-  baseUrl: string
-}) => (manifest: Manifest) => Promise<Manifest>
+export declare const comicInfoHook: ({ archive, baseUrl }: {
+    archive: Archive;
+    baseUrl: string;
+}) => (manifest: Manifest) => Promise<Manifest>;

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

@@ -1,3 +1,6 @@
-import { Manifest } from "@prose-reader/shared"
-import { Archive } from "../../../archives/types"
-export declare const defaultHook: ({ archive, baseUrl }: { archive: Archive; baseUrl: string }) => () => Promise<Manifest>
+import { Manifest } from "@prose-reader/shared";
+import { Archive } from "../../../archives/types";
+export declare const defaultHook: ({ archive, baseUrl }: {
+    archive: Archive;
+    baseUrl: string;
+}) => () => Promise<Manifest>;

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

@@ -1,15 +1,12 @@
-import xmldoc from "xmldoc"
-import type { Manifest } from "@prose-reader/shared"
-import { Archive } from "../../../archives/types"
+import xmldoc from "xmldoc";
+import type { Manifest } from "@prose-reader/shared";
+import { Archive } from "../../../archives/types";
 export declare const getItemsFromDoc: (doc: xmldoc.XmlDocument) => {
-  href: string
-  id: string
-  mediaType: string | undefined
-}[]
-export declare const epubHook: ({
-  archive,
-  baseUrl,
-}: {
-  archive: Archive
-  baseUrl: string
-}) => (manifest: Manifest) => Promise<Manifest>
+    href: string;
+    id: string;
+    mediaType: string | undefined;
+}[];
+export declare const epubHook: ({ archive, baseUrl }: {
+    archive: Archive;
+    baseUrl: string;
+}) => (manifest: Manifest) => Promise<Manifest>;

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

@@ -1,9 +1,6 @@
-import { Manifest } from "@prose-reader/shared"
-import { Archive } from "../../../archives/types"
-export declare const epubOptimizerHook: ({
-  archive,
-  baseUrl,
-}: {
-  archive: Archive
-  baseUrl: string
-}) => (manifest: Manifest) => Promise<Manifest>
+import { Manifest } from "@prose-reader/shared";
+import { Archive } from "../../../archives/types";
+export declare const epubOptimizerHook: ({ archive, baseUrl }: {
+    archive: Archive;
+    baseUrl: string;
+}) => (manifest: Manifest) => Promise<Manifest>;

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

@@ -1,15 +1,12 @@
-import { Manifest } from "@prose-reader/shared"
-import { Archive } from "../../../archives/types"
+import { Manifest } from "@prose-reader/shared";
+import { Archive } from "../../../archives/types";
 /**
  * In case no navigation was generated prior to this hook, we will try
  * to generate something based on the structure of the archive.
  *
  * We use folders as chapters.
  */
-export declare const navigationFallbackHook: ({
-  archive,
-  baseUrl,
-}: {
-  archive: Archive
-  baseUrl: string
-}) => (manifest: Manifest) => Promise<Manifest>
+export declare const navigationFallbackHook: ({ archive, baseUrl }: {
+    archive: Archive;
+    baseUrl: string;
+}) => (manifest: Manifest) => Promise<Manifest>;

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

@@ -1,10 +1,5 @@
-import type { Manifest } from "@prose-reader/shared"
-import { Archive } from "../../archives/types"
-export declare const generateManifestFromArchive: (
-  archive: Archive,
-  {
-    baseUrl,
-  }?: {
-    baseUrl?: string | undefined
-  }
-) => Promise<Manifest>
+import type { Manifest } from "@prose-reader/shared";
+import { Archive } from "../../archives/types";
+export declare const generateManifestFromArchive: (archive: Archive, { baseUrl }?: {
+    baseUrl?: string | undefined;
+}) => Promise<Manifest>;

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

@@ -1,9 +1,6 @@
-import { Archive } from "../../../archives/types"
-import { HookResource } from "./types"
-export declare const cssFixHook: ({
-  archive,
-  resourcePath,
-}: {
-  archive: Archive
-  resourcePath: string
-}) => (resource: HookResource) => Promise<HookResource>
+import { Archive } from "../../../archives/types";
+import { HookResource } from "./types";
+export declare const cssFixHook: ({ archive, resourcePath }: {
+    archive: Archive;
+    resourcePath: string;
+}) => (resource: HookResource) => Promise<HookResource>;

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

@@ -1,9 +1,6 @@
-import { Archive } from "../../../archives/types"
-import { HookResource } from "./types"
-export declare const defaultHook: ({
-  archive,
-  resourcePath,
-}: {
-  archive: Archive
-  resourcePath: string
-}) => (resource: HookResource) => Promise<HookResource>
+import { Archive } from "../../../archives/types";
+import { HookResource } from "./types";
+export declare const defaultHook: ({ archive, resourcePath }: {
+    archive: Archive;
+    resourcePath: string;
+}) => (resource: HookResource) => Promise<HookResource>;

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

@@ -1,7 +1,7 @@
 export type HookResource = {
-  body?: string
-  params: {
-    headers?: Record<string, string>
-    status: number
-  }
-}
+    body?: string;
+    params: {
+        headers?: Record<string, string>;
+        status: number;
+    };
+};

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

@@ -1,20 +1,17 @@
-import { Archive } from "../.."
-export declare const generateResourceFromArchive: (
-  archive: Archive,
-  resourcePath: string
-) => Promise<{
-  body: string | Blob
-  params: {
-    headers?: Record<string, string> | undefined
-    status: number
-  }
-}>
+import { Archive } from "../..";
+export declare const generateResourceFromArchive: (archive: Archive, resourcePath: string) => Promise<{
+    body: string | Blob;
+    params: {
+        headers?: Record<string, string> | undefined;
+        status: number;
+    };
+}>;
 export declare const generateResourceFromError: (error: unknown) => {
-  body: string
-  params: {
-    status: number
-    headers: {
-      "Content-Type": string
-    }
-  }
-}
+    body: string;
+    params: {
+        status: number;
+        headers: {
+            "Content-Type": string;
+        };
+    };
+};

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-export { generateResourceFromArchive, generateResourceFromError } from "./generators/resources"
-export { generateManifestFromArchive } from "./generators/manifest"
-export { getArchiveOpfInfo } from "./archives/getArchiveOpfInfo"
-export { createArchiveFromUrls } from "./archives/createArchiveFromUrls"
-export { createArchiveFromText } from "./archives/createArchiveFromText"
-export { createArchiveFromJszip } from "./archives/createArchiveFromJszip"
-export { createArchiveFromArrayBufferList } from "./archives/createArchiveFromArrayBufferList"
-export type { Manifest } from "@prose-reader/shared"
-export type { Archive } from "./archives/types"
-export { configure } from "./configure"
+export { generateResourceFromArchive, generateResourceFromError } from "./generators/resources";
+export { generateManifestFromArchive } from "./generators/manifest";
+export { getArchiveOpfInfo } from "./archives/getArchiveOpfInfo";
+export { createArchiveFromUrls } from "./archives/createArchiveFromUrls";
+export { createArchiveFromText } from "./archives/createArchiveFromText";
+export { createArchiveFromJszip } from "./archives/createArchiveFromJszip";
+export { createArchiveFromArrayBufferList } from "./archives/createArchiveFromArrayBufferList";
+export type { Manifest } from "@prose-reader/shared";
+export type { Archive } from "./archives/types";
+export { configure } from "./configure";

package/dist/parsers/kobo.d.ts

@@ -1,6 +1,6 @@
-import { Archive } from ".."
+import { Archive } from "..";
 type KoboInformation = {
-  renditionLayout?: `reflowable` | `pre-paginated` | undefined
-}
-export declare const extractKoboInformationFromArchive: (archive: Archive) => Promise<KoboInformation>
-export {}
+    renditionLayout?: `reflowable` | `pre-paginated` | undefined;
+};
+export declare const extractKoboInformationFromArchive: (archive: Archive) => Promise<KoboInformation>;
+export {};

package/dist/parsers/nav.d.ts

@@ -1,11 +1,5 @@
-import xmldoc from "xmldoc"
-import { Archive } from ".."
-export declare const parseToc: (
-  opfXmlDoc: xmldoc.XmlDocument,
-  archive: Archive,
-  {
-    baseUrl,
-  }: {
-    baseUrl: string
-  }
-) => Promise<import("@prose-reader/shared").TocItem[] | undefined>
+import xmldoc from "xmldoc";
+import { Archive } from "..";
+export declare const parseToc: (opfXmlDoc: xmldoc.XmlDocument, archive: Archive, { baseUrl }: {
+    baseUrl: string;
+}) => Promise<import("@prose-reader/shared").TocItem[] | undefined>;