wp-epub-gen 0.1.0

package/src/render.ts

@@ -0,0 +1,84 @@
+/**
+ * render
+ * @author: oldj
+ * @homepage: https://oldj.net
+ */
+
+import * as archiver from 'archiver'
+import * as fs from 'fs-extra'
+import * as path from 'path'
+import { downloadAllImages } from './downloadImage'
+import { generateTempFile } from './generateTempFile'
+import makeCover from './makeCover'
+import { IEpubData } from './types'
+import { fileIsStable } from './utils'
+
+export async function render(data: IEpubData): Promise<void> {
+  let { log } = data
+
+  log('Generating Template Files...')
+  await generateTempFile(data)
+  log('Downloading Images...')
+  await downloadAllImages(data)
+  log('Making Cover...')
+  await makeCover(data)
+  log('Generating Epub Files...')
+  await genEpub(data)
+  if (fs.existsSync(data.output)) {
+    log('Output: ' + data.output)
+    log('Done.')
+  } else {
+    log('Output fail!')
+  }
+}
+
+async function genEpub(epubData: IEpubData): Promise<void> {
+  let { log, dir, output } = epubData
+
+  let archive = archiver('zip', { zlib: { level: 9 } })
+  let outputStream = fs.createWriteStream(epubData.output)
+  log('Zipping temp dir to ' + output)
+
+  return new Promise((resolve, reject) => {
+    archive.on('end', async () => {
+      log('Done zipping, clearing temp dir...')
+
+      // log(fs.statSync(epubData.output).size)
+      // setTimeout(() => log(fs.statSync(epubData.output).size), 1)
+      // setTimeout(() => log(fs.statSync(epubData.output).size), 100)
+      // setTimeout(() => log(fs.statSync(epubData.output).size), 1000)
+      let stable = await fileIsStable(epubData.output)
+      if (!stable) {
+        log('Output epub file is not stable!')
+      }
+
+      try {
+        fs.removeSync(dir)
+        resolve()
+      } catch (e) {
+        log('[Error] ' + e.message)
+        reject(e)
+      }
+    })
+
+    archive.on('close', () => {
+      log('Zip close..')
+    })
+
+    archive.on('finish', () => {
+      log('Zip finish..')
+    })
+
+    archive.on('error', (err) => {
+      log('[Archive Error] ' + err.message)
+      reject(err)
+    })
+
+    archive.pipe(outputStream)
+    archive.append('application/epub+zip', { store: true, name: 'mimetype' })
+    archive.directory(path.join(dir, 'META-INF'), 'META-INF')
+    archive.directory(path.join(dir, 'OEBPS'), 'OEBPS')
+
+    archive.finalize()
+  })
+}

package/src/types.d.ts

@@ -0,0 +1,79 @@
+/**
+ * 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) => 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
+}

package/src/utils.ts

@@ -0,0 +1,39 @@
+/**
+ * utils
+ * @author: oldj
+ * @homepage: https://oldj.net
+ */
+
+import * as fs from 'fs'
+import { promisify } from 'util'
+
+export const readFile = promisify(fs.readFile)
+export const writeFile = promisify(fs.writeFile)
+
+export 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'
+
+export const wait = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms))
+
+export async function fileIsStable(filename: string, max_wait: number = 30000): Promise<boolean> {
+  let start_time = new Date().getTime()
+  let last_size = fs.statSync(filename).size
+
+  while (new Date().getTime() - start_time <= max_wait) {
+    await wait(1000)
+    let size = fs.statSync(filename).size
+    if (size === last_size) return true
+    last_size = size
+  }
+
+  return false
+}
+
+export function simpleMinifier(xhtml: string) {
+  xhtml = xhtml
+    .replace(/\s+<\/a>/gi, '</a>')
+    .replace(/\n\s+</g, '\n<')
+    .replace(/\n+/g, '\n')
+
+  return xhtml
+}

