wp-epub-gen 0.1.3 → 0.1.4

package/src/parseContent.ts

@@ -1,351 +0,0 @@
-/**
- * parseContent
- * @author: oldj
- * @homepage: https://oldj.net
- */
-
-import * as cheerio from 'cheerio'
-import { remove as removeDiacritics } from 'diacritics'
-import * as mime from 'mime'
-import * as path from 'path'
-import * as uslug from 'uslug'
-import { v4 as uuidv4 } from 'uuid'
-import { IChapter, IChapterData, IEpubData, IEpubImage } from './types'
-
-export default function parseContent(
-  content: IChapter,
-  index: number | string,
-  epubConfigs: IEpubData,
-): IChapterData {
-  let chapter: IChapterData = { ...content } as IChapterData
-
-  if (!chapter.filename) {
-    let titleSlug = uslug(removeDiacritics(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`
-    if (is_xhtml) {
-      chapter.filePath = path.join(epubConfigs.dir, 'OEBPS', chapter.filename)
-    } else {
-      chapter.filePath = path.join(epubConfigs.dir, 'OEBPS', `${chapter.filename}.xhtml`)
-    }
-  }
-
-  chapter.id = `item_${index}`
-  chapter.dir = path.dirname(chapter.filePath)
-  chapter.excludeFromToc = chapter.excludeFromToc || false
-  chapter.beforeToc = chapter.beforeToc || false
-
-  // fix author array
-  if (chapter.author && typeof chapter.author === 'string') {
-    chapter.author = [chapter.author]
-  } else if (!chapter.author || !Array.isArray(chapter.author)) {
-    chapter.author = []
-  }
-
-  let allowedAttributes = [
-    'content',
-    'alt',
-    'id',
-    'title',
-    'src',
-    'href',
-    'about',
-    'accesskey',
-    'aria-activedescendant',
-    'aria-atomic',
-    'aria-autocomplete',
-    'aria-busy',
-    'aria-checked',
-    'aria-controls',
-    'aria-describedat',
-    'aria-describedby',
-    'aria-disabled',
-    'aria-dropeffect',
-    'aria-expanded',
-    'aria-flowto',
-    'aria-grabbed',
-    'aria-haspopup',
-    'aria-hidden',
-    'aria-invalid',
-    'aria-label',
-    'aria-labelledby',
-    'aria-level',
-    'aria-live',
-    'aria-multiline',
-    'aria-multiselectable',
-    'aria-orientation',
-    'aria-owns',
-    'aria-posinset',
-    'aria-pressed',
-    'aria-readonly',
-    'aria-relevant',
-    'aria-required',
-    'aria-selected',
-    'aria-setsize',
-    'aria-sort',
-    'aria-valuemax',
-    'aria-valuemin',
-    'aria-valuenow',
-    'aria-valuetext',
-    'class',
-    'content',
-    'contenteditable',
-    'contextmenu',
-    'datatype',
-    'dir',
-    'draggable',
-    'dropzone',
-    'hidden',
-    'hreflang',
-    'id',
-    'inlist',
-    'itemid',
-    'itemref',
-    'itemscope',
-    'itemtype',
-    'lang',
-    'media',
-    'ns1:type',
-    'ns2:alphabet',
-    'ns2:ph',
-    'onabort',
-    'onblur',
-    'oncanplay',
-    'oncanplaythrough',
-    'onchange',
-    'onclick',
-    'oncontextmenu',
-    'ondblclick',
-    'ondrag',
-    'ondragend',
-    'ondragenter',
-    'ondragleave',
-    'ondragover',
-    'ondragstart',
-    'ondrop',
-    'ondurationchange',
-    'onemptied',
-    'onended',
-    'onerror',
-    'onfocus',
-    'oninput',
-    'oninvalid',
-    'onkeydown',
-    'onkeypress',
-    'onkeyup',
-    'onload',
-    'onloadeddata',
-    'onloadedmetadata',
-    'onloadstart',
-    'onmousedown',
-    'onmousemove',
-    'onmouseout',
-    'onmouseover',
-    'onmouseup',
-    'onmousewheel',
-    'onpause',
-    'onplay',
-    'onplaying',
-    'onprogress',
-    'onratechange',
-    'onreadystatechange',
-    'onreset',
-    'onscroll',
-    'onseeked',
-    'onseeking',
-    'onselect',
-    'onshow',
-    'onstalled',
-    'onsubmit',
-    'onsuspend',
-    'ontimeupdate',
-    'onvolumechange',
-    'onwaiting',
-    'prefix',
-    'property',
-    'rel',
-    'resource',
-    'rev',
-    'role',
-    'spellcheck',
-    'style',
-    'tabindex',
-    'target',
-    'title',
-    'type',
-    'typeof',
-    'vocab',
-    'xml:base',
-    'xml:lang',
-    'xml:space',
-    'colspan',
-    'rowspan',
-    'epub:type',
-    'epub:prefix',
-  ]
-  let allowedXhtml11Tags = [
-    'div',
-    'p',
-    'h1',
-    'h2',
-    'h3',
-    'h4',
-    'h5',
-    'h6',
-    'ul',
-    'ol',
-    'li',
-    'dl',
-    'dt',
-    'dd',
-    'address',
-    'hr',
-    'pre',
-    'blockquote',
-    'center',
-    'ins',
-    'del',
-    'a',
-    'span',
-    'bdo',
-    'br',
-    'em',
-    'strong',
-    'dfn',
-    'code',
-    'samp',
-    'kbd',
-    'bar',
-    'cite',
-    'abbr',
-    'acronym',
-    'q',
-    'sub',
-    'sup',
-    'tt',
-    'i',
-    'b',
-    'big',
-    'small',
-    'u',
-    's',
-    'strike',
-    'basefont',
-    'font',
-    'object',
-    'param',
-    'img',
-    'table',
-    'caption',
-    'colgroup',
-    'col',
-    'thead',
-    'tfoot',
-    'tbody',
-    'tr',
-    'th',
-    'td',
-    'embed',
-    'applet',
-    'iframe',
-    'img',
-    'map',
-    'noscript',
-    'ns:svg',
-    'object',
-    'script',
-    'table',
-    'tt',
-    'var',
-  ]
-
-  let $ = cheerio.load(chapter.data, {
-    lowerCaseTags: true,
-    recognizeSelfClosing: true,
-  })
-
-  // only body innerHTML is allowed
-  let body = $('body')
-  if (body.length) {
-    let html = body.html()
-    if (html) {
-      $ = cheerio.load(html, {
-        lowerCaseTags: true,
-        recognizeSelfClosing: true,
-      })
-    }
-  }
-
-  $($('*').get().reverse()).each(function (elemIndex, elem) {
-    // @ts-ignore
-    let attrs = elem.attribs
-    // @ts-ignore
-    let that: CheerioElement = this
-    let tags = ['img', 'br', 'hr']
-    if (tags.includes(that.name)) {
-      if (that.name === 'img' && !$(that).attr('alt')) {
-        $(that).attr('alt', 'image-placeholder')
-      }
-    }
-
-    Object.entries(attrs).map(([k, v]) => {
-      if (allowedAttributes.includes(k)) {
-        if (k === 'type' && that.name !== 'script') {
-          $(that).removeAttr(k)
-        }
-      } else {
-        $(that).removeAttr(k)
-      }
-    })
-
-    if (epubConfigs.version === 2) {
-      if (!allowedXhtml11Tags.includes(that.name)) {
-        if (epubConfigs.verbose) {
-          console.log(
-            'Warning (content[' + index + ']):',
-            that.name,
-            "tag isn't allowed on EPUB 2/XHTML 1.1 DTD.",
-          )
-        }
-        let child = $(that).html()
-        $(that).replaceWith($('<div>' + child + '</div>'))
-      }
-    }
-  })
-
-  $('img').each((index, elem) => {
-    let url = $(elem).attr('src') || ''
-    let image = epubConfigs.images.find((el) => el.url === url)
-    let id: string
-    let extension: string
-
-    if (image) {
-      id = image.id
-      extension = image.extension
-    } else {
-      id = uuidv4()
-      let mediaType: string = mime.getType(url.replace(/\?.*/, '')) || ''
-      extension = mime.getExtension(mediaType) || ''
-      let dir = chapter.dir || ''
-
-      let img: IEpubImage = { id, url, dir, mediaType, extension }
-      epubConfigs.images.push(img)
-    }
-
-    $(elem).attr('src', `images/${id}.${extension}`)
-  })
-
-  chapter.data = $.xml()
-
-  if (Array.isArray(chapter.children)) {
-    chapter.children = chapter.children.map((content, idx) =>
-      parseContent(content, `${index}_${idx}`, epubConfigs),
-    )
-  }
-
-  return chapter
-}

package/src/render.ts

@@ -1,84 +0,0 @@
-/**
- * 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

@@ -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) => 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

@@ -1,39 +0,0 @@
-/**
- * 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/test/basic.test.js

@@ -1,28 +0,0 @@
-/**
- * @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

@@ -1,21 +0,0 @@
-/**
- * @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

@@ -1,21 +0,0 @@
-{
-  "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

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