@push.rocks/smartarchive 4.2.3 → 5.0.0

package/dist_ts/interfaces.d.ts

@@ -0,0 +1,115 @@
+import type * as stream from 'node:stream';
+import type { SmartFile, StreamFile } from '@push.rocks/smartfile';
+/**
+ * Supported archive formats
+ */
+export type TArchiveFormat = 'tar' | 'tar.gz' | 'tgz' | 'zip' | 'gz' | 'bz2';
+/**
+ * Compression level (0 = no compression, 9 = maximum compression)
+ */
+export type TCompressionLevel = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+/**
+ * Supported MIME types for archive detection
+ */
+export type TSupportedMime = 'application/gzip' | 'application/zip' | 'application/x-bzip2' | 'application/x-tar' | undefined;
+/**
+ * Entry to add to an archive during creation
+ */
+export interface IArchiveEntry {
+    /** Path within the archive */
+    archivePath: string;
+    /** Content: string, Buffer, Readable stream, SmartFile, or StreamFile */
+    content: string | Buffer | stream.Readable | SmartFile | StreamFile;
+    /** Optional size hint for streams (improves performance) */
+    size?: number;
+    /** Optional file mode/permissions */
+    mode?: number;
+    /** Optional modification time */
+    mtime?: Date;
+}
+/**
+ * Options for creating archives
+ */
+export interface IArchiveCreationOptions {
+    /** Target archive format */
+    format: TArchiveFormat;
+    /** Compression level (0-9, default depends on format) */
+    compressionLevel?: TCompressionLevel;
+    /** Base path to strip from file paths in archive */
+    basePath?: string;
+}
+/**
+ * Options for extracting archives
+ */
+export interface IArchiveExtractionOptions {
+    /** Target directory for extraction */
+    targetDir: string;
+    /** Optional filename for single-file archives (gz, bz2) */
+    fileName?: string;
+    /** Number of leading path components to strip */
+    stripComponents?: number;
+    /** Filter function to select which entries to extract */
+    filter?: (entry: IArchiveEntryInfo) => boolean;
+    /** Whether to overwrite existing files */
+    overwrite?: boolean;
+}
+/**
+ * Information about an archive entry
+ */
+export interface IArchiveEntryInfo {
+    /** Path of the entry within the archive */
+    path: string;
+    /** Size in bytes */
+    size: number;
+    /** Whether this entry is a directory */
+    isDirectory: boolean;
+    /** Whether this entry is a file */
+    isFile: boolean;
+    /** Modification time */
+    mtime?: Date;
+    /** File mode/permissions */
+    mode?: number;
+}
+/**
+ * Result of archive analysis
+ */
+export interface IArchiveInfo {
+    /** Detected archive format */
+    format: TArchiveFormat | null;
+    /** Whether the archive is compressed */
+    isCompressed: boolean;
+    /** Whether this is a recognized archive format */
+    isArchive: boolean;
+    /** List of entries (if available without full extraction) */
+    entries?: IArchiveEntryInfo[];
+}
+/**
+ * Options for adding a file to a TAR pack stream
+ */
+export interface IAddFileOptions {
+    /** Filename within the archive */
+    fileName?: string;
+    /** File content */
+    content?: string | Buffer | stream.Readable | SmartFile | StreamFile;
+    /** Size in bytes (required for streams) */
+    byteLength?: number;
+    /** Path to file on disk (alternative to content) */
+    filePath?: string;
+}
+/**
+ * Bit reader interface for BZIP2 decompression
+ */
+export interface IBitReader {
+    (n: number | null): number | void;
+    bytesRead: number;
+}
+/**
+ * Huffman group for BZIP2 decompression
+ */
+export interface IHuffmanGroup {
+    permute: Int32Array;
+    limit: Int32Array;
+    base: Int32Array;
+    minLen: number;
+    maxLen: number;
+}

package/dist_ts/interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2ludGVyZmFjZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist_ts/plugins.d.ts

