feat: simplify user api

yjl9903 · Feb 26, 2023 · fd500a7 · fd500a7
1 parent cd7be7f
commit fd500a7
Show file tree

Hide file tree

Showing 13 changed files with 119 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,12 @@ It will support the generation of the [latest epub standard](https://www.w3.org/
 
 > 👷‍♂️ Still work in progress.
 
+## Installation
+
+```bash
+npm i -g epubook
+```
+
 ## Resources
 
 + [EPUB 3.2 specification](https://www.w3.org/publishing/epub32/)

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -1,11 +1,34 @@
-# epubook
+# @epubook/core
 
-A Node EPUB generation library.
-
-It will support the generation of the [latest epub standard](https://www.w3.org/TR/epub-33/) (3.3).
+The fundamental module of [epubook](https://github.com/yjl9903/epubook) for generating EPUB books.
 
 > 👷‍♂️ Still work in progress.
 
+## Installation
+
+```bash
+npm i @epubook/core
+```
+
+## Usage
+
+```ts
+import { Epubook } from '@epubook/core'
+
+const book = new Epubook({
+  title: 'Test Book',
+  date: new Date('2023-02-01T11:00:00.000Z'),
+  lastModified: new Date('2023-02-26T11:00:00.000Z'),
+  creator: 'XLor',
+  description: 'for test usage',
+  source: 'imagine'
+})
+
+// ...
+
+await book.writeFile('./test.epub')
+```
+
 ## License
 
 MIT License © 2023 [XLor](https://github.com/yjl9903)
diff --git a/packages/core/src/bundle/index.ts b/packages/core/src/bundle/index.ts
@@ -17,11 +17,11 @@ import { toISO8601String } from '../utils';
 export async function bundle(epub: Epubook): Promise<Uint8Array> {
   return new Promise(async (res, rej) => {
     const opfs = epub
-      .packageDocuments()
+      .packages()
       .map((opf) => [opf.filename(), fflate.strToU8(makePackageDocument(opf))] as const);
 
     const items: Record<string, Uint8Array> = {};
-    for (const opf of epub.packageDocuments()) {
+    for (const opf of epub.packages()) {
       const base = path.dirname(opf.filename());
       for (const item of opf.items()) {
         const name = path.join(base, item.filename());
@@ -77,7 +77,7 @@ export function makeContainer(epub: Epubook): string {
     unpairedTags: ['rootfile']
   });
 
-  const rootfile = epub.packageDocuments().map((p) => ({
+  const rootfile = epub.packages().map((p) => ({
     '@_full-path': p.filename(),
     '@_media-type': 'application/oebps-package+xml',
     '#text': ''

diff --git a/packages/core/src/epub/epub.ts b/packages/core/src/epub/epub.ts
@@ -1,7 +1,7 @@
 import * as path from 'pathe';
 import { existsSync, mkdirSync, promises as fs } from 'node:fs';
 
-import { PackageDocument } from './opf';
+import { PackageDocument, PackageDocumentMeta } from './opf';
 
 export class Epubook {
   /**
@@ -13,13 +13,15 @@ export class Epubook {
    */
   private opfs: PackageDocument[] = [new PackageDocument('OEBPS/content.opf')];
 
-  constructor() {}
+  constructor(meta: Partial<PackageDocumentMeta> = {}) {
+    this.opfs[0].update(meta);
+  }
 
-  public packageDocuments(): PackageDocument[] {
+  public packages(): PackageDocument[] {
     return this.opfs;
   }
 
-  public mainPackageDocument() {
+  public main() {
     return this.opfs[0];
   }
 

diff --git a/packages/core/src/epub/opf.ts b/packages/core/src/epub/opf.ts
@@ -11,6 +11,24 @@ const defu = createDefu((obj: any, key, value: any) => {
   }
 });
 
+export interface PackageDocumentMeta {
+  title: string;
+  language: string;
+  contributor: string[];
+  coverage: string;
+  creator: string;
+  date: Date;
+  description: string;
+  format: string;
+  publisher: string;
+  relation: string;
+  rights: string;
+  source: string;
+  subject: string;
+  type: string;
+  lastModified: Date;
+}
+
 export class PackageDocument {
   private readonly file: string;
 
@@ -20,7 +38,7 @@ export class PackageDocument {
 
   private _identifier = randomUUID();
 
-  private _metadata = {
+  private _metadata: PackageDocumentMeta = {
     title: '',
     language: 'zh-CN',
     contributor: [] as string[],
@@ -57,7 +75,7 @@ export class PackageDocument {
   }
 
   // --- metadata ---
-  public update(info: Partial<typeof this._metadata>) {
+  public update(info: Partial<PackageDocumentMeta>) {
     // TODO: valiate input data
     this._metadata = defu(info, this._metadata);
     return this;

diff --git a/packages/core/test/bundle.test.ts b/packages/core/test/bundle.test.ts
@@ -21,7 +21,7 @@ describe('Bundle Epub', () => {
   it('generate opf', () => {
     const epub = new Epubook();
 
-    const opf = epub.mainPackageDocument();
+    const opf = epub.main();
     opf.setIdentifier('test-book-id', 'BookId');
     opf.update({
       title: 'Test Book',
@@ -63,11 +63,7 @@ describe('Bundle Epub', () => {
   });
 
   it('write epub', async () => {
-    const epub = new Epubook();
-
-    const opf = epub.mainPackageDocument();
-    opf.setIdentifier('test-book-id', 'BookId');
-    opf.update({
+    const epub = new Epubook({
       title: 'Test Book',
       date: new Date('2023-02-01T11:00:00.000Z'),
       lastModified: new Date('2023-02-26T11:00:00.000Z'),
@@ -76,6 +72,9 @@ describe('Bundle Epub', () => {
       source: 'imagine'
     });
 
+    const opf = epub.main();
+    opf.setIdentifier('test-book-id', 'BookId');
+
     const content = `<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en">
   <head>
     <title>Data URL does not open in top-level context</title>

diff --git a/packages/epubook/README.md b/packages/epubook/README.md
@@ -6,6 +6,18 @@ It will support the generation of the [latest epub standard](https://www.w3.org/
 
 > 👷‍♂️ Still work in progress.
 
+## Installation
+
+```bash
+npm i -g epubook
+```
+
+## Resources
+
++ [EPUB 3.2 specification](https://www.w3.org/publishing/epub32/)
++ [EPUB 3.3 specification](https://www.w3.org/TR/epub-33/)
++ [EbookLib](https://github.com/aerkalov/ebooklib)
+
 ## License
 
 MIT License © 2023 [XLor](https://github.com/yjl9903)
diff --git a/packages/epubook/build.config.ts b/packages/epubook/build.config.ts
@@ -1,12 +1,10 @@
-import { defineBuildConfig } from 'unbuild'
+import { defineBuildConfig } from 'unbuild';
 
 export default defineBuildConfig({
-  entries: [
-    'src/index',
-  ],
+  entries: ['src/index', 'src/cli.ts'],
   declaration: true,
   clean: true,
   rollup: {
-    emitCJS: true,
-  },
-});
+    emitCJS: true
+  }
+});
diff --git a/packages/epubook/epubook.mjs b/packages/epubook/epubook.mjs
@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import('./dist/cli.mjs');
diff --git a/packages/epubook/package.json b/packages/epubook/package.json
@@ -14,6 +14,7 @@
   "license": "MIT",
   "author": "XLor",
   "sideEffects": false,
+  "type": "module",
   "exports": {
     ".": {
       "require": "./dist/index.cjs",
@@ -24,7 +25,11 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "bin": {
+    "epubook": "epubook.mjs"
+  },
   "files": [
+    "*.mjs",
     "dist"
   ],
   "scripts": {
@@ -35,7 +40,8 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@epubook/core": "workspace:*"
+    "@epubook/core": "workspace:*",
+    "breadc": "^0.8.8"
   },
   "devDependencies": {
     "vitest": "^0.29.1"

diff --git a/packages/epubook/src/cli.ts b/packages/epubook/src/cli.ts
@@ -0,0 +1,12 @@
+import { breadc } from 'breadc';
+
+import { version } from '../package.json';
+
+const cli = breadc('epubook', {
+  version,
+  description: 'Generate EPUB books'
+});
+
+cli.command('').action(() => {});
+
+cli.run(process.argv.slice(2)).catch((err) => console.error(err));
diff --git a/packages/epubook/src/index.ts b/packages/epubook/src/index.ts
@@ -1,3 +1 @@
-export function hello() {
-  return 'world';
-}
+export * from '@epubook/core';
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml