NeoZipKit Developer Documentation

import { ZipkitBrowser } from 'neozipkit/browser';
import { CompressOptions } from 'neozipkit';

const zipKit = new ZipkitBrowser();
const options: CompressOptions = {
  useZstd: false, // Use deflate compression
  level: 6
};

// Add files to ZIP
await zipKit.addFile('example.txt', fileBuffer, options);
const zipBuffer = await zipKit.finalize();

import { ZipkitServer } from 'neozipkit/server';

const zip = new ZipkitServer();

// Load ZIP from file
await zip.loadZipFile('archive.zip');

// Extract entry to file
const entry = zip.getZipEntry('document.pdf');
await zip.extractToFile(entry, './output/document.pdf');

// Extract all entries
await zip.extractAll('./output', {
  preservePaths: true,
  onProgress: (entry, bytes) => {
    console.log(`Extracted ${entry.filename}: ${bytes} bytes`);
  }
});

// Close file handle when done
await zip.closeFile();

import { ZipkitBrowser } from 'neozipkit/browser';
import { ZipEntry } from 'neozipkit';

const zipKit = new ZipkitBrowser();
// IMPORTANT: You must call loadZipBlob() first to populate zipEntries[]
const entries: ZipEntry[] = await zipKit.loadZipBlob(zipBlob);

// Verify file integrity
for (const entry of entries) {
  const isValid = await zipKit.verifyEntry(entry);
  console.log(`${entry.filename}: ${isValid ? 'Valid' : 'Invalid'}`);
}

import { createTimestamp, verifyOts } from 'neozipkit/blockchain';

// Create timestamp for ZIP file
const timestampResult = await createTimestamp(zipFileBuffer);

// Verify timestamp
const isValid = await verifyOts(timestampResult.otsData, zipFileHash);

import { ZipkitMinterBrowser, WalletManagerBrowser } from 'neozipkit';
import { getContractConfig } from 'neozipkit/blockchain/core/contracts';

// Initialize wallet manager
const walletManager = new WalletManagerBrowser();
await walletManager.connect();

// Initialize minter
const minter = new ZipkitMinterBrowser(walletManager);
const networkConfig = getContractConfig(8453); // Base Mainnet

// Mint NFT for ZIP file
const result = await minter.mintZipFile({
  zipFileBuffer: zipBuffer,
  merkleRoot: hash,
  ipfsHash: ipfsHash,
  metadataURI: metadataURI
}, networkConfig);

import { ZipkitVerifierBrowser } from 'neozipkit';
import { getContractConfig } from 'neozipkit/blockchain/core/contracts';

const verifier = new ZipkitVerifierBrowser();
const networkConfig = getContractConfig(8453);

// Verify tokenized ZIP file
const verification = await verifier.verifyZipFile(
  zipFileBuffer,
  tokenId,
  networkConfig
);

if (verification.isValid) {
  console.log('ZIP file is valid and tokenized');
}