@likecoin/epub-ts 0.3.93

package/dist/utils/core.d.ts

@@ -0,0 +1,337 @@
+/**
+ * Vendor prefixed requestAnimationFrame
+ * @returns {function} requestAnimationFrame
+ * @memberof Core
+ */
+export declare const requestAnimationFrame: any;
+/**
+ * Generates a UUID
+ * based on: http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript
+ * @returns {string} uuid
+ * @memberof Core
+ */
+export declare function uuid(): string;
+/**
+ * Gets the height of a document
+ * @returns {number} height
+ * @memberof Core
+ */
+export declare function documentHeight(): number;
+/**
+ * Checks if a node is an element
+ * @param {object} obj
+ * @returns {boolean}
+ * @memberof Core
+ */
+export declare function isElement(obj: unknown): boolean;
+/**
+ * @param {any} n
+ * @returns {boolean}
+ * @memberof Core
+ */
+export declare function isNumber(n: unknown): boolean;
+/**
+ * @param {any} n
+ * @returns {boolean}
+ * @memberof Core
+ */
+export declare function isFloat(n: unknown): boolean;
+/**
+ * Get a prefixed css property
+ * @param {string} unprefixed
+ * @returns {string}
+ * @memberof Core
+ */
+export declare function prefixed(unprefixed: string): string;
+/**
+ * Apply defaults to an object
+ * @param {object} obj
+ * @returns {object}
+ * @memberof Core
+ */
+export declare function defaults(obj: any, ..._sources: any[]): any;
+/**
+ * Extend properties of an object
+ * @param {object} target
+ * @returns {object}
+ * @memberof Core
+ */
+export declare function extend(target: any, ..._args: any[]): any;
+/**
+ * Fast quicksort insert for sorted array -- based on:
+ *  http://stackoverflow.com/questions/1344500/efficient-way-to-insert-a-number-into-a-sorted-array-of-numbers
+ * @param {any} item
+ * @param {array} array
+ * @param {function} [compareFunction]
+ * @returns {number} location (in array)
+ * @memberof Core
+ */
+export declare function insert(item: any, array: any[], compareFunction?: (a: any, b: any) => number): number;
+/**
+ * Finds where something would fit into a sorted array
+ * @param {any} item
+ * @param {array} array
+ * @param {function} [compareFunction]
+ * @param {function} [_start]
+ * @param {function} [_end]
+ * @returns {number} location (in array)
+ * @memberof Core
+ */
+export declare function locationOf(item: any, array: any[], compareFunction?: (a: any, b: any) => number, _start?: number, _end?: number): number;
+/**
+ * Finds index of something in a sorted array
+ * Returns -1 if not found
+ * @param {any} item
+ * @param {array} array
+ * @param {function} [compareFunction]
+ * @param {function} [_start]
+ * @param {function} [_end]
+ * @returns {number} index (in array) or -1
+ * @memberof Core
+ */
+export declare function indexOfSorted(item: any, array: any[], compareFunction?: (a: any, b: any) => number, _start?: number, _end?: number): number;
+/**
+ * Find the bounds of an element
+ * taking padding and margin into account
+ * @param {element} el
+ * @returns {{ width: Number, height: Number}}
+ * @memberof Core
+ */
+export declare function bounds(el: Element): {
+    width: number;
+    height: number;
+};
+/**
+ * Find the bounds of an element
+ * taking padding, margin and borders into account
+ * @param {element} el
+ * @returns {{ width: Number, height: Number}}
+ * @memberof Core
+ */
+export declare function borders(el: Element): {
+    width: number;
+    height: number;
+};
+/**
+ * Find the bounds of any node
+ * allows for getting bounds of text nodes by wrapping them in a range
+ * @param {node} node
+ * @returns {BoundingClientRect}
+ * @memberof Core
+ */
+export declare function nodeBounds(node: Node): DOMRect;
+/**
+ * Find the equivalent of getBoundingClientRect of a browser window
+ * @returns {{ width: Number, height: Number, top: Number, left: Number, right: Number, bottom: Number }}
+ * @memberof Core
+ */
+export declare function windowBounds(): {
+    top: number;
+    left: number;
+    right: number;
+    bottom: number;
+    width: number;
+    height: number;
+};
+/**
+ * Gets the index of a node in its parent
+ * @param {Node} node
+ * @param {string} typeId
+ * @return {number} index
+ * @memberof Core
+ */
+export declare function indexOfNode(node: Node, typeId: number): number;
+/**
+ * Gets the index of a text node in its parent
+ * @param {node} textNode
+ * @returns {number} index
+ * @memberof Core
+ */
+export declare function indexOfTextNode(textNode: Node): number;
+/**
+ * Gets the index of an element node in its parent
+ * @param {element} elementNode
+ * @returns {number} index
+ * @memberof Core
+ */
+export declare function indexOfElementNode(elementNode: Node): number;
+/**
+ * Check if extension is xml
+ * @param {string} ext
+ * @returns {boolean}
+ * @memberof Core
+ */
+export declare function isXml(ext: string): boolean;
+/**
+ * Create a new blob
+ * @param {any} content
+ * @param {string} mime
+ * @returns {Blob}
+ * @memberof Core
+ */
+export declare function createBlob(content: BlobPart, mime: string): Blob;
+/**
+ * Create a new blob url
+ * @param {any} content
+ * @param {string} mime
+ * @returns {string} url
+ * @memberof Core
+ */
+export declare function createBlobUrl(content: BlobPart, mime: string): string;
+/**
+ * Remove a blob url
+ * @param {string} url
+ * @memberof Core
+ */
+export declare function revokeBlobUrl(url: string): void;
+/**
+ * Create a new base64 encoded url
+ * @param {any} content
+ * @param {string} mime
+ * @returns {string} url
+ * @memberof Core
+ */
+export declare function createBase64Url(content: string, mime: string): string | undefined;
+/**
+ * Get type of an object
+ * @param {object} obj
+ * @returns {string} type
+ * @memberof Core
+ */
+export declare function type(obj: unknown): string;
+/**
+ * Parse xml (or html) markup
+ * @param {string} markup
+ * @param {string} mime
+ * @param {boolean} forceXMLDom force using xmlDom to parse instead of native parser
+ * @returns {document} document
+ * @memberof Core
+ */
+export declare function parse(markup: string, mime: string, forceXMLDom?: boolean): Document;
+/**
+ * querySelector polyfill
+ * @param {element} el
+ * @param {string} sel selector string
+ * @returns {element} element
+ * @memberof Core
+ */
+export declare function qs(el: Document | Element, sel: string): Element | undefined;
+/**
+ * querySelectorAll polyfill
+ * @param {element} el
+ * @param {string} sel selector string
+ * @returns {element[]} elements
+ * @memberof Core
+ */
+export declare function qsa(el: Document | Element, sel: string): NodeListOf<Element> | HTMLCollectionOf<Element>;
+/**
+ * querySelector by property
+ * @param {element} el
+ * @param {string} sel selector string
+ * @param {object[]} props
+ * @returns {element[]} elements
+ * @memberof Core
+ */
+export declare function qsp(el: Document | Element, sel: string, props: Record<string, string>): Element | undefined;
+/**
+ * Sprint through all text nodes in a document
+ * @memberof Core
+ * @param  {element} root element to start with
+ * @param  {function} func function to run on each element
+ */
+export declare function sprint(root: Node, func: (node: Node) => void): void;
+/**
+ * Create a treeWalker
+ * @memberof Core
+ * @param  {element} root element to start with
+ * @param  {function} func function to run on each element
+ * @param  {function | object} filter function or object to filter with
+ */
+export declare function treeWalker(root: Node, func: (node: Node) => void, filter: number): void;
+/**
+ * @memberof Core
+ * @param {node} node
+ * @param {callback} return false for continue,true for break inside callback
+ */
+export declare function walk(node: Node, callback: (node: Node) => boolean, _unused?: boolean): boolean | undefined;
+/**
+ * Convert a blob to a base64 encoded string
+ * @param {Blog} blob
+ * @returns {string}
+ * @memberof Core
+ */
+export declare function blob2base64(blob: Blob): Promise<string | ArrayBuffer>;
+/**
+ * Creates a new pending promise and provides methods to resolve or reject it.
+ * From: https://developer.mozilla.org/en-US/docs/Mozilla/JavaScript_code_modules/Promise.jsm/Deferred#backwards_forwards_compatible
+ * @memberof Core
+ */
+export declare class defer {
+    id: string;
+    resolve: (value?: any) => void;
+    reject: (reason?: any) => void;
+    promise: Promise<any>;
+    constructor();
+}
+/**
+ * querySelector with filter by epub type
+ * @param {element} html
+ * @param {string} element element type to find
+ * @param {string} type epub type to find
+ * @returns {element[]} elements
+ * @memberof Core
+ */
+export declare function querySelectorByType(html: Document | Element, element: string, type: string): Element | undefined;
+/**
+ * Find direct descendents of an element
+ * @param {element} el
+ * @returns {element[]} children
+ * @memberof Core
+ */
+export declare function findChildren(el: Element): Element[];
+/**
+ * Find all parents (ancestors) of an element
+ * @param {element} node
+ * @returns {element[]} parents
+ * @memberof Core
+ */
+export declare function parents(node: Node | null | undefined): Node[];
+/**
+ * Find all direct descendents of a specific type
+ * @param {element} el
+ * @param {string} nodeName
+ * @param {boolean} [single]
+ * @returns {element[]} children
+ * @memberof Core
+ */
+export declare function filterChildren(el: Element, nodeName: string, single?: boolean): Element | Element[] | undefined;
+/**
+ * Filter all parents (ancestors) with tag name
+ * @param {element} node
+ * @param {string} tagname
+ * @returns {element[]} parents
+ * @memberof Core
+ */
+export declare function getParentByTagName(node: Node, tagname: string): Element | undefined;
+/**
+ * Lightweight Polyfill for DOM Range
+ * @class
+ * @memberof Core
+ */
+export declare class RangeObject {
+    collapsed: boolean;
+    commonAncestorContainer: Node | undefined;
+    endContainer: Node | undefined;
+    endOffset: number | undefined;
+    startContainer: Node | undefined;
+    startOffset: number | undefined;
+    constructor();
+    setStart(startNode: Node, startOffset: number): void;
+    setEnd(endNode: Node, endOffset: number): void;
+    collapse(toStart: boolean): void;
+    selectNode(referenceNode: Node): void;
+    selectNodeContents(referenceNode: Node): void;
+    _commonAncestorContainer(startContainer?: Node, endContainer?: Node): Node | undefined;
+    _checkCollapsed(): void;
+    toString(): string;
+}

