modern-tar 0.3.4 → 0.4.0

package/README.md

@@ -10,7 +10,7 @@ Zero-dependency, cross-platform, streaming tar archive library for every JavaScr
 - 📝 **TypeScript First** - Full type safety with detailed TypeDoc documentation.
 - ⚡ **Zero Dependencies** - No external dependencies, minimal bundle size.
 - 🌐 **Cross-Platform** - Works in browsers, Node.js, Cloudflare Workers, and other JavaScript runtimes.
-- 📁 **Node.js Integration** - Additional high-level APIs for directory packing and extraction.å
+- 📁 **Node.js Integration** - Additional high-level APIs for directory packing and extraction.
 
 ## Installation
 
@@ -186,7 +186,9 @@ const extractStream = unpackTar('./output', {
 	// Filesystem-specific options
 	fmode: 0o644, // Override file permissions
 	dmode: 0o755, // Override directory permissions
-	maxDepth: 50  // Limit extraction depth for security (default: 1024)
+	maxDepth: 50,  // Limit extraction depth for security (default: 1024)
+	concurrency: 8, // Limit concurrent filesystem operations (default: CPU cores)
+	streamTimeout: 10000 // Timeout after 10 seconds of inactivity (default: 5000ms)
 });
 
 await pipeline(sourceStream, extractStream);

package/dist/fs/index.d.ts

@@ -1,4 +1,4 @@
-import { TarEntryData, TarHeader, UnpackOptions } from "../index-1Ec89lu7.js";
+import { TarEntryData, TarHeader, UnpackOptions } from "../types-D-xPQp4Z.js";
 import { Stats } from "node:fs";
 import { Readable, Writable } from "node:stream";
 
@@ -17,6 +17,8 @@ interface PackOptionsFS {
   filter?: (path: string, stat: Stats) => boolean;
   /** Transform function to modify tar headers before packing */
   map?: (header: TarHeader) => TarHeader;
+  /** Base directory for symlink security validation, when `dereference` is set to true. */
+  baseDir?: string;
 }
 /**
  * Filesystem-specific configuration options for extracting tar archives to the filesystem.
@@ -29,11 +31,6 @@ interface UnpackOptionsFS extends UnpackOptions {
   dmode?: number;
   /** Default mode for created files (e.g., 0o644). If not specified, uses mode from tar header or system default */
   fmode?: number;
-  /**
-   * Prevent symlinks from pointing outside the extraction directory.
-   * @default true
-   */
-  validateSymlinks?: boolean;
   /**
    * The maximum depth of paths to extract. Prevents Denial of Service (DoS) attacks
    * from malicious archives with deeply nested directories.
@@ -42,6 +39,11 @@ interface UnpackOptionsFS extends UnpackOptions {
    * @default 1024
    */
   maxDepth?: number;
+  /**
+   * Maximum number of concurrent filesystem operations during extraction.
+   * @default os.cpus().length || 8
+   */
+  concurrency?: number;
 }
 /** Describes a file on the local filesystem to be added to the archive. */
 interface FileSource {
@@ -72,12 +74,13 @@ interface ContentSource {
 /** A union of all possible source types for creating a tar archive. */
 type TarSource = FileSource | DirectorySource | ContentSource;
 //#endregion
-//#region src/fs/archive.d.ts
+//#region src/fs/pack.d.ts
 /**
  * Packs multiple sources into a tar archive as a Node.js Readable stream from an
  * array of sources (files, directories, or raw content).
  *
  * @param sources - An array of {@link TarSource} objects describing what to include.
+ * @param options - Optional packing configuration using {@link PackOptionsFS}.
  * @returns A Node.js [`Readable`](https://nodejs.org/api/stream.html#class-streamreadable)
  * stream that outputs the tar archive bytes.
  *
@@ -95,17 +98,13 @@ type TarSource = FileSource | DirectorySource | ContentSource;
  * await pipeline(archiveStream, createWriteStream('project.tar'));
  * ```
  */
-declare function packTarSources(sources: TarSource[]): Readable;
-//#endregion
-//#region src/fs/pack.d.ts
+declare function packTarSources(sources: TarSource[], options?: PackOptionsFS): Readable;
 /**
- * Pack a directory into a Node.js [`Readable`](https://nodejs.org/api/stream.html#class-streamreadable) stream containing tar archive bytes.
- *
- * Recursively walks the directory structure and creates tar entries for files, directories,
- * symlinks, and hardlinks.
+ * Pack a directory into a Node.js `Readable` stream. This is a convenience
+ * wrapper around `packTarSources` that reads the contents of the specified directory.
  *
- * @param directoryPath - Path to directory to pack
- * @param options - Optional packing configuration
+ * @param directoryPath - Path to directory to pack.
+ * @param options - Optional packing configuration using {@link PackOptionsFS}.
  * @returns Node.js [`Readable`](https://nodejs.org/api/stream.html#class-streamreadable) stream of tar archive bytes
  *
  * @example