rar-stream 5.2.2 → 5.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +15 -9
  2. package/index.d.ts +1 -1
  3. package/package.json +2 -3
package/README.md CHANGED
@@ -1,15 +1,19 @@
1
- # rar-stream
1
+ <div align="center">
2
+ <h1>rar-stream</h1>
3
+ </div>
4
+
5
+ <div align="center"><p>
6
+ <a href="https://crates.io/crates/rar-stream"><img alt="Crates.io" src="https://img.shields.io/crates/v/rar-stream?style=for-the-badge&logo=rust&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" /></a>
7
+ <a href="https://crates.io/crates/rar-stream"><img alt="Crates.io Downloads" src="https://img.shields.io/crates/d/rar-stream?style=for-the-badge&logo=rust&color=A6E3A1&logoColor=D9E0EE&labelColor=302D41" /></a>
8
+ <a href="https://docs.rs/rar-stream"><img alt="docs.rs" src="https://img.shields.io/docsrs/rar-stream?style=for-the-badge&logo=docs.rs&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41" /></a>
9
+ <a href="https://www.npmjs.com/package/rar-stream"><img alt="npm" src="https://img.shields.io/npm/v/rar-stream?style=for-the-badge&logo=npm&color=F5A97F&logoColor=D9E0EE&labelColor=302D41" /></a>
10
+ <a href="https://www.npmjs.com/package/rar-stream"><img alt="npm Downloads" src="https://img.shields.io/npm/dm/rar-stream?style=for-the-badge&logo=npm&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" /></a>
11
+ <a href="https://github.com/doom-fish/rar-stream#license"><img alt="License" src="https://img.shields.io/crates/l/rar-stream?style=for-the-badge&logo=apache&color=ee999f&logoColor=D9E0EE&labelColor=302D41" /></a>
12
+ <a href="https://github.com/doom-fish/rar-stream/actions"><img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/doom-fish/rar-stream/ci.yml?branch=main&style=for-the-badge&logo=github&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" /></a>
13
+ </p></div>
2
14
 
3
15
  > Fast RAR archive streaming for Rust, Node.js, and browsers. Zero dependencies core.
4
16
 
5
- [![CI](https://github.com/doom-fish/rar-stream/actions/workflows/ci.yml/badge.svg)](https://github.com/doom-fish/rar-stream/actions/workflows/ci.yml)
6
- [![npm version](https://img.shields.io/npm/v/rar-stream.svg)](https://www.npmjs.com/package/rar-stream)
7
- [![npm downloads](https://img.shields.io/npm/dm/rar-stream.svg)](https://www.npmjs.com/package/rar-stream)
8
- [![crates.io](https://img.shields.io/crates/v/rar-stream.svg)](https://crates.io/crates/rar-stream)
9
- [![crates.io downloads](https://img.shields.io/crates/d/rar-stream.svg)](https://crates.io/crates/rar-stream)
10
- [![docs.rs](https://docs.rs/rar-stream/badge.svg)](https://docs.rs/rar-stream)
11
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
12
-
13
17
  ## Installation
14
18
 
15
19
  ### Node.js
@@ -18,6 +22,8 @@
18
22
  npm install rar-stream
19
23
  ```
20
24
 
25
+ Native binaries are automatically downloaded from [GitHub Releases](https://github.com/doom-fish/rar-stream/releases) during install. Supported platforms: Linux (x64, arm64), macOS (x64, arm64), Windows (x64).
26
+
21
27
  ### Rust
22
28
 
23
29
  ```toml
package/index.d.ts CHANGED
@@ -28,7 +28,7 @@ export interface RarFileInfo {
28
28
  * The buffer should contain at least the first ~300 bytes of a .rar file.
29
29
  */
30
30
  export declare function parseRarHeader(buffer: Buffer): RarFileInfo | null
31
- /** Check if a buffer starts with a RAR signature. */
31
+ /** Check if a buffer starts with a RAR signature (RAR4 or RAR5). */
32
32
  export declare function isRarArchive(buffer: Buffer): boolean
33
33
  /** LocalFileMedia - reads from local filesystem. */
34
34
  export declare class LocalFileMedia {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rar-stream",
3
- "version": "5.2.2",
3
+ "version": "5.3.0",
4
4
  "description": "RAR streaming library - Rust implementation with NAPI and WASM bindings",
5
5
  "main": "lib/index.mjs",
6
6
  "browser": "lib/browser.mjs",
@@ -75,8 +75,7 @@
75
75
  "bench:compare": "cargo bench -- --baseline main",
76
76
  "profile": "cargo build --release && perf record -g ./target/release/examples/profile_decompress && perf report",
77
77
  "flamegraph": "cargo flamegraph --bench decompress -- --bench",
78
- "postinstall": "node scripts/postinstall.js",
79
- "prepublishOnly": "napi prepublish -t npm --skip-gh-release"
78
+ "postinstall": "node scripts/postinstall.js"
80
79
  },
81
80
  "devDependencies": {
82
81
  "@eslint/js": "^9.0.0",