wp-epub-gen 0.1.3 → 0.2.0

package/{src → build}/types.d.ts

@@ -45,7 +45,7 @@ export interface IEpubData extends IEpubGenOptions {
   baseDir: string
   _coverMediaType?: string
   _coverExtension?: string
-  log: (msg) => void
+  log: (msg: any) => void
   content: IChapterData[]
   timeoutSeconds: number
 }

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "wp-epub-gen",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Epub generator.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
   "scripts": {
     "tsc": "tsc",
     "test": "mocha -r espower-typescript/guess -r tsconfig-paths/register test/*.test.js",
     "tt": "npm run build && node ./test/tt.js",
-    "build": "tsc",
+    "build": "cross-env NODE_ENV=production vite build --config vite.config.ts",
+    "build:0": "rm -rf ./build && tsc",
     "bt": "npm run build && npm run test",
     "w": "tsc -w",
     "p": "npm run build && npm run test && npm publish --access public"
@@ -24,43 +25,42 @@
   },
   "homepage": "https://github.com/oldj/wp-epub-gen#readme",
   "dependencies": {
-    "@types/diacritics": "^1.3.1",
-    "@types/uslug": "^1.0.1",
-    "@types/uuid": "^8.3.4",
     "archiver": "^5.3.1",
     "cheerio": "^0.22.0",
     "diacritics": "^1.3.0",
     "ejs": "^3.1.8",
     "entities": "^4.4.0",
-    "fs-extra": "^10.1.0",
+    "fs-extra": "^11.1.0",
     "mime": "^3.0.0",
-    "superagent": "^8.0.3",
+    "superagent": "^8.0.6",
     "uslug": "^1.0.4",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@types/archiver": "^5.3.1",
     "@types/cheerio": "^0.22.31",
+    "@types/diacritics": "^1.3.1",
     "@types/ejs": "^3.1.1",
     "@types/fs-extra": "^9.0.13",
     "@types/mime": "^3.0.1",
-    "@types/superagent": "^4.1.15",
-    "@typescript-eslint/eslint-plugin": "^5.43.0",
-    "@typescript-eslint/parser": "^5.43.0",
+    "@types/superagent": "^4.1.16",
+    "@types/uslug": "^1.0.1",
+    "@types/uuid": "^9.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.47.0",
+    "@typescript-eslint/parser": "^5.47.0",
     "chai": "^4.3.7",
     "cross-env": "^7.0.3",
-    "eslint": "^8.28.0",
+    "eslint": "^8.30.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "espower-typescript": "^10.0.1",
-    "mocha": "^10.1.0",
-    "prettier": "^2.7.1",
-    "terser-webpack-plugin": "^5.3.6",
-    "ts-loader": "^9.4.1",
-    "tsconfig-paths": "^4.1.0",
-    "typescript": "^4.9.3",
-    "webpack": "^5.75.0",
-    "webpack-cli": "^5.0.0",
-    "webpack-notifier": "^1.15.0"
+    "mocha": "^10.2.0",
+    "prettier": "^2.8.1",
+    "ts-loader": "^9.4.2",
+    "tsconfig-paths": "^4.1.1",
+    "typescript": "^4.9.4",
+    "vite": "^4.0.3",
+    "vite-plugin-dts": "^1.7.1",
+    "vite-tsconfig-paths": "^4.0.3"
   }
 }

package/tsconfig.json

