neozipkit 0.1.1 → 0.2.1

package/src/server/ZipKitServer.ts

@@ -0,0 +1,305 @@
+/**
+ * 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 * as fs from 'fs';
+import * as path from 'path';
+import { v4 as uuidv4 } from 'uuid';
+import { exit } from 'process';
+
+import ZipKit,{ CompressOptions, ZipEntry, TIMESTAMP_METADATA, TIMESTAMP_SUBMITTED, CMP_METHOD } from '../shared/ZipKit';
+import * as Headers from '../shared/constants/Headers';
+import { upgradeOTS as upgradeZipOts, createCertificateOts as createCertificateOtsFile, createOtsMetadataEntry } from '../blockchain/ZipKitOTS';
+
+// Re-export everything from ZipKit
+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() {
+    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: string): void {
+    let inBuffer: Buffer | null = null;
+    let fdIn: number | null = 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 as Buffer, 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: 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: string): void {
+    try {
+      // Check if the file exists before trying to read it
+      if (!fs.existsSync(zipFile)) {
+        console.error(`Error: Zip file "${zipFile}" does not exist`);
+        exit(1);
+      }
+      
+      const inBuffer = fs.readFileSync(zipFile);
+      super.loadZip(inBuffer);
+    } catch (error) {
+      console.error(`Error: Failed to read zip file "${zipFile}"`);
+      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: string, freshen: boolean = false, update: boolean = false): void {
+    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: string[], freshen: boolean = false, update: boolean = 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: 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}`);
+      } 
+    });
+    
+    // Write the metadata entry to the .zip fi
+    await super.finishZipFileData(
+      offset, 
+      function onOutputBuffer(buffer: 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: string[]): number {
+
+    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;
+  }
+}

package/src/shared/ZipEntry.ts

@@ -27,7 +27,7 @@ const VER_EXTRACT = 10;                             // Version needed to extract
  * Class representing a single entry (file or directory) within a ZIP archive
  */
 export default class ZipEntry implements ZipFileEntry {
-  debug = true;
+  debug = false;
 
   verMadeBy: number = 0;        // Read Version Made By
   verExtract: number = 0;       // Read Version Needed to Extract

package/src/shared/ZipKit.ts

@@ -459,7 +459,7 @@ export default class ZipKit {
 
     if (options?.useSHA256) {
       entry.sha256 = sha256(data);
-      console.log('SHA256: ', entry.sha256);
+      // console.log('SHA256: ', entry.sha256);
     };
 
     if (options?.password) {
@@ -827,24 +827,6 @@ export default class ZipKit {
     return ots;
   }
 
-  /**
-   * Creates a new timestamp metadata entry for the ZIP file
-   * Calculates merkle root from file hashes and obtains blockchain timestamp
-   * @returns Promise<ZipEntry | null> The created timestamp metadata entry or null if failed
-   */
-  createTimestampMetadataEntry(ots: Buffer | null): ZipEntry | null {
-    if (!ots) return null;
-    const tsEntry = this.createZipEntry(TIMESTAMP_SUBMITTED);
-    tsEntry.crc = crc32(ots);
-    tsEntry.uncompressedSize = ots.length;
-    tsEntry.compressedSize = ots.length;
-    tsEntry.cmpMethod = CMP_METHOD.STORED;
-    tsEntry.fileBuffer = ots;
-    tsEntry.isMetaData = true;
-
-    return tsEntry;
-  }
-
   /**
    * Sets the ZIP file comment
    * @param msg - Comment to set

package/src/shared/types.ts

@@ -1,4 +1,4 @@
-import { VERSION } from './version';
+import { NEOZIPKIT_VERSION, NEOZIPKIT_RELEASE_DATE } from './version';
 
 export interface FileData {
   name: string;
@@ -38,6 +38,6 @@ export interface NeoZipKitInfo {
 }
 
 export const NEOZIPKIT_INFO: NeoZipKitInfo = {
-  version: VERSION.number,
-  releaseDate: VERSION.date
+  version: NEOZIPKIT_VERSION,
+  releaseDate: NEOZIPKIT_RELEASE_DATE
 };

package/src/shared/version.ts

@@ -1,4 +1,3 @@
-export const VERSION = {
-  number: '0.1.51',
-  date: '04-17-2025'
-}; 
+// Global-style constants for easy import across the package
+export const NEOZIPKIT_VERSION = '0.1.2';
+export const NEOZIPKIT_RELEASE_DATE = '08-12-2025';

package/src/types/modules.d.ts

@@ -3,6 +3,16 @@ declare module 'pako' {
   export function inflateRaw(data: Uint8Array | Buffer): Buffer;
 }
 
+// Minimal typings to satisfy TS in environments without @types/moment-timezone
+declare module 'moment' {
+  const moment: any;
+  export default moment;
+}
+declare module 'moment-timezone' {
+  const momentTz: any;
+  export default momentTz;
+}
+
 declare module 'opentimestamps' {
   export class Ops {
     static OpSHA256: any;
@@ -19,4 +29,4 @@ declare module 'opentimestamps' {
   export function upgrade(ots: DetachedTimestampFile): Promise<boolean>;
   export function verify(ots: DetachedTimestampFile, hash: DetachedTimestampFile, options?: any): Promise<any>;
   export function info(detached: DetachedTimestampFile): string;
-} 
+}

package/contracts/Lock.sol

@@ -1,34 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity ^0.8.28;
-
-// Uncomment this line to use console.log
-// import "hardhat/console.sol";
-
-contract Lock {
-    uint public unlockTime;
-    address payable public owner;
-
-    event Withdrawal(uint amount, uint when);
-
-    constructor(uint _unlockTime) payable {
-        require(
-            block.timestamp < _unlockTime,
-            "Unlock time should be in the future"
-        );
-
-        unlockTime = _unlockTime;
-        owner = payable(msg.sender);
-    }
-
-    function withdraw() public {
-        // Uncomment this line, and the import of "hardhat/console.sol", to print a log in your terminal
-        // console.log("Unlock time is %o and block timestamp is %o", unlockTime, block.timestamp);
-
-        require(block.timestamp >= unlockTime, "You can't withdraw yet");
-        require(msg.sender == owner, "You aren't the owner");
-
-        emit Withdrawal(address(this).balance, block.timestamp);
-
-        owner.transfer(address(this).balance);
-    }
-}

package/contracts/compile-contract.js

@@ -1,168 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Contract Compilation Helper for NZIP
- * 
- * This script helps compile the NZIP-NFT.sol contract
- * Usage: node compile-contract.js
- */
-
-const fs = require('fs');
-const path = require('path');
-
-const readline = require('readline');
-
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout
-});
-
-console.log('🔧 NZIP Contract Compilation Helper');
-console.log('===================================\n');
-
-const contractPath = path.join(__dirname, 'src/NZIP-NFT.sol');
-const deployPath = path.join(__dirname, 'deploy/deploy-public-contract.js');
-
-if (!fs.existsSync(contractPath)) {
-  console.log('❌ Contract file not found:', contractPath);
-  process.exit(1);
-}
-
-console.log('📋 Choose your compilation method:\n');
-console.log('1️⃣  Remix IDE (Online) - RECOMMENDED');
-console.log('2️⃣  Remix IDE (Step-by-Step Guide) - NEW!');
-console.log('3️⃣  Local Hardhat (Advanced)');
-console.log('4️⃣  View Deprecated Contract Info');
-console.log('5️⃣  View Contract Source Code');
-console.log('6️⃣  Exit\n');
-
-rl.question('Enter your choice (1-6): ', (choice) => {
-  console.log('');
-  
-  switch(choice.trim()) {
-    case '1':
-      showRemixInstructions();
-      break;
-    case '2':
-      showRemixGuide();
-      break;
-    case '3':
-      showHardhatInstructions();
-      break;
-    case '4':
-      showDeprecatedInfo();
-      break;
-    case '5':
-      showContractSource();
-      break;
-    case '6':
-      console.log('👋 Goodbye!');
-      rl.close();
-      return;
-    default:
-      console.log('❌ Invalid choice. Please run the script again and choose 1-6.');
-      rl.close();
-      return;
-  }
-  
-  rl.close();
-});
-
-function showRemixInstructions() {
-  console.log('🌐 Remix IDE Compilation (RECOMMENDED)');
-  console.log('======================================\n');
-  console.log('📋 Steps:');
-  console.log('1. Go to https://remix.ethereum.org');
-  console.log('2. Create new file: NZIP-NFT.sol');
-  console.log('3. Copy contract content (run with option 5 to see source)');
-  console.log('4. Install OpenZeppelin dependencies');
-  console.log('5. Compile with Solidity 0.8.19+');
-  console.log('6. Copy bytecode and ABI from compilation artifacts');
-  console.log('7. Update deployment script with compiled data\n');
-  
-  console.log('🎯 After compilation:');
-  console.log('• Update CONTRACT_BYTECODE in deploy-public-contract.js');
-  console.log('• Update CONTRACT_ABI in deploy-public-contract.js');
-  console.log('• Run: npm run deploy:public');
-}
-
-function showRemixGuide() {
-  console.log('📋 Remix IDE Step-by-Step Guide');
-  console.log('===============================\n');
-  console.log('For a detailed, interactive walkthrough of the entire Remix compilation process:');
-  console.log('');
-  console.log('🎯 Run this command:');
-  console.log('npm run remix-compile\n');
-  
-  console.log('✨ This dedicated guide will:');
-  console.log('• Walk you through each step interactively');
-  console.log('• Show you exactly what to do in Remix');
-  console.log('• Display the contract source when needed');
-  console.log('• Guide you through extracting bytecode and ABI');
-  console.log('• Help you update the deployment script');
-  console.log('• Prepare you for deployment\n');
-  
-  console.log('💡 Perfect for first-time users or when you need detailed guidance!');
-}
-
-function showHardhatInstructions() {
-  console.log('💻 Local Hardhat Compilation (Advanced)');
-  console.log('=======================================\n');
-  console.log('📋 Setup Steps:');
-  console.log('1. npm install --save-dev hardhat @nomiclabs/hardhat-ethers ethers @openzeppelin/contracts');
-  console.log('2. npx hardhat init');
-  console.log('3. Copy contract to contracts/ folder');
-  console.log('4. npx hardhat compile');
-  console.log('5. Extract bytecode and ABI from artifacts/\n');
-  
-  console.log('📁 Artifact Location:');
-  console.log('• Bytecode: artifacts/contracts/NZIP-NFT.sol/ZipFileNFT.json');
-  console.log('• Look for "bytecode" and "abi" fields in the JSON file\n');
-  
-  console.log('🎯 After compilation:');
-  console.log('• Update CONTRACT_BYTECODE in deploy-public-contract.js');
-  console.log('• Update CONTRACT_ABI in deploy-public-contract.js');
-  console.log('• Run: npm run deploy:public');
-}
-
-function showDeprecatedInfo() {
-  console.log('⚠️  Deprecated Contract Notice');
-  console.log('=============================\n');
-  console.log('Previous contract is now DEPRECATED:');
-  console.log('Address: 0xb78CB3bcC788fca38c731b1E9D70CF60b04CA015');
-  console.log('Network: Base Sepolia');
-  console.log('Status: ❌ DEPRECATED - Do not use\n');
-  
-  console.log('🚨 Why it\'s deprecated:');
-  console.log('• Had broken block hash storage (always returned 0)');
-  console.log('• Missing input validation');
-  console.log('• Lacked proper version tracking\n');
-  
-  console.log('✅ New contract fixes:');
-  console.log('• Removed unreliable block hash storage');
-  console.log('• Added comprehensive input validation');
-  console.log('• Version 2.0 with proper documentation');
-  console.log('• Improved error handling\n');
-  
-  console.log('📋 Action Required:');
-  console.log('You MUST compile and deploy a new contract!');
-}
-
-function showContractSource() {
-  console.log('📄 NZIP NFT Contract v2.0 Source Code');
-  console.log('=====================================\n');
-  console.log('Copy this code to your compilation environment:\n');
-  
-  try {
-    const contractContent = fs.readFileSync(contractPath, 'utf8');
-    console.log(contractContent);
-  } catch (err) {
-    console.log('❌ Error reading contract:', err.message);
-  }
-  
-  console.log('\n🎯 Next Steps:');
-  console.log('1. Copy the contract code above');
-  console.log('2. Use Remix IDE or Hardhat to compile');
-  console.log('3. Update deployment script with compiled bytecode/ABI');
-  console.log('4. Deploy with: npm run deploy:public');
-}