epub-maker2/src/epubtpl-lib/zip.ts

Easily create epub files with javascript

/**
 * Created by user on 2017/12/12/012.
 */

import JSZip from 'jszip';
import { IFiles, ICover, EpubConfig, IEpubConfig } from '../config';
import { compileTpl } from './handlebar-helpers';
import path from 'upath2';
import { EpubMaker } from '../index';
import { fetchFile } from './ajax';
import { hashSum, BPromise } from '../lib/util';
import { consoleLogger as console } from 'debug-color2/logger';

export { JSZip }

/*
export async function addMimetype(zip: JSZip, epub: EpubMaker, options)
{
	return zip.file('mimetype', options.templates.mimetype);
}

export function addContainerInfo(zip: JSZip, epub: EpubMaker, options)
{
	return zip.folder('META-INF').file('container.xml', compileTpl(options.templates.container, epub.epubConfig));
}
*/

export function parseFileSetting(coverUrl, epubConfig: IEpubConfig): IFiles
{
	let cover: ICover;

	if (typeof coverUrl == 'string')
	{
		let r = /^(?:\w+:)?\/{2,3}.+/;

		//console.log(path.isAbsolute(coverUrl), coverUrl, r.exec(coverUrl));

		if (!path.isAbsolute(coverUrl) && r.exec(coverUrl))
		{
			cover = {
				url: coverUrl,
			};
		}
		else
		{
			let cwd = epubConfig.cwd || process.cwd();

			cover = {
				file: path.isAbsolute(coverUrl) ? coverUrl : path.join(cwd, coverUrl),
			};
		}

		//console.log(cover);
	}
	else if (coverUrl && (coverUrl.url || coverUrl.file))
	{
		cover = coverUrl;
	}

	return cover;
}

export function addStaticFiles(zip, staticFiles: IFiles[])
{
	let cache = {} as {
		[k: string]: IFiles,
	};

	return BPromise.mapSeries(staticFiles, async function (_file: IFiles, index, length)
		{
			let file: IFiles;

			if (!_file.data
				&& _file.url
				&& cache[_file.url]
				&& cache[_file.url].data
			)
			{
				let cf = cache[_file.url];

				_file.data = cf.data;
				_file.mime = _file.mime || cf.mime;
			}

			let label: string = `[${(index + 1).toString().padStart(4, '0')}／${length.toString().padStart(4, '0')}]`;

			console.debug(`處理附加檔案`, label, _file)

			file = await fetchFile(_file)
				.catch(e => {

					console.warn(`[SKIP] 處理附加檔案時失敗，忽略附加此檔案`, label, _file, e);

					return null
				})
			;

			if (!file)
			{
				return;
			}

			if (_file.url)
			{
				cache[_file.url] = _file;
			}

			zip
				.folder(file.folder)
				.file(file.name, file.data)
			;

			return file;
		})
		.tap(function ()
		{
			cache = null;
		})
		;
}

export function addFiles(zip: JSZip, epub: EpubMaker, options)
{
	let staticFiles = epub.epubConfig.additionalFiles.reduce(function (a, file)
	{
		a.push(Object.assign({}, file, {
			folder: file.folder ? path.join('EPUB', file.folder) : 'EPUB',
		}));

		return a;
	}, []);

	return addStaticFiles(zip, staticFiles)
		.then(function (staticFiles)
		{

			epub.epubConfig.additionalFiles.forEach((v, i) =>
			{

				let s = staticFiles[i] ?? {};

				v.mime = v.mime || s.mime;
				v.name = s.name ?? v.name;

				if (v.folder === null)
				{
					// @ts-ignore
					v.href = v.name;
				}
				else
				{
					// @ts-ignore
					v.href = [v.folder, v.name].join('/');
				}

				// @ts-ignore
				v.id = v.id || 'additionalFiles-' + hashSum(v.name);

			});

			//console.log(epub.epubConfig.additionalFiles, staticFiles);

			return staticFiles;
		})
		;
}

export async function addCover(zip: JSZip, epub: EpubMaker, options)
{
	if (epub.epubConfig.cover)
	{
		epub.epubConfig.cover.basename = 'CoverDesign';
		let file = await fetchFile(epub.epubConfig.cover)
			.catch(e =>
			{
				console.error(e && e.meggage || `can't fetch cover`);
				return null;
			})
		;

		if (!file)
		{
			return false;
		}

		//file.name = `CoverDesign${file.ext}`;

		let filename = file.name = file.folder ? path.join(file.folder, file.name) : file.name;

		zip
			.folder('EPUB')
			//.folder('images')
			.file(filename, file.data)
		;

		return filename;
	}

	return false;
}

export interface IAddSubSectionsCallback
{
	(zip: JSZip, section: EpubMaker.Section, epubConfig: EpubConfig, options?)
}

export function addSubSections(zip: JSZip,
	section: EpubMaker.Section,
	cb: IAddSubSectionsCallback,
	epub: EpubMaker,
	options?,
)
{
	return BPromise
		.resolve(cb(zip, section, epub.epubConfig, options))
		.then(function ()
		{
			return BPromise.mapSeries(section.subSections, function (subSection: EpubMaker.Section)
			{
				return addSubSections(zip, subSection, cb, epub, options);
			});
		})
		;
}

export default exports as typeof import('./zip');