@@ -1,11 +1,11 @@
 {
   "compilerOptions": {
-    "target": "es6",
+    "target": "es5",
     "module": "commonjs",
     "allowJs": true,
     "sourceMap": true,
     "declaration": true,
-    "outDir": "./dist",
+    "outDir": "./build",
     "resolveJsonModule": true,
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": true,
@@ -15,8 +15,16 @@
     "noImplicitReturns": true,
     "moduleResolution": "node",
     "experimentalDecorators": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
     "plugins": [
-    ]
+    ],
+    "baseUrl": "./",
+    "paths": {
+      "@/*": [
+        "src/*"
+      ]
+    }
   },
   "include": [
     "src"

package/vite.config.ts

@@ -0,0 +1,40 @@
+import * as path from 'path'
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+import tsconfigPaths from 'vite-tsconfig-paths'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  // root: path.join(__dirname, 'src', 'main'),
+  base: './',
+  build: {
+    rollupOptions: {
+      input: {
+        index: path.join(__dirname, 'src', 'index.ts'),
+      },
+    },
+    lib: {
+      entry: path.join(__dirname, 'src', 'index.ts'),
+      name: 'index',
+      formats: ['cjs'],
+      // fileName: (format) => `main.${format}.js`,
+      fileName: () => `index.js`,
+    },
+    outDir: path.join(__dirname, 'build'),
+    minify: false,
+    ssr: true,
+    // emptyOutDir: false,
+  },
+  resolve: {
+    alias: {
+      '@': path.resolve(__dirname, 'src'),
+    },
+  },
+  plugins: [
+    tsconfigPaths(),
+    dts({
+      entryRoot: path.join(__dirname, 'src'),
+      // outputDir: path.join(__dirname, 'build', 'types'),
+    }),
+  ],
+})

package/dist/downloadImage.js