package/dist/utils/event-emitter.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Minimal EventEmitter mixin.
+ * Drop-in replacement for the "event-emitter" npm package.
+ * Supports on(type, fn), off(type, fn), emit(type, ...args).
+ */
+export default function EventEmitter(target: any): any;

package/dist/utils/hook.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Hooks allow for injecting functions that must all complete in order before finishing
+ * They will execute in parallel but all must finish before continuing
+ * Functions may return a promise if they are async.
+ * @param {any} context scope of this
+ * @example this.content = new EPUBJS.Hook(this);
+ */
+declare class Hook {
+    context: any;
+    hooks: Function[];
+    constructor(context?: any);
+    /**
+     * Adds a function to be run before a hook completes
+     * @example this.content.register(function(){...});
+     */
+    register(..._args: any[]): void;
+    /**
+     * Removes a function
+     * @example this.content.deregister(function(){...});
+     */
+    deregister(func: Function): void;
+    /**
+     * Triggers a hook to run all functions
+     * @example this.content.trigger(args).then(function(){...});
+     */
+    trigger(..._args: any[]): Promise<any[]>;
+    list(): Function[];
+    clear(): Function[];
+}
+export default Hook;

package/dist/utils/mime.d.ts

@@ -0,0 +1,5 @@
+declare function lookup(filename: string): string;
+declare const _default: {
+    lookup: typeof lookup;
+};
+export default _default;

