neozip-cli 0.70.0-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/CHANGELOG.md +72 -0
  2. package/DOCUMENTATION.md +194 -0
  3. package/LICENSE +22 -0
  4. package/README.md +504 -0
  5. package/WHY_NEOZIP.md +212 -0
  6. package/bin/neolist +16 -0
  7. package/bin/neounzip +16 -0
  8. package/bin/neozip +15 -0
  9. package/dist/neozipkit-bundles/blockchain.js +13091 -0
  10. package/dist/neozipkit-bundles/browser.js +5733 -0
  11. package/dist/neozipkit-bundles/core.js +3766 -0
  12. package/dist/neozipkit-bundles/server.js +14996 -0
  13. package/dist/neozipkit-wrappers/blockchain/core/contracts.js +16 -0
  14. package/dist/neozipkit-wrappers/blockchain/index.js +2 -0
  15. package/dist/neozipkit-wrappers/core/ZipDecompress.js +2 -0
  16. package/dist/neozipkit-wrappers/core/components/HashCalculator.js +2 -0
  17. package/dist/neozipkit-wrappers/core/components/Logger.js +2 -0
  18. package/dist/neozipkit-wrappers/core/constants/Errors.js +2 -0
  19. package/dist/neozipkit-wrappers/core/constants/Headers.js +2 -0
  20. package/dist/neozipkit-wrappers/core/encryption/ZipCrypto.js +7 -0
  21. package/dist/neozipkit-wrappers/core/index.js +3 -0
  22. package/dist/neozipkit-wrappers/index.js +13 -0
  23. package/dist/neozipkit-wrappers/server/index.js +2 -0
  24. package/dist/src/config/ConfigSetup.js +455 -0
  25. package/dist/src/config/ConfigStore.js +373 -0
  26. package/dist/src/config/ConfigWizard.js +453 -0
  27. package/dist/src/config/WalletConfig.js +372 -0
  28. package/dist/src/exit-codes.js +210 -0
  29. package/dist/src/index.js +141 -0
  30. package/dist/src/neolist.js +1194 -0
  31. package/dist/src/neounzip.js +2177 -0
  32. package/dist/src/neozip/CommentManager.js +240 -0
  33. package/dist/src/neozip/blockchain.js +383 -0
  34. package/dist/src/neozip/createZip.js +2273 -0
  35. package/dist/src/neozip/file-operations.js +920 -0
  36. package/dist/src/neozip/types.js +6 -0
  37. package/dist/src/neozip/user-interaction.js +256 -0
  38. package/dist/src/neozip/utils.js +96 -0
  39. package/dist/src/neozip.js +785 -0
  40. package/dist/src/server/CommentManager.js +240 -0
  41. package/dist/src/version.js +59 -0
  42. package/env.example +101 -0
  43. package/package.json +175 -0
