neozipkit 0.2.1 → 0.3.0

package/dist/server/ZipKitServer.d.ts

@@ -1,74 +0,0 @@
-/**
- * ZipKitServer
- * Copyright (c) 2025 NeoWare, Inc. All rights reserved.
- *
- * Server-side implementation of ZipKit that passes through all functions
- * directly to the parent ZipKit class. This class provides a consistent interface
- * for server environments and ensures all ZipKit functionality is available.
- */
-import ZipKit, { CompressOptions } from '../shared/ZipKit';
-import * as Headers from '../shared/constants/Headers';
-export * from '../shared/ZipKit';
-export { Headers };
-/**
- * This implementation is optimized for server environments and handles all
- * ZIP operations including compression, extraction, encryption, and file management.
- */
-export default class ZipKitServer extends ZipKit {
-    /**
-     * Creates a new ZipKitServer instance
-     *
-     * Initializes the parent ZipKit class and logs environment support information
-     * for diagnostic purposes.
-     */
-    constructor();
-    /**
-     * Loads a ZIP file from the filesystem for updating/creating operations
-     *
-     * Attempts to read an existing ZIP file, but creates a new empty archive if
-     * the file doesn't exist. This method is used when adding or updating entries
-     * in an archive, handling both new and existing ZIP files gracefully.
-     *
-     * @param zipFile - Path to the ZIP file to load or create
-     */
-    loadZipFile(zipFile: string): void;
-    /**
-     * Loads a ZIP file from the filesystem for extraction and listing operations
-     *
-     * Reads an existing ZIP file and throws an error if the file doesn't exist.
-     * Use this method when working with existing archives that need to be extracted.
-     *
-     * @param zipFile - Path to the ZIP file to load
-     * @throws Error if the file doesn't exist or can't be read
-     */
-    loadUnzipFile(zipFile: string): void;
-    /**
-     * Adds a single file to the ZIP archive
-     * @param filename - Path to the file to be added
-     * @param comment - Optional comment for the file entry
-     *
-     * Handles:
-     * - Creating/updating ZipEntry objects
-     * - Setting file attributes and timestamps
-     * - Respecting freshen (-f) and update (-u) flags
-     * - Setting compression method
-     */
-    addFile(filename: string, freshen?: boolean, update?: boolean): void;
-    /**
-     * Processes files to be added to the ZIP archive
-     * Creates ZipEntry objects for each file and initiates the compression process
-     */
-    addFiles(files: string[], freshen?: boolean, update?: boolean): number;
-    /**
-     * Creates a ZIP file
-     */
-    createZip(zipFile: string, compressOptions: CompressOptions): Promise<void>;
-    /**
-     * Creates a ZIP file with OpenTimestamps (OTS) metadata
-     */
-    /**
-     * Removes specified files from the ZIP archive
-     * Deletes matching ZipEntry objects and rebuilds the archive if any files were removed
-     */
-    deleteFiles(delFiles: string[]): number;
-}

package/dist/server/ZipKitServer.js