package/templates/epub2/content.opf.ejs

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf"
+         version="2.0"
+         unique-identifier="BookId">
+
+    <metadata xmlns:dc="http://purl.org/dc/elements/1.1/"
+              xmlns:opf="http://www.idpf.org/2007/opf">
+
+        <dc:identifier id="BookId" opf:scheme="URN"><%= id %></dc:identifier>
+        <dc:title><%= title %></dc:title>
+        <dc:description><%= description %></dc:description>
+        <dc:publisher><%= publisher || "anonymous" %></dc:publisher>
+        <dc:creator opf:role="aut" opf:file-as="<%= author.length ? author.join(",") : author %>"><%= author.length ? author.join(",") : author %></dc:creator>
+        <dc:date opf:event="modification"><%= date %></dc:date>
+        <dc:language><%= lang || "en" %></dc:language>
+        <meta name="cover" content="image_cover"/>
+        <meta name="generator" content="epub-gen"/>
+
+    </metadata>
+
+    <manifest>
+        <item id="ncx" href="toc.ncx" media-type="application/x-dtbncx+xml"/>
+        <item id="toc" href="toc.xhtml" media-type="application/xhtml+xml"/>
+        <item id="css" href="style.css" media-type="text/css"/>
+
+        <% if(locals.cover) { %>
+            <item id="image_cover" href="cover.<%= _coverExtension %>" media-type="<%= _coverMediaType %>"/>
+        <% } %>
+
+        <% images.forEach(function(image, index){ %>
+            <item id="image_<%= index %>" href="images/<%= image.id %>.<%= image.extension %>" media-type="<%= image.mediaType %>"/>
+        <% }) %>
+
+        <% content.forEach(function(content, index){ %>
+            <item id="content_<%= index %>_<%= content.id %>" href="<%= content.href %>" media-type="application/xhtml+xml"/>
+        <% }) %>
+
+        <% fonts.forEach(function(font, index) { %>
+            <item id="font_<%= index %>" href="fonts/<%= font %>" media-type="application/x-font-ttf"/>
+        <% }) %>
+    </manifest>
+
+    <spine toc="ncx">
+        <% content.forEach(function(content, index){ %>
+            <% if(content.beforeToc && !content.excludeFromToc){ %>
+                <itemref idref="content_<%= index %>_<%= content.id %>"/>
+            <% } %>
+        <% }) %>
+        <itemref idref="toc"/>
+        <% content.forEach(function(content, index){ %>
+            <% if(!content.beforeToc && !content.excludeFromToc){ %>
+                <itemref idref="content_<%= index %>_<%= content.id %>"/>
+            <% } %>
+        <% }) %>
+    </spine>
+    <guide/>
+</package>

package/templates/epub2/toc.xhtml.ejs

@@ -0,0 +1,26 @@
+<?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 xml:lang="<%- lang %>" xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <title><%= title %></title>
+    <meta charset="UTF-8"/>
+    <link rel="stylesheet" type="text/css" href="style.css"/>
+</head>
+<body>
+<h1 class="h1"><%= tocTitle %></h1>
+<% content.forEach(function(content, index){ %>
+    <% if(!content.excludeFromToc){ %>
+        <p class="table-of-content">
+            <a href="<%= content.href %>"><%= (1 + index) + ". " + (content.title || "Chapter " + (1 + index)) %>
+                <% if(content.author.length){ %>
+                    - <small class="toc-author"><%= content.author.join(",") %></small>
+                <% } %>
+                <% if(content.url){ %><span class="toc-link"><%= content.url %></span>
+                <% }else{ %><span class="toc-link"></span>
+                <% } %>
+            </a>
+        </p>
+    <% } %>
+<% }) %>
+</body>
+</html>

