rar-stream 5.3.2 → 5.5.0

package/README.md

@@ -125,6 +125,41 @@ interface FileMedia {
 | `streamToBuffer(stream)` | Convert Readable to Buffer |
 | `createFileMedia(source)` | Wrap any `{ createReadStream }` as FileMedia |
 
+### Rust API
+
+#### In-Memory (no features required)
+
+```rust
+use rar_stream::{MemoryArchive, is_rar_archive, detect_version};
+
+// Check format
+let data = std::fs::read("archive.rar")?;
+assert!(is_rar_archive(&data));
+
+// Parse and extract
+let archive = MemoryArchive::new(&data)?;
+let info = archive.archive_info();
+println!("Format: {:?}, solid: {}", info.version, info.is_solid);
+
+for entry in archive.entries() {
+    println!("{}: {} bytes", entry.name, entry.unpacked_size);
+}
+let content = archive.extract(0)?;
+let readme = archive.extract_by_name("README.md")?;
+```
+
+#### Async (requires `async` feature)
+
+```rust
+use rar_stream::{RarFilesPackage, ParseOptions, LocalFileMedia, FileMedia};
+use std::sync::Arc;
+
+let file: Arc<dyn FileMedia> = Arc::new(LocalFileMedia::new("archive.rar")?);
+let package = RarFilesPackage::new(vec![file]);
+let files = package.parse(ParseOptions::default()).await?;
+let content = files[0].read_to_end().await?;
+```
+
 ## Feature Flags
 
 ### Rust (Cargo)

package/browser.d.ts

@@ -16,7 +16,14 @@ export function isRarArchive(data: Uint8Array): boolean;
 /** Get RAR version (15 for RAR4, 50 for RAR5, 0 if not RAR) */
 export function getRarVersion(data: Uint8Array): number;
 
-/** Parse RAR header information (returns first file's header) */
+/** Extract the first file from a RAR archive buffer */
+export function extractFile(archive: Uint8Array): {
+  name: string;
+  data: Uint8Array;
+  length: number;
+};
+
+/** Parse RAR4 header information (returns first file's header) */
 export function parseRarHeader(data: Uint8Array): {
   name: string;
   packedSize: number;
@@ -26,7 +33,57 @@ export function parseRarHeader(data: Uint8Array): {
   dataOffset: number;
 };
 
-/** RAR decompressor class */
+/** Parse RAR5 header information (returns first file's header) */
+export function parseRar5Header(data: Uint8Array): {
+  name: string;
+  packedSize: number;
+  unpackedSize: number;
+  method: number;
+  dictSizeLog: number;
+  isCompressed: boolean;
+  isDirectory: boolean;
+  dataOffset: number;
+};
+
+/** Parse all RAR4 file headers from a buffer */
+export function parseRarHeaders(data: Uint8Array): Array<{
+  name: string;
+  packedSize: number;
+  unpackedSize: number;
+  method: number;
+  isCompressed: boolean;
+  dataOffset: number;
+}>;
+
+/** Parse all RAR5 file headers from a buffer */
+export function parseRar5Headers(data: Uint8Array): Array<{
+  name: string;
+  packedSize: number;
+  unpackedSize: number;
+  method: number;
+  dictSizeLog: number;
+  isCompressed: boolean;
+  isDirectory: boolean;
+  dataOffset: number;
+}>;
+
+/** High-level RAR archive reader */
+export class RarFilesPackage {
+  constructor(data: Uint8Array);
+  free(): void;
+  [Symbol.dispose](): void;
+  readonly length: number;
+  parse(): Array<{
+    name: string;
+    length: number;
+    packedSize: number;
+    isDirectory: boolean;
+  }>;
+  extract(index: number): { name: string; data: Uint8Array; length: number };
+  extractAll(): Array<{ name: string; data: Uint8Array; length: number }>;
+}
+
+/** RAR4 decompressor */
 export class RarDecoder {
   constructor(unpacked_size: bigint);
   free(): void;
@@ -37,8 +94,33 @@ export class RarDecoder {
   reset(): void;
 }
 
+/** RAR5 decompressor */
+export class Rar5Decoder {
+  constructor(unpacked_size: bigint, dict_size_log: number, method: number, is_solid: boolean);
+  free(): void;
+  [Symbol.dispose](): void;
+  decompress(data: Uint8Array): Uint8Array;
+  reset(): void;
+}
+
+/** RAR5 AES-256 crypto helper */
+export class Rar5Crypto {
+  constructor(password: string, salt: Uint8Array, lg2_count: number);
+  free(): void;
+  [Symbol.dispose](): void;
+  decrypt(iv: Uint8Array, data: Uint8Array): Uint8Array;
+  verify_password(check_value: Uint8Array): boolean;
+}
+
 // Snake_case aliases for compatibility
 export { isRarArchive as is_rar_archive };
 export { getRarVersion as get_rar_version };
+export { extractFile as extract_file };
 export { parseRarHeader as parse_rar_header };
+export { parseRar5Header as parse_rar5_header };
+export { parseRarHeaders as parse_rar_headers };
+export { parseRar5Headers as parse_rar5_headers };
 export { RarDecoder as WasmRarDecoder };
+export { Rar5Decoder as WasmRar5Decoder };
+export { Rar5Crypto as WasmRar5Crypto };
+export { RarFilesPackage as WasmRarArchive };

package/index.d.ts

@@ -11,6 +11,7 @@ export interface ReadIntervalJs {
 /** Parse options for filtering results. */
 export interface ParseOptionsJs {
   maxFiles?: number
+  headerPrefetchSize?: number
 }
 /** Parsed file info from RAR header. */
 export interface RarFileInfo {

package/lib/index.mjs

@@ -247,7 +247,7 @@ class JsInnerFile {
       if (start !== 0 || end !== this.length - 1) {
         throw new Error('Range reads not supported for compressed files. Use readToEnd() instead.');
       }
-      // TODO: streaming decompression
+      // Streaming decompression not supported for custom FileMedia
       throw new Error('Streaming compressed files not yet supported for custom FileMedia.');
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rar-stream",
-  "version": "5.3.2",
+  "version": "5.5.0",
   "description": "RAR streaming library - Rust implementation with NAPI and WASM bindings",
   "main": "lib/index.mjs",
   "browser": "lib/browser.mjs",