id3-wasm 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Tamás Halasi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,117 @@
+# id3-wasm
+
+A high-performance library for reading and writing ID3 tags, powered by Rust and WebAssembly.
+
+This package provides the core JavaScript interface for the `id3-wasm` module. For a live demonstration of its capabilities, please see the [demo application](https://steve-keep.github.io/id3-wasm/).
+
+## Installation
+
+```bash
+pnpm add id3-wasm
+```
+or
+```bash
+npm install id3-wasm
+```
+
+## Usage
+
+The library can be used in both Node.js and modern browsers. It's fully compatible with Web Workers.
+
+### Initializing the Module
+
+Before using any functions, you must initialize the WebAssembly module. In a browser environment with a bundler like Vite, this is often handled automatically. In Node.js or a test environment, you may need to do it explicitly.
+
+```javascript
+import init from 'id3-wasm';
+
+// This returns a promise that resolves when the Wasm module is ready.
+await init();
+```
+
+### Reading Metadata from an MP3 File
+
+To read ID3 tags, create a `TagController` from a file buffer (`Uint8Array`) and then get the metadata from it.
+
+```javascript
+import init, { TagController } from 'id3-wasm';
+import * as fs from 'fs/promises';
+
+// Initialize the Wasm module
+await init();
+
+// Example of reading a file in Node.js
+const buffer = await fs.readFile('path/to/your/song.mp3');
+const uint8Array = new Uint8Array(buffer);
+
+let tagController;
+let metadata;
+try {
+  tagController = TagController.from(uint8Array);
+  metadata = tagController.getMetadata();
+
+  console.log('Title:', metadata.title);
+  console.log('Artist:', metadata.artist);
+  console.log('Album:', metadata.album);
+  console.log('Year:', metadata.year);
+
+} catch (e) {
+  console.error('Failed to read metadata:', e);
+} finally {
+  // IMPORTANT: The objects hold pointers to Wasm memory.
+  // You MUST free them when you are done to avoid memory leaks.
+  if (metadata) {
+    metadata.free();
+  }
+  if (tagController) {
+    tagController.free();
+  }
+}
+```
+
+### Modifying Metadata
+
+The `TagController` also allows you to modify tags and write them back into a new buffer.
+
+```javascript
+import init, { TagController } from 'id3-wasm';
+import * as fs from 'fs/promises';
+
+await init();
+
+const buffer = await fs.readFile('path/to/your/song.mp3');
+const uint8Array = new Uint8Array(buffer);
+
+let tagController;
+try {
+  tagController = TagController.from(uint8Array);
+
+  // Change the metadata
+  tagController.setTitle('A New Title');
+  tagController.setArtist('A New Artist');
+  tagController.setYear(2024);
+
+  // The putTagInto method returns a *new* buffer with the updated tags.
+  const newBuffer = tagController.putTagInto(uint8Array);
+
+  // You can now save the newBuffer to a file
+  await fs.writeFile('path/to/your/new-song.mp3', newBuffer);
+  console.log('New file saved!');
+
+} catch (e) {
+  console.error('Failed to modify metadata:', e);
+} finally {
+  // IMPORTANT: The tagController also needs to be freed.
+  if (tagController) {
+    tagController.free();
+  }
+}
+```
+
+## API
+
+The full API is exposed via the `TagController` and `Metadata` classes. Refer to the TypeScript definitions in `index.d.ts` for a complete list of available methods and properties.
+
+## Contributing
+
+Interested in contributing? Please refer to the main [README.md](../../README.md) at the root of the repository for setup, build, and testing instructions.

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from '../wasm/id3_wasm.js';

package/dist/index.js

@@ -0,0 +1 @@
+export * from '../wasm/id3_wasm.js';

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "id3-wasm",
+  "version": "0.0.1",
+  "description": "Insanely quick ID3 reading & writing for JavaScript powered by WebAssembly.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./wasm/id3_wasm.js",
+        "types": "./wasm/id3_wasm.d.ts"
+      },
+      "default": {
+        "import": "./dist/index.js",
+        "types": "./dist/index.d.ts"
+      }
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/steve-keep/id3-wasm.git"
+  },
+  "keywords": [
+    "webassembly",
+    "wasm",
+    "rust",
+    "id3"
+  ],
+  "bugs": {
+    "url": "https://github.com/steve-keep/id3-wasm/issues"
+  },
+  "homepage": "https://github.com/steve-keep/id3-wasm#readme",
+  "files": [
+    "wasm",
+    "dist"
+  ],
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "vitest": "^1.6.1"
+  },
+  "scripts": {
+    "clean": "rm -rf ./wasm ./dist",
+    "build": "pnpm run clean && pnpm --filter rust build && mv ../rust/dist ./wasm && tsc",
+    "test": "vitest run",
+    "publish:npm": "pnpm publish --no-git-checks"
+  }
+}

package/wasm/README.md

@@ -0,0 +1,27 @@
+# Rust Crate for `id3-wasm`
+
+This directory contains the core Rust crate that powers the `id3-wasm` library.
+
+## Overview
+
+This crate is responsible for all the low-level ID3 tag parsing and manipulation. It is built upon the excellent [`id3` crate](https://crates.io/crates/id3) and exposes a simplified API for common operations, which is then compiled to WebAssembly.
+
+The primary interface is exposed through a `TagController` struct, which is designed to be used via `wasm-bindgen` from JavaScript.
+
+## Building
+
+This crate is not intended to be built or used as a standalone package. It is an integral part of the `id3-wasm` monorepo.
+
+To build the crate, you should use the root-level build command, which orchestrates the entire process of compiling the Rust code to WebAssembly and integrating it into the final JavaScript package.
+
+For detailed instructions on how to build and test the entire project, please refer to the main [README.md](../../README.md) at the root of the repository.
+
+### Dependencies
+
+-   `id3`: For the core ID3 logic.
+-   `wasm-bindgen`: For generating the JavaScript bindings for the WebAssembly module.
+-   `js-sys`: To interact with JavaScript types.
+
+## Contributing
+
+If you wish to contribute to the Rust portion of the codebase, please follow the development and testing workflow outlined in the root `README.md`. All changes to this crate should be tested through the main project's testing suite.