epub-wasm 0.1.0 → 0.1.2

package/README.md

@@ -1,141 +1,111 @@
 # epub-wasm
 
-A Rust crate that compiles to WebAssembly for parsing EPUB files into structured JSON format. This crate provides the core EPUB parsing logic that powers the [`epub-wasm` npm package](pkg/README.md).
-
-## Overview
-
-This crate leverages the [`rbook`](https://crates.io/crates/rbook) and [`scraper`](https://crates.io/crates/scraper) crates to parse EPUB files and extract their content into a clean JSON structure with chapters, headings, and paragraphs. The parsed data is then exposed via WebAssembly bindings for use in web applications.
+A WebAssembly module for parsing EPUB files into structured JSON format. This package provides a fast, browser-compatible way to extract and process EPUB content without server-side processing.
 
 ## Features
 
-- **EPUB parsing**: Extracts text content from EPUB files
-- **Structured output**: Organizes content into books, chapters, and blocks
-- **WebAssembly compatible**: Designed for compilation to WASM
-- **Fast**: Leverages Rust's performance for efficient parsing
-
-## Building
-
-### Prerequisites
-
-- [Rust](https://rustup.rs/) (latest stable)
-- [wasm-pack](https://rustwasm.github.io/wasm-pack/)
-
-### Build for WebAssembly
-
-```bash
-# Install wasm-pack if not installed
-cargo install wasm-pack
-
-# Build for bundler (recommended for Vite/SvelteKit)
-wasm-pack build --release --target bundler --out-dir pkg
-
-# Or build for web (serves WASM from URL)
-wasm-pack build --release --target web --out-dir pkg
-```
+- **Fast EPUB parsing**: Leverages Rust's performance compiled to WebAssembly
+- **Browser-ready**: Works directly in web browsers and modern JavaScript environments
+- **Structured output**: Converts EPUB content into clean JSON with chapters, headings, and paragraphs
+- **Zero dependencies**: Self-contained WebAssembly module
 
-### Build for Native (Testing)
+## Installation
 
 ```bash
-cargo build --release
+npm install epub-wasm
+# or
+yarn add epub-wasm
+# or
+bun add epub-wasm
 ```
 
 ## Usage
 
-This crate is primarily designed to be compiled to WebAssembly. The main entry point is the `parse_epub` function:
+```javascript
+import * as wasm from "epub-wasm";
 
-```rust
-use epub_wasm::parse_epub;
+async function parseEpub() {
+  // Load the EPUB file
+  const response = await fetch("./book.epub");
+  const arrayBuffer = await response.arrayBuffer();
+  const uint8Array = new Uint8Array(arrayBuffer);
 
-// Parse EPUB bytes into JSON string
-let epub_data: &[u8] = // ... load EPUB file
-let json_result = parse_epub(epub_data);
-let book: serde_json::Value = serde_json::from_str(&json_result).unwrap();
+  // Parse with WebAssembly
+  const jsonString = await wasm.parse_epub(uint8Array);
+  const bookData = JSON.parse(jsonString);
+
+  console.log("Book:", bookData);
+  // Access chapters: bookData.chapters
+  // Access first chapter blocks: bookData.chapters[0].blocks
+}
 ```
 
-## API
+## API Reference
 
-### `parse_epub(data: &[u8]) -> String`
+### `parse_epub(data: Uint8Array) -> string`
 
-Parses an EPUB file from raw bytes and returns a JSON string representation.
+Parses an EPUB file from a byte array and returns a JSON string.
 
 **Parameters:**
 
-- `data`: Raw bytes of the EPUB file
-
-**Returns:** JSON string with the following structure:
-
-```json
-{
-  "id": "book_001",
-  "title": "Book Title",
-  "chapters": [
-    {
-      "title": "Chapter Title",
-      "id": "chapter_001",
-      "blocks": [
-        {
-          "type": "heading",
-          "text": "Heading Text"
-        },
-        {
-          "type": "paragraph",
-          "text": "Paragraph text..."
-        }
-      ]
-    }
-  ]
-}
-```
+- `data`: `Uint8Array` - The raw bytes of the EPUB file
 
-## Dependencies
+**Returns:** `string` - JSON representation of the parsed book
 
-- [`rbook`](https://crates.io/crates/rbook): EPUB parsing library
-- [`scraper`](https://crates.io/crates/scraper): HTML parsing and CSS selector engine
-- [`serde`](https://crates.io/crates/serde): Serialization framework
-- [`wasm-bindgen`](https://crates.io/crates/wasm-bindgen): WebAssembly bindings
+**Throws:** Will return a fallback empty book JSON if parsing fails
 
-## Project Structure
+### Extraction Process
 
-```
-epub-wasm/
-├── src/
-│   └── lib.rs          # Main library code with WASM bindings
-├── pkg/                # Generated WebAssembly package (after build)
-│   ├── epub_wasm.js
-│   ├── epub_wasm_bg.wasm
-│   └── ...
-├── Cargo.toml          # Package configuration
-└── README.md           # This file
-```
+The EPUB parsing extracts content based on the following TypeScript type definitions:
 
-## Development
+```typescript
+type Book = {
+  id: string;
+  title: string;
+  chapters: Chapter[];
+};
 
-### Testing
+type Chapter = {
+  title: string;
+  id: string;
+  blocks: Block[];
+};
 
-```bash
-cargo test
+type Block = {
+  text: string;
+  type: "heading" | "paragraph";
+};
 ```
 
-### Running the Web Example
+**How extraction works:**
 
-After building with wasm-pack, you can test the generated package:
-
-```bash
-cd pkg
-# Serve locally (requires a web server)
-python3 -m http.server 8000
-# Then open index.html in browser
-```
+- **Book**: Represents the entire EPUB with a unique ID, title, and array of chapters
+- **Chapter**: Each chapter contains a title, unique ID, and content broken into blocks
+- **Block**: Individual content units that are either headings (`h1`-`h6`) or paragraphs
+- Content is extracted from HTML/XHTML files within the EPUB, preserving the document structure
+- Headings and paragraphs are identified and categorized automatically from the EPUB's markup
 
-## Contributing
+### JSON Output Structure
 
-Contributions are welcome! Please feel free to submit issues and pull requests.
+```typescript
+interface Book {
+  id: string;
+  title: string;
+  chapters: Chapter[];
+}
 
-## License
+interface Chapter {
+  title: string;
+  id: string;
+  blocks: Block[];
+}
 
-Licensed under MIT/Apache-2.0.
+interface Block {
+  type: "heading" | "paragraph";
+  text: string;
+}
+```
 
-## Related Projects
+## License
 
-- [`rs-epub`](https://github.com/0xmiki/rs-epub) - Parent Rust project with additional EPUB utilities
-- [`epub-wasm` npm package](pkg/README.md) - The WebAssembly package published to npm
+MIT/Apache-2.0

package/epub_wasm_bg.js

@@ -0,0 +1,120 @@
+let wasm;
+export function __wbg_set_wasm(val) {
+    wasm = val;
+}
+
+function addHeapObject(obj) {
+    if (heap_next === heap.length) heap.push(heap.length + 1);
+    const idx = heap_next;
+    heap_next = heap[idx];
+
+    heap[idx] = obj;
+    return idx;
+}
+
+function dropObject(idx) {
+    if (idx < 132) return;
+    heap[idx] = heap_next;
+    heap_next = idx;
+}
+
+function getArrayU8FromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
+}
+
+let cachedDataViewMemory0 = null;
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return decodeText(ptr, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function getObject(idx) { return heap[idx]; }
+
+function handleError(f, args) {
+    try {
+        return f.apply(this, args);
+    } catch (e) {
+        wasm.__wbindgen_export(addHeapObject(e));
+    }
+}
+
+let heap = new Array(128).fill(undefined);
+heap.push(undefined, null, true, false);
+
+let heap_next = heap.length;
+
+function passArray8ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 1, 1) >>> 0;
+    getUint8ArrayMemory0().set(arg, ptr / 1);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+
+function takeObject(idx) {
+    const ret = getObject(idx);
+    dropObject(idx);
+    return ret;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+let WASM_VECTOR_LEN = 0;
+
+/**
+ * @param {Uint8Array} data
+ * @returns {string}
+ */
+export function parse_epub(data) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_export2);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.parse_epub(retptr, ptr0, len0);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred2_0 = r0;
+        deferred2_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_export3(deferred2_0, deferred2_1, 1);
+    }
+}
+
+export function __wbg_getRandomValues_9b655bdd369112f2() { return handleError(function (arg0, arg1) {
+    globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
+}, arguments) };
+
+export function __wbindgen_object_drop_ref(arg0) {
+    takeObject(arg0);
+};

package/package.json

@@ -5,7 +5,7 @@
     "Mikiyas <0xmik@proton.me>"
   ],
   "description": "EPUB utilities compiled to WebAssembly",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "license": "MIT/Apache-2.0",
   "repository": {
     "type": "git",
@@ -14,6 +14,7 @@
   "files": [
     "epub_wasm.js",
     "epub_wasm_bg.wasm",
+    "epub_wasm_bg.js",
     "epub_wasm.d.ts",
     "epub_wasm_bg.wasm.d.ts",
     "package.json",