@likecoin/epub-ts 0.4.5 → 0.4.7

package/dist/index.d.ts

@@ -20,3 +20,13 @@ import { default as ePub } from './epub';
 export default ePub;
 export { Book, EpubCFI, Rendition, Contents, Layout, Section, Spine, Locations, Navigation, PageList, Resources, Packaging, Archive, Store, DisplayOptions, Annotations, Themes, Mapping, };
 export * from './types';
+export type { BookEvents } from './book';
+export type { RenditionEvents } from './rendition';
+export type { AnnotationEvents } from './annotations';
+export type { LocationsEvents } from './locations';
+export type { LayoutEvents } from './layout';
+export type { ContentsEvents } from './contents';
+export type { StoreEvents } from './store';
+export type { DefaultManagerEvents } from './managers/default/index';
+export type { IframeViewEvents } from './managers/views/iframe';
+export type { InlineViewEvents } from './managers/views/inline';

package/dist/layout.d.ts

@@ -10,10 +10,13 @@ import { default as Section } from './section';
  * @param {number} [settings.minSpreadWidth=800]
  * @param {boolean} [settings.evenSpreads=false]
  */
-declare class Layout implements IEventEmitter {
-    on: (type: string, fn: (...args: any[]) => void) => this;
-    off: (type: string, fn?: (...args: any[]) => void) => this;
-    emit: (type: string, ...args: unknown[]) => void;
+export interface LayoutEvents extends Record<string, any[]> {
+    "updated": [LayoutProps, Partial<LayoutProps>];
+}
+declare class Layout implements IEventEmitter<LayoutEvents> {
+    on: IEventEmitter<LayoutEvents>["on"];
+    off: IEventEmitter<LayoutEvents>["off"];
+    emit: IEventEmitter<LayoutEvents>["emit"];
     settings: LayoutSettings;
     name: string;
     _spread: boolean;

package/dist/locations.d.ts

@@ -9,10 +9,15 @@ import { default as Section } from './section';
  * @param {request} request
  * @param {number} [pause=100]
  */
-declare class Locations implements IEventEmitter {
-    on: (type: string, fn: (...args: any[]) => void) => this;
-    off: (type: string, fn?: (...args: any[]) => void) => this;
-    emit: (type: string, ...args: unknown[]) => void;
+export interface LocationsEvents extends Record<string, any[]> {
+    "changed": [{
+        percentage: number;
+    }];
+}
+declare class Locations implements IEventEmitter<LocationsEvents> {
+    on: IEventEmitter<LocationsEvents>["on"];
+    off: IEventEmitter<LocationsEvents>["off"];
+    emit: IEventEmitter<LocationsEvents>["emit"];
     spine: Spine | undefined;
     request: RequestFunction | undefined;
     pause: number | undefined;

package/dist/managers/default/index.d.ts

@@ -7,7 +7,25 @@ import { default as Section } from '../../section';
 import { default as Contents } from '../../contents';
 import { default as IframeView } from '../views/iframe';
 import { IEventEmitter, ManagerOptions, ViewSettings, ViewLocation, RequestFunction, SizeObject, ReframeBounds, LayoutProps } from '../../types';
-declare class DefaultViewManager implements IEventEmitter {
+export interface DefaultManagerEvents extends Record<string, any[]> {
+    "resize": [Section];
+    "resized": [{
+        width: number;
+        height: number;
+    }, string?];
+    "orientationchange": [number];
+    "added": [IframeView];
+    "scroll": [{
+        top: number;
+        left: number;
+    }];
+    "scrolled": [{
+        top: number;
+        left: number;
+    }];
+    "removed": [IframeView];
+}
+declare class DefaultViewManager implements IEventEmitter<DefaultManagerEvents> {
     name: string;
     optsSettings: ManagerOptions["settings"];
     View: new (section: Section, options?: ViewSettings) => IframeView;
@@ -54,10 +72,10 @@ declare class DefaultViewManager implements IEventEmitter {
         width: number;
         height: number;
     };
-    on: IEventEmitter["on"];
-    off: IEventEmitter["off"];
-    emit: IEventEmitter["emit"];
-    __listeners: IEventEmitter["__listeners"];
+    on: IEventEmitter<DefaultManagerEvents>["on"];
+    off: IEventEmitter<DefaultManagerEvents>["off"];
+    emit: IEventEmitter<DefaultManagerEvents>["emit"];
+    __listeners: IEventEmitter<DefaultManagerEvents>["__listeners"];
     constructor(options: ManagerOptions);
     render(element: HTMLElement, size: SizeObject): void;
     addEventListeners(): void;

package/dist/managers/helpers/snap.d.ts

@@ -2,7 +2,8 @@ import { IEventEmitter } from '../../types';
 import { default as DefaultViewManager } from '../default/index';
 import { default as Contents } from '../../contents';
 import { default as Layout } from '../../layout';
-declare class Snap implements IEventEmitter {
+import { default as IframeView } from '../views/iframe';
+declare class Snap implements IEventEmitter<Record<string, any[]>> {
     settings: {
         duration: number;
         minVelocity: number;
@@ -32,12 +33,10 @@ declare class Snap implements IEventEmitter {
     _onTouchStart: ((e: TouchEvent) => void) | undefined;
     _onTouchMove: ((e: TouchEvent) => void) | undefined;
     _onTouchEnd: ((e?: TouchEvent) => void) | undefined;
-    _afterDisplayed: ((view: {
-        contents: Contents;
-    }) => void) | undefined;
-    on: IEventEmitter["on"];
-    off: IEventEmitter["off"];
-    emit: IEventEmitter["emit"];
+    _afterDisplayed: ((view: IframeView) => void) | undefined;
+    on: IEventEmitter<Record<string, any[]>>["on"];
+    off: IEventEmitter<Record<string, any[]>>["off"];
+    emit: IEventEmitter<Record<string, any[]>>["emit"];
     constructor(manager: DefaultViewManager, options?: Record<string, unknown>);
     setup(manager: DefaultViewManager): void;
     supportsTouch(): boolean;
@@ -45,9 +44,7 @@ declare class Snap implements IEventEmitter {
     enableScroll(): void;
     addListeners(): void;
     removeListeners(): void;
-    afterDisplayed(view: {
-        contents: Contents;
-    }): void;
+    afterDisplayed(view: IframeView): void;
     triggerViewEvent(e: TouchEvent, contents: Contents): void;
     onScroll(_e?: Event): void;
     onResize(_e?: Event): void;

package/dist/managers/views/iframe.d.ts

@@ -4,7 +4,18 @@ import { Pane, Mark } from '../../marks-pane';
 import { IEventEmitter, ViewSettings, ReframeBounds, RequestFunction } from '../../types';
 import { default as Section } from '../../section';
 import { default as Layout } from '../../layout';
-declare class IframeView implements IEventEmitter {
+export interface IframeViewEvents extends Record<string, any[]> {
+    "axis": [string];
+    "writingMode": [string];
+    "loaderror": [unknown];
+    "rendered": [Section];
+    "resized": [ReframeBounds];
+    "displayed": [IframeView];
+    "shown": [IframeView];
+    "hidden": [IframeView];
+    "markClicked": [string, object | undefined];
+}
+declare class IframeView implements IEventEmitter<IframeViewEvents> {
     settings: ViewSettings;
     id: string;
     section: Section;
@@ -61,10 +72,10 @@ declare class IframeView implements IEventEmitter {
     stopExpanding: boolean;
     axis: string;
     expanded?: boolean;
-    on: IEventEmitter["on"];
-    off: IEventEmitter["off"];
-    emit: IEventEmitter["emit"];
-    __listeners: IEventEmitter["__listeners"];
+    on: IEventEmitter<IframeViewEvents>["on"];
+    off: IEventEmitter<IframeViewEvents>["off"];
+    emit: IEventEmitter<IframeViewEvents>["emit"];
+    __listeners: IEventEmitter<IframeViewEvents>["__listeners"];
     constructor(section: Section, options?: ViewSettings);
     container(axis?: string): HTMLElement;
     create(): HTMLIFrameElement;

package/dist/managers/views/inline.d.ts

@@ -3,7 +3,18 @@ import { default as Contents } from '../../contents';
 import { default as Section } from '../../section';
 import { default as Layout } from '../../layout';
 import { IEventEmitter, ViewSettings, RequestFunction, SizeObject, ReframeBounds } from '../../types';
-declare class InlineView implements IEventEmitter {
+export interface InlineViewEvents extends Record<string, any[]> {
+    "loaderror": [unknown];
+    "rendered": [Section];
+    "resized": [{
+        width: number;
+        height: number;
+    }];
+    "displayed": [InlineView];
+    "shown": [InlineView];
+    "hidden": [InlineView];
+}
+declare class InlineView implements IEventEmitter<InlineViewEvents> {
     settings: ViewSettings & {
         layout: Layout;
     };
@@ -37,9 +48,9 @@ declare class InlineView implements IEventEmitter {
     contents: Contents | undefined;
     rendering: boolean;
     stopExpanding: boolean;
-    on: IEventEmitter["on"];
-    off: IEventEmitter["off"];
-    emit: IEventEmitter["emit"];
+    on: IEventEmitter<InlineViewEvents>["on"];
+    off: IEventEmitter<InlineViewEvents>["off"];
+    emit: IEventEmitter<InlineViewEvents>["emit"];
     constructor(section: Section, options?: ViewSettings);
     container(axis?: string): HTMLElement;
     create(): HTMLDivElement;

package/dist/node.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Node.js parsing-only entry point for epub.ts.
+ *
+ * Requires `linkedom` as a peer dependency to provide DOMParser
+ * and document globals that the parsing chain needs.
+ *
+ * Usage:
+ *   import { Book } from "@likecoin/epub-ts/node";
+ *   const book = new Book(buffer);
+ *   await book.opened;
+ */
+export { default as Book } from './book';
+export { default as EpubCFI } from './epubcfi';
+export { default as Container } from './container';
+export { default as Packaging } from './packaging';
+export { default as Navigation } from './navigation';
+export { default as Spine } from './spine';
+export { default as Locations } from './locations';
+export { default as Section } from './section';
+export { default as Archive } from './archive';
+export { default as PageList } from './pagelist';
+export { default as Resources } from './resources';
+export { default as DisplayOptions } from './displayoptions';
+export { default as Layout } from './layout';
+export * from './types';

package/dist/rendition.d.ts

@@ -6,7 +6,7 @@ import { default as Layout } from './layout';
 import { default as Themes } from './themes';
 import { default as Contents } from './contents';
 import { default as Annotations } from './annotations';
-import { IEventEmitter, RenditionOptions, Location, GlobalLayout, ViewLocation, SizeObject, PackagingMetadataObject, ViewManagerConstructor, ViewConstructor } from './types';
+import { IEventEmitter, RenditionOptions, Location, GlobalLayout, ViewLocation, SizeObject, PackagingMetadataObject, LayoutProps, ViewManagerConstructor, ViewConstructor } from './types';
 import { default as Book } from './book';
 import { default as Section } from './section';
 import { default as IframeView } from './managers/views/iframe';
@@ -35,6 +35,30 @@ import { default as DefaultViewManager } from './managers/default/index';
  * @param {boolean} [options.allowScriptedContent=false] enable running scripts in content
  * @param {boolean} [options.allowPopups=false] enable opening popup in content
  */
+export interface RenditionEvents extends Record<string, any[]> {
+    "started": [];
+    "attached": [];
+    "displayed": [Section | undefined];
+    "displayerror": [Error];
+    "rendered": [Section, IframeView];
+    "removed": [Section, IframeView];
+    "resized": [{
+        width: number;
+        height: number;
+    }, string?];
+    "orientationchange": [number];
+    "locationChanged": [{
+        index: number;
+        href: string;
+        start: string;
+        end: string;
+        percentage: number | undefined;
+    }];
+    "relocated": [Location];
+    "markClicked": [string, object | undefined, Contents];
+    "selected": [string, Contents];
+    "layout": [LayoutProps, Partial<LayoutProps>];
+}
 interface RenditionHooks {
     display: Hook;
     serialize: Hook;
@@ -44,7 +68,7 @@ interface RenditionHooks {
     render: Hook;
     show: Hook;
 }
-declare class Rendition implements IEventEmitter {
+declare class Rendition implements IEventEmitter<RenditionEvents> {
     settings: RenditionOptions;
     book: Book;
     hooks: RenditionHooks;
@@ -55,14 +79,14 @@ declare class Rendition implements IEventEmitter {
     location: Location | undefined;
     starting: defer<void>;
     started: Promise<void>;
-    manager: DefaultViewManager | undefined;
+    manager: DefaultViewManager;
     ViewManager: ViewManagerConstructor;
     View: ViewConstructor;
     _layout: Layout | undefined;
     displaying: defer<Section | undefined> | undefined;
-    on: IEventEmitter["on"];
-    off: IEventEmitter["off"];
-    emit: IEventEmitter["emit"];
+    on: IEventEmitter<RenditionEvents>["on"];
+    off: IEventEmitter<RenditionEvents>["off"];
+    emit: IEventEmitter<RenditionEvents>["emit"];
     constructor(book: Book, options?: RenditionOptions);
     /**
      * Set the manager function
@@ -130,7 +154,7 @@ declare class Rendition implements IEventEmitter {
      * Report orientation events and display the last seen location
      * @private
      */
-    onOrientationChange(orientation: string): void;
+    onOrientationChange(orientation: number): void;
     /**
      * Move the Rendition to a specific offset
      * Usually you would be better off calling display()
@@ -234,7 +258,7 @@ declare class Rendition implements IEventEmitter {
      * @private
      * @param  {EpubCFI} cfirange
      */
-    triggerMarkEvent(cfiRange: string, data: object, contents: Contents): void;
+    triggerMarkEvent(cfiRange: string, data: object | undefined, contents: Contents): void;
     /**
      * Get a Range from a Visible CFI
      * @param  {string} cfi EpubCfi String

package/dist/resources.d.ts

@@ -15,15 +15,15 @@ declare class Resources {
         archive: Archive;
         resolver: (href: string, absolute?: boolean) => string;
         request: RequestFunction;
-    } | undefined;
-    manifest: PackagingManifestObject | undefined;
-    resources: PackagingManifestItem[] | undefined;
-    replacementUrls: string[] | undefined;
-    html: PackagingManifestItem[] | undefined;
-    assets: PackagingManifestItem[] | undefined;
-    css: PackagingManifestItem[] | undefined;
-    urls: string[] | undefined;
-    cssUrls: string[] | undefined;
+    };
+    manifest: PackagingManifestObject;
+    resources: PackagingManifestItem[];
+    replacementUrls: string[];
+    html: PackagingManifestItem[];
+    assets: PackagingManifestItem[];
+    css: PackagingManifestItem[];
+    urls: string[];
+    cssUrls: string[];
     constructor(manifest: PackagingManifestObject, options?: {
         replacements?: string;
         archive?: Archive;

package/dist/store.d.ts

@@ -10,10 +10,14 @@ interface SimpleStorage {
  * @param {function} [requester]
  * @param {function} [resolver]
  */
-declare class Store implements IEventEmitter {
-    on: (type: string, fn: (...args: any[]) => void) => this;
-    off: (type: string, fn?: (...args: any[]) => void) => this;
-    emit: (type: string, ...args: unknown[]) => void;
+export interface StoreEvents extends Record<string, any[]> {
+    "online": [Store];
+    "offline": [Store];
+}
+declare class Store implements IEventEmitter<StoreEvents> {
+    on: IEventEmitter<StoreEvents>["on"];
+    off: IEventEmitter<StoreEvents>["off"];
+    emit: IEventEmitter<StoreEvents>["emit"];
     urlCache: Record<string, string>;
     storage: SimpleStorage;
     name: string;

package/dist/types.d.ts

@@ -6,10 +6,11 @@ export interface Deferred<T = unknown> {
     reject: (reason?: unknown) => void;
     promise: Promise<T>;
 }
-export interface IEventEmitter {
-    on(type: string, fn: (...args: any[]) => void): unknown;
-    off(type: string, fn?: (...args: any[]) => void): unknown;
-    emit(type: string, ...args: unknown[]): void;
+export type EventMap = Record<string, any[]>;
+export interface IEventEmitter<E extends EventMap = Record<string, any[]>> {
+    on<K extends keyof E & string>(type: K, fn: (...args: E[K]) => void): void;
+    off<K extends keyof E & string>(type: K, fn?: (...args: E[K]) => void): void;
+    emit<K extends keyof E & string>(type: K, ...args: E[K]): void;
     __listeners?: Record<string, Array<(...args: any[]) => void>>;
 }
 export interface PackagingMetadataObject {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@likecoin/epub-ts",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "description": "TypeScript EPUB parser and renderer, forked from epubjs",
   "keywords": [
     "epub",
@@ -20,15 +20,23 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/epub.js",
       "require": "./dist/epub.cjs"
+    },
+    "./node": {
+      "types": "./dist/node.d.ts",
+      "import": "./dist/epub.node.js",
+      "require": "./dist/epub.node.cjs"
     }
   },
-  "sideEffects": false,
+  "sideEffects": [
+    "dist/epub.node.js",
+    "dist/epub.node.cjs"
+  ],
   "files": [
     "dist"
   ],
   "repository": "https://github.com/likecoin/epub.ts",
   "scripts": {
-    "build": "vite build",
+    "build": "vite build && vite build --config vite.config.node.ts",
     "test": "vitest run",
     "test:watch": "vitest",
     "typecheck": "tsc --noEmit",
@@ -49,7 +57,9 @@
   "devDependencies": {
     "@eslint/js": "^9.39.2",
     "eslint": "^9.39.2",
+    "fake-indexeddb": "^6.2.5",
     "jsdom": "^28.0.0",
+    "linkedom": "^0.18.0",
     "typedoc": "^0.28.16",
     "typedoc-plugin-markdown": "^4.10.0",
     "typescript": "^5.7.3",
@@ -58,6 +68,14 @@
     "vite-plugin-dts": "^4.5.4",
     "vitest": "^3.0.5"
   },
+  "peerDependencies": {
+    "linkedom": ">=0.16.0"
+  },
+  "peerDependenciesMeta": {
+    "linkedom": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "jszip": "^3.10.1"
   }