package/templates/epub3/content.opf.ejs

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf"
+         version="3.0"
+         unique-identifier="BookId"
+         xmlns:dc="http://purl.org/dc/elements/1.1/"
+         xmlns:dcterms="http://purl.org/dc/terms/"
+         xml:lang="en"
+         xmlns:media="http://www.idpf.org/epub/vocab/overlays/#"
+         prefix="ibooks: http://vocabulary.itunes.apple.com/rdf/ibooks/vocabulary-extensions-1.0/">
+
+    <metadata xmlns:dc="http://purl.org/dc/elements/1.1/"
+              xmlns:opf="http://www.idpf.org/2007/opf">
+
+        <dc:identifier id="BookId"><%= id %></dc:identifier>
+        <meta refines="#BookId" property="identifier-type" scheme="onix:codelist5">
+        22</meta>
+        <meta property="dcterms:identifier" id="meta-identifier">
+        BookId</meta>
+        <dc:title><%= title %></dc:title>
+        <meta property="dcterms:title" id="meta-title"><%= title %></meta>
+        <dc:language><%= lang || "en" %></dc:language>
+        <meta property="dcterms:language" id="meta-language"><%= lang || "en" %></meta>
+        <meta property="dcterms:modified"><%= (new Date()).toISOString().split(".")[0] + "Z" %></meta>
+        <dc:creator id="creator"><%= author.length ? author.join(",") : author %></dc:creator>
+        <meta refines="#creator" property="file-as"><%= author.length ? author.join(",") : author %></meta>
+        <meta property="dcterms:publisher"><%= publisher || "anonymous" %></meta>
+        <dc:publisher><%= publisher || "anonymous" %></dc:publisher>
+        <% var date = new Date(); var year = date.getFullYear(); var month = date.getMonth() + 1; var day = date.getDate(); var stringDate = "" + year + "-" + month + "-" + day; %>
+        <meta property="dcterms:date"><%= stringDate %></meta>
+        <dc:date><%= stringDate %></dc:date>
+        <meta property="dcterms:rights">
+        All rights reserved</meta>
+        <dc:rights>Copyright &#x00A9; <%= (new Date()).getFullYear() %> by <%= publisher || "anonymous" %></dc:rights>
+        <meta name="cover" content="image_cover"/>
+        <meta name="generator" content="epub-gen"/>
+        <meta property="ibooks:specified-fonts">
+        true</meta>
+    </metadata>
+
+    <manifest>
+        <item id="ncx" href="toc.ncx" media-type="application/x-dtbncx+xml"/>
+        <item id="toc" href="toc.xhtml" media-type="application/xhtml+xml" properties="nav"/>
+        <item id="css" href="style.css" media-type="text/css"/>
+
+        <% if(locals.cover) { %>
+            <item id="image_cover" href="cover.<%= _coverExtension %>" media-type="<%= _coverMediaType %>"/>
+        <% } %>
+
+        <% images.forEach(function(image, index){ %>
+            <item id="image_<%= index %>" href="images/<%= image.id %>.<%= image.extension %>" media-type="<%= image.mediaType %>"/>
+        <% }) %>
+
+        <% function renderContentItem(content) { %>
+            <% content.forEach(function(content){ %>
+                <item id="content_<%= content.id %>" href="<%= content.href %>" media-type="application/xhtml+xml"/>
+                <% if (Array.isArray(content.children)) { %>
+                    <% renderContentItem(content.children) %>
+                <% } %>
+            <% }) %>
+        <% } %>
+        <% renderContentItem(content) %>
+
+        <% fonts.forEach(function(font, index){ %>
+            <item id="font_<%= index %>" href="fonts/<%= font %>" media-type="application/x-font-ttf"/>
+        <% }) %>
+    </manifest>
+
+    <spine toc="ncx">
+        <% var nodes_1 = content.filter(item => !item.excludeFromToc && item.beforeToc) %>
+        <% var nodes_2 = content.filter(item => !item.excludeFromToc && !item.beforeToc) %>
+        <% function renderToc(nodes) { %>
+            <% nodes.forEach(function(content){ %>
+                <itemref idref="content_<%= content.id %>"/>
+                <% if (Array.isArray(content.children)) { %>
+                    <% renderToc(content.children) %>
+                <% } %>
+            <% }) %>
+        <% } %>
+        <% renderToc(nodes_1) %>
+        <itemref idref="toc"/>
+        <% renderToc(nodes_2) %>
+    </spine>
+    <guide>
+        <reference type="text" title="Table of Content" href="toc.xhtml"/>
+    </guide>
+</package>

