@prose-reader/streamer 0.0.22

package/dist/parsers/nav.js

@@ -0,0 +1,121 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import xmldoc from 'xmldoc';
+import { getArchiveOpfInfo } from '..';
+const extractNavChapter = (li, { opfBasePath, baseUrl }) => {
+    const chp = {
+        contents: [],
+        path: ``,
+        href: ``,
+        title: ``
+    };
+    let contentNode = li.childNamed(`span`) || li.childNamed(`a`);
+    chp.title = (contentNode === null || contentNode === void 0 ? void 0 : contentNode.attr.title) || (contentNode === null || contentNode === void 0 ? void 0 : contentNode.val.trim()) || chp.title;
+    let node = contentNode === null || contentNode === void 0 ? void 0 : contentNode.name;
+    if (node !== `a`) {
+        contentNode = li.descendantWithPath(`${node}.a`);
+        if (contentNode) {
+            node = contentNode.name.toLowerCase();
+        }
+    }
+    if (node === `a` && (contentNode === null || contentNode === void 0 ? void 0 : contentNode.attr.href)) {
+        chp.path = opfBasePath ? `${opfBasePath}/${contentNode.attr.href}` : `${contentNode.attr.href}`;
+        chp.href = opfBasePath ? `${baseUrl}/${opfBasePath}/${contentNode.attr.href}` : `${baseUrl}/${contentNode.attr.href}`;
+    }
+    const sublistNode = li.childNamed(`ol`);
+    if (sublistNode) {
+        const children = sublistNode.childrenNamed(`li`);
+        if (children && children.length > 0) {
+            chp.contents = children.map((child) => extractNavChapter(child, { opfBasePath, baseUrl }));
+        }
+    }
+    return chp;
+};
+const buildTOCFromNav = (doc, { opfBasePath, baseUrl }) => {
+    var _a, _b;
+    const toc = [];
+    let navDataChildren;
+    if (doc.descendantWithPath(`body.nav.ol`)) {
+        navDataChildren = (_a = doc.descendantWithPath(`body.nav.ol`)) === null || _a === void 0 ? void 0 : _a.children;
+    }
+    else if (doc.descendantWithPath(`body.section.nav.ol`)) {
+        navDataChildren = (_b = doc.descendantWithPath(`body.section.nav.ol`)) === null || _b === void 0 ? void 0 : _b.children;
+    }
+    if (navDataChildren && navDataChildren.length > 0) {
+        navDataChildren
+            .filter((li) => li.name === `li`)
+            .forEach((li) => toc.push(extractNavChapter(li, { opfBasePath, baseUrl })));
+    }
+    return toc;
+};
+const parseTocFromNavPath = (opfXmlDoc, archive, { opfBasePath, baseUrl }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    // Try to detect if there is a nav item
+    const navItem = (_a = opfXmlDoc.childNamed(`manifest`)) === null || _a === void 0 ? void 0 : _a.childrenNamed(`item`).find((child) => child.attr.properties === `nav`);
+    if (navItem) {
+        const tocFile = Object.values(archive.files).find(item => item.uri.endsWith(navItem.attr.href || ``));
+        if (tocFile) {
+            const doc = new xmldoc.XmlDocument(yield tocFile.string());
+            return buildTOCFromNav(doc, { opfBasePath, baseUrl });
+        }
+    }
+});
+const mapNcxChapter = (point, { opfBasePath, baseUrl, prefix }) => {
+    var _a, _b;
+    const src = ((_a = point === null || point === void 0 ? void 0 : point.childNamed(`${prefix}content`)) === null || _a === void 0 ? void 0 : _a.attr.src) || ``;
+    const out = {
+        title: ((_b = point === null || point === void 0 ? void 0 : point.descendantWithPath(`${prefix}navLabel.${prefix}text`)) === null || _b === void 0 ? void 0 : _b.val) || ``,
+        path: opfBasePath ? `${opfBasePath}/${src}` : `${src}`,
+        href: opfBasePath ? `${baseUrl}/${opfBasePath}/${src}` : `${baseUrl}/${src}`,
+        contents: []
+    };
+    const children = point.childrenNamed(`${prefix}navPoint`);
+    if (children && children.length > 0) {
+        out.contents = children.map((pt) => mapNcxChapter(pt, { opfBasePath, baseUrl, prefix }));
+    }
+    return out;
+};
+const buildTOCFromNCX = (ncxData, { opfBasePath, baseUrl }) => {
+    var _a;
+    const toc = [];
+    const rootTagName = ncxData.name;
+    let prefix = ``;
+    if (rootTagName.indexOf(`:`) !== -1) {
+        prefix = rootTagName.split(`:`)[0] + `:`;
+    }
+    (_a = ncxData
+        .childNamed(`${prefix}navMap`)) === null || _a === void 0 ? void 0 : _a.childrenNamed(`${prefix}navPoint`).forEach((point) => toc.push(mapNcxChapter(point, { opfBasePath, baseUrl, prefix })));
+    return toc;
+};
+const parseTocFromNcx = ({ opfData, opfBasePath, baseUrl, archive }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _b;
+    const spine = opfData.childNamed(`spine`);
+    const ncxId = spine && spine.attr.toc;
+    if (ncxId) {
+        const ncxItem = (_b = opfData
+            .childNamed(`manifest`)) === null || _b === void 0 ? void 0 : _b.childrenNamed(`item`).find((item) => item.attr.id === ncxId);
+        if (ncxItem) {
+            const ncxPath = `${opfBasePath}${opfBasePath === `` ? `` : `/`}${ncxItem.attr.href}`;
+            const file = Object.values(archive.files).find(item => item.uri.endsWith(ncxPath));
+            if (file) {
+                const ncxData = new xmldoc.XmlDocument(yield file.string());
+                return buildTOCFromNCX(ncxData, { opfBasePath, baseUrl });
+            }
+        }
+    }
+});
+export const parseToc = (opfXmlDoc, archive, { baseUrl }) => __awaiter(void 0, void 0, void 0, function* () {
+    const { basePath: opfBasePath } = getArchiveOpfInfo(archive) || {};
+    const tocFromNcx = yield parseTocFromNcx({ opfData: opfXmlDoc, opfBasePath, archive, baseUrl });
+    if (tocFromNcx) {
+        return tocFromNcx;
+    }
+    return yield parseTocFromNavPath(opfXmlDoc, archive, { opfBasePath, baseUrl });
+});

