@likecoin/epub-ts 0.4.4 → 0.4.6

package/README.md

@@ -49,6 +49,30 @@ fileInput.addEventListener("change", async (event) => {
 });
 ```
 
+### Node.js (parsing only)
+
+Parse EPUB metadata, spine, navigation, and section content without a browser. Requires [`linkedom`](https://github.com/WebReflection/linkedom) as a peer dependency.
+
+```bash
+npm install linkedom
+```
+
+```typescript
+import { Book } from "@likecoin/epub-ts/node";
+import { readFileSync } from "node:fs";
+
+const data = readFileSync("book.epub");
+const arrayBuffer = data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength);
+const book = new Book(arrayBuffer);
+await book.opened;
+
+console.log(book.packaging.metadata.title);
+console.log(book.navigation.toc.map(item => item.label));
+
+const section = book.spine.first();
+const html = await section.render(book.archive.request.bind(book.archive));
+```
+
 ## Migration from epubjs
 
 Drop-in replacement. Change your import:
@@ -102,12 +126,11 @@ Key classes:
 
 ## Supported Environments
 
-| Environment | Notes |
-|-------------|-------|
-| Modern browsers | Chrome, Firefox, Safari, Edge (requires DOM) |
-| Vite / webpack | ESM or CJS imports |
-
-> **Note**: This library requires a DOM environment. Node.js support (parsing-only, no rendering) is planned but not yet available.
+| Environment | Import | Notes |
+|-------------|--------|-------|
+| Modern browsers | `@likecoin/epub-ts` | Chrome, Firefox, Safari, Edge |
+| Vite / webpack | `@likecoin/epub-ts` | ESM or CJS |
+| Node.js 18+ | `@likecoin/epub-ts/node` | Parsing only (no rendering); requires `linkedom` peer dep |
 
 ## What's Changed from epubjs
 
@@ -118,6 +141,7 @@ Key classes:
 - Replaced `event-emitter` with inline typed emitter
 - Replaced `localforage` with native IndexedDB wrapper
 - Replaced `@xmldom/xmldom` with native DOMParser/XMLSerializer
+- Added Node.js parsing-only entry point (`@likecoin/epub-ts/node`) with `linkedom`
 - Dropped IE8–IE11 support
 
 ## Development

package/dist/annotations.d.ts

@@ -2,12 +2,12 @@ import { IEventEmitter } from './types';
 import { default as Rendition } from './rendition';
 interface AnnotationView {
     index: number;
-    highlight: Function;
-    underline: Function;
-    mark: Function;
-    unhighlight: Function;
-    ununderline: Function;
-    unmark: Function;
+    highlight: (cfiRange: string, data?: Record<string, string>, cb?: EventListener, className?: string, styles?: Record<string, string>) => object | undefined;
+    underline: (cfiRange: string, data?: Record<string, string>, cb?: EventListener, className?: string, styles?: Record<string, string>) => object | undefined;
+    mark: (cfiRange: string, data?: Record<string, string>, cb?: EventListener) => object | null | undefined;
+    unhighlight: (cfiRange: string) => void;
+    ununderline: (cfiRange: string) => void;
+    unmark: (cfiRange: string) => void;
 }
 /**
     * Handles managing adding & removing Annotations
@@ -32,7 +32,7 @@ declare class Annotations {
      * @param {object} styles CSS styles to assign to annotation
      * @returns {Annotation} annotation
      */
-    add(type: string, cfiRange: string, data?: Record<string, any>, cb?: Function, className?: string, styles?: Record<string, string>): Annotation;
+    add(type: string, cfiRange: string, data?: Record<string, any>, cb?: EventListener, className?: string, styles?: Record<string, string>): Annotation;
     /**
      * Remove an annotation from store
      * @param {EpubCFI} cfiRange EpubCFI range the annotation is attached to
@@ -57,7 +57,7 @@ declare class Annotations {
      * @param {string} className CSS class to assign to annotation
      * @param {object} styles CSS styles to assign to annotation
      */
-    highlight(cfiRange: string, data?: Record<string, any>, cb?: Function, className?: string, styles?: Record<string, string>): Annotation;
+    highlight(cfiRange: string, data?: Record<string, any>, cb?: EventListener, className?: string, styles?: Record<string, string>): Annotation;
     /**
      * Add a underline to the store
      * @param {EpubCFI} cfiRange EpubCFI range to attach annotation to
@@ -66,14 +66,14 @@ declare class Annotations {
      * @param {string} className CSS class to assign to annotation
      * @param {object} styles CSS styles to assign to annotation
      */
-    underline(cfiRange: string, data?: Record<string, any>, cb?: Function, className?: string, styles?: Record<string, string>): Annotation;
+    underline(cfiRange: string, data?: Record<string, any>, cb?: EventListener, className?: string, styles?: Record<string, string>): Annotation;
     /**
      * Add a mark to the store
      * @param {EpubCFI} cfiRange EpubCFI range to attach annotation to
      * @param {object} data Data to assign to annotation
      * @param {function} cb Callback after annotation is clicked
      */
-    mark(cfiRange: string, data?: Record<string, any>, cb?: Function): Annotation;
+    mark(cfiRange: string, data?: Record<string, any>, cb?: EventListener): Annotation;
     /**
      * iterate over annotations in the store
      */
@@ -114,24 +114,28 @@ declare class Annotations {
  * @param {object} styles CSS styles to assign to annotation
  * @returns {Annotation} annotation
  */
-declare class Annotation implements IEventEmitter {
+export interface AnnotationEvents extends Record<string, any[]> {
+    "attach": [object | null | undefined];
+    "detach": [];
+}
+declare class Annotation implements IEventEmitter<AnnotationEvents> {
     type: string;
     cfiRange: string;
     data: Record<string, any>;
     sectionIndex: number;
-    mark: object | undefined;
-    cb: Function;
+    mark: object | null | undefined;
+    cb: EventListener;
     className: string;
     styles: Record<string, string>;
-    on: IEventEmitter["on"];
-    off: IEventEmitter["off"];
-    emit: IEventEmitter["emit"];
+    on: IEventEmitter<AnnotationEvents>["on"];
+    off: IEventEmitter<AnnotationEvents>["off"];
+    emit: IEventEmitter<AnnotationEvents>["emit"];
     constructor({ type, cfiRange, data, sectionIndex, cb, className, styles }: {
         type: string;
         cfiRange: string;
         data?: Record<string, any>;
         sectionIndex?: number;
-        cb?: Function;
+        cb?: EventListener;
         className?: string;
         styles?: Record<string, string>;
     });
@@ -144,12 +148,12 @@ declare class Annotation implements IEventEmitter {
      * Add to a view
      * @param {View} view
      */
-    attach(view: AnnotationView): object | undefined;
+    attach(view: AnnotationView): object | null | undefined;
     /**
      * Remove from a view
      * @param {View} view
      */
-    detach(view: AnnotationView): object | undefined;
+    detach(view: AnnotationView): void;
     /**
      * [Not Implemented] Get text of an annotation
      * @TODO: needs implementation in contents

package/dist/book.d.ts

@@ -35,6 +35,9 @@ interface BookLoadedState {
     resources: Promise<Resources>;
     displayOptions: Promise<DisplayOptions>;
 }
+export interface BookEvents extends Record<string, any[]> {
+    "openFailed": [Error];
+}
 /**
  * An Epub representation with methods for the loading, parsing and manipulation
  * of its contents.
@@ -53,35 +56,35 @@ interface BookLoadedState {
  * @example new Book("/path/to/book.epub", {})
  * @example new Book({ replacements: "blobUrl" })
  */
-declare class Book implements IEventEmitter {
+declare class Book implements IEventEmitter<BookEvents> {
     settings: BookOptions;
     opening: defer<Book>;
-    opened: Promise<Book> | undefined;
+    opened: Promise<Book>;
     isOpen: boolean;
-    loading: BookLoadingState | undefined;
-    loaded: BookLoadedState | undefined;
-    ready: Promise<[PackagingManifestObject, Spine, PackagingMetadataObject, string, Navigation, Resources, DisplayOptions]> | undefined;
+    loading: BookLoadingState;
+    loaded: BookLoadedState;
+    ready: Promise<[PackagingManifestObject, Spine, PackagingMetadataObject, string, Navigation, Resources, DisplayOptions]>;
     isRendered: boolean;
     request: RequestFunction;
-    spine: Spine | undefined;
-    locations: Locations | undefined;
-    navigation: Navigation | undefined;
-    pageList: PageList | undefined;
-    url: Url | undefined;
+    spine: Spine;
+    locations: Locations;
+    navigation: Navigation;
+    pageList: PageList;
+    url: Url;
     path: Path | undefined;
     archived: boolean;
     archive: Archive | undefined;
     storage: Store | undefined;
-    resources: Resources | undefined;
+    resources: Resources;
     rendition: Rendition | undefined;
     container: Container | undefined;
-    packaging: Packaging | undefined;
+    packaging: Packaging;
     displayOptions: DisplayOptions | undefined;
     package: Packaging | undefined;
     cover: string;
-    on: IEventEmitter["on"];
-    off: IEventEmitter["off"];
-    emit: IEventEmitter["emit"];
+    on: IEventEmitter<BookEvents>["on"];
+    off: IEventEmitter<BookEvents>["off"];
+    emit: IEventEmitter<BookEvents>["emit"];
     constructor(url?: string | ArrayBuffer | Blob | BookOptions, options?: BookOptions);
     /**
      * Open a epub or url

package/dist/contents.d.ts

@@ -10,11 +10,22 @@ import { default as Section } from './section';
     * @param {string} cfiBase Section component of CFIs
     * @param {number} sectionIndex Index in Spine of Conntent's Section
     */
-declare class Contents implements IEventEmitter {
-    on: (type: string, fn: (...args: any[]) => void) => this;
-    off: (type: string, fn?: (...args: any[]) => void) => this;
-    emit: (type: string, ...args: unknown[]) => void;
-    __listeners: IEventEmitter["__listeners"];
+export interface ContentsEvents {
+    "expand": [];
+    "resize": [{
+        width: number;
+        height: number;
+    }];
+    "selected": [string];
+    "selectedRange": [Range];
+    "linkClicked": [string];
+    [event: string]: any[];
+}
+declare class Contents implements IEventEmitter<ContentsEvents> {
+    on: IEventEmitter<ContentsEvents>["on"];
+    off: IEventEmitter<ContentsEvents>["off"];
+    emit: IEventEmitter<ContentsEvents>["emit"];
+    __listeners: IEventEmitter<ContentsEvents>["__listeners"];
     epubcfi: EpubCFI;
     document: Document;
     documentElement: HTMLElement;