package/WHY_NEOZIP.md ADDED
@@ -0,0 +1,212 @@
1
+ # Why NeoZip?
2
+
3
+ ## A New Generation of Archive Applications
4
+
5
+ NeoZip CLI represents the first release of a new generation of archive applications that integrate blockchain technology for data integrity, authenticity, and provenance. While maintaining near-perfect compatibility with traditional ZIP utilities, NeoZip introduces revolutionary capabilities that transform archives from simple containers into cryptographically verifiable, blockchain-anchored data structures.
6
+
7
+ For more information, visit [https://neozip.io](https://neozip.io).
8
+
9
+ ## The Problem with Traditional Archives
10
+
11
+ Traditional ZIP files have served us well for decades, but they have fundamental limitations:
12
+
13
+ - **No Cryptographic Proof**: Traditional ZIPs lack cryptographic proof of integrity. You can't verify that an archive hasn't been tampered with without external verification systems.
14
+ - **No Authenticity Verification**: There's no built-in way to verify that an archive is authentic or that it was created by a specific party.
15
+ - **No Immutable Record**: Archive creation and modification history can be lost or altered. There's no permanent, immutable record of when or how an archive was created.
16
+ - **Limited Provenance Tracking**: Tracking the origin and history of archived data requires external systems and manual processes.
17
+
18
+ These limitations become critical in scenarios where data integrity, authenticity, and provenance matter—legal documentation, software distribution, digital preservation, and compliance requirements.
19
+
20
+ ## The NeoZip Solution
21
+
22
+ NeoZip solves these problems by integrating blockchain technology directly into the archive format:
23
+
24
+ ### Blockchain Tokenization
25
+
26
+ Each archive can be tokenized as an NFT on a blockchain network. This creates an immutable, on-chain record of the archive's existence and contents. The token serves as a permanent cryptographic proof of the archive's creation.
27
+
28
+ ### Smart Contract Integration
29
+
30
+ NeoZip archives connect to smart contracts for automated verification and interaction. This enables archives to participate in decentralized workflows, automated compliance checks, and programmable data management.
31
+
32
+ ### Integrity Verification
33
+
34
+ NeoZip calculates SHA-256 hashes for all files in an archive and constructs a Merkle tree. The Merkle root is stored on-chain, providing cryptographic proof that the archive contents haven't been modified. Anyone can verify an archive's integrity by comparing the calculated Merkle root with the on-chain value.
35
+
36
+ ### Provenance Tracking
37
+
38
+ Every tokenized archive has an immutable blockchain record showing when it was created, on which network, and by which wallet address. This creates a permanent audit trail for compliance and legal purposes.
39
+
40
+ ### Standard Compatibility
41
+
42
+ Despite these advanced features, NeoZip maintains ~99% compatibility with PKzip, InfoZip utilities and the standard ZIP format. NeoZip archives work with existing ZIP tools and infrastructure, ensuring backward compatibility while adding new capabilities.
43
+
44
+ ## Key Features & Benefits
45
+
46
+ ### Data Integrity
47
+
48
+ - SHA-256 hashes for all files ensure data integrity
49
+ - Merkle root stored on-chain provides tamper-proof verification
50
+ - Automatic integrity checks during extraction
51
+
52
+ ### Authenticity Verification
53
+
54
+ - Verify that archives haven't been tampered with
55
+ - Cryptographic proof of archive contents
56
+ - On-chain verification without external systems
57
+
58
+ ### Blockchain Provenance
59
+
60
+ - Immutable record of archive creation
61
+ - Permanent audit trail on the blockchain
62
+ - Timestamp and creator information stored on-chain
63
+
64
+ ### Smart Contract Integration
65
+
66
+ - Archives can interact with decentralized applications
67
+ - Programmable archive management
68
+ - Integration with DeFi and Web3 ecosystems
69
+
70
+ ### Standard ZIP Format
71
+
72
+ - Works with existing ZIP tools
73
+ - Compatible with standard ZIP infrastructure
74
+ - No vendor lock-in
75
+
76
+ ## Technical Innovation
77
+
78
+ NeoZip is the first archive utility to integrate blockchain tokenization natively. Key innovations include:
79
+
80
+ - **Merkle Tree-Based Verification**: Uses cryptographic Merkle trees to create tamper-proof integrity proofs
81
+ - **Multi-Network Support**: Supports multiple EVM blockchain networks including Base, Arbitrum, and Ethereum
82
+ - **OpenTimestamp Integration**: Optional Bitcoin blockchain timestamping for additional verification
83
+ - **Smart Contract Architecture**: Designed to work with smart contracts for automated verification and management
84
+
85
+ ## The NeoZip Ecosystem
86
+
87
+ NeoZip is more than a single tool—it's an ecosystem of applications and libraries. Learn more about the NeoZip ecosystem at [https://neozip.io](https://neozip.io):
88
+
89
+ ### neozip-cli
90
+
91
+ The command-line interface (this package) is the first release of the NeoZip ecosystem. It provides full-featured ZIP creation, extraction, and listing capabilities with integrated blockchain tokenization.
92
+
93
+ ### NeoZip GUI
94
+
95
+ A graphical user interface is currently in development. The GUI will provide a user-friendly interface for blockchain-enabled archives, making blockchain tokenization accessible to non-technical users while maintaining all the power and features of the CLI.
96
+
97
+ ### neozipkit
98
+
99
+ The core library will be released as open-source software, enabling developers to build custom archive applications. This open-source release will:
100
+
101
+ - Enable developers to build custom archive applications
102
+ - Encourage community development and innovation
103
+ - Provide the foundation for next-generation archive tools
104
+ - Support integration with other blockchain protocols and applications
105
+
106
+ ## Use Cases
107
+
108
+ NeoZip's blockchain integration opens up new possibilities across industries and applications. Learn more about specific use cases at [https://neozip.io](https://neozip.io):
109
+
110
+ ### Secure Document Archiving
111
+
112
+ Safeguard sensitive documents by creating NeoZip archives that are tokenized as NFTs on the blockchain, ensuring verifiable ownership and protection against tampering. The immutable blockchain record provides cryptographic proof that documents haven't been altered, making NeoZip ideal for:
113
+
114
+ - **Legal Documentation**: Contracts, agreements, and legal filings with provable authenticity
115
+ - **Medical Records**: Patient data archives with immutable integrity verification
116
+ - **Financial Documents**: Transaction records, invoices, and audit trails
117
+ - **Government Records**: Public records and official documentation with permanent verification
118
+
119
+ ### Digital Asset Management
120
+
121
+ Manage and transfer digital assets securely by tokenizing ZIP files, providing a transparent and immutable record of ownership and authenticity. NeoZip enables:
122
+
123
+ - **Content Distribution**: Verify that digital content (media, software, documents) hasn't been modified during distribution
124
+ - **Asset Provenance**: Track the origin and ownership history of digital assets
125
+ - **Transfer Verification**: Ensure digital assets maintain integrity during transfers between parties
126
+ - **Collection Management**: Create verifiable collections of digital assets with blockchain-backed ownership records
127
+
128
+ ### Intellectual Property Protection
129
+
130
+ Protect intellectual property by creating NeoZip archives that serve as proof of creation and ownership, deterring unauthorized use or distribution. The blockchain timestamp provides indisputable evidence of:
131
+
132
+ - **Copyright Claims**: Prove when creative works were created and archived
133
+ - **Patent Documentation**: Maintain immutable records of invention documentation
134
+ - **Trade Secrets**: Archive confidential information with cryptographic integrity guarantees
135
+ - **Research Data**: Preserve research findings with verifiable timestamps and integrity
136
+
137
+ ### Regulatory Compliance
138
+
139
+ Meet compliance requirements by maintaining unalterable records of file existence and integrity, facilitated through blockchain timestamping. NeoZip helps organizations satisfy:
140
+
141
+ - **GDPR Requirements**: Immutable audit trails for data processing and archival
142
+ - **SOX Compliance**: Financial records with tamper-proof verification
143
+ - **HIPAA Compliance**: Healthcare data archives with cryptographic integrity
144
+ - **Industry Standards**: Sector-specific compliance requirements with blockchain-backed verification
145
+
146
+ ### Software Distribution
147
+
148
+ Verify that software packages haven't been tampered with between creation and installation. The blockchain record provides cryptographic proof of package integrity, essential for:
149
+
150
+ - **Package Repositories**: Verify software packages before installation
151
+ - **CI/CD Pipelines**: Integrate NeoZip into automated workflows for verifiable build artifacts
152
+ - **Software Supply Chain**: Ensure software integrity throughout the distribution chain
153
+ - **Update Verification**: Verify that software updates are authentic and unmodified
154
+
155
+ ### Automated Workflows
156
+
157
+ Integrate NeoZip into automated workflows using the command-line interface to create verifiable archives programmatically, enhancing efficiency in:
158
+
159
+ - **CI/CD Pipelines**: Automatically create blockchain-verified archives of build artifacts
160
+ - **Batch Processing**: Process large volumes of files with automated tokenization
161
+ - **Scheduled Backups**: Create cryptographically verified backups on a schedule
162
+ - **Data Pipeline Integration**: Integrate blockchain verification into existing data processing workflows
163
+
164
+ ### Digital Preservation
165
+
166
+ Long-term archival with cryptographic proof ensures that archived data can be verified decades later, even if the original systems are no longer available. NeoZip provides:
167
+
168
+ - **Museum Archives**: Preserve digital collections with permanent integrity verification
169
+ - **Library Systems**: Maintain digital archives with blockchain-backed authenticity
170
+ - **Historical Records**: Archive historical documents with immutable verification
171
+ - **Cultural Heritage**: Preserve cultural artifacts in digital form with cryptographic guarantees
172
+
173
+ ### Document Management
174
+
175
+ Prove document authenticity and creation time with immutable blockchain records. This is valuable for:
176
+
177
+ - **Contract Management**: Maintain verifiable records of contract creation and modifications
178
+ - **Certificate Verification**: Issue and verify certificates with blockchain-backed authenticity
179
+ - **Notarization**: Create blockchain-backed notarized documents
180
+ - **Chain of Custody**: Track document handling with immutable audit trails
181
+
182
+ ### Data Backup & Recovery
183
+
184
+ Cryptographically verified backups ensure that backup data hasn't been corrupted or tampered with, providing confidence in data recovery:
185
+
186
+ - **Enterprise Backups**: Verify backup integrity before and after storage
187
+ - **Disaster Recovery**: Ensure recovery data is authentic and unmodified
188
+ - **Cloud Storage Verification**: Verify data integrity in cloud storage systems
189
+ - **Backup Validation**: Automatically verify backup archives during creation and restoration
190
+
191
+ ## Future Vision
192
+
193
+ The upcoming open-source release of neozipkit will enable:
194
+
195
+ - **Custom Archive Applications**: Developers can build specialized archive tools for specific use cases
196
+ - **Protocol Integration**: Integration with other blockchain protocols and decentralized storage systems
197
+ - **Community Innovation**: Open-source development will drive new features and use cases
198
+ - **Ecosystem Growth**: A thriving ecosystem of NeoZip-based applications and tools
199
+
200
+ NeoZip represents the evolution of archive technology—combining the reliability and compatibility of traditional ZIP files with the security, verifiability, and programmability of blockchain technology. It's not just a new tool—it's a new foundation for how we think about data archiving, integrity, and provenance in the digital age.
201
+
202
+ ---
203
+
204
+ **Get Started**: Install NeoZip CLI and begin creating blockchain-verified archives today.
205
+
206
+ ```bash
207
+ npm install -g neozip-cli@alpha
208
+ ```
209
+
210
+ ---
211
+
212
+ **Learn More**: For detailed documentation, tutorials, and the latest updates, visit [https://neozip.io](https://neozip.io).
package/bin/neolist ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env node
2
+
3
+ /**
4
+ * NeoZip CLI - Full-featured command-line ZIP application
5
+ * Executable entry point for neolist command
6
+ */
7
+
8
+ // Import and run the main CLI (properly handle async)
9
+ // Note: Environment variables should be set by user or in their shell profile
10
+ // For blockchain features, set: NEOWARE_WALLET_KEY, NEOWARE_NETWORK, etc.
11
+ const main = require('../dist/src/index.js').default;
12
+ main().catch(error => {
13
+ console.error('Error:', error);
14
+ process.exit(1);
15
+ });
16
+
package/bin/neounzip ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env node
2
+
3
+ /**
4
+ * NeoZip CLI - Full-featured command-line ZIP application
5
+ * Executable entry point for neounzip command
6
+ */
7
+
8
+ // Import and run the main CLI (properly handle async)
9
+ // Note: Environment variables should be set by user or in their shell profile
10
+ // For blockchain features, set: NEOWARE_WALLET_KEY, NEOWARE_NETWORK, etc.
11
+ const main = require('../dist/src/index.js').default;
12
+ main().catch(error => {
13
+ console.error('Error:', error);
14
+ process.exit(1);
15
+ });
16
+
package/bin/neozip ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env node
2
+
3
+ /**
4
+ * NeoZip CLI - Full-featured command-line ZIP application
5
+ * Executable entry point for neozip command
6
+ */
7
+
8
+ // Import and run the main CLI (properly handle async)
9
+ // Note: Environment variables should be set by user or in their shell profile
10
+ // For blockchain features, set: NEOWARE_WALLET_KEY, NEOWARE_NETWORK, etc.
11
+ const main = require('../dist/src/index.js').default;
12
+ main().catch(error => {
13
+ console.error('Error:', error);
14
+ process.exit(1);
15
+ });