npm - wp-epub-gen - Versions diffs - 0.1.2 → 0.1.4 - Mend

wp-epub-gen 0.1.2 → 0.1.4

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 (43) hide show

package/{dist → build}/downloadImage.d.ts +0 -0
package/{dist → build}/downloadImage.js +0 -0
package/build/downloadImage.js.map +1 -0
package/{dist → build}/errors.d.ts +0 -0
package/{dist → build}/errors.js +0 -0
package/build/errors.js.map +1 -0
package/{dist → build}/generateTempFile.d.ts +0 -0
package/{dist → build}/generateTempFile.js +0 -0
package/build/generateTempFile.js.map +1 -0
package/{dist → build}/index.d.ts +0 -0
package/{dist → build}/index.js +0 -0
package/build/index.js.map +1 -0
package/{dist → build}/makeCover.d.ts +0 -0
package/{dist → build}/makeCover.js +0 -0
package/build/makeCover.js.map +1 -0
package/{dist → build}/parseContent.d.ts +0 -0
package/{dist → build}/parseContent.js +0 -0
package/build/parseContent.js.map +1 -0
package/{dist → build}/render.d.ts +0 -0
package/{dist → build}/render.js +0 -0
package/build/render.js.map +1 -0
package/{dist → build}/utils.d.ts +0 -0
package/{dist → build}/utils.js +0 -0
package/build/utils.js.map +1 -0
package/cpi.epub +0 -0
package/package.json +17 -21
package/templates/epub3/content.opf.ejs +19 -22
package/test.epub +0 -0
package/tsconfig.json +1 -1
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/types.d.ts +0 -79
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/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
-}

package/src/render.ts DELETED Viewed

@@ -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 DELETED Viewed

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