package/dist/utils/path-utils.d.ts

@@ -0,0 +1,14 @@
+import { ParsedPath } from '../types';
+export declare function resolve(..._args: string[]): string;
+export declare function relative(from: string, to: string): string;
+export declare function dirname(path: string): string;
+export declare function isAbsolute(path: string): boolean;
+export declare function parse(path: string): ParsedPath;
+declare const pathUtils: {
+    resolve: typeof resolve;
+    relative: typeof relative;
+    dirname: typeof dirname;
+    isAbsolute: typeof isAbsolute;
+    parse: typeof parse;
+};
+export default pathUtils;

package/dist/utils/path.d.ts

@@ -0,0 +1,55 @@
+import { ParsedPath } from '../types';
+/**
+ * Creates a Path object for parsing and manipulation of a path strings
+ *
+ * Uses a polyfill for Nodejs path: https://nodejs.org/api/path.html
+ * @param	{string} pathString	a url string (relative or absolute)
+ * @class
+ */
+declare class Path {
+    path: string;
+    directory: string;
+    filename: string;
+    extension: string;
+    constructor(pathString: string);
+    /**
+     * Parse the path: https://nodejs.org/api/path.html#path_path_parse_path
+     * @param	{string} what
+     * @returns {object}
+     */
+    parse(what: string): ParsedPath;
+    /**
+     * @param	{string} what
+     * @returns {boolean}
+     */
+    isAbsolute(what?: string): boolean;
+    /**
+     * Check if path ends with a directory
+     * @param	{string} what
+     * @returns {boolean}
+     */
+    isDirectory(what: string): boolean;
+    /**
+     * Resolve a path against the directory of the Path
+     *
+     * https://nodejs.org/api/path.html#path_path_resolve_paths
+     * @param	{string} what
+     * @returns {string} resolved
+     */
+    resolve(what: string): string;
+    /**
+     * Resolve a path relative to the directory of the Path
+     *
+     * https://nodejs.org/api/path.html#path_path_relative_from_to
+     * @param	{string} what
+     * @returns {string} relative
+     */
+    relative(what: string): string;
+    splitPath(filename: string): string[];
+    /**
+     * Return the path string
+     * @returns {string} path
+     */
+    toString(): string;
+}
+export default Path;

