@neoware_inc/neozipkit 0.5.0

package/examples/list-zip.ts

@@ -0,0 +1,161 @@
+#!/usr/bin/env node
+
+/**
+ * List ZIP Example
+ * 
+ * Demonstrates listing ZIP archive contents using ZipkitNode.
+ * This is a minimal example showing how to read ZIP metadata.
+ */
+
+import ZipkitNode from '../src/node';
+import type ZipEntry from '../src/core/ZipEntry';
+import * as fs from 'fs';
+import * as path from 'path';
+
+async function main() {
+  console.log('Listing ZIP archive contents...\n');
+
+  // Example: Use the ZIP file created by create-zip.ts
+  // You can also specify your own ZIP file path here
+  const archivePath = path.join(__dirname, 'output', 'example.zip');
+
+  // Check if ZIP file exists
+  if (!fs.existsSync(archivePath)) {
+    console.error(`❌ ZIP file not found: ${archivePath}`);
+    console.error('💡 Tip: Run create-zip.ts first to create a test ZIP file,');
+    console.error('   or modify archivePath to point to your own ZIP file.');
+    process.exit(1);
+  }
+
+  // Get file stats
+  const stats = fs.statSync(archivePath);
+  console.log(`Archive: ${archivePath}`);
+  console.log(`Size: ${stats.size} bytes\n`);
+
+  // Create ZipkitNode instance
+  const zip = new ZipkitNode();
+
+  try {
+    // Load the ZIP file
+    console.log('Loading ZIP file...');
+    const entries = await zip.loadZipFile(archivePath);
+
+    console.log(`✅ ZIP file loaded successfully\n`);
+    console.log(`Total entries: ${entries.length}\n`);
+
+    if (entries.length === 0) {
+      console.log('Archive is empty.');
+      return;
+    }
+
+    // Display entries in a table format
+    console.log('─'.repeat(80));
+    console.log(
+      padRight('Filename', 30) +
+      padLeft('Original', 10) +
+      padLeft('Compressed', 12) +
+      padLeft('Ratio', 10) +
+      '   ' +
+      padRight('Method', 10)
+    );
+    console.log('─'.repeat(80));
+
+    let totalSize = 0;
+    let totalCompressed = 0;
+
+    entries.forEach((entry: ZipEntry) => {
+      const filename = entry.filename || '(unnamed)';
+      const size = entry.uncompressedSize || 0;
+      const compressed = entry.compressedSize || 0;
+      const method = entry.cmpMethodToString();
+      const ratio = size > 0 ? ((1 - compressed / size) * 100).toFixed(1) : '0.0';
+
+      totalSize += size;
+      totalCompressed += compressed;
+
+      console.log(
+        padRight(filename.length > 28 ? filename.substring(0, 25) + '...' : filename, 30) +
+        padLeft(formatBytes(size), 10) +
+        padLeft(formatBytes(compressed), 12) +
+        padLeft(ratio + '%', 10) +
+        '   ' +
+        padRight(method, 10)
+      );
+    });
+
+    console.log('─'.repeat(80));
+    const totalRatio = totalSize > 0 ? ((1 - totalCompressed / totalSize) * 100).toFixed(1) : '0.0';
+    console.log(
+      padRight('Total', 30) +
+      padLeft(formatBytes(totalSize), 10) +
+      padLeft(formatBytes(totalCompressed), 12) +
+      padLeft(totalRatio + '%', 10) +
+      '   ' +
+      padRight('', 10)
+    );
+    console.log('─'.repeat(80));
+
+    // Display additional information
+    console.log('\nAdditional Information:');
+    console.log(`  Archive comment: ${zip.getZipComment() || '(none)'}`);
+    
+    // Show compression methods used
+    const methods = new Set(entries.map((e: ZipEntry) => e.cmpMethodToString()));
+    console.log(`  Compression methods: ${Array.from(methods).join(', ')}`);
+
+    // Show entries with SHA-256 hashes (for blockchain features)
+    const entriesWithHash = entries.filter((e: ZipEntry) => (e as any).sha256);
+    if (entriesWithHash.length > 0) {
+      console.log(`  Entries with SHA-256: ${entriesWithHash.length}`);
+    }
+
+    console.log('\n💡 Tip: You can access individual entry properties:');
+    console.log('   entry.filename - File name');
+    console.log('   entry.uncompressedSize - Original file size');
+    console.log('   entry.compressedSize - Compressed size');
+    console.log('   entry.cmpMethod - Compression method code');
+    console.log('   entry.crc - CRC-32 checksum');
+    console.log('   entry.timeDateDOS - File timestamp');
+
+  } catch (error) {
+    console.error('❌ Error reading ZIP archive:');
+    console.error(error instanceof Error ? error.message : String(error));
+    if (error instanceof Error && error.stack) {
+      console.error('\nStack trace:');
+      console.error(error.stack);
+    }
+    process.exit(1);
+  }
+}
+
+/**
+ * Helper function to format bytes
+ */
+function formatBytes(bytes: number): string {
+  if (bytes === 0) return '0 B';
+  const k = 1024;
+  const sizes = ['B', 'KB', 'MB', 'GB'];
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+  return (bytes / Math.pow(k, i)).toFixed(1) + ' ' + sizes[i];
+}
+
+/**
+ * Helper function to pad string to the right
+ */
+function padRight(str: string, length: number): string {
+  return (str + ' '.repeat(length)).slice(0, length);
+}
+
+/**
+ * Helper function to pad string to the left
+ */
+function padLeft(str: string, length: number): string {
+  return (' '.repeat(length) + str).slice(-length);
+}
+
+// Run the example
+main().catch((error) => {
+  console.error('Fatal error:', error);
+  process.exit(1);
+});
+

