@prose-reader/streamer 1.2.0 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/streamer",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "type": "module",
   "main": "./dist/prose-streamer.umd.cjs",
   "module": "./dist/prose-streamer.js",
@@ -22,13 +22,13 @@
     "test": "vitest run --coverage"
   },
   "dependencies": {
-    "@prose-reader/shared": "^1.2.0"
+    "@prose-reader/shared": "^1.3.0"
   },
   "peerDependencies": {
     "buffer": "^6.0.3",
     "xmldoc": "^1.1.2"
   },
-  "gitHead": "5d7417fa95f62a079a4e60ae38aa1c76afc9ef83",
+  "gitHead": "f51fc8a53e4cdf76fb1c9bae4a45762f72d6248a",
   "devDependencies": {
     "buffer": "^6.0.3",
     "vitest": "*",

package/dist/dist/archives/createArchiveFromArrayBufferList.d.ts

@@ -1,10 +0,0 @@
-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/dist/archives/createArchiveFromJszip.d.ts

@@ -1,34 +0,0 @@
-/// <reference types="node" />
-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;
-}
-declare 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;
-}
-interface JSZip {
-    files: {
-        [key: string]: JSZipObject;
-    };
-}
-export declare const createArchiveFromJszip: (jszip: JSZip, { orderByAlpha, name }?: {
-    orderByAlpha?: boolean | undefined;
-    name?: string | undefined;
-}) => Promise<Archive>;
-export {};

package/dist/dist/archives/createArchiveFromText.d.ts

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

package/dist/dist/archives/createArchiveFromUrls.d.ts

@@ -1,9 +0,0 @@
-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>;

package/dist/dist/archives/getArchiveOpfInfo.d.ts

@@ -1,15 +0,0 @@
-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?: "image/png" | "image/jpg" | "image/jpeg" | "text/plain" | "image/webp" | undefined;
-    } | undefined;
-    basePath: string;
-};

package/dist/dist/archives/types.d.ts

@@ -1,20 +0,0 @@
-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;
-}
-export declare 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?: undefined | `text/plain` | `image/png` | `image/jpg` | `image/jpeg` | `image/webp`;
-    }[];
-};

package/dist/dist/epub/getSpineItemFilesFromArchive.d.ts

@@ -1,14 +0,0 @@
-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?: "image/png" | "image/jpg" | "image/jpeg" | "text/plain" | "image/webp" | undefined;
-}[]>;

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

@@ -1,10 +0,0 @@
-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 comicInfoGenerator: ({ archive, baseUrl }: {
-    archive: Archive;
-    baseUrl: string;
-}) => (manifest: Manifest) => Promise<Manifest>;

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

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

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

@@ -1,12 +0,0 @@
-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 epubGenerator: ({ archive, baseUrl }: {
-    archive: Archive;
-    baseUrl: string;
-}) => (manifest: Manifest) => Promise<Manifest>;

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

@@ -1,4 +0,0 @@
-import { Archive } from "../../archives/types";
-export declare const getManifestFromArchive: (archive: Archive, { baseUrl }?: {
-    baseUrl?: string | undefined;
-}) => Promise<Response>;

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

@@ -1,2 +0,0 @@
-import { Archive } from "..";
-export declare const getResourceFromArchive: (archive: Archive, resourcePath: string) => Promise<Response>;

package/dist/dist/index.d.ts

@@ -1,12 +0,0 @@
-import xmldoc from "xmldoc";
-export { getResourceFromArchive } from "./generators/resources";
-export { getManifestFromArchive } from "./generators/manifest";
-export { Report } from "./report";
-export type { Manifest } from "@prose-reader/shared";
-export type { Archive } from "./archives/types";
-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 { xmldoc };

package/dist/dist/parsers/kobo.d.ts

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

package/dist/dist/parsers/nav.d.ts

@@ -1,5 +0,0 @@
-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>;

package/dist/dist/report.d.ts

@@ -1,13 +0,0 @@
-export declare const Report: {
-    enable: (enable: boolean) => void;
-    log: (...data: any[]) => void;
-    warn: (...data: any[]) => void;
-    error: (...data: any[]) => void;
-    time: (label?: string | undefined) => void;
-    timeEnd: (label?: string | undefined) => void;
-    metric: (performanceEntry: {
-        name: string;
-        duration: number;
-    }, targetDuration?: number) => void;
-    measurePerformance: <F extends (...args: any[]) => any>(name: string, targetDuration: number | undefined, functionToMeasure: F) => (...args: Parameters<F>) => ReturnType<F>;
-};

package/dist/dist/utils/blobToBAse64.d.ts

