npm - wp-epub-gen - Versions diffs - 0.1.3 → 0.2.0 - Mend

wp-epub-gen 0.1.3 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (36) hide show

package/{dist → build}/downloadImage.d.ts +0 -0
package/{dist → build}/errors.d.ts +0 -0
package/{dist → build}/generateTempFile.d.ts +0 -0
package/{dist → build}/index.d.ts +1 -0
package/build/index.js +752 -0
package/{dist → build}/makeCover.d.ts +0 -0
package/{dist → build}/parseContent.d.ts +0 -0
package/{dist → build}/render.d.ts +0 -0
package/{src → build}/types.d.ts +1 -1
package/{dist → build}/utils.d.ts +0 -0
package/cpi.epub +0 -0
package/package.json +22 -22
package/test.epub +0 -0
package/tsconfig.json +11 -3
package/vite.config.ts +40 -0
package/dist/downloadImage.js +0 -88
package/dist/errors.js +0 -14
package/dist/generateTempFile.js +0 -121
package/dist/index.js +0 -128
package/dist/makeCover.js +0 -63
package/dist/parseContent.js +0 -331
package/dist/render.js +0 -90
package/dist/utils.js +0 -48
package/src/downloadImage.ts +0 -83
package/src/errors.ts +0 -11
package/src/generateTempFile.ts +0 -144
package/src/index.ts +0 -152
package/src/makeCover.ts +0 -52
package/src/parseContent.ts +0 -351
package/src/render.ts +0 -84
package/src/utils.ts +0 -39
package/test/basic.test.js +0 -28
package/test/child-page-image.test.js +0 -21
package/test/data/1.json +0 -21
package/test/tt.js +0 -16
package/webpack.config.js +0 -75

package/src/generateTempFile.ts DELETED Viewed

@@ -1,144 +0,0 @@
-/**
- * generateTempFile
- * @author: oldj
- * @homepage: https://oldj.net
- */
-import * as ejs from 'ejs'
-import * as entities from 'entities'
-import * as fs from 'fs-extra'
-import * as path from 'path'
-import { IChapterData, IEpubData } from './types'
-import { readFile, simpleMinifier, writeFile } from './utils'
-export const generateTempFile = async (epubData: IEpubData) => {
-  let { log } = epubData
-  let oebps_dir = path.join(epubData.dir, 'OEBPS')
-  await fs.ensureDir(oebps_dir)
-  const templates_dir = path.join(epubData.baseDir, 'templates')
-  epubData.css =
-    epubData.css ||
-    (await readFile(path.join(epubData.baseDir, 'templates', 'template.css'), 'utf-8'))
-  await writeFile(path.join(oebps_dir, 'style.css'), epubData.css, 'utf-8')
-  if (epubData.fonts?.length) {
-    let fonts_dir = path.join(oebps_dir, 'fonts')
-    await 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?: boolean, local_append?: boolean): boolean => {
-    if (typeof local_append === 'boolean') return local_append
-    return !!global_append
-  }
-  const saveContentToFile = (content: IChapterData) => {
-    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 && content.author?.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'),
-    await ejs.renderFile(opfPath, epubData),
-    'utf-8',
-  )
-  fs.writeFileSync(
-    path.join(oebps_dir, 'toc.ncx'),
-    await ejs.renderFile(ncxTocPath, { ...epubData, toc_depth }),
-    'utf-8',
-  )
-  // 说明：toc.xhtml 的内容在 macOS 自带的 Books 会被当作目录显示，如果空格太多，目录显示可能会不正常，因此这儿简单去掉了不必要的空格
-  fs.writeFileSync(
-    path.join(oebps_dir, 'toc.xhtml'),
-    simpleMinifier(await ejs.renderFile(htmlTocPath, epubData)),
-    'utf-8',
-  )
-}

package/src/index.ts DELETED Viewed

@@ -1,152 +0,0 @@
-/**
- * index.ts
- * @author: oldj
- * @homepage: https://oldj.net
- */
-import * as mime from 'mime'
-import * as os from 'os'
-import * as path from 'path'
-import { v4 as uuidv4 } from 'uuid'
-import { errors } from './errors'
-import parseContent from './parseContent'
-import { render } from './render'
-import { IEpubData, IEpubGenOptions, IOut } from './types'
-const baseDir = path.dirname(__dirname)
-function result(success: boolean, message?: string, options?: IEpubGenOptions): IOut {
-  if (options && options.verbose) {
-    if (!success) {
-      console.error(new Error(message))
-    }
-  }
-  let out: IOut = {
-    success,
-  }
-  if (typeof message === 'string') {
-    out.message = message
-  }
-  if (options) {
-    out.options = options
-  }
-  return out
-}
-function check(options: IEpubGenOptions): IOut {
-  if (!options.output) {
-    return result(false, errors.no_output_path, options)
-  }
-  if (!options.title) {
-    return result(false, errors.no_title, options)
-  }
-  if (!options.content) {
-    return result(false, errors.no_content, options)
-  }
-  return result(true, undefined, options)
-}
-function parseOptions(options: IEpubGenOptions): IEpubData {
-  let tmpDir = options.tmpDir || os.tmpdir()
-  let id = uuidv4()
-  let data: IEpubData = {
-    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, // 15 min
-    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) => parseContent(content, index, data))
-  if (data.cover) {
-    data._coverMediaType = mime.getType(data.cover) || ''
-    data._coverExtension = mime.getExtension(data._coverMediaType) || ''
-  }
-  return data
-}
-export async function epubGen(options: IEpubGenOptions, output?: string): Promise<IOut> {
-  options = { ...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: any
-  try {
-    let data = parseOptions(options)
-    let timeoutSeconds: number = 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`)
-    }
-    await render(data)
-    return result(true, undefined, data)
-  } catch (e) {
-    if (verbose) console.error(e)
-    return result(false, e.message, options)
-  } finally {
-    clearTimeout(t)
-  }
-}
-export const gen = epubGen

package/src/makeCover.ts DELETED Viewed

@@ -1,52 +0,0 @@
-/**
- * makeCover
- * @author: oldj
- * @homepage: https://oldj.net
- */
-import * as fs from 'fs-extra'
-import * as path from 'path'
-import * as request from 'superagent'
-import { IEpubData } from './types'
-import { USER_AGENT } from './utils'
-export default async function makeCover(data: IEpubData): Promise<void> {
-  let { cover, _coverExtension, log } = data
-  if (!cover) return
-  let destPath = path.join(data.dir, 'OEBPS', `cover.${_coverExtension}`)
-  let writeStream: any = null
-  if (cover.startsWith('http')) {
-    writeStream = request.get(cover).set({ 'User-Agent': 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: any) => {
-      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!')
-    })
-  })
-}

package/src/parseContent.ts DELETED Viewed

@@ -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
-}