@epubook/core 0.0.4 → 0.0.5

package/README.md

@@ -1,8 +1,8 @@
 # @epubook/core
 
-The fundamental module of [epubook](https://github.com/yjl9903/epubook) for generating EPUB books.
+[![version](https://img.shields.io/npm/v/@epubook/core?color=rgb%2850%2C203%2C86%29&label=@epubook/core)](https://www.npmjs.com/package/@epubook/theme-core) [![CI](https://github.com/yjl9903/epubook/actions/workflows/ci.yml/badge.svg)](https://github.com/yjl9903/epubook/actions/workflows/ci.yml)
 
-> 👷‍♂️ Still work in progress.
+The fundamental module of [epubook](https://github.com/yjl9903/epubook). It provides low-level API for generating EPUB books.
 
 ## Installation
 

package/dist/index.cjs

@@ -242,6 +242,7 @@ class XHTMLBuilder {
     };
     this._head = [];
     this._body = [];
+    this._bodyAttrs = {};
     this._filename = filename;
     this._meta.title = path__namespace$1.basename(filename);
   }
@@ -287,6 +288,14 @@ class XHTMLBuilder {
     this._body.push(...node);
     return this;
   }
+  bodyAttrs(attrs = {}) {
+    const a = Object.entries(attrs).map(([key, value]) => [`@_${key}`, value]);
+    this._bodyAttrs = {
+      ...this._bodyAttrs,
+      ...Object.fromEntries(a)
+    };
+    return this;
+  }
   build() {
     const content = builder.build({
       html: {
@@ -298,7 +307,10 @@ class XHTMLBuilder {
           title: this._meta.title,
           ...list(this._head)
         },
-        body: list(this._body)
+        body: {
+          ...this._bodyAttrs,
+          ...list(this._body)
+        }
       }
     });
     return new XHTML(this._filename, this._meta, content);

package/dist/index.d.ts

@@ -1,266 +1,268 @@
 import { Plugin } from 'rollup';
 import { BuildConfig } from 'unbuild';
 
-declare const MIMETYPE = "application/epub+zip";
-declare const ImageGif = "image/gif";
-declare const ImageJpeg = "image/jpeg";
-declare const ImagePng = "image/png";
-declare const ImageSvg = "image/svg+xml";
-declare const ImageWebp = "image/webp";
-type ImageMediaType = typeof ImageGif | typeof ImageJpeg | typeof ImagePng | typeof ImageSvg | typeof ImageWebp;
-type ImageExtension = 'gif' | 'jpg' | 'jpeg' | 'png' | 'svg' | 'webp';
-declare const TextCSS = "text/css";
-declare const TextXHTML = "application/xhtml+xml";
-type MediaType = ImageMediaType | typeof TextCSS | typeof TextXHTML;
+declare const MIMETYPE = "application/epub+zip";
+declare const ImageGif = "image/gif";
+declare const ImageJpeg = "image/jpeg";
+declare const ImagePng = "image/png";
+declare const ImageSvg = "image/svg+xml";
+declare const ImageWebp = "image/webp";
+type ImageMediaType = typeof ImageGif | typeof ImageJpeg | typeof ImagePng | typeof ImageSvg | typeof ImageWebp;
+type ImageExtension = 'gif' | 'jpg' | 'jpeg' | 'png' | 'svg' | 'webp';
+declare const TextCSS = "text/css";
+declare const TextXHTML = "application/xhtml+xml";
+type MediaType = ImageMediaType | typeof TextCSS | typeof TextXHTML;
 declare function getImageMediaType(file: string): ImageMediaType | undefined;
 
-declare class ManifestItem {
-    private _href;
-    private _id;
-    private optional;
-    constructor(href: string, id: string);
-    update(info: typeof this$1.optional): this;
-    href(): string;
-    id(): string;
-    fallback(): string | undefined;
-    mediaOverlay(): string | undefined;
-    mediaType(): MediaType | undefined;
-    properties(): string | undefined;
-    ref(): ManifestItemRef;
-}
-declare class ManifestItemRef {
-    private _idref;
-    private optional;
-    constructor(idref: string);
-    update(info: typeof this$1.optional): this;
-    idref(): string;
-    id(): string | undefined;
-    linear(): string | undefined;
-    properties(): string | undefined;
+declare class ManifestItem {
+    private _href;
+    private _id;
+    private optional;
+    constructor(href: string, id: string);
+    update(info: typeof this$1.optional): this;
+    href(): string;
+    id(): string;
+    fallback(): string | undefined;
+    mediaOverlay(): string | undefined;
+    mediaType(): MediaType | undefined;
+    properties(): string | undefined;
+    ref(): ManifestItemRef;
+}
+declare class ManifestItemRef {
+    private _idref;
+    private optional;
+    constructor(idref: string);
+    update(info: typeof this$1.optional): this;
+    idref(): string;
+    id(): string | undefined;
+    linear(): string | undefined;
+    properties(): string | undefined;
 }
 
-declare abstract class Item {
-    private readonly file;
-    private readonly mediaType;
-    private _properties?;
-    constructor(file: string, mediaType: MediaType);
-    filename(): string;
-    relative(from: string): string;
-    update(info: Partial<{
-        properties: string;
-    }>): this;
-    id(): string;
-    manifest(): ManifestItem;
-    itemref(): ManifestItemRef;
-    abstract bundle(): Promise<Uint8Array>;
-}
-declare class Style extends Item {
-    private content;
-    constructor(file: string, content: string);
-    static read(src: string, dst: string): Promise<Style | undefined>;
-    bundle(): Promise<Uint8Array>;
-}
-declare class Image extends Item {
-    private data;
-    constructor(file: string, type: ImageMediaType, data: Uint8Array);
-    static read(file: string, src: string): Promise<Image | undefined>;
-    bundle(): Promise<Uint8Array>;
-}
-declare class HTML extends Item {
-    private content;
-    constructor(file: string, content: string);
-    static read(src: string, dst: string): Promise<HTML | undefined>;
-    bundle(): Promise<Uint8Array>;
+declare abstract class Item {
+    private readonly file;
+    private readonly mediaType;
+    private _properties?;
+    constructor(file: string, mediaType: MediaType);
+    filename(): string;
+    relative(from: string): string;
+    update(info: Partial<{
+        properties: string;
+    }>): this;
+    id(): string;
+    manifest(): ManifestItem;
+    itemref(): ManifestItemRef;
+    abstract bundle(): Promise<Uint8Array>;
+}
+declare class Style extends Item {
+    private content;
+    constructor(file: string, content: string);
+    static read(src: string, dst: string): Promise<Style | undefined>;
+    bundle(): Promise<Uint8Array>;
+}
+declare class Image extends Item {
+    private data;
+    constructor(file: string, type: ImageMediaType, data: Uint8Array);
+    static read(file: string, src: string): Promise<Image | undefined>;
+    bundle(): Promise<Uint8Array>;
+}
+declare class HTML extends Item {
+    private content;
+    constructor(file: string, content: string);
+    static read(src: string, dst: string): Promise<HTML | undefined>;
+    bundle(): Promise<Uint8Array>;
 }
 
-type Prettify<T> = {
-    [K in keyof T]: T[K];
+type Prettify<T> = {
+    [K in keyof T]: T[K];
 } & {};
 
-declare global {
-    namespace JSX {
-        interface IntrinsicElements extends EpubIntrinsicElements {
-        }
-    }
-}
-interface XHTMLNode {
-    tag: string;
-    attrs?: Record<string, string>;
-    children?: Array<string | XHTMLNode>;
-}
-interface EpubIntrinsicElements {
-    nav: {};
-    ul: {};
-    ol: {};
-    li: {};
-    h1: {};
-    h2: {};
-    h3: {};
-    h4: {};
-    h5: {};
-    h6: {};
-    p: {};
-    pre: {};
-    span: {};
-    code: {};
-    a: {
-        href: string;
-    };
+declare global {
+    namespace JSX {
+        interface IntrinsicElements extends EpubIntrinsicElements {
+        }
+    }
+}
+interface XHTMLNode {
+    tag: string;
+    attrs?: Record<string, string>;
+    children?: Array<string | XHTMLNode>;
+}
+interface EpubIntrinsicElements {
+    nav: {};
+    ul: {};
+    ol: {};
+    li: {};
+    h1: {};
+    h2: {};
+    h3: {};
+    h4: {};
+    h5: {};
+    h6: {};
+    p: {};
+    pre: {};
+    span: {};
+    code: {};
+    a: {
+        href: string;
+    };
 }
 
-declare const Fragment = "Fragment";
-declare function h(tag: string, attrs?: Record<string, string>, ...children: Array<string | XHTMLNode | Array<string | XHTMLNode>>): {
-    tag: string;
-    attrs: Record<string, string>;
-    children: (string | XHTMLNode)[];
+declare const Fragment = "Fragment";
+declare function h(tag: string, attrs?: Record<string, string>, ...children: Array<string | XHTMLNode | Array<string | XHTMLNode>>): {
+    tag: string;
+    attrs: Record<string, string>;
+    children: (string | XHTMLNode)[];
 };
 
-interface HTMLMeta {
-    language: string;
-    title: string;
-}
-declare class XHTML extends Item {
-    private _meta;
-    private _content;
-    constructor(file: string, meta: HTMLMeta, content: string);
-    meta(): HTMLMeta;
-    title(): string;
-    language(): string;
-    content(): string;
-    bundle(): Promise<Uint8Array>;
-}
-declare class XHTMLBuilder {
-    private _meta;
-    private _filename;
-    private _head;
-    private _body;
-    constructor(filename: string);
-    language(value: string): this;
-    title(value: string): this;
-    style(...list: Array<string | Style>): this;
-    head(...node: XHTMLNode[]): this;
-    body(...node: XHTMLNode[]): this;
-    build(): XHTML;
+interface HTMLMeta {
+    language: string;
+    title: string;
+}
+declare class XHTML extends Item {
+    private _meta;
+    private _content;
+    constructor(file: string, meta: HTMLMeta, content: string);
+    meta(): HTMLMeta;
+    title(): string;
+    language(): string;
+    content(): string;
+    bundle(): Promise<Uint8Array>;
+}
+declare class XHTMLBuilder {
+    private _meta;
+    private _filename;
+    private _head;
+    private _body;
+    private _bodyAttrs;
+    constructor(filename: string);
+    language(value: string): this;
+    title(value: string): this;
+    style(...list: Array<string | Style>): this;
+    head(...node: XHTMLNode[]): this;
+    body(...node: XHTMLNode[]): this;
+    bodyAttrs(attrs?: Record<string, string>): this;
+    build(): XHTML;
 }
 
-type NavItem = {
-    title: string;
-    attrs?: Record<string, string>;
-};
-type NavLink = Prettify<NavItem & {
-    page: HTML | XHTML;
-}>;
-type NavSubList = Prettify<NavItem & {
-    list: NavLink[];
-}>;
-type NavList = Array<NavLink | NavSubList>;
-interface NavOption {
-    title: string;
-    heading: 1 | 2 | 3 | 4 | 5 | 6;
-    titleAttrs: Record<string, string>;
-    builder?: XHTMLBuilder;
-}
-declare class Toc extends XHTML {
-    constructor(file: string, meta: HTMLMeta, content: string);
-    static from(xhtml: XHTML): Toc;
-    static generate(file: string, nav: NavList, { title, heading, titleAttrs, builder }?: Partial<NavOption>): XHTMLBuilder;
+type NavItem = {
+    title: string;
+    attrs?: Record<string, string>;
+};
+type NavLink = Prettify<NavItem & {
+    page: HTML | XHTML;
+}>;
+type NavSubList = Prettify<NavItem & {
+    list: NavLink[];
+}>;
+type NavList = Array<NavLink | NavSubList>;
+interface NavOption {
+    title: string;
+    heading: 1 | 2 | 3 | 4 | 5 | 6;
+    titleAttrs: Record<string, string>;
+    builder?: XHTMLBuilder;
+}
+declare class Toc extends XHTML {
+    constructor(file: string, meta: HTMLMeta, content: string);
+    static from(xhtml: XHTML): Toc;
+    static generate(file: string, nav: NavList, { title, heading, titleAttrs, builder }?: Partial<NavOption>): XHTMLBuilder;
 }
 
-interface Author {
-    name: string;
-    fileAs?: string;
-    role?: string;
-    uid?: string;
-}
-interface PackageDocumentMeta {
-    title: string;
-    language: string;
-    contributor: Author[];
-    coverage: string;
-    creator: Author;
-    date: Date;
-    description: string;
-    format: string;
-    publisher: string;
-    relation: string;
-    rights: string;
-    source: string;
-    subject: string;
-    type: string;
-    lastModified: Date;
-}
-declare class PackageDocument {
-    private readonly file;
-    private readonly SpecVersion;
-    private _uniqueIdentifier;
-    private _identifier;
-    private _metadata;
-    private _toc;
-    private _items;
-    private _spine;
-    constructor(file: string);
-    filename(): string;
-    version(): "3.0";
-    update(info: Partial<PackageDocumentMeta>): this;
-    title(): string;
-    language(): string;
-    creator(): Author;
-    metadata(): PackageDocumentMeta;
-    addItem(item: Item): this;
-    items(): Item[];
-    manifest(): ManifestItem[];
-    spine(): ManifestItemRef[];
-    setSpine(items: Item[]): this;
-    toc(): Toc | undefined;
-    setToc(nav: NavList, option?: Partial<NavOption>): this;
-    uniqueIdentifier(): string;
-    identifier(): string;
-    setIdentifier(identifier: string, uniqueIdentifier?: string): void;
+interface Author {
+    name: string;
+    fileAs?: string;
+    role?: string;
+    uid?: string;
+}
+interface PackageDocumentMeta {
+    title: string;
+    language: string;
+    contributor: Author[];
+    coverage: string;
+    creator: Author;
+    date: Date;
+    description: string;
+    format: string;
+    publisher: string;
+    relation: string;
+    rights: string;
+    source: string;
+    subject: string;
+    type: string;
+    lastModified: Date;
+}
+declare class PackageDocument {
+    private readonly file;
+    private readonly SpecVersion;
+    private _uniqueIdentifier;
+    private _identifier;
+    private _metadata;
+    private _toc;
+    private _items;
+    private _spine;
+    constructor(file: string);
+    filename(): string;
+    version(): "3.0";
+    update(info: Partial<PackageDocumentMeta>): this;
+    title(): string;
+    language(): string;
+    creator(): Author;
+    metadata(): PackageDocumentMeta;
+    addItem(item: Item): this;
+    items(): Item[];
+    manifest(): ManifestItem[];
+    spine(): ManifestItemRef[];
+    setSpine(items: Item[]): this;
+    toc(): Toc | undefined;
+    setToc(nav: NavList, option?: Partial<NavOption>): this;
+    uniqueIdentifier(): string;
+    identifier(): string;
+    setIdentifier(identifier: string, uniqueIdentifier?: string): void;
 }
 
-declare class Epub {
-    /**
-     * See: https://www.w3.org/TR/epub-33/#sec-package-doc
-     *
-     * Now, it only supports single opf (OEBPS/content.opf)
-     *
-     * @returns list of package documents
-     */
-    private opfs;
-    constructor(meta?: Partial<PackageDocumentMeta>);
-    packages(): PackageDocument[];
-    main(): PackageDocument;
-    item(...items: Item[]): this;
-    toc(nav: NavList, option?: Partial<NavOption>): this;
-    spine(...items: Item[]): this;
-    bundle(): Promise<Uint8Array>;
-    writeFile(file: string): Promise<void>;
+declare class Epub {
+    /**
+     * See: https://www.w3.org/TR/epub-33/#sec-package-doc
+     *
+     * Now, it only supports single opf (OEBPS/content.opf)
+     *
+     * @returns list of package documents
+     */
+    private opfs;
+    constructor(meta?: Partial<PackageDocumentMeta>);
+    packages(): PackageDocument[];
+    main(): PackageDocument;
+    item(...items: Item[]): this;
+    toc(nav: NavList, option?: Partial<NavOption>): this;
+    spine(...items: Item[]): this;
+    bundle(): Promise<Uint8Array>;
+    writeFile(file: string): Promise<void>;
 }
 
-declare class BundleError extends Error {
-    constructor(msg: string);
+declare class BundleError extends Error {
+    constructor(msg: string);
 }
 
-type PageTemplate<T = any> = (file: string, props: T) => XHTMLBuilder;
-interface Theme<P extends Record<string, PageTemplate<any>>> {
-    name: string;
-    styles: string[];
-    images: string[];
-    pages: Prettify<{
-        cover(file: string, props: {
-            image: Image;
-            title?: string;
-        }): XHTMLBuilder;
-        nav(file: string, props: {
-            nav: NavList;
-            option: Partial<NavOption>;
-        }): XHTMLBuilder;
-    } & P>;
+type PageTemplate<T = any> = (file: string, props: T) => XHTMLBuilder;
+interface Theme<P extends Record<string, PageTemplate<any>>> {
+    name: string;
+    styles: string[];
+    images: string[];
+    pages: Prettify<{
+        cover(file: string, props: {
+            image: Image;
+            title?: string;
+        }): XHTMLBuilder;
+        nav(file: string, props: {
+            nav: NavList;
+            option: Partial<NavOption>;
+        }): XHTMLBuilder;
+    } & P>;
 }
 
-declare const UnbuildPreset: (options?: {
-    inject?: boolean;
-}) => BuildConfig;
+declare const UnbuildPreset: (options?: {
+    inject?: boolean;
+}) => BuildConfig;
 declare function Rollup(): Plugin;
 
 export { Author, BundleError, Epub, EpubIntrinsicElements, Fragment, HTML, HTMLMeta, Image, ImageExtension, ImageGif, ImageJpeg, ImageMediaType, ImagePng, ImageSvg, ImageWebp, Item, MIMETYPE, ManifestItem, ManifestItemRef, MediaType, NavList, NavOption, PackageDocument, PackageDocumentMeta, PageTemplate, Rollup, Style, TextCSS, TextXHTML, Theme, Toc, UnbuildPreset, XHTML, XHTMLBuilder, XHTMLNode, getImageMediaType, h };

package/dist/index.mjs

@@ -226,6 +226,7 @@ class XHTMLBuilder {
     };
     this._head = [];
     this._body = [];
+    this._bodyAttrs = {};
     this._filename = filename;
     this._meta.title = path$1.basename(filename);
   }
@@ -271,6 +272,14 @@ class XHTMLBuilder {
     this._body.push(...node);
     return this;
   }
+  bodyAttrs(attrs = {}) {
+    const a = Object.entries(attrs).map(([key, value]) => [`@_${key}`, value]);
+    this._bodyAttrs = {
+      ...this._bodyAttrs,
+      ...Object.fromEntries(a)
+    };
+    return this;
+  }
   build() {
     const content = builder.build({
       html: {
@@ -282,7 +291,10 @@ class XHTMLBuilder {
           title: this._meta.title,
           ...list(this._head)
         },
-        body: list(this._body)
+        body: {
+          ...this._bodyAttrs,
+          ...list(this._body)
+        }
       }
     });
     return new XHTML(this._filename, this._meta, content);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epubook/core",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "",
   "keywords": [
     "ebook",