@@ -1,310 +0,0 @@
-"use strict";
-/**
- * ZipKitServer
- * Copyright (c) 2025 NeoWare, Inc. All rights reserved.
- *
- * Server-side implementation of ZipKit that passes through all functions
- * directly to the parent ZipKit class. This class provides a consistent interface
- * for server environments and ensures all ZipKit functionality is available.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Headers = void 0;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const uuid_1 = require("uuid");
-const process_1 = require("process");
-const ZipKit_1 = __importDefault(require("../shared/ZipKit"));
-const Headers = __importStar(require("../shared/constants/Headers"));
-exports.Headers = Headers;
-// Re-export everything from ZipKit
-__exportStar(require("../shared/ZipKit"), exports);
-/**
- * This implementation is optimized for server environments and handles all
- * ZIP operations including compression, extraction, encryption, and file management.
- */
-class ZipKitServer extends ZipKit_1.default {
-    /**
-     * Creates a new ZipKitServer instance
-     *
-     * Initializes the parent ZipKit class and logs environment support information
-     * for diagnostic purposes.
-     */
-    constructor() {
-        super(); // Call the parent constructor
-    }
-    /**
-     * Loads a ZIP file from the filesystem for updating/creating operations
-     *
-     * Attempts to read an existing ZIP file, but creates a new empty archive if
-     * the file doesn't exist. This method is used when adding or updating entries
-     * in an archive, handling both new and existing ZIP files gracefully.
-     *
-     * @param zipFile - Path to the ZIP file to load or create
-     */
-    loadZipFile(zipFile) {
-        let inBuffer = null;
-        let fdIn = null;
-        try {
-            if (fs.existsSync(zipFile)) {
-                fdIn = fs.openSync(zipFile, 'r');
-                const stats = fs.fstatSync(fdIn);
-                inBuffer = Buffer.alloc(stats.size);
-                // inBuffer is allocated above; ensure non-null for readSync
-                fs.readSync(fdIn, inBuffer, 0, stats.size, 0);
-            }
-            else {
-                // File doesn't exist, use an empty buffer
-                inBuffer = Buffer.alloc(0);
-            }
-        }
-        catch (error) {
-            console.log('Warning: Could not open existing file. Creating new archive.');
-            inBuffer = Buffer.alloc(0);
-        }
-        finally {
-            if (fdIn !== null) {
-                fs.closeSync(fdIn);
-            }
-        }
-        // Initialize empty buffer if null
-        const buffer = inBuffer ?? Buffer.alloc(0);
-        super.loadZip(buffer);
-    }
-    /**
-     * Loads a ZIP file from the filesystem for extraction and listing operations
-     *
-     * Reads an existing ZIP file and throws an error if the file doesn't exist.
-     * Use this method when working with existing archives that need to be extracted.
-     *
-     * @param zipFile - Path to the ZIP file to load
-     * @throws Error if the file doesn't exist or can't be read
-     */
-    loadUnzipFile(zipFile) {
-        try {
-            // Check if the file exists before trying to read it
-            if (!fs.existsSync(zipFile)) {
-                console.error(`Error: Zip file "${zipFile}" does not exist`);
-                (0, process_1.exit)(1);
-            }
-            const inBuffer = fs.readFileSync(zipFile);
-            super.loadZip(inBuffer);
-        }
-        catch (error) {
-            console.error(`Error: Failed to read zip file "${zipFile}"`);
-            (0, process_1.exit)(1);
-        }
-    }
-    /**
-     * Adds a single file to the ZIP archive
-     * @param filename - Path to the file to be added
-     * @param comment - Optional comment for the file entry
-     *
-     * Handles:
-     * - Creating/updating ZipEntry objects
-     * - Setting file attributes and timestamps
-     * - Respecting freshen (-f) and update (-u) flags
-     * - Setting compression method
-     */
-    addFile(filename, freshen = false, update = false) {
-        let entry = super.getZipEntry(filename);
-        if (!entry) {
-            // Check for Freshen option
-            if (freshen)
-                return;
-            entry = super.createZipEntry(filename);
-        }
-        else if (!update) {
-            // Mark this entry as not being updated
-            entry.isUpdated = false;
-            return;
-        }
-        entry.platform = process.platform;
-        // Correctly retrieve file stats
-        let attr = fs.statSync(filename); // Synchronously get the stats of the file
-        entry.uncompressedSize = attr.size;
-        // Set the DOS file time/date based on the Date stamp of the file.
-        const utcDate = new Date(attr.mtime.getTime());
-        entry.timeDateDOS = entry.setDateTime(utcDate);
-        entry.universalTime = Math.floor(attr.mtime.getTime() / 1000); // Store Unix timestamp
-        // Set Unix UID/GID if on Unix-like system
-        if (process.platform !== 'win32') {
-            entry.uid = attr.uid;
-            entry.gid = attr.gid;
-        }
-        // Use attr.mode for file permissions
-        entry.isDirectory = attr.isDirectory();
-        let _fattr = (attr.mode & 0xfff) | (entry.isDirectory ? 0x4000 : 0x8000);
-        entry.extFileAttr = ((_fattr << 16) | (entry.isDirectory ? 0x10 : 0)) >>> 0;
-    }
-    /**
-     * Processes files to be added to the ZIP archive
-     * Creates ZipEntry objects for each file and initiates the compression process
-     */
-    addFiles(files, freshen = false, update = false) {
-        let filesAdded = 0;
-        for (var i = 0; files[i] != undefined; i++) {
-            const filename = String(files[i]);
-            // Skip arguments that look like options (start with hyphen but aren't files)
-            if (filename.startsWith('-') && !fs.existsSync(filename)) {
-                console.warn(`Warning: Skipping '${filename}' which appears to be an option, not a file.`);
-                continue;
-            }
-            this.addFile(filename, freshen, update);
-            filesAdded++;
-        }
-        return filesAdded;
-    }
-    /**
-     * Creates a ZIP file
-     */
-    async createZip(zipFile, compressOptions) {
-        // Ensure the directory structure for the output file exists
-        const outputDir = path.dirname(zipFile);
-        if (!fs.existsSync(outputDir)) {
-            fs.mkdirSync(outputDir, { recursive: true });
-        }
-        // Generate a unique temporary file name in the output directory
-        const _tempZipFile = path.join(outputDir, `neozip-${(0, uuid_1.v4)()}.zip`);
-        // Open or create the .zip file for writing
-        const fd = fs.openSync(_tempZipFile, 'w');
-        let offset = await super.createZipFileData(compressOptions, {
-            onReadEntryData: (entry) => {
-                try {
-                    return fs.readFileSync(entry.filename);
-                }
-                catch (error) {
-                    throw new Error(`Failed to read file: ${entry.filename}`);
-                }
-            },
-            onOutputBuffer: (buffer) => {
-                fs.writeSync(fd, buffer);
-            },
-            onEntryDone: (entry, status) => {
-                console.log(`${status} ${entry.filename} to ${zipFile}`);
-            }
-        });
-        // Write the metadata entry to the .zip fi
-        await super.finishZipFileData(offset, function onOutputBuffer(buffer) {
-            fs.writeSync(fd, buffer);
-        }, undefined);
-        // Close the .zip file
-        fs.closeSync(fd);
-        // Delete the existing .zip file if it exists
-        if (fs.existsSync(zipFile)) {
-            fs.unlinkSync(zipFile);
-        }
-        // Replace the existing .zip file with the temporary file
-        fs.renameSync(_tempZipFile, zipFile);
-    }
-    /**
-     * Creates a ZIP file with OpenTimestamps (OTS) metadata
-     */
-    // async createZipOTS(zipFile: string, compressOptions: CompressOptions) {
-    //   // Ensure the directory structure for the output file exists
-    //   const outputDir = path.dirname(zipFile);
-    //   if (!fs.existsSync(outputDir)) {
-    //     fs.mkdirSync(outputDir, { recursive: true });
-    //   }
-    //   // Generate a unique temporary file name in the output directory
-    //   const _tempZipFile = path.join(outputDir, `neozip-${uuidv4()}.zip`);
-    //   // Open or create the .zip file for writing
-    //   const fd = fs.openSync(_tempZipFile, 'w');
-    //   let offset = await super.createZipFileData(compressOptions, {
-    //     onReadEntryData: (entry: ZipEntry) => {
-    //       try {
-    //         return fs.readFileSync(entry.filename);
-    //       } catch (error) {
-    //         throw new Error(`Failed to read file: ${entry.filename}`);
-    //       }
-    //     },
-    //     onOutputBuffer: (buffer: Buffer) => {
-    //       fs.writeSync(fd, buffer);
-    //     },
-    //     onEntryDone: (entry: ZipEntry, status: string) => {
-    //       console.log(`${status} ${entry.filename} to ${zipFile}`);
-    //     } 
-    //   });
-    //   // Timestamp the zip file to the Bitcoin blockchain
-    //   let _metadataEntry = null;
-    //   console.log('Timestamping to Bitcoin blockchain...');
-    //   const _merkleRoot = super.getMerkleRoot();
-    //   console.log('Merkle Root: ' + _merkleRoot);
-    //   const _ots = await createTimestamp(_merkleRoot);
-    //   _metadataEntry = super.createTimestampMetadataEntry(_ots);
-    //   // Write the metadata entry to the .zip fi
-    //   await super.finishZipFileData(
-    //     offset, 
-    //     function onOutputBuffer(buffer: Buffer) {
-    //       fs.writeSync(fd, buffer);
-    //     },
-    //     _metadataEntry || undefined
-    //   );
-    //   // Close the .zip file
-    //   fs.closeSync(fd);
-    //   // Delete the existing .zip file if it exists
-    //   if (fs.existsSync(zipFile)) {
-    //     fs.unlinkSync(zipFile);
-    //   }
-    //   // Replace the existing .zip file with the temporary file
-    //   fs.renameSync(_tempZipFile, zipFile);
-    // }
-    /**
-     * Removes specified files from the ZIP archive
-     * Deletes matching ZipEntry objects and rebuilds the archive if any files were removed
-     */
-    deleteFiles(delFiles) {
-        super.getDirectory();
-        let filesDel = 0;
-        delFiles.forEach(fname => {
-            const deleted = super.deleteFile(fname);
-            if (deleted) {
-                console.log('   deleting: ' + fname + "\n");
-                ++filesDel;
-            }
-            else {
-                console.log('   warning: name not found: ' + fname + "\n");
-            }
-        });
-        return filesDel;
-    }
-}
-exports.default = ZipKitServer;