@@ -1,6 +1,12 @@
-import * as path from 'path';
-import * as stream from 'stream';
-export { path, stream };
+import * as path from 'node:path';
+import * as stream from 'node:stream';
+import * as fs from 'node:fs';
+import * as fsPromises from 'node:fs/promises';
+export { path, stream, fs, fsPromises };
+/**
+ * List files in a directory recursively, returning relative paths
+ */
+export declare function listFileTree(dirPath: string, _pattern?: string): Promise<string[]>;
 import * as smartfile from '@push.rocks/smartfile';
 import * as smartdelay from '@push.rocks/smartdelay';
 import * as smartpath from '@push.rocks/smartpath';

package/dist_ts/plugins.js

@@ -1,7 +1,30 @@
 // node native scope
-import * as path from 'path';
-import * as stream from 'stream';
-export { path, stream };
+import * as path from 'node:path';
+import * as stream from 'node:stream';
+import * as fs from 'node:fs';
+import * as fsPromises from 'node:fs/promises';
+export { path, stream, fs, fsPromises };
+/**
+ * List files in a directory recursively, returning relative paths
+ */
+export async function listFileTree(dirPath, _pattern = '**/*') {
+    const results = [];
+    async function walkDir(currentPath, relativePath = '') {
+        const entries = await fsPromises.readdir(currentPath, { withFileTypes: true });
+        for (const entry of entries) {
+            const entryRelPath = relativePath ? path.join(relativePath, entry.name) : entry.name;
+            const entryFullPath = path.join(currentPath, entry.name);
+            if (entry.isDirectory()) {
+                await walkDir(entryFullPath, entryRelPath);
+            }
+            else if (entry.isFile()) {
+                results.push(entryRelPath);
+            }
+        }
+    }
+    await walkDir(dirPath);
+    return results;
+}
 // @pushrocks scope
 import * as smartfile from '@push.rocks/smartfile';
 import * as smartdelay from '@push.rocks/smartdelay';
