neozipkit 0.2.1 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neozipkit",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "NeoZipKit - Advanced ZIP file creation and verification with blockchain timestamping",
   "main": "index.js",
   "types": "index.d.ts",
@@ -25,21 +25,32 @@
       "types": "./dist/browser/*.d.ts",
       "default": "./dist/browser/*.js"
     },
-    "./server": {
-      "types": "./dist/server/index.d.ts",
-      "default": "./dist/server/index.js"
+    "./browser-esm": {
+      "types": "./dist/browser-esm/index.d.ts",
+      "import": "./dist/browser-esm/index.js"
     },
-    "./server/*": {
-      "types": "./dist/server/*.d.ts",
-      "default": "./dist/server/*.js"
+    "./browser-umd": {
+      "types": "./dist/browser-umd/index.d.ts",
+      "import": "./dist/browser-umd/index.js",
+      "require": "./dist/browser-umd/index.js"
     },
-    "./server/blockchain/*": {
-      "types": "./dist/server/blockchain/*.d.ts",
-      "default": "./dist/server/blockchain/*.js"
+    "./node": {
+      "types": "./dist/node/index.d.ts",
+      "import": "./dist/node/index.js",
+      "require": "./dist/node/index.js",
+      "default": "./dist/node/index.js"
     },
-    "./server/platform/*": {
-      "types": "./dist/server/platform/*.d.ts",
-      "default": "./dist/server/platform/*.js"
+    "./node/*": {
+      "types": "./dist/node/*.d.ts",
+      "default": "./dist/node/*.js"
+    },
+    "./node/blockchain/*": {
+      "types": "./dist/node/blockchain/*.d.ts",
+      "default": "./dist/node/blockchain/*.js"
+    },
+    "./node/platform/*": {
+      "types": "./dist/node/platform/*.d.ts",
+      "default": "./dist/node/platform/*.js"
     },
     "./shared": {
       "types": "./dist/shared/index.d.ts",
@@ -64,27 +75,90 @@
     "./blockchain/*": {
       "types": "./dist/blockchain/*.d.ts",
       "default": "./dist/blockchain/*.js"
+    },
+    "./src": {
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    },
+    "./src/*": {
+      "types": "./src/*.ts",
+      "default": "./src/*.ts"
+    },
+    "./src/node": {
+      "types": "./src/node/index.ts",
+      "default": "./src/node/index.ts"
+    },
+    "./src/node/*": {
+      "types": "./src/node/*.ts",
+      "default": "./src/node/*.ts"
+    },
+    "./src/blockchain": {
+      "types": "./src/blockchain/index.ts",
+      "default": "./src/blockchain/index.ts"
+    },
+    "./src/blockchain/*": {
+      "types": "./src/blockchain/*.ts",
+      "default": "./src/blockchain/*.ts"
+    },
+    "./src/components/*": {
+      "types": "./src/components/*.ts",
+      "default": "./src/components/*.ts"
     }
   },
   "files": [
     "dist/",
     "src/",
-    "contracts/",
+    "contracts/ABI.txt",
+    "contracts/Bytecode.txt",
+    "contracts/COMPILATION_NOTES.md",
+    "contracts/README.md",
+    "contracts/QUICK_DEPLOY.md",
+    "contracts/VERIFICATION.md",
+    "contracts/deploy-interactive.js",
+    "contracts/deployment-*.json",
+    "contracts/hardhat.config.js",
+    "contracts/package.json",
+    "contracts/src/",
+    "contracts/scripts/",
     "examples/",
     "README.md",
-    "PACKAGE_STRUCTURE.md",
-    "BLOCKCHAIN_INTEGRATION.md",
-    "TYPESCRIPT_WORKFLOW.md"
+    "LICENSE"
   ],
   "scripts": {
-    "clean": "rm -rf dist/ && find . -maxdepth 1 -name '*.js' -delete && find . -maxdepth 1 -name '*.d.ts' -delete && rm -rf components constants platform types blockchain",
+    "clean": "node scripts/clean.js",
     "compile": "tsc",
-    "create-browser-entry": "cp dist/browser-index.js dist/browser.js && cp dist/browser-index.d.ts dist/browser.d.ts",
-    "build": "npm run clean && npm run compile && npm run create-browser-entry",
+    "create-browser-entry": "node scripts/create-browser-entry.js",
+    "build": "npm run clean && npm run compile && npm run create-browser-entry && npm run build:browser",
+    "build:browser": "npm run build:browser:esm && npm run build:browser:umd",
+    "build:browser:esm": "node scripts/build-browser-bundle.js --esm",
+    "build:browser:umd": "node scripts/build-browser-bundle.js --umd",
     "watch": "tsc --watch",
-    "test": "echo \"No tests specified\" && exit 0",
+    "dev:clean": "node scripts/dev-clean.js",
+    "dev:compile": "tsc --project tsconfig.dev.json",
+    "dev:create-browser-entry": "node scripts/dev-create-browser-entry.js",
+    "dev:build": "npm run dev:clean && npm run dev:compile && npm run dev:create-browser-entry",
+    "dev:watch": "tsc --project tsconfig.dev.json --watch",
+    "build:auto": "node scripts/auto-build.js",
+    "build:ci": "node scripts/check-branch.js && npm run clean && npm run compile && npm run create-browser-entry && npm run build:browser",
+    "test": "jest",
+    "test:unit": "jest tests/unit",
+    "test:examples": "npx ts-node scripts/test-examples.ts",
+    "test:all": "npm run test:unit && npm run test:examples",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "example:create-zip": "npx ts-node examples/create-zip.ts",
+    "example:extract-zip": "npx ts-node examples/extract-zip.ts",
+    "example:list-zip": "npx ts-node examples/list-zip.ts",
+    "example:blockchain-tokenize": "npx ts-node examples/blockchain-tokenize.ts",
+    "example:verify-tokenized-zip": "npx ts-node examples/verify-tokenized-zip.ts",
+    "check:nft": "npx ts-node scripts/check-nft.ts",
     "deploy:base": "node contracts/deploy-bytecode.mjs",
-    "deploy:base:sepolia": "NETWORK=base-sepolia node contracts/deploy-bytecode.mjs"
+    "deploy:base:sepolia": "NETWORK=base-sepolia node contracts/deploy-bytecode.mjs",
+    "version": "node scripts/update-version.js",
+    "version:set": "node scripts/update-version.js",
+    "version:patch": "node scripts/update-version.js patch",
+    "version:minor": "node scripts/update-version.js minor",
+    "version:major": "node scripts/update-version.js major"
   },
   "keywords": [
     "zip",
@@ -107,13 +181,22 @@
   "homepage": "https://github.com/NeoWareInc/neozipkit#readme",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^20.0.0",
+    "@openzeppelin/contracts": "^5.4.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.3.1",
     "@types/pako": "^2.0.3",
     "@types/uuid": "^9.0.0",
+    "dotenv": "^17.2.3",
+    "esbuild": "^0.19.12",
+    "hardhat": "^3.0.15",
+    "jest": "^30.2.0",
+    "minimatch": "^10.1.1",
+    "ts-jest": "^29.4.6",
     "typescript": "^5.0.0"
   },
   "dependencies": {
     "@oneidentity/zstd-js": "^1.0.3",
+    "buffer": "^6.0.3",
     "ethers": "^6.0.0",
     "opentimestamps": "^0.4.9",
     "pako": "^2.1.0",
@@ -123,5 +206,6 @@
   "peerDependencies": {
     "ethers": "^6.0.0",
     "web3": "^4.0.0"
-  }
+  },
+  "packageManager": "yarn@4.9.2+sha512.1fc009bc09d13cfd0e19efa44cbfc2b9cf6ca61482725eb35bbc5e257e093ebf4130db6dfe15d604ff4b79efd8e1e8e99b25fa7d0a6197c9f9826358d4d65c3c"
 }

package/src/blockchain/README.md

@@ -10,22 +10,25 @@ This directory provides all blockchain-related functionality for NeoZipKit, incl
 
 ```
 src/blockchain/
-├── contracts.ts             # Contract ABI + network configs + addresses
-├── ZipKitOTS.ts             # OpenTimestamps utilities
-├── TokenVerifier.ts         # ZIP tokenization verification
-├── TokenQuerier.ts          # Blockchain token queries
-├── NFTMinter.ts             # NFT minting operations
-├── WalletManager.ts         # Wallet connection management
-├── WalletAnalyzer.ts        # Wallet token analysis
-├── (removed)                # Token display formatting (deprecated)
-├── ZipMetadata.ts           # ZIP metadata validation
-├── ZipKitMinter.ts          # High-level minting interface
-├── ZipKitVerifier.ts        # High-level verification interface
-├── ZipKitNFT.ts             # Unified NFT facade (minter + verifier)
-├── ZipKitWallet.ts          # Wallet setup + WalletAnalyzer utilities (combined)
-├── ZipTokenProcessor.ts     # Token processing utilities
-├── types.ts                 # Shared blockchain types
-└── index.ts                 # Module exports
+├── core/                    # Core blockchain functionality
+│   ├── WalletManager.ts     # CoreWalletManager - platform-agnostic wallet operations
+│   ├── ZipkitMinter.ts      # Core minting functionality
+│   ├── ZipkitVerifier.ts    # Core verification functionality
+│   ├── ZipkitOTS.ts         # OpenTimestamps utilities
+│   ├── contracts.ts         # Contract ABI + network configs + addresses
+│   ├── types.ts             # Shared blockchain types
+│   └── index.ts             # Core exports
+├── browser/                 # Browser-specific implementations
+│   ├── WalletManagerBrowser.ts    # Browser wallet management
+│   ├── ZipkitMinterBrowser.ts     # Browser minting
+│   ├── TokenVerifierBrowser.ts    # Browser token verification
+│   └── index.ts             # Browser exports
+├── server/                  # Server-specific implementations
+│   ├── WalletManagerServer.ts     # Server wallet management with file system
+│   ├── ZipkitMinterServer.ts      # Server minting
+│   ├── ZipkitVerifierServer.ts    # Server verification
+│   └── index.ts             # Server exports
+└── index.ts                 # Main module exports
 ```
 
 ### Package Entry
@@ -34,10 +37,11 @@ Import from the package root or from `src/blockchain` directly:
 ```ts
 // Yes! You can import directly from the blockchain directory
 import { 
-  ZipMetadata,
-  ZipKitMinter,
-  ZipKitVerifier,
-  ZipKitWallet,
+  ZipkitMinter,
+  ZipkitVerifier,
+  CoreWalletManager,
+  WalletManagerServer,
+  WalletManagerBrowser,
   WalletAnalyzer,
   CONTRACT_CONFIGS,
   NZIP_CONTRACT_ABI,
@@ -45,30 +49,23 @@ import {
 } from 'neozipkit/blockchain';
 
 // Or from the main package (re-exports everything from blockchain)
-import { ZipMetadata, ZipKitMinter, ZipKitVerifier, ZipKitWallet, WalletAnalyzer } from 'neozipkit';
+import { ZipkitMinter, ZipkitVerifier, CoreWalletManager, WalletAnalyzer } from 'neozipkit';
 
 // From source (monorepo/local development)
-import { ZipMetadata, ZipKitMinter, ZipKitVerifier, ZipKitWallet, WalletAnalyzer } from '../src/blockchain';
+import { ZipkitMinter, ZipkitVerifier, CoreWalletManager, WalletAnalyzer } from '../src/blockchain';
 ```
 
-### Unified NFT APIs (ZipKitNFT.ts)
+### Direct NFT APIs
 
-Prefer the unified entry point for minting and verification:
+Use the individual classes directly for minting and verification:
 
 ```ts
-import { ZipKitNFT, ZipKitNFTMinter, ZipKitNFTVerifier } from 'neozipkit/blockchain';
-
-// Facade usage
-const nft = new ZipKitNFT({
-  archiveName: 'archive.zip',
-  merkleRoot: 'abc123...',
-  mintingOptions: { walletPrivateKey: '0x...', network: 'base-sepolia' },
-  verificationOptions: { debug: false }
-});
-
-// Or use classes directly
-const minter = new ZipKitNFTMinter('archive.zip', 'abc123...', { walletPrivateKey: '0x...', network: 'base-sepolia' });
-const verifier = new ZipKitNFTVerifier({ debug: false });
+import { ZipkitMinter, ZipkitVerifier, CoreWalletManager } from 'neozipkit/blockchain';
+
+// Use classes directly
+const walletManager = new CoreWalletManager();
+const minter = new ZipkitMinter('archive.zip', 'abc123...', { walletPrivateKey: '0x...', network: 'base-sepolia' });
+const verifier = new ZipkitVerifier({ debug: false });
 ```
 
 ### OpenTimestamps (ZipKitOTS.ts)
@@ -98,9 +95,7 @@ Bitcoin blockchain timestamping utilities for ZIP file integrity verification.
 - `parseVerifyResult(verifyResult: TimestampResult): Promise<TimestampInfo>`
   - Parses timestamp verification result into readable information. Formats blockchain attestation data with human-readable messages and dates.
 
-**Certificate & Upgrade:**
-- `createCertificateOts(fileName: string, zipEntries: ZipEntry[], timestampResult: TimestampResult): Promise<string>`
-  - Creates an HTML certificate for OpenTimestamps verification. Generates a certificate file documenting the timestamp verification results.
+**Upgrade:**
 - `upgradeOTS(zipFilePath: string, upgradedOts: Buffer): Promise<void>`
   - Upgrades OpenTimestamps proof in an existing ZIP file. Replaces old timestamp metadata with upgraded OTS proof data.
 - `createOtsMetadataEntry(zipKit: any, ots: Buffer | null): any | null`
@@ -184,40 +179,39 @@ All contract-related constants and configurations in one place:
 ### Token Verification (ZipKitVerifier.ts)
 - High-level verification API for NZIP‑NFT contract and on-chain checks.
 
-### Token Query (TokenQuerier.ts)
-- `queryBlockchainForExistingToken(merkleRoot: string, networkName: string): Promise<ExistingTokenInfo | null>`
-- `queryWalletTokens(address: string, networkName: string, options?: TokenQueryOptions): Promise<ExistingTokenInfo[]>`
-  - `TokenQueryOptions` include pagination/filters as implemented in the module.
-
-Re‑exports (index.ts):
-- `queryBlockchainForExistingToken`, `queryWalletTokens`, `ExistingTokenInfo`, `TokenQueryOptions`.
-
-### Wallet Manager (WalletManager.ts)
-- `class WalletManager`
-  - Handles provider, signer, and basic transaction flows for the library’s contract interactions.
+### Token Query
+Token querying functionality is integrated into the core wallet and verification classes:
+- `CoreWalletManager.queryWalletTokens()` - Query tokens for a wallet address
+- `ZipkitVerifier.queryBlockchainForExistingToken()` - Query for existing tokens by merkle root
 
-Re‑exports (index.ts):
-- `WalletManager`.
+### Wallet Management
+- `class CoreWalletManager`: Platform-agnostic wallet operations (core functionality)
+- `class WalletManagerServer`: Server-specific wallet management with file system operations
+- `class WalletManagerBrowser`: Browser-specific wallet management with provider connections
+- `class WalletAnalyzer`: Analyze balances, scan NZIP tokens, ERC‑20s and NFTs.
+- Types re‑exported: `TokenInfo`, `NZipTokenDetails`, `WalletBasicInfo`, `TokenScanResult`, `CommonTokenConfig`.
 
-### NFT Minting (ZipKitMinter.ts)
+### NFT Minting (ZipkitMinter.ts)
 - High‑level minting API for NZIP‑NFT contract.
+- Core functionality in `core/ZipkitMinter.ts`
+- Browser-specific implementation in `browser/ZipkitMinterBrowser.ts`
+- Server-specific implementation in `server/ZipkitMinterServer.ts`
 
-### Wallets (ZipKitWallet.ts)
-- `class ZipKitWallet`: Create/load/connect wallets and providers.
-- `class WalletAnalyzer`: Analyze balances, scan NZIP tokens, ERC‑20s and NFTs.
-- Types re‑exported: `TokenInfo`, `NZipTokenDetails`, `WalletBasicInfo`, `TokenScanResult`, `CommonTokenConfig`.
+### NFT Verification (ZipkitVerifier.ts)
+- High‑level verification API for NZIP‑NFT contract.
+- Core functionality in `core/ZipkitVerifier.ts`
+- Browser token verification in `browser/TokenVerifierBrowser.ts`
+- Server-specific implementation in `server/ZipkitVerifierServer.ts`
 
   - Helpers to format token and wallet data for display.
 
 Re‑exports (index.ts):
 Wallet formatting helpers have been removed. Use your app's UI layer for presentation formatting.
 
-### ZIP Metadata Helpers (ZipMetadata.ts)
-- `class ZipMetadata`
-  - Validation and rendering helpers for token metadata embedded in ZIPs.
-
-Re‑exports (index.ts):
-- `ZipMetadata`.
+### ZIP Metadata Helpers
+ZIP metadata functionality is integrated into the core ZIP handling classes:
+- Token metadata validation and processing is handled by `ZipkitMinter` and `ZipkitVerifier`
+- Metadata entries are managed through the core ZIP utilities
 
 ### Module Types (types.ts)
 Exports shared types used across blockchain operations, including:
@@ -225,5 +219,4 @@ Exports shared types used across blockchain operations, including:
 
 ### Notes
 - All OTS utilities suppress verbose logs by default. Pass `{ debug: true }` to see OpenTimestamps logs.
-- Contract addresses vary per network; see `CONTRACT_ADDRESSES` and keep them updated after deployments.
-
+- Contract addresses vary per network; see `CONTRACT_CONFIGS` and keep them updated after deployments.