@@ -1,88 +0,0 @@
-"use strict";
-/**
- * downloadImage
- * @author: oldj
- * @homepage: https://oldj.net
- */
-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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadAllImages = void 0;
-const fs = require("fs-extra");
-const path = require("path");
-const request = require("superagent");
-const utils_1 = require("./utils");
-const downloadImage = (epubData, options) => __awaiter(void 0, void 0, void 0, function* () {
-    let { url } = options;
-    let { log } = epubData;
-    let epub_dir = epubData.dir;
-    if (!url) {
-        return;
-    }
-    let image_dir = path.join(epub_dir, 'OEBPS', 'images');
-    fs.ensureDirSync(image_dir);
-    let filename = path.join(image_dir, options.id + '.' + options.extension);
-    if (url.startsWith('file://') || url.startsWith('/')) {
-        let auxPath = url.replace(/^file:\/\//i, '');
-        if (process.platform === 'win32') {
-            // Windows 下，把 /C:/ 转换成 C:/ 这样的形式
-            if (auxPath.match(/^\/[a-zA-Z]:/)) {
-                auxPath = auxPath.replace(/^\//, '');
-            }
-        }
-        log(`[Copy 1] '${auxPath}' to '${filename}'`);
-        if (fs.existsSync(auxPath)) {
-            try {
-                fs.copySync(auxPath, filename);
-            }
-            catch (e) {
-                log('[Copy 1 Error] ' + e.message);
-            }
-        }
-        else {
-            log(`[Copy 1 Fail] '${url}' not exists!`);
-        }
-        return;
-    }
-    let requestAction;
-    if (url.startsWith('http')) {
-        requestAction = request.get(url).set({ 'User-Agent': utils_1.USER_AGENT });
-        requestAction.pipe(fs.createWriteStream(filename));
-    }
-    else {
-        log(`[Copy 2] '${url}' to '${filename}'`);
-        requestAction = fs.createReadStream(path.join(options.dir || '', url));
-        requestAction.pipe(fs.createWriteStream(filename));
-    }
-    return new Promise((resolve, reject) => {
-        requestAction.on('error', (err) => {
-            log('[Download Error] Error while downloading: ' + url);
-            log(err);
-            fs.unlinkSync(filename);
-            // reject(err)
-            resolve();
-        });
-        requestAction.on('end', () => {
-            log('[Download Success] ' + url);
-            resolve();
-        });
-    });
-});
-const downloadAllImages = (epubData) => __awaiter(void 0, void 0, void 0, function* () {
-    let { images } = epubData;
-    if (images.length === 0)
-        return;
-    fs.ensureDirSync(path.join(epubData.dir, 'OEBPS', 'images'));
-    for (let image of images) {
-        yield downloadImage(epubData, image);
-    }
-});
-exports.downloadAllImages = downloadAllImages;
-//# sourceMappingURL=downloadImage.js.map

package/dist/errors.js

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * errors
- * @author: oldj
- * @homepage: https://oldj.net
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.errors = void 0;
-exports.errors = {
-    no_output_path: 'No output path!',
-    no_title: 'Title is required.',
-    no_content: 'Content is required.',
-};
-//# sourceMappingURL=errors.js.map

package/dist/generateTempFile.js

@@ -1,121 +0,0 @@
-"use strict";
-/**
- * generateTempFile
- * @author: oldj
- * @homepage: https://oldj.net
- */
-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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateTempFile = void 0;
-const ejs = require("ejs");
-const entities = require("entities");
-const fs = require("fs-extra");
-const path = require("path");
-const utils_1 = require("./utils");
-const generateTempFile = (epubData) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
-    let { log } = epubData;
-    let oebps_dir = path.join(epubData.dir, 'OEBPS');
-    yield fs.ensureDir(oebps_dir);
-    const templates_dir = path.join(epubData.baseDir, 'templates');
-    epubData.css =
-        epubData.css ||
-            (yield (0, utils_1.readFile)(path.join(epubData.baseDir, 'templates', 'template.css'), 'utf-8'));
-    yield (0, utils_1.writeFile)(path.join(oebps_dir, 'style.css'), epubData.css, 'utf-8');
-    if ((_a = epubData.fonts) === null || _a === void 0 ? void 0 : _a.length) {
-        let fonts_dir = path.join(oebps_dir, 'fonts');
-        yield fs.ensureDir(fonts_dir);
-        epubData.fonts = epubData.fonts.map((font) => {
-            let filename = path.basename(font);
-            if (!fs.existsSync(font)) {
-                log(`Custom font not found at '${font}'.`);
-            }
-            else {
-                fs.copySync(font, path.join(fonts_dir, filename));
-            }
-            return filename;
-        });
-    }
-    const isAppendTitle = (global_append, local_append) => {
-        if (typeof local_append === 'boolean')
-            return local_append;
-        return !!global_append;
-    };
-    const saveContentToFile = (content) => {
-        var _a;
-        let title = entities.encodeXML(content.title || '');
-        let html = `${epubData.docHeader}
-<head>
-<meta charset="UTF-8" />
-<title>${title}</title>
-<link rel="stylesheet" type="text/css" href="style.css" />
-</head>
-<body>
-`;
-        if (content.title && isAppendTitle(epubData.appendChapterTitles, content.appendChapterTitle)) {
-            html += `<h1>${title}</h1>`;
-        }
-        html +=
-            content.title && content.author && ((_a = content.author) === null || _a === void 0 ? void 0 : _a.length)
-                ? `<p class='epub-author'>${entities.encodeXML(content.author.join(', '))}</p>`
-                : '';
-        html +=
-            content.title && content.url
-                ? `<p class="epub-link"><a href="${content.url}">${content.url}</a></p>`
-                : '';
-        html += `${content.data}`;
-        html += '\n</body>\n</html>';
-        fs.ensureDirSync(path.dirname(content.filePath));
-        fs.writeFileSync(content.filePath, html, 'utf-8');
-        if (Array.isArray(content.children)) {
-            content.children.map(saveContentToFile);
-        }
-    };
-    epubData.content.map(saveContentToFile);
-    // write meta-inf/container.xml
-    let metainf_dir = path.join(epubData.dir, 'META-INF');
-    fs.ensureDirSync(metainf_dir);
-    fs.writeFileSync(path.join(metainf_dir, 'container.xml'), `<?xml version="1.0" encoding="UTF-8" ?>
-<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
-<rootfiles><rootfile full-path="OEBPS/content.opf" media-type="application/oebps-package+xml"/></rootfiles>
-</container>`, 'utf-8');
-    if (epubData.version === 2) {
-        let fn = path.join(metainf_dir, 'com.apple.ibooks.display-options.xml');
-        fs.writeFileSync(fn, `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<display_options>
-  <platform name="*">
-    <option name="specified-fonts">true</option>
-  </platform>
-</display_options>
-`, 'utf-8');
-    }
-    let opfPath = epubData.customOpfTemplatePath ||
-        path.join(templates_dir, `epub${epubData.version}`, 'content.opf.ejs');
-    if (!fs.existsSync(opfPath)) {
-        throw new Error('Custom file to OPF template not found.');
-    }
-    let ncxTocPath = epubData.customNcxTocTemplatePath || path.join(templates_dir, `toc.ncx.ejs`);
-    if (!fs.existsSync(ncxTocPath)) {
-        throw new Error('Custom file the NCX toc template not found.');
-    }
-    let htmlTocPath = epubData.customHtmlTocTemplatePath ||
-        path.join(templates_dir, `epub${epubData.version}`, 'toc.xhtml.ejs');
-    if (!fs.existsSync(htmlTocPath)) {
-        throw new Error('Custom file to HTML toc template not found.');
-    }
-    let toc_depth = 1;
-    fs.writeFileSync(path.join(oebps_dir, 'content.opf'), yield ejs.renderFile(opfPath, epubData), 'utf-8');
-    fs.writeFileSync(path.join(oebps_dir, 'toc.ncx'), yield ejs.renderFile(ncxTocPath, Object.assign(Object.assign({}, epubData), { toc_depth })), 'utf-8');
-    // 说明：toc.xhtml 的内容在 macOS 自带的 Books 会被当作目录显示，如果空格太多，目录显示可能会不正常，因此这儿简单去掉了不必要的空格
-    fs.writeFileSync(path.join(oebps_dir, 'toc.xhtml'), (0, utils_1.simpleMinifier)(yield ejs.renderFile(htmlTocPath, epubData)), 'utf-8');
-});
-exports.generateTempFile = generateTempFile;
-//# sourceMappingURL=generateTempFile.js.map