@@ -18,4 +41,4 @@ import * as fileType from 'file-type';
 import * as fflate from 'fflate';
 import tarStream from 'tar-stream';
 export { fileType, fflate, tarStream };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3BsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsb0JBQW9CO0FBQ3BCLE9BQU8sS0FBSyxJQUFJLE1BQU0sTUFBTSxDQUFDO0FBQzdCLE9BQU8sS0FBSyxNQUFNLE1BQU0sUUFBUSxDQUFDO0FBRWpDLE9BQU8sRUFBRSxJQUFJLEVBQUUsTUFBTSxFQUFFLENBQUM7QUFFeEIsbUJBQW1CO0FBQ25CLE9BQU8sS0FBSyxTQUFTLE1BQU0sdUJBQXVCLENBQUM7QUFDbkQsT0FBTyxLQUFLLFVBQVUsTUFBTSx3QkFBd0IsQ0FBQztBQUNyRCxPQUFPLEtBQUssU0FBUyxNQUFNLHVCQUF1QixDQUFDO0FBQ25ELE9BQU8sS0FBSyxZQUFZLE1BQU0sMEJBQTBCLENBQUM7QUFDekQsT0FBTyxLQUFLLFlBQVksTUFBTSwwQkFBMEIsQ0FBQztBQUN6RCxPQUFPLEtBQUssV0FBVyxNQUFNLHlCQUF5QixDQUFDO0FBQ3ZELE9BQU8sS0FBSyxXQUFXLE1BQU0seUJBQXlCLENBQUM7QUFDdkQsT0FBTyxLQUFLLE9BQU8sTUFBTSxxQkFBcUIsQ0FBQztBQUMvQyxPQUFPLEtBQUssUUFBUSxNQUFNLHNCQUFzQixDQUFDO0FBRWpELE9BQU8sRUFDTCxTQUFTLEVBQ1QsVUFBVSxFQUNWLFNBQVMsRUFDVCxZQUFZLEVBQ1osWUFBWSxFQUNaLFdBQVcsRUFDWCxXQUFXLEVBQ1gsT0FBTyxFQUNQLFFBQVEsR0FDVCxDQUFDO0FBRUYsb0JBQW9CO0FBQ3BCLE9BQU8sS0FBSyxRQUFRLE1BQU0sV0FBVyxDQUFDO0FBQ3RDLE9BQU8sS0FBSyxNQUFNLE1BQU0sUUFBUSxDQUFDO0FBQ2pDLE9BQU8sU0FBUyxNQUFNLFlBQVksQ0FBQztBQUVuQyxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3BsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsb0JBQW9CO0FBQ3BCLE9BQU8sS0FBSyxJQUFJLE1BQU0sV0FBVyxDQUFDO0FBQ2xDLE9BQU8sS0FBSyxNQUFNLE1BQU0sYUFBYSxDQUFDO0FBQ3RDLE9BQU8sS0FBSyxFQUFFLE1BQU0sU0FBUyxDQUFDO0FBQzlCLE9BQU8sS0FBSyxVQUFVLE1BQU0sa0JBQWtCLENBQUM7QUFFL0MsT0FBTyxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsRUFBRSxFQUFFLFVBQVUsRUFBRSxDQUFDO0FBRXhDOztHQUVHO0FBQ0gsTUFBTSxDQUFDLEtBQUssVUFBVSxZQUFZLENBQUMsT0FBZSxFQUFFLFdBQW1CLE1BQU07SUFDM0UsTUFBTSxPQUFPLEdBQWEsRUFBRSxDQUFDO0lBRTdCLEtBQUssVUFBVSxPQUFPLENBQUMsV0FBbUIsRUFBRSxlQUF1QixFQUFFO1FBQ25FLE1BQU0sT0FBTyxHQUFHLE1BQU0sVUFBVSxDQUFDLE9BQU8sQ0FBQyxXQUFXLEVBQUUsRUFBRSxhQUFhLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztRQUMvRSxLQUFLLE1BQU0sS0FBSyxJQUFJLE9BQU8sRUFBRSxDQUFDO1lBQzVCLE1BQU0sWUFBWSxHQUFHLFlBQVksQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxZQUFZLEVBQUUsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDO1lBQ3JGLE1BQU0sYUFBYSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUV6RCxJQUFJLEtBQUssQ0FBQyxXQUFXLEVBQUUsRUFBRSxDQUFDO2dCQUN4QixNQUFNLE9BQU8sQ0FBQyxhQUFhLEVBQUUsWUFBWSxDQUFDLENBQUM7WUFDN0MsQ0FBQztpQkFBTSxJQUFJLEtBQUssQ0FBQyxNQUFNLEVBQUUsRUFBRSxDQUFDO2dCQUMxQixPQUFPLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDO1lBQzdCLENBQUM7UUFDSCxDQUFDO0lBQ0gsQ0FBQztJQUVELE1BQU0sT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3ZCLE9BQU8sT0FBTyxDQUFDO0FBQ2pCLENBQUM7QUFFRCxtQkFBbUI7QUFDbkIsT0FBTyxLQUFLLFNBQVMsTUFBTSx1QkFBdUIsQ0FBQztBQUNuRCxPQUFPLEtBQUssVUFBVSxNQUFNLHdCQUF3QixDQUFDO0FBQ3JELE9BQU8sS0FBSyxTQUFTLE1BQU0sdUJBQXVCLENBQUM7QUFDbkQsT0FBTyxLQUFLLFlBQVksTUFBTSwwQkFBMEIsQ0FBQztBQUN6RCxPQUFPLEtBQUssWUFBWSxNQUFNLDBCQUEwQixDQUFDO0FBQ3pELE9BQU8sS0FBSyxXQUFXLE1BQU0seUJBQXlCLENBQUM7QUFDdkQsT0FBTyxLQUFLLFdBQVcsTUFBTSx5QkFBeUIsQ0FBQztBQUN2RCxPQUFPLEtBQUssT0FBTyxNQUFNLHFCQUFxQixDQUFDO0FBQy9DLE9BQU8sS0FBSyxRQUFRLE1BQU0sc0JBQXNCLENBQUM7QUFFakQsT0FBTyxFQUNMLFNBQVMsRUFDVCxVQUFVLEVBQ1YsU0FBUyxFQUNULFlBQVksRUFDWixZQUFZLEVBQ1osV0FBVyxFQUNYLFdBQVcsRUFDWCxPQUFPLEVBQ1AsUUFBUSxHQUNULENBQUM7QUFFRixvQkFBb0I7QUFDcEIsT0FBTyxLQUFLLFFBQVEsTUFBTSxXQUFXLENBQUM7QUFDdEMsT0FBTyxLQUFLLE1BQU0sTUFBTSxRQUFRLENBQUM7QUFDakMsT0FBTyxTQUFTLE1BQU0sWUFBWSxDQUFDO0FBRW5DLE9BQU8sRUFBRSxRQUFRLEVBQUUsTUFBTSxFQUFFLFNBQVMsRUFBRSxDQUFDIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartarchive",
