wp-epub-gen 0.2.0 → 0.2.2

package/README.md

@@ -80,7 +80,7 @@ epubGen(option).then(
     - `appendChapterTitle`:
         optional, Automatically append the chapter title at the beginning of current chapter, this value will overwrite the global `appendChapterTitles`.
 - `verbose`:
-    specify whether or not to console.log progress messages, default: false.
+    specify whether to console.log progress messages, default: false.
 - `timeoutSeconds`:
     specify timeout in seconds, `0` means no timeout, default: 0.
 - `tocAutoNumber`:

package/build/index.js

@@ -43,20 +43,25 @@ const errors = {
   no_title: "Title is required.",
   no_content: "Content is required."
 };
+function safeFineName(name) {
+  return name.replace(/[/\\?%*:|"<>\t\r\n]/g, "_");
+}
 function parseContent(content, index, epubConfigs) {
   let chapter = { ...content };
-  if (!chapter.filename) {
+  let { filename } = chapter;
+  if (!filename) {
     let titleSlug = uslug(diacritics.remove(chapter.title || "no title"));
     titleSlug = titleSlug.replace(/[\/\\]/g, "_");
     chapter.href = `${index}_${titleSlug}.xhtml`;
     chapter.filePath = path.join(epubConfigs.dir, "OEBPS", chapter.href);
   } else {
-    let is_xhtml = chapter.filename.endsWith(".xhtml");
-    chapter.href = is_xhtml ? chapter.filename : `${chapter.filename}.xhtml`;
+    filename = safeFineName(filename);
+    let is_xhtml = filename.endsWith(".xhtml");
+    chapter.href = is_xhtml ? filename : `${filename}.xhtml`;
     if (is_xhtml) {
-      chapter.filePath = path.join(epubConfigs.dir, "OEBPS", chapter.filename);
+      chapter.filePath = path.join(epubConfigs.dir, "OEBPS", filename);
     } else {
-      chapter.filePath = path.join(epubConfigs.dir, "OEBPS", `${chapter.filename}.xhtml`);
+      chapter.filePath = path.join(epubConfigs.dir, "OEBPS", `${filename}.xhtml`);
     }
   }
   chapter.id = `item_${index}`;
@@ -361,9 +366,9 @@ const writeFile = util.promisify(fs__namespace.writeFile);
 const USER_AGENT = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.116 Safari/537.36";
 const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 async function fileIsStable(filename, max_wait = 3e4) {
-  let start_time = new Date().getTime();
+  let start_time = (/* @__PURE__ */ new Date()).getTime();
   let last_size = fs__namespace.statSync(filename).size;
-  while (new Date().getTime() - start_time <= max_wait) {
+  while ((/* @__PURE__ */ new Date()).getTime() - start_time <= max_wait) {
     await wait(1e3);
     let size = fs__namespace.statSync(filename).size;
     if (size === last_size)
@@ -669,12 +674,13 @@ function parseOptions(options) {
     author: ["anonymous"],
     tocTitle: "Table Of Contents",
     appendChapterTitles: true,
-    date: new Date().toISOString(),
+    date: (/* @__PURE__ */ new Date()).toISOString(),
     lang: "en",
     fonts: [],
     version: 3,
     verbose: true,
     timeoutSeconds: 15 * 60,
+    // 15 min
     tocAutoNumber: false,
     ...options,
     id,

package/build/libs/safeFineName.d.ts

@@ -0,0 +1,6 @@
+/**
+ * safeFineName.ts
+ * @author: oldj
+ * @homepage: https://oldj.net
+ */
+export default function (name: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wp-epub-gen",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Epub generator.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -28,39 +28,39 @@
     "archiver": "^5.3.1",
     "cheerio": "^0.22.0",
     "diacritics": "^1.3.0",
-    "ejs": "^3.1.8",
-    "entities": "^4.4.0",
-    "fs-extra": "^11.1.0",
+    "ejs": "^3.1.9",
+    "entities": "^4.5.0",
+    "fs-extra": "^11.1.1",
     "mime": "^3.0.0",
-    "superagent": "^8.0.6",
+    "superagent": "^8.1.0",
     "uslug": "^1.0.4",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@types/archiver": "^5.3.1",
+    "@types/archiver": "^5.3.2",
     "@types/cheerio": "^0.22.31",
     "@types/diacritics": "^1.3.1",
-    "@types/ejs": "^3.1.1",
-    "@types/fs-extra": "^9.0.13",
+    "@types/ejs": "^3.1.2",
+    "@types/fs-extra": "^11.0.1",
     "@types/mime": "^3.0.1",
-    "@types/superagent": "^4.1.16",
+    "@types/superagent": "^4.1.18",
     "@types/uslug": "^1.0.1",
-    "@types/uuid": "^9.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.47.0",
-    "@typescript-eslint/parser": "^5.47.0",
+    "@types/uuid": "^9.0.2",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
     "chai": "^4.3.7",
     "cross-env": "^7.0.3",
-    "eslint": "^8.30.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint": "^8.47.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.0",
     "espower-typescript": "^10.0.1",
     "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"
+    "prettier": "^3.0.1",
+    "ts-loader": "^9.4.4",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.1.6",
+    "vite": "^4.4.9",
+    "vite-plugin-dts": "^3.5.2",
+    "vite-tsconfig-paths": "^4.2.0"
   }
 }

package/build/types.d.ts

@@ -1,79 +0,0 @@
-/**
- * types.d.ts
- * @author: oldj
- * @homepage: https://oldj.net
- */
-
-export interface IEpubImage {
-  id: string
-  url: string
-  dir: string
-  mediaType: string
-  extension: string
-}
-
-export interface IEpubGenOptions {
-  title: string
-  author?: string | string[]
-  publisher?: string
-  cover: string
-  output: string
-  version?: 2 | 3
-  css?: string
-  fonts?: string[]
-  lang?: 'en'
-  tocTitle?: string
-  appendChapterTitles?: boolean // For advanced customizations: absolute path to an OPF template.
-  customOpfTemplatePath?: string // For advanced customizations: absolute path to a NCX toc template.
-  customHtmlTocTemplatePath?: string // For advanced customizations: absolute path to a HTML toc template.
-  customNcxTocTemplatePath?: string
-  content: IChapter[] // Book Chapters content. It's should be an array of objects. eg. [{title: "Chapter 1",data: "<div>..."}, {data: ""},...]
-  verbose?: boolean // specify whether or not to console.log progress messages, default: false
-  description?: string
-  date?: string
-  tmpDir?: string
-  timeoutSeconds?: number
-  tocAutoNumber?: boolean
-}
-
-export interface IEpubData extends IEpubGenOptions {
-  id: string
-  docHeader: string
-  dir: string
-  images: IEpubImage[]
-  tmpDir: string
-  baseDir: string
-  _coverMediaType?: string
-  _coverExtension?: string
-  log: (msg: any) => void
-  content: IChapterData[]
-  timeoutSeconds: number
-}
-
-export interface IChapter {
-  id?: string
-  title?: string
-  author?: string | string[]
-  data: string // HTML String of the chapter content. image paths should be absolute path (should start with "http" or "https"), so that they could be downloaded. With the upgrade is possible to use local images (for this the path must start with file: //)
-  excludeFromToc?: boolean // default: false
-  beforeToc?: boolean // if is shown before Table of content, such like copyright pages. default: false
-  filename?: string // specify filename for each chapter
-  url?: string
-  children?: IChapter[]
-  appendChapterTitle?: boolean
-}
-
-export interface IChapterData extends IChapter {
-  id: string
-  href?: string
-  dir?: string
-  children: IChapterData[]
-  filePath: string
-  author: string[]
-}
-
-export interface IOut {
-  success?: boolean
-  message?: string
-  options?: IEpubGenOptions
-}