package/dist/index.js

@@ -1,128 +0,0 @@
-"use strict";
-/**
- * index.ts
- * @author: oldj
- * @homepage: https://oldj.net
- */
-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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.gen = exports.epubGen = void 0;
-const mime = require("mime");
-const os = require("os");
-const path = require("path");
-const uuid_1 = require("uuid");
-const errors_1 = require("./errors");
-const parseContent_1 = require("./parseContent");
-const render_1 = require("./render");
-const baseDir = path.dirname(__dirname);
-function result(success, message, options) {
-    if (options && options.verbose) {
-        if (!success) {
-            console.error(new Error(message));
-        }
-    }
-    let out = {
-        success,
-    };
-    if (typeof message === 'string') {
-        out.message = message;
-    }
-    if (options) {
-        out.options = options;
-    }
-    return out;
-}
-function check(options) {
-    if (!options.output) {
-        return result(false, errors_1.errors.no_output_path, options);
-    }
-    if (!options.title) {
-        return result(false, errors_1.errors.no_title, options);
-    }
-    if (!options.content) {
-        return result(false, errors_1.errors.no_content, options);
-    }
-    return result(true, undefined, options);
-}
-function parseOptions(options) {
-    let tmpDir = options.tmpDir || os.tmpdir();
-    let id = (0, uuid_1.v4)();
-    let data = Object.assign(Object.assign({ description: options.title, publisher: 'anonymous', author: ['anonymous'], tocTitle: 'Table Of Contents', appendChapterTitles: true, date: new Date().toISOString(), lang: 'en', fonts: [], version: 3, verbose: true, timeoutSeconds: 15 * 60, tocAutoNumber: false }, options), { id,
-        tmpDir, dir: path.resolve(tmpDir, id), baseDir, docHeader: '', images: [], content: [], log: (msg) => options.verbose && console.log(msg) });
-    if (data.version === 2) {
-        data.docHeader = `<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="#{self.options.lang}">
-`;
-    }
-    else {
-        data.docHeader = `<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" lang="#{self.options.lang}">
-`;
-    }
-    if (Array.isArray(data.author) && data.author.length === 0) {
-        data.author = ['anonymous'];
-    }
-    if (typeof data.author === 'string') {
-        data.author = [data.author];
-    }
-    data.content = options.content.map((content, index) => (0, parseContent_1.default)(content, index, data));
-    if (data.cover) {
-        data._coverMediaType = mime.getType(data.cover) || '';
-        data._coverExtension = mime.getExtension(data._coverMediaType) || '';
-    }
-    return data;
-}
-function epubGen(options, output) {
-    return __awaiter(this, void 0, void 0, function* () {
-        options = Object.assign({}, options);
-        if (output) {
-            options.output = output;
-        }
-        let o = check(options);
-        let verbose = options.verbose !== false;
-        if (!o.success) {
-            if (verbose)
-                console.error(o.message);
-            return o;
-        }
-        let t;
-        try {
-            let data = parseOptions(options);
-            let timeoutSeconds = data.timeoutSeconds || 0;
-            if (timeoutSeconds > 0) {
-                if (verbose)
-                    console.log(`TIMEOUT: ${timeoutSeconds}s`);
-                t = setTimeout(() => {
-                    throw new Error('timeout!');
-                }, timeoutSeconds * 1000);
-            }
-            else {
-                if (verbose)
-                    console.log(`TIMEOUT: N/A`);
-            }
-            yield (0, render_1.render)(data);
-            return result(true, undefined, data);
-        }
-        catch (e) {
-            if (verbose)
-                console.error(e);
-            return result(false, e.message, options);
-        }
-        finally {
-            clearTimeout(t);
-        }
-    });
-}
-exports.epubGen = epubGen;
-exports.gen = epubGen;
-//# sourceMappingURL=index.js.map