package/dist/report.d.ts

@@ -0,0 +1,13 @@
+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: 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/report.js

@@ -0,0 +1,68 @@
+let enabled = false;
+export const Report = {
+    enable: (enable) => {
+        enabled = enable;
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    log: (...data) => {
+        if (enabled) {
+            // eslint-disable-next-line no-console
+            console.log(`[prose-reader-streamer]`, ...data);
+        }
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    warn: (...data) => {
+        if (enabled) {
+            // eslint-disable-next-line no-console
+            console.warn(`[prose-reader-streamer]`, ...data);
+        }
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    error: (...data) => {
+        // eslint-disable-next-line no-console
+        console.error(...data);
+    },
+    time: (label) => {
+        if (enabled) {
+            // eslint-disable-next-line no-console
+            console.time(`[prose-reader-streamer] [metric] ${label}`);
+        }
+    },
+    timeEnd: (label) => {
+        if (enabled) {
+            // eslint-disable-next-line no-console
+            console.timeEnd(`[prose-reader-streamer] [metric] ${label}`);
+        }
+    },
+    metric: (performanceEntry, targetDuration = Infinity) => {
+        const duration = typeof performanceEntry === `number` ? performanceEntry : performanceEntry.duration;
+        if (enabled) {
+            if (performanceEntry.duration <= targetDuration) {
+                // eslint-disable-next-line no-console
+                console.log(`[prose-reader-streamer] [metric] `, `${performanceEntry.name} took ${duration}ms`);
+            }
+            else {
+                // eslint-disable-next-line no-console
+                console.warn(`[prose-reader-streamer] [metric] `, `${performanceEntry.name} took ${performanceEntry.duration}ms which is above the ${targetDuration}ms target for this function`);
+            }
+        }
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    measurePerformance: (name, targetDuration = 10, functionToMeasure) => {
+        return (...args) => {
+            const t0 = performance.now();
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const response = functionToMeasure(...args);
+            if (response && response.then) {
+                return response.then((res) => {
+                    const t1 = performance.now();
+                    Report.metric({ name, duration: t1 - t0 }, targetDuration);
+                    return res;
+                });
+            }
+            const t1 = performance.now();
+            Report.metric({ name, duration: t1 - t0 }, targetDuration);
+            return response;
+        };
+    }
+};

package/dist/streamer/src/archives/createArchiveFromJszip.d.ts

@@ -0,0 +1,34 @@
+/// <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/streamer/src/generators/manifest.d.ts

@@ -0,0 +1,10 @@
+import xmldoc from 'xmldoc';
+import { Archive } from '..';
+export declare const getManifestFromArchive: (archive: Archive, { baseUrl }?: {
+    baseUrl?: string | undefined;
+}) => Promise<Response>;
+export declare const getItemsFromDoc: (doc: xmldoc.XmlDocument) => {
+    href: string;
+    id: string;
+    mediaType: string | undefined;
+}[];

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

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

package/dist/streamer/src/index.d.ts

@@ -0,0 +1,10 @@
+export { getResourceFromArchive } from './generators/resources';
+export { getManifestFromArchive } from './generators/manifest';
+export type { Manifest } from '@oboku/shared';
+export { Report } from './report';
+export { 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';

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

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

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

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

package/dist/utils/blobToBAse64.d.ts

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

package/dist/utils/blobToBAse64.js

@@ -0,0 +1,19 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export const blobToBase64 = (blob) => __awaiter(void 0, void 0, void 0, function* () {
+    return new Promise(resolve => {
+        const reader = new FileReader();
+        reader.readAsDataURL(blob);
+        reader.onloadend = function () {
+            const base64data = reader.result;
+            resolve(base64data);
+        };
+    });
+});

package/dist/utils/sortByTitleComparator.d.ts

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

package/dist/utils/sortByTitleComparator.js

@@ -0,0 +1,18 @@
+export const sortByTitleComparator = (a, b) => {
+    var _a;
+    const alist = a.split(/(\d+)/);
+    const blist = b.split(/(\d+)/);
+    alist.slice(-1) === [``] && alist.pop();
+    blist.slice(-1) === [``] && blist.pop();
+    for (let i = 0, len = alist.length; i < len; i++) {
+        if (alist[i] !== blist[i]) {
+            if ((_a = alist[i]) === null || _a === void 0 ? void 0 : _a.match(/\d/)) {
+                return +(alist[i] || ``) - +(blist[i] || ``);
+            }
+            else {
+                return (alist[i] || ``).localeCompare((blist[i] || ``));
+            }
+        }
+    }
+    return 1;
+};

package/dist/utils/uri.d.ts

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

package/dist/utils/uri.js

@@ -0,0 +1 @@
+export const getUriBasename = (uri) => uri.substring(uri.lastIndexOf(`/`) + 1) || uri;

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@prose-reader/streamer",
+  "version": "0.0.22",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "start": "NODE_ENV=development webpack build --config ./webpack.config.js --watch",
+    "build": "NODE_ENV=development webpack build --config ./webpack.config.js",
+    "build:prod": "rm -rf dist && NODE_ENV=production webpack build --config ./webpack.config.js",
+    "lint": "eslint '**/*.{js,ts,tsx}'",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@prose-reader/shared": "^0.0.4",
+    "@types/xmldoc": "^1.1.5",
+    "buffer": "6.0.3",
+    "xmldoc": "^1.1.2"
+  },
+  "devDependencies": {
+    "@babel/preset-typescript": "^7.16.0",
+    "@types/jest": "^27.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "eslint": "^7.32.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-jest": "^25.3.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.1",
+    "jest": "^27.3.1",
+    "ts-loader": "^9.2.6",
+    "typescript": "*",
+    "webpack": "^5.64.3",
+    "webpack-cli": "^4.9.1",
+    "webpack-dev-server": "^4.6.0"
+  },
+  "gitHead": "a005ccf2d302179a488d3f5e79c1f043d3ce29de"
+}