package/templates/epub3/toc.xhtml.ejs

@@ -0,0 +1,38 @@
+<?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" xml:lang="<%- lang %>"
+      lang="<%- lang %>">
+<head>
+    <title><%= title %></title>
+    <meta charset="UTF-8" />
+    <link rel="stylesheet" type="text/css" href="style.css" />
+</head>
+<body>
+<h1 class="h1"><%= tocTitle %></h1>
+<nav id="toc" class="TOC" epub:type="toc">
+    <% var nodes_1 = content.filter(item => !item.excludeFromToc && item.beforeToc) %>
+    <% var nodes_2 = content.filter(item => !item.excludeFromToc && !item.beforeToc) %>
+    <% function renderToc(nodes, indent = 0) { %>
+        <ol>
+            <% nodes.forEach(function(content, index){ %>
+                <li class="table-of-content">
+                    <a href="<%= content.href %>"><%= (content.title || "Chapter " + (1 + index)) %>
+                        <% if(content.author.length){ %> - <small
+                                class="toc-author"><%= content.author.join(",") %></small>
+                        <% } %>
+                        <% if(content.url){ %><span class="toc-link"><%= content.url %></span>
+                        <% } %>
+                    </a>
+                    <% if (Array.isArray(content.children) && content.children.length > 0) { %>
+                        <% renderToc(content.children, indent + 1) %>
+                    <% } %>
+                </li>
+            <% }) %>
+        </ol>
+    <% } %>
+    <% renderToc(nodes_1) %>
+    <% renderToc(nodes_2) %>
+</nav>
+
+</body>
+</html>

package/templates/template.css

@@ -0,0 +1,46 @@
+.epub-author {
+  color: #555;
+}
+
+.epub-link {
+  margin-bottom: 30px;
+}
+
+.epub-link a {
+  color: #666;
+  font-size: 90%;
+}
+
+.toc-author {
+  font-size: 90%;
+  color: #555;
+}
+
+.toc-link {
+  color: #999;
+  font-size: 85%;
+  display: block;
+}
+
+hr {
+  border: 0;
+  border-bottom: 1px solid #dedede;
+  margin: 60px 10%;
+}
+
+.TOC > ol {
+  margin: 0;
+  padding: 0;
+}
+
+.TOC > ol ol {
+  padding: 0;
+  margin-left: 2em;
+}
+
+.TOC li {
+  font-size: 16px;
+  list-style: none;
+  margin: 0 auto;
+  padding: 0;
+}

package/templates/toc.ncx.ejs

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1">
+    <head>
+        <meta name="dtb:uid" content="<%= id %>"/>
+        <meta name="dtb:generator" content="epub-gen"/>
+        <meta name="dtb:depth" content="<%= (toc_depth || 1)%>"/>
+        <meta name="dtb:totalPageCount" content="0"/>
+        <meta name="dtb:maxPageNumber" content="0"/>
+    </head>
+    <docTitle>
+        <text><%= title %></text>
+    </docTitle>
+    <docAuthor>
+        <text><%= author %></text>
+    </docAuthor>
+    <navMap>
+        <% var _index = 1; %>
+        <% var nodes_1 = content.filter(c => !c.excludeFromToc && c.beforeToc) %>
+        <% var nodes_2 = content.filter(c => !c.excludeFromToc && !c.beforeToc) %>
+        <% function renderToc(nodes) { %>
+            <% nodes.forEach(function(content, index){ %>
+                <navPoint id="content_<%= content.id %>" playOrder="<%= _index++ %>" class="chapter">
+                    <navLabel>
+                        <text><%= (tocAutoNumber ? ((1 + index) + ". ") : "") + (content.title || "Chapter " + (1 + index)) %></text>
+                    </navLabel>
+                    <content src="<%= content.href %>"/>
+                    <% if (Array.isArray(content.children)) { %>
+                    <% renderToc(content.children) %>
+                    <% } %>
+                </navPoint>
+            <% }) %>
+        <% } %>
+
+        <% renderToc(nodes_1) %>
+
+        <navPoint id="toc" playOrder="<%= _index++ %>" class="chapter">
+            <navLabel>
+                <text><%= tocTitle %></text>
+            </navLabel>
+            <content src="toc.xhtml"/>
+        </navPoint>
+
+        <% renderToc(nodes_2) %>
+    </navMap>
+</ncx>