-  "version": "4.2.3",
+  "version": "5.0.0",
   "description": "A library for working with archive files, providing utilities for compressing and decompressing data.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -17,7 +17,7 @@
   "homepage": "https://code.foss.global/push.rocks/smartarchive#readme",
   "dependencies": {
     "@push.rocks/smartdelay": "^3.0.5",
-    "@push.rocks/smartfile": "^11.2.7",
+    "@push.rocks/smartfile": "^13.0.0",
     "@push.rocks/smartpath": "^6.0.0",
     "@push.rocks/smartpromise": "^4.2.3",
     "@push.rocks/smartrequest": "^4.2.2",
@@ -28,8 +28,7 @@
     "@types/tar-stream": "^3.1.4",
     "fflate": "^0.8.2",
     "file-type": "^21.0.0",
-    "tar-stream": "^3.1.7",
-    "through": "^2.3.8"
+    "tar-stream": "^3.1.7"
   },
   "devDependencies": {
     "@git.zone/tsbuild": "^3.1.0",

package/readme.hints.md

@@ -1 +1,38 @@
- 
+# Smartarchive Development Hints
+
+## Dependency Upgrades (2025-01-25)
+
+### Completed Upgrades
+- **@git.zone/tsbuild**: ^2.6.6 → ^3.1.0
+- **@git.zone/tsrun**: ^1.3.3 → ^2.0.0
+- **@git.zone/tstest**: ^2.3.4 → ^3.1.3
+- **@push.rocks/smartfile**: ^11.2.7 → ^13.0.0
+
+### Migration Notes
+
+#### Smartfile v13 Migration
+Smartfile v13 removed filesystem operations (`fs`, `memory`, `fsStream` namespaces). These were replaced with Node.js native `fs` and `fs/promises`:
+
+**Replacements made:**
+- `smartfile.fs.ensureDir(path)` → `fsPromises.mkdir(path, { recursive: true })`
+- `smartfile.fs.stat(path)` → `fsPromises.stat(path)`
+- `smartfile.fs.toReadStream(path)` → `fs.createReadStream(path)`
+- `smartfile.fs.toStringSync(path)` → `fsPromises.readFile(path, 'utf8')`
+- `smartfile.fs.listFileTree(dir, pattern)` → custom `listFileTree()` helper
+- `smartfile.fsStream.createReadStream(path)` → `fs.createReadStream(path)`
+- `smartfile.fsStream.createWriteStream(path)` → `fs.createWriteStream(path)`
+- `smartfile.memory.toFs(content, path)` → `fsPromises.writeFile(path, content)`
+
+**Still using from smartfile v13:**
+- `SmartFile` class (in-memory file representation)
+- `StreamFile` class (streaming file handling)
+
+### Removed Dependencies
+- `through@2.3.8` - was unused in the codebase
+
+## Architecture Notes
+
+- Uses `fflate` for ZIP/GZIP compression (pure JS, works in browser)
+- Uses `tar-stream` for TAR archive handling
+- Uses `file-type` for MIME type detection
+- Custom BZIP2 implementation in `ts/bzip2/` directory