package/dist/utils/queue.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Queue for handling tasks one at a time
+ * @class
+ * @param {scope} context what this will resolve to in the tasks
+ */
+declare class Queue {
+    _q: any[];
+    context: any;
+    tick: any;
+    running: any;
+    paused: boolean;
+    defered: any;
+    constructor(context: any);
+    /**
+     * Add an item to the queue
+     * @return {Promise}
+     */
+    enqueue(..._args: any[]): Promise<any>;
+    /**
+     * Run one item
+     * @return {Promise}
+     */
+    dequeue(): any;
+    dump(): void;
+    /**
+     * Run all tasks sequentially, at convince
+     * @return {Promise}
+     */
+    run(): Promise<any>;
+    /**
+     * Flush all, as quickly as possible
+     * @return {Promise}
+     */
+    flush(): any;
+    /**
+     * Clear all items in wait
+     */
+    clear(): void;
+    /**
+     * Get the number of tasks in the queue
+     * @return {number} tasks
+     */
+    length(): number;
+    /**
+     * Pause a running queue
+     */
+    pause(): void;
+    /**
+     * End the queue
+     */
+    stop(): void;
+}
+/**
+ * Create a new task from a callback
+ * @class
+ * @private
+ * @param {function} task
+ * @param {array} args
+ * @param {scope} context
+ * @return {function} task
+ */
+declare class Task {
+    constructor(task: Function, args: any[], context: any);
+}
+export default Queue;
+export { Task };