package/examples/test-files/data.json

@@ -0,0 +1,116 @@
+{
+  "name": "Sample Data File",
+  "description": "This is a JSON file with structured data",
+  "items": [
+    {
+      "id": 0,
+      "name": "Item 0",
+      "description": "This is item number 0 with some descriptive text",
+      "value": 123.45,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": 1,
+      "name": "Item 1",
+      "description": "This is item number 1 with some descriptive text",
+      "value": 234.56,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": 2,
+      "name": "Item 2",
+      "description": "This is item number 2 with some descriptive text",
+      "value": 345.67,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": 3,
+      "name": "Item 3",
+      "description": "This is item number 3 with some descriptive text",
+      "value": 456.78,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": 4,
+      "name": "Item 4",
+      "description": "This is item number 4 with some descriptive text",
+      "value": 567.89,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": 5,
+      "name": "Item 5",
+      "description": "This is item number 5 with some descriptive text",
+      "value": 678.90,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": 6,
+      "name": "Item 6",
+      "description": "This is item number 6 with some descriptive text",
+      "value": 789.01,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": 7,
+      "name": "Item 7",
+      "description": "This is item number 7 with some descriptive text",
+      "value": 890.12,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": 8,
+      "name": "Item 8",
+      "description": "This is item number 8 with some descriptive text",
+      "value": 901.23,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": 9,
+      "name": "Item 9",
+      "description": "This is item number 9 with some descriptive text",
+      "value": 12.34,
+      "tags": ["tag1", "tag2", "tag3"],
+      "metadata": {
+        "created": "2025-01-01T00:00:00.000Z",
+        "updated": "2025-01-01T00:00:00.000Z"
+      }
+    }
+  ]
+}

package/examples/test-files/document.md

@@ -0,0 +1,80 @@
+# Sample Document
+
+This is a markdown document with multiple sections.
+
+## Introduction
+
+This document demonstrates various markdown features.
+
+## Features
+
+- Feature 1: Description of the first feature
+- Feature 2: Description of the second feature
+- Feature 3: Description of the third feature
+
+## Code Example
+
+```javascript
+function example() {
+  return "Hello, World!";
+}
+```
+
+## More Content
+
+This section contains additional content to make the file larger.
+The content is repeated to demonstrate compression capabilities.
+
+# Sample Document
+
+This is a markdown document with multiple sections.
+
+## Introduction
+
+This document demonstrates various markdown features.
+
+## Features
+
+- Feature 1: Description of the first feature
+- Feature 2: Description of the second feature
+- Feature 3: Description of the third feature
+
+## Code Example
+
+```javascript
+function example() {
+  return "Hello, World!";
+}
+```
+
+## More Content
+
+This section contains additional content to make the file larger.
+The content is repeated to demonstrate compression capabilities.
+
+# Sample Document
+
+This is a markdown document with multiple sections.
+
+## Introduction
+
+This document demonstrates various markdown features.
+
+## Features
+
+- Feature 1: Description of the first feature
+- Feature 2: Description of the second feature
+- Feature 3: Description of the third feature
+
+## Code Example
+
+```javascript
+function example() {
+  return "Hello, World!";
+}
+```
+
+## More Content
+
+This section contains additional content to make the file larger.
+The content is repeated to demonstrate compression capabilities.

package/examples/test-files/document.txt

@@ -0,0 +1,6 @@
+This is a sample document.
+It will be tokenized on the blockchain.
+
+- Feature 1: Description of the first feature
+- Feature 2: Description of the second feature
+- Feature 3: Description of the third feature

package/examples/test-files/file1.txt

@@ -0,0 +1,48 @@
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+This is the first file.
+It contains repetitive text content that will compress well.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.

package/examples/test-files/file2.txt

@@ -0,0 +1,80 @@
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern
+This is the second file.
+It contains structured data with patterns.
+Line 1: Data entry with some information
+Line 2: Another data entry with similar structure
+Line 3: More data following the same pattern

package/examples/tsconfig.json

@@ -0,0 +1,44 @@
+{
+  "compilerOptions": {
+    /* Language and Environment */
+    "target": "es2020",
+    "lib": ["es2020", "dom"],
+    
+    /* Modules */
+    "module": "Node16",
+    "rootDir": "./",
+    "moduleResolution": "node16",
+    
+    /* Emit */
+    "declaration": false,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "removeComments": false,
+    
+    /* Interop Constraints */
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    
+    /* Type Checking */
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "skipLibCheck": true,
+    
+    /* JavaScript Support */
+    "allowJs": false,
+    
+    /* Node.js types */
+    "types": ["node"]
+  },
+  "include": [
+    "*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}
+