package/dist/shared/ZipKit.d.ts

@@ -1,243 +0,0 @@
-import ZipEntry from './ZipEntry';
-import Errors from './constants/Errors';
-import { LOCAL_HDR, ENCRYPT_HDR_SIZE, CMP_METHOD, CENTRAL_END, CENTRAL_DIR, ZIP64_CENTRAL_END, ZIP64_CENTRAL_DIR, GP_FLAG, TIMESTAMP_SUBMITTED, TIMESTAMP_METADATA, TOKENIZED_METADATA, LOCAL_FILE_HEADER, CENTRAL_FILE_HEADER, CENTRAL_DIRECTORY_END, HDR_ID } from './constants/Headers';
-export { ZipEntry, Errors, CMP_METHOD, TIMESTAMP_METADATA, TIMESTAMP_SUBMITTED, TOKENIZED_METADATA, LOCAL_HDR, ENCRYPT_HDR_SIZE, CENTRAL_END, CENTRAL_DIR, ZIP64_CENTRAL_END, ZIP64_CENTRAL_DIR, GP_FLAG, LOCAL_FILE_HEADER, CENTRAL_FILE_HEADER, CENTRAL_DIRECTORY_END, HDR_ID };
-/**
- * Options for compressing files in a ZIP archive
- */
-export interface CompressOptions {
-    level?: number;
-    password?: string | null;
-    useSHA256?: boolean;
-    useZstd?: boolean;
-}
-/**
- * Callbacks for ZIP file creation process
- */
-export interface CreateZipOptions {
-    onError?: (error: Error) => void;
-    onEntryDone?: (entry: ZipEntry, status: string) => void;
-    onReadEntryData?: (entry: ZipEntry) => Buffer;
-    onOutputBuffer?: (data: Buffer) => void;
-}
-/**
- * Main class for ZIP file operations including compression, extraction, and encryption
- */
-export default class ZipKit {
-    static readonly version: string;
-    static readonly releaseDate: string;
-    private inBuffer;
-    private zipEntries;
-    private sortName;
-    private centralDirSize;
-    private centralDirOffset;
-    private stampEntry;
-    zipComment: string | null;
-    static support: {
-        base64: boolean;
-        array: boolean;
-        string: boolean;
-        isNode: boolean;
-        buffer: boolean;
-        uint8array: boolean;
-        arrayBuffer: boolean;
-        blob: boolean;
-        streams: boolean;
-        fileReader: boolean;
-    };
-    /**
-     * Creates a new ZipKit instance
-     */
-    constructor();
-    /**
-     * Resets all ZIP-related data to initial state
-     */
-    resetZipData(): void;
-    /**
-     * Loads a ZIP file from a buffer
-     * @param inBuf - Buffer containing ZIP file data
-     */
-    loadZip(inBuf: Buffer): void;
-    /**
-     * Tests if data matches the CRC32 checksum
-     * @param entry - ZIP entry to check
-     * @param data - Data buffer to verify
-     * @returns boolean indicating if CRC matches
-     */
-    testCRC32(entry: ZipEntry, data: Buffer): boolean;
-    /**
-     * Tests if data matches the SHA256 hash
-     * @param entry - ZIP entry to check
-     * @param data - Data buffer to verify
-     * @returns boolean indicating if SHA256 matches
-     * @throws Error if entry has no SHA256 hash
-     */
-    testSHA256(entry: ZipEntry, data: Buffer): boolean;
-    /**
-     * Locates and parses the central end directory
-     * @param inBuffer - Buffer containing ZIP file data
-     * @returns Number of entries in ZIP file
-     * @throws Error if central directory is invalid
-     */
-    getCentralEnd(inBuffer: Buffer): number;
-    /**
-     * Creates the central end directory header
-     * @param centralDirSize - Size of central directory
-     * @param centralDirOffset - Offset to central directory
-     * @returns Buffer containing end directory header
-     */
-    centralEndHdr(centralDirSize: number, centralDirOffset: number): Buffer;
-    /**
-     * Reads and parses the ZIP file directory
-     * @param debug - Enable debug logging
-     * @returns Array of ZIP entries
-     */
-    getDirectory(debug?: boolean): ZipEntry[];
-    /**
-     * Gets a ZIP entry by filename
-     * @param fname - Filename to search for
-     * @returns ZipEntry if found, null otherwise
-     */
-    getZipEntry(fname: string): ZipEntry | null;
-    /**
-     * Creates a new ZIP entry
-     * @param fname - Filename for new entry
-     * @param comment - Optional entry comment
-     * @returns Created ZipEntry
-     */
-    createZipEntry(fname: string, comment?: string): ZipEntry;
-    /**
-     * Deletes an entry from the ZIP file
-     * @param fname - Filename to delete
-     * @returns boolean indicating if file was deleted
-     */
-    deleteFile(fname: string): boolean;
-    /**
-     * Parses local header and returns entry data
-     * @param entry - ZIP entry to parse
-     * @param withLocalHdrData - Include header in returned data
-     * @returns Buffer containing entry data
-     * @throws Error if header is invalid
-     */
-    parseLocalHeader(entry: ZipEntry, withLocalHdrData?: boolean): Buffer;
-    /**
-     * Copies an entry's data from source ZIP
-     * @param entry - Entry to copy
-     * @returns Buffer containing entry data with headers
-     */
-    copyEntry(entry: ZipEntry): Buffer;
-    /**
-     * Compresses data for a ZIP entry
-     * @param entry - ZIP entry to compress
-     * @param data - Data to compress
-     * @param options - Compression options
-     * @returns Buffer containing compressed data
-     */
-    compressData(entry: ZipEntry, data: Buffer, options?: CompressOptions): Promise<Buffer>;
-    /**
-     * Compresses data using deflate algorithm
-     * @param inbuf - Data to compress
-     * @param options - Compression options
-     * @returns Compressed data buffer
-     */
-    private deflate;
-    /**
-     * Compresses data using Zstandard (zstd) algorithm
-     * @param inbuf - Data to compress
-     * @param options - Compression options
-     * @returns Compressed data buffer
-     */
-    private zstdCompress;
-    /**
-     * Decompresses data using Zstandard (zstd) algorithm
-     * @param inbuf - Compressed data buffer
-     * @returns Decompressed data buffer
-     */
-    zstdDecompress(inbuf: Buffer): Promise<Buffer>;
-    /**
-     * Creates new Zip data file with the passed ZipEntries
-     * @param cmpOptions - Compression options
-     * @param zipOptions - Create ZIP options
-     * @returns Promise<number> - The offset of the last entry
-     */
-    createZipFileData(cmpOptions?: CompressOptions, zipOptions?: CreateZipOptions): Promise<number>;
-    /**
-     * Finishes Zip data file by adding any Metadata entries and the Central End Directory
-     * @param offset - The current offset in the zip data file
-     * @param onOutputBuffer - The callback function to output the data buffer
-     * @param metaEntry - The Metadata ZipEntry to add to the Zip file
-     */
-    finishZipFileData(offset: number, onOutputBuffer: (data: Buffer) => void, metaEntry?: ZipEntry): Promise<void>;
-    /**
-     * Unzips the data buffer using pako inflate method
-     * @param inbuf - Data buffer to inflate
-     * @returns Inflated data buffer
-     * @throws Error if extraction fails
-     */
-    inflate(inbuf: Buffer): Buffer;
-    /**
-     * Extracts the data from the ZipEntry and returns the data as a Buffer
-     * @param entry - ZIP entry to extract
-     * @param skipHashCheck - Whether to skip hash checking
-     * @returns Buffer containing extracted data or null if extraction fails
-     */
-    extract(entry: ZipEntry, skipHashCheck?: boolean): Promise<Buffer | null>;
-    /**
-     * Decrypts the entry data
-     * @param entry - ZIP entry to decrypt
-     * @param password - Password for decryption
-     * @returns Decrypted data buffer or null if decryption fails
-     */
-    decryptEntry(entry: ZipEntry, password: string): Buffer | null;
-    /**
-     * Checks if a filename is a blockchain metadata file that should be excluded from Merkle Root calculation
-     * @param filename - The filename to check
-     * @returns boolean - True if the file is a metadata file
-     */
-    private isMetadataFile;
-    /**
-     * Calculates the Merkle Root of the ZIP file
-     * Excludes blockchain metadata files (META-INF/*) to ensure consistent calculation
-     * @returns string - The Merkle Root of the ZIP file
-     */
-    getMerkleRoot(): string | null;
-    /**
-     * Checks if a ZIP file contains valid timestamp metadata
-     * @returns { merkleRoot: string | null, ots: Buffer | null }
-     * Returns the merkle root hash and timestamp metadata if found, null otherwise
-     */
-    checkForTimestamp(): string | null;
-    /**
-     * Gets the OTS from the timestamp metadata entry
-     * @returns Promise<Buffer | null> - The OTS from the timestamp metadata entry or null if not found
-     */
-    getOts(): Promise<Buffer | null>;
-    /**
-     * Sets the ZIP file comment
-     * @param msg - Comment to set
-     */
-    setZipComment(msg: string | null): void;
-    /**
-     * Gets the ZIP file comment
-     * @returns string | null - The ZIP file comment
-     */
-    getZipComment(): string | null;
-    /**
-     * Converts the compression method to a string
-     * @param cmpMethod - Compression method number
-     * @returns string - Compression method as a string
-     */
-    cmpMethodToString(cmpMethod: number): string;
-    /**
-     * Ensures ZIP entries are loaded
-     * @returns Array of ZIP entries
-     * @throws Error if no ZIP entries are loaded
-     */
-    private ensureZipEntries;
-    /**
-     * Ensures ZIP data buffer is loaded
-     * @returns Buffer containing ZIP data
-     * @throws Error if no ZIP data is loaded
-     */
-    private ensureBuffer;
-}