@@ -1 +0,0 @@
-export declare const blobToBase64: (blob: Blob) => Promise<string>;

package/dist/dist/utils/sortByTitleComparator.d.ts

@@ -1 +0,0 @@
-export declare const sortByTitleComparator: (a: string, b: string) => number;

package/dist/dist/utils/uri.d.ts

@@ -1 +0,0 @@
-export declare const getUriBasename: (uri: string) => string;

package/dist/src/archives/createArchiveFromArrayBufferList.d.ts

@@ -1,10 +0,0 @@
-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/src/archives/createArchiveFromJszip.d.ts

@@ -1,34 +0,0 @@
-/// <reference types="node" />
-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;
-}
-declare 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;
-}
-interface JSZip {
-    files: {
-        [key: string]: JSZipObject;
-    };
-}
-export declare const createArchiveFromJszip: (jszip: JSZip, { orderByAlpha, name }?: {
-    orderByAlpha?: boolean | undefined;
-    name?: string | undefined;
-}) => Promise<Archive>;
-export {};

package/dist/src/archives/createArchiveFromText.d.ts

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

package/dist/src/archives/createArchiveFromUrls.d.ts

@@ -1,9 +0,0 @@
-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>;

package/dist/src/archives/getArchiveOpfInfo.d.ts

@@ -1,15 +0,0 @@
-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?: "image/png" | "image/jpg" | "image/jpeg" | "text/plain" | "image/webp" | undefined;
-    } | undefined;
-    basePath: string;
-};

package/dist/src/archives/types.d.ts

@@ -1,20 +0,0 @@
-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;
-}
-export declare 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?: undefined | `text/plain` | `image/png` | `image/jpg` | `image/jpeg` | `image/webp`;
-    }[];
-};

package/dist/src/epub/getSpineItemFilesFromArchive.d.ts

@@ -1,14 +0,0 @@
-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?: "image/png" | "image/jpg" | "image/jpeg" | "text/plain" | "image/webp" | undefined;
-}[]>;

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

@@ -1,10 +0,0 @@
-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 comicInfoGenerator: ({ archive, baseUrl }: {
-    archive: Archive;
-    baseUrl: string;
-}) => (manifest: Manifest) => Promise<Manifest>;

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

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

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

@@ -1,12 +0,0 @@
-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 epubGenerator: ({ archive, baseUrl }: {
-    archive: Archive;
-    baseUrl: string;
-}) => (manifest: Manifest) => Promise<Manifest>;

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

@@ -1,4 +0,0 @@
-import { Archive } from "../../archives/types";
-export declare const getManifestFromArchive: (archive: Archive, { baseUrl }?: {
-    baseUrl?: string | undefined;
-}) => Promise<Response>;

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

@@ -1,2 +0,0 @@
-import { Archive } from "..";
-export declare const getResourceFromArchive: (archive: Archive, resourcePath: string) => Promise<Response>;

package/dist/src/index.d.ts

@@ -1,12 +0,0 @@
-import xmldoc from "xmldoc";
-export { getResourceFromArchive } from "./generators/resources";
-export { getManifestFromArchive } from "./generators/manifest";
-export { Report } from "./report";
-export type { Manifest } from "@prose-reader/shared";
-export type { Archive } from "./archives/types";
-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 { xmldoc };

package/dist/src/parsers/kobo.d.ts

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

package/dist/src/parsers/nav.d.ts

@@ -1,5 +0,0 @@
-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>;

package/dist/src/report.d.ts

@@ -1,13 +0,0 @@
-export declare const Report: {
-    enable: (enable: boolean) => void;
-    log: (...data: any[]) => void;
-    warn: (...data: any[]) => void;
-    error: (...data: any[]) => void;
-    time: (label?: string | undefined) => void;
-    timeEnd: (label?: string | undefined) => void;
-    metric: (performanceEntry: {
-        name: string;
-        duration: number;
-    }, targetDuration?: number) => void;
-    measurePerformance: <F extends (...args: any[]) => any>(name: string, targetDuration: number | undefined, functionToMeasure: F) => (...args: Parameters<F>) => ReturnType<F>;
-};

package/dist/src/utils/blobToBAse64.d.ts

@@ -1 +0,0 @@
-export declare const blobToBase64: (blob: Blob) => Promise<string>;

package/dist/src/utils/sortByTitleComparator.d.ts

@@ -1 +0,0 @@
-export declare const sortByTitleComparator: (a: string, b: string) => number;

package/dist/src/utils/uri.d.ts

@@ -1 +0,0 @@
-export declare const getUriBasename: (uri: string) => string;