package/test/basic.test.js

@@ -0,0 +1,28 @@
+/**
+ * @author: oldj
+ * @homepage: https://oldj.net
+ */
+
+import { assert } from 'chai'
+import { epubGen } from '../dist/index'
+import { errors } from '../dist/errors'
+import * as data from './data/1.json'
+
+describe('Basic', () => {
+  it('no output path error', async () => {
+    let out = await epubGen({ ...data, verbose: false })
+    assert.equal(out.success, false)
+    assert.equal(out.message, errors.no_output_path)
+  })
+
+  it('basic test', async () => {
+    let out = { options: {} }
+    try {
+      out = await epubGen({ ...data }, 'test.epub')
+    } catch (e) {
+      console.error('Error 24: ' + e.message)
+    }
+    assert.equal(out.success, true)
+    assert.equal(typeof out.options.tmpDir, 'string')
+  }).timeout(60 * 1000)
+})

package/test/child-page-image.test.js

@@ -0,0 +1,21 @@
+/**
+ * @author: oldj
+ * @homepage: https://oldj.net
+ */
+
+import { assert } from 'chai'
+import { epubGen } from '../dist/index'
+import * as data from './data/1.json'
+
+describe('Child page image', () => {
+  it.only('should has image', async () => {
+    let out = { options: {} }
+    try {
+      out = await epubGen({ ...data }, 'cpi.epub')
+    } catch (e) {
+      console.error('Error 24: ' + e.message)
+    }
+    assert.equal(out.success, true)
+    assert.equal(typeof out.options.tmpDir, 'string')
+  }).timeout(60 * 1000)
+})

package/test/data/1.json

@@ -0,0 +1,21 @@
+{
+  "title": "多层目录",
+  "author": "Andy",
+  "lang": "zh-cn",
+  "content": [
+    {
+      "title": "aaa",
+      "data": "<div>aa</div>"
+    },
+    {
+      "title": "bbb",
+      "data": "bb",
+      "children": [
+        {
+          "title": "cc1",
+          "data": "<div><img src=\"https://media.zine.la/booklet/81/a3/23/8b05c1faa4fb7ffe84727d99a2_1593030700_James-Turrell-2.jpg?imageMogr2/thumbnail/!400x520r/gravity/Center/crop/400x520\"/></div>"
+        }
+      ]
+    }
+  ]
+}

package/test/tt.js

@@ -0,0 +1,16 @@
+/**
+ * t.js
+ * @author: oldj
+ * @homepage: https://oldj.net
+ */
+
+const {epubGen} = require('../dist/index')
+const data = require('./data/1.json')
+
+;(async () => {
+  try {
+    await epubGen({...data, tocAutoNumber: true}, 'test.epub')
+  } catch (e) {
+    console.error('Error 24: ' + e.message)
+  }
+})()

package/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "allowJs": true,
+    "sourceMap": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "useUnknownInCatchVariables": false,
+    "noImplicitThis": true,
+    "noImplicitReturns": true,
+    "moduleResolution": "node",
+    "experimentalDecorators": true,
+    "plugins": [
+    ]
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "test",
+    "dist"
+  ],
+  "externals": {
+  }
+}