package/dist/makeCover.js

@@ -1,63 +0,0 @@
-"use strict";
-/**
- * makeCover
- * @author: oldj
- * @homepage: https://oldj.net
- */
-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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs-extra");
-const path = require("path");
-const request = require("superagent");
-const utils_1 = require("./utils");
-function makeCover(data) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let { cover, _coverExtension, log } = data;
-        if (!cover)
-            return;
-        let destPath = path.join(data.dir, 'OEBPS', `cover.${_coverExtension}`);
-        let writeStream = null;
-        if (cover.startsWith('http')) {
-            writeStream = request.get(cover).set({ 'User-Agent': utils_1.USER_AGENT });
-            writeStream.pipe(fs.createWriteStream(destPath));
-        }
-        else {
-            if (!fs.existsSync(cover))
-                return;
-            log('local cover image: ' + cover);
-            writeStream = fs.createReadStream(cover);
-            writeStream.pipe(fs.createWriteStream(destPath));
-        }
-        return new Promise((resolve) => {
-            writeStream.on('end', () => {
-                log('[Success] cover image saved.');
-                resolve();
-            });
-            writeStream.on('error', (e) => {
-                log('[Error] cover image error: ' + e.message);
-                log('destPath: ' + destPath);
-                if (fs.existsSync(destPath)) {
-                    try {
-                        fs.unlinkSync(destPath);
-                        log('destPath removed.');
-                    }
-                    catch (e) {
-                        log('[Error] remove cover image error: ' + e.message);
-                    }
-                }
-                resolve(e);
-                // throw new Error('[Fail] cover image save fail!')
-            });
-        });
-    });
-}
-exports.default = makeCover;
-//# sourceMappingURL=makeCover.js.map