@epubook/core 0.0.10 → 0.0.12-beta.1

package/README.md

@@ -1,6 +1,6 @@
 # @epubook/core
 
-[![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)
+[![version](https://img.shields.io/npm/v/@epubook/core?color=rgb%2850%2C203%2C86%29&label=@epubook/core)](https://www.npmjs.com/package/@epubook/core) [![CI](https://github.com/yjl9903/epubook/actions/workflows/ci.yml/badge.svg)](https://github.com/yjl9903/epubook/actions/workflows/ci.yml)
 
 The fundamental module of [epubook](https://github.com/yjl9903/epubook). It provides low-level API for generating EPUB books.
 
@@ -36,39 +36,19 @@ await book.writeFile('./test.epub')
 You can use jsx to create XHTML node.
 
 ```tsx
-// Your theme code ...
+/** @jsxImportSource @epubook/xml */
 
 import { XHTMLBuilder } from '@epubook/core'
 
 const builder = new XHTMLBuilder()
 
-builder
-  .body(<h1>Title</h1>)
-  .body(<p>This is a paragraph</p>)
+const xhtml = builder
+  .appendBody(<h1>Title</h1>)
+  .appendBody(<p>This is a paragraph</p>)
   .build()
 ```
 
-Currently, it supports use [unbuild](https://github.com/unjs/unbuild) to transform JSX / TSX and bundle your library.
-
-```ts
-// build.config.ts
-
-import { defineBuildConfig } from 'unbuild';
-
-import { UnbuildPreset } from '@epubook/core';
-
-export default defineBuildConfig({
-  entries: ['src/index'],
-  declaration: true,
-  clean: true,
-  rollup: {
-    emitCJS: true
-  },
-  preset: UnbuildPreset()
-});
-```
-
-You can see [@epubook/theme-default](https://github.com/yjl9903/epubook/tree/main/packages/theme-default) for more details.
+You can see [@epubook/theme](https://github.com/yjl9903/epubook/tree/main/packages/theme) for more details.
 
 ## License
 

package/dist/index.d.mts

@@ -0,0 +1,235 @@
+import * as _$_epubook_xml0 from "@epubook/xml";
+import { XHTMLMeta } from "@epubook/xml";
+
+//#region src/utils/types.d.ts
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+//#endregion
+//#region src/constant.d.ts
+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;
+type Properties = 'nav' | 'cover-image' | string;
+declare function getImageMediaType(file: string): ImageMediaType | undefined;
+//#endregion
+//#region src/epub/manifest.d.ts
+declare class Manifest {
+  readonly rendition: Rendition;
+  private _resources;
+  constructor(rendition: Rendition);
+  get resources(): Resource[];
+  get items(): Item[];
+  get itemrefs(): ItemRef[];
+  add(...resources: Resource[]): this;
+  [Symbol.iterator](): ArrayIterator<Resource>;
+  map(fn: (resource: Resource, index: number, manifest: Manifest) => boolean): Resource[];
+  filter(predicate: (resource: Resource, index: number, manifest: Manifest) => boolean): Manifest;
+}
+declare class Item {
+  private _href;
+  private _id;
+  private optional;
+  constructor(href: string, id: string, info?: typeof this.optional);
+  update(info: typeof this.optional): this;
+  href(): string;
+  id(): string;
+  fallback(): string | undefined;
+  mediaOverlay(): string | undefined;
+  mediaType(): MediaType | undefined;
+  properties(): string | undefined;
+  ref(): ItemRef;
+}
+declare class ItemRef {
+  private _idref;
+  private optional;
+  constructor(idref: string);
+  update(info: typeof this.optional): this;
+  idref(): string;
+  id(): string | undefined;
+  linear(): string | undefined;
+  properties(): string | undefined;
+}
+//#endregion
+//#region src/resource/resource.d.ts
+declare abstract class Resource {
+  protected readonly _id: string;
+  protected readonly _fullPath: string;
+  protected _mediaType: MediaType;
+  protected _properties?: Properties;
+  constructor(id: string | undefined, fullPath: string, mediaType: MediaType);
+  get id(): string;
+  get path(): string;
+  relative(from: string): any;
+  updateAttrs(info: Partial<{
+    mediaType: MediaType;
+    properties: Properties;
+  }>): this;
+  item(): Item;
+  itemref(): ItemRef;
+  abstract bundle(): Promise<Uint8Array>;
+}
+declare class StyleSheet extends Resource {
+  private _content;
+  constructor(fullPath: string, content?: string, options?: {
+    id?: string;
+  });
+  update(content: string): this;
+  bundle(): Promise<Uint8Array>;
+}
+declare class Image extends Resource {
+  private _data;
+  constructor(fullPath: string, type: ImageMediaType, data?: Uint8Array | undefined, options?: {
+    id?: string;
+  });
+  update(type: ImageMediaType, data: Uint8Array): this;
+  bundle(): Promise<Uint8Array>;
+}
+declare class Cover extends Image {
+  constructor(fullPath: string, type: ImageMediaType, data?: Uint8Array | undefined, options?: {
+    id?: string;
+  });
+}
+declare class XHTML extends Resource {
+  private _meta;
+  private _content;
+  constructor(fullPath: string, meta?: Partial<XHTMLMeta>, content?: string | undefined, options?: {
+    id?: string;
+  });
+  get meta(): XHTMLMeta;
+  get title(): string;
+  get language(): string;
+  get content(): string | undefined;
+  update(text: string): this;
+  bundle(): Promise<Uint8Array>;
+}
+//#endregion
+//#region src/resource/navigation.d.ts
+type NavItem = {
+  title: string;
+  attrs?: Record<string, string>;
+};
+type NavResourceLink = Prettify<NavItem & {
+  resource: Resource;
+}>;
+type NavStaticLink = Prettify<NavItem & {
+  href: string;
+}>;
+type NavLink = NavResourceLink | NavStaticLink;
+type NavSubList = Prettify<NavItem & {
+  children: NavLink[];
+}>;
+type NavList = Array<NavLink | NavSubList>;
+interface NavOption {
+  title?: string;
+  heading?: {
+    level?: 1 | 2 | 3 | 4 | 5 | 6;
+    attrs?: Record<string, string>;
+    text?: string;
+  };
+}
+declare class Navigation extends Resource {
+  private _nav;
+  private _options;
+  constructor(fullPath?: string, nav?: NavList, options?: Partial<NavOption>);
+  update(nav: NavList, options?: Partial<NavOption>): this;
+  generate(): {
+    filename: string;
+    meta: _$_epubook_xml0.XHTMLMeta;
+    content: string;
+  };
+  bundle(): Promise<Uint8Array>;
+}
+//#endregion
+//#region src/epub/spine.d.ts
+declare class Spine {
+  readonly rendition: Rendition;
+  private _itemrefs;
+  constructor(rendition: Rendition);
+  get itemrefs(): ItemRef[];
+  shift(): ItemRef | undefined;
+  unshift(ref: ItemRef): this;
+  pop(): ItemRef | undefined;
+  push(...itemrefs: ItemRef[]): this;
+  clear(): this;
+  [Symbol.iterator](): ArrayIterator<ItemRef>;
+}
+//#endregion
+//#region src/epub/rendition.d.ts
+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 Rendition {
+  private readonly _fullPath;
+  private readonly _specVersion;
+  private _uniqueIdentifier;
+  private _identifier;
+  private _metadata;
+  private _cover;
+  private _manifest;
+  private _spine;
+  private _navigation;
+  constructor(fullPath: string);
+  get path(): string;
+  get version(): "3.0";
+  get title(): string;
+  get language(): string;
+  get creator(): Author;
+  get metadata(): PackageDocumentMeta;
+  get cover(): Cover | undefined;
+  updateMetadata(newMetadata: Partial<PackageDocumentMeta>): this;
+  get uniqueIdentifier(): string;
+  get identifier(): string;
+  setIdentifier(identifier: string, uniqueIdentifier?: string): this;
+  get manifest(): Manifest;
+  get spine(): Spine;
+  get navigation(): Navigation | undefined;
+  setNavigation(navigation: Navigation): this;
+  setCover(cover: Cover): this;
+  addResource(resource: Resource): this;
+}
+//#endregion
+//#region src/epub/publication.d.ts
+declare class EpubPublication {
+  /**
+   * 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 _rootfiles;
+  private constructor();
+  static empty(): EpubPublication;
+  static create(fullPath?: string, rootMeta?: Partial<PackageDocumentMeta>): EpubPublication;
+  get rootfile(): Rendition;
+  get rootfiles(): Rendition[];
+}
+//#endregion
+export { Author, Cover, EpubPublication, Image, ImageExtension, ImageGif, ImageJpeg, ImageMediaType, ImagePng, ImageSvg, ImageWebp, Item, ItemRef, MIMETYPE, Manifest, MediaType, NavItem, NavLink, NavList, NavOption, NavResourceLink, NavStaticLink, NavSubList, Navigation, PackageDocumentMeta, Properties, Rendition, Resource, StyleSheet, TextCSS, TextXHTML, XHTML, getImageMediaType };