package/dist/utils/replacements.d.ts

@@ -0,0 +1,11 @@
+export declare function replaceBase(doc: Document, section: {
+    url: string;
+}): void;
+export declare function replaceCanonical(doc: Document, section: {
+    canonical: string;
+}): void;
+export declare function replaceMeta(doc: Document, section: {
+    idref: string;
+}): void;
+export declare function replaceLinks(contents: Element, fn: (path: string) => void): void;
+export declare function substitute(content: string, urls: string[], replacements: string[]): string;

package/dist/utils/request.d.ts

@@ -0,0 +1,2 @@
+declare function request(url: string, type?: string, withCredentials?: boolean, headers?: Record<string, string>): Promise<any>;
+export default request;

package/dist/utils/scrolltype.d.ts

@@ -0,0 +1,2 @@
+export default function scrollType(): string;
+export declare function createDefiner(): HTMLDivElement;

package/dist/utils/url.d.ts

@@ -0,0 +1,42 @@
+import { default as Path } from './path';
+/**
+ * creates a Url object for parsing and manipulation of a url string
+ * @param	{string} urlString	a url string (relative or absolute)
+ * @param	{string} [baseString] optional base for the url,
+ * default to window.location.href
+ */
+declare class Url {
+    Url: URL | undefined;
+    href: string;
+    protocol: string;
+    origin: string;
+    hash: string;
+    search: string;
+    base: string | false | undefined;
+    Path: Path;
+    directory: string;
+    filename: string;
+    extension: string;
+    constructor(urlString: string, baseString?: string | false);
+    /**
+     * @returns {Path}
+     */
+    path(): Path;
+    /**
+     * Resolves a relative path to a absolute url
+     * @param {string} what
+     * @returns {string} url
+     */
+    resolve(what: string): string;
+    /**
+     * Resolve a path relative to the url
+     * @param {string} what
+     * @returns {string} path
+     */
+    relative(what: string): string;
+    /**
+     * @returns {string}
+     */
+    toString(): string;
+}
+export default Url;

package/license

@@ -0,0 +1,28 @@
+Copyright (c) 2024-2026, 3ook.com
+Copyright (c) 2013, FuturePress
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies, 
+either expressed or implied, of the FreeBSD Project.

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@likecoin/epub-ts",
+  "version": "0.3.93",
+  "description": "Parse and Render Epubs",
+  "keywords": ["epub", "ebook", "reader", "typescript", "epubjs", "parser", "renderer"],
+  "type": "module",
+  "main": "dist/epub.cjs",
+  "module": "dist/epub.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/epub.js",
+      "require": "./dist/epub.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": "https://github.com/likecoin/epub.ts",
+  "scripts": {
+    "build": "vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix"
+  },
+  "author": "William Chong <me@williamchong.cloud>",
+  "contributors": [
+    {
+      "name": "Fred Chasen",
+      "email": "fchasen@gmail.com"
+    }
+  ],
+  "homepage": "https://github.com/likecoin/epub.ts",
+  "bugs": "https://github.com/likecoin/epub.ts/issues",
+  "license": "BSD-2-Clause",
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@types/localforage": "0.0.34",
+    "eslint": "^9.39.2",
+    "jsdom": "^28.0.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.54.0",
+    "vite": "^6.1.0",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^3.0.5"
+  },
+  "dependencies": {
+    "@xmldom/xmldom": "^0.7.5",
+    "jszip": "^3.7.1",
+    "localforage": "^1.10.0"
+  }
+}