epub-wasm 0.1.0

package/README.md

@@ -0,0 +1,141 @@
+# 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.
+
+## 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
+```
+
+### Build for Native (Testing)
+
+```bash
+cargo build --release
+```
+
+## Usage
+
+This crate is primarily designed to be compiled to WebAssembly. The main entry point is the `parse_epub` function:
+
+```rust
+use epub_wasm::parse_epub;
+
+// 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();
+```
+
+## API
+
+### `parse_epub(data: &[u8]) -> String`
+
+Parses an EPUB file from raw bytes and returns a JSON string representation.
+
+**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..."
+        }
+      ]
+    }
+  ]
+}
+```
+
+## Dependencies
+
+- [`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
+
+## Project Structure
+
+```
+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
+```
+
+## Development
+
+### Testing
+
+```bash
+cargo test
+```
+
+### Running the Web Example
+
+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
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit issues and pull requests.
+
+## License
+
+Licensed under MIT/Apache-2.0.
+
+## Related Projects
+
+- [`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

package/epub_wasm.d.ts

@@ -0,0 +1,4 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export function parse_epub(data: Uint8Array): string;

package/epub_wasm.js

@@ -0,0 +1,4 @@
+import * as wasm from "./epub_wasm_bg.wasm";
+export * from "./epub_wasm_bg.js";
+import { __wbg_set_wasm } from "./epub_wasm_bg.js";
+__wbg_set_wasm(wasm);

package/epub_wasm_bg.wasm.d.ts

@@ -0,0 +1,8 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const parse_epub: (a: number, b: number, c: number) => void;
+export const __wbindgen_export: (a: number) => void;
+export const __wbindgen_add_to_stack_pointer: (a: number) => number;
+export const __wbindgen_export2: (a: number, b: number) => number;
+export const __wbindgen_export3: (a: number, b: number, c: number) => void;

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "epub-wasm",
+  "type": "module",
+  "collaborators": [
+    "Mikiyas <0xmik@proton.me>"
+  ],
+  "description": "EPUB utilities compiled to WebAssembly",
+  "version": "0.1.0",
+  "license": "MIT/Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/0xmiki/epub-wasm"
+  },
+  "files": [
+    "epub_wasm.js",
+    "epub_wasm_bg.wasm",
+    "epub_wasm.d.ts",
+    "epub_wasm_bg.wasm.d.ts",
+    "package.json",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "main": "epub_wasm.js",
+  "types": "epub_wasm.d.ts"
+}