librats 0.3.1 → 0.5.0

package/scripts/prepare-package.js

@@ -1,91 +1,91 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const path = require('path');
-
-/**
- * Prepare package script
- * 
- * This script runs before packing and publishing to ensure the package
- * is ready for distribution. It checks that all necessary files are present.
- */
-
-console.log('Preparing package for distribution...');
-
-const projectRoot = path.resolve(__dirname, '..', '..');
-const nodejsRoot = path.resolve(__dirname, '..');
-
-// Critical files that must be included in the package
-const criticalFiles = [
-    // Node.js binding files
-    { path: path.join(nodejsRoot, 'binding.gyp'), desc: 'Node.js binding configuration' },
-    { path: path.join(nodejsRoot, 'lib', 'index.js'), desc: 'JavaScript wrapper' },
-    { path: path.join(nodejsRoot, 'lib', 'index.d.ts'), desc: 'TypeScript definitions' },
-    { path: path.join(nodejsRoot, 'src', 'librats_node.cpp'), desc: 'Node.js binding source' },
-    { path: path.join(nodejsRoot, 'scripts', 'build-librats.js'), desc: 'Build script' },
-    { path: path.join(nodejsRoot, 'scripts', 'postinstall.js'), desc: 'Post-install script' },
-    
-    // Librats C++ library files
-    { path: path.join(projectRoot, 'CMakeLists.txt'), desc: 'CMake configuration' },
-    { path: path.join(projectRoot, 'src', 'librats.cpp'), desc: 'Librats main source' },
-    { path: path.join(projectRoot, 'src', 'librats.h'), desc: 'Librats main header' },
-    { path: path.join(projectRoot, 'src', 'librats_c.cpp'), desc: 'Librats C API' },
-    { path: path.join(projectRoot, 'src', 'librats_c.h'), desc: 'Librats C API header' },
-];
-
-let allFilesPresent = true;
-let missingFiles = [];
-
-console.log('\nChecking required files:');
-for (const file of criticalFiles) {
-    if (fs.existsSync(file.path)) {
-        console.log(`  ✓ ${file.desc}`);
-    } else {
-        console.log(`  ✗ ${file.desc} - MISSING`);
-        allFilesPresent = false;
-        missingFiles.push(file);
-    }
-}
-
-if (!allFilesPresent) {
-    console.error('\n❌ ERROR: Some required files are missing!');
-    console.error('\nMissing files:');
-    missingFiles.forEach(file => {
-        console.error(`  - ${file.path}`);
-        console.error(`    (${file.desc})`);
-    });
-    console.error('\nThe package cannot be published without these files.');
-    process.exit(1);
-}
-
-// Check that lib directory exists and has content
-const libDir = path.join(nodejsRoot, 'lib');
-if (!fs.existsSync(libDir)) {
-    console.error('\n❌ ERROR: lib directory does not exist!');
-    console.error('Create it with the JavaScript wrapper and TypeScript definitions.');
-    process.exit(1);
-}
-
-// Check that scripts directory exists
-const scriptsDir = path.join(nodejsRoot, 'scripts');
-if (!fs.existsSync(scriptsDir)) {
-    console.error('\n❌ ERROR: scripts directory does not exist!');
-    console.error('This directory is required for the build process.');
-    process.exit(1);
-}
-
-// Count source files
-const srcDir = path.join(projectRoot, 'src');
-if (fs.existsSync(srcDir)) {
-    const sourceFiles = fs.readdirSync(srcDir)
-        .filter(f => f.endsWith('.cpp') || f.endsWith('.h'));
-    console.log(`\n✓ Found ${sourceFiles.length} source files in src/`);
-}
-
-console.log('\n✅ Package is ready for distribution!\n');
-console.log('When users install this package via npm:');
-console.log('  1. The preinstall script will build the librats C++ library');
-console.log('  2. The install script will build the Node.js native addon');
-console.log('  3. The postinstall script will verify the installation');
-console.log('\nNo manual build steps are required by users!\n');
-
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Prepare package script
+ * 
+ * This script runs before packing and publishing to ensure the package
+ * is ready for distribution. It checks that all necessary files are present.
+ */
+
+console.log('Preparing package for distribution...');
+
+const projectRoot = path.resolve(__dirname, '..', '..');
+const nodejsRoot = path.resolve(__dirname, '..');
+
+// Critical files that must be included in the package
+const criticalFiles = [
+    // Node.js binding files
+    { path: path.join(nodejsRoot, 'binding.gyp'), desc: 'Node.js binding configuration' },
+    { path: path.join(nodejsRoot, 'lib', 'index.js'), desc: 'JavaScript wrapper' },
+    { path: path.join(nodejsRoot, 'lib', 'index.d.ts'), desc: 'TypeScript definitions' },
+    { path: path.join(nodejsRoot, 'src', 'librats_node.cpp'), desc: 'Node.js binding source' },
+    { path: path.join(nodejsRoot, 'scripts', 'build-librats.js'), desc: 'Build script' },
+    { path: path.join(nodejsRoot, 'scripts', 'postinstall.js'), desc: 'Post-install script' },
+    
+    // Librats C++ library files
+    { path: path.join(projectRoot, 'CMakeLists.txt'), desc: 'CMake configuration' },
+    { path: path.join(projectRoot, 'src', 'librats.cpp'), desc: 'Librats main source' },
+    { path: path.join(projectRoot, 'src', 'librats.h'), desc: 'Librats main header' },
+    { path: path.join(projectRoot, 'src', 'librats_c.cpp'), desc: 'Librats C API' },
+    { path: path.join(projectRoot, 'src', 'librats_c.h'), desc: 'Librats C API header' },
+];
+
+let allFilesPresent = true;
+let missingFiles = [];
+
+console.log('\nChecking required files:');
+for (const file of criticalFiles) {
+    if (fs.existsSync(file.path)) {
+        console.log(`  ✓ ${file.desc}`);
+    } else {
+        console.log(`  ✗ ${file.desc} - MISSING`);
+        allFilesPresent = false;
+        missingFiles.push(file);
+    }
+}
+
+if (!allFilesPresent) {
+    console.error('\n❌ ERROR: Some required files are missing!');
+    console.error('\nMissing files:');
+    missingFiles.forEach(file => {
+        console.error(`  - ${file.path}`);
+        console.error(`    (${file.desc})`);
+    });
+    console.error('\nThe package cannot be published without these files.');
+    process.exit(1);
+}
+
+// Check that lib directory exists and has content
+const libDir = path.join(nodejsRoot, 'lib');
+if (!fs.existsSync(libDir)) {
+    console.error('\n❌ ERROR: lib directory does not exist!');
+    console.error('Create it with the JavaScript wrapper and TypeScript definitions.');
+    process.exit(1);
+}
+
+// Check that scripts directory exists
+const scriptsDir = path.join(nodejsRoot, 'scripts');
+if (!fs.existsSync(scriptsDir)) {
+    console.error('\n❌ ERROR: scripts directory does not exist!');
+    console.error('This directory is required for the build process.');
+    process.exit(1);
+}
+
+// Count source files
+const srcDir = path.join(projectRoot, 'src');
+if (fs.existsSync(srcDir)) {
+    const sourceFiles = fs.readdirSync(srcDir)
+        .filter(f => f.endsWith('.cpp') || f.endsWith('.h'));
+    console.log(`\n✓ Found ${sourceFiles.length} source files in src/`);
+}
+
+console.log('\n✅ Package is ready for distribution!\n');
+console.log('When users install this package via npm:');
+console.log('  1. The preinstall script will build the librats C++ library');
+console.log('  2. The install script will build the Node.js native addon');
+console.log('  3. The postinstall script will verify the installation');
+console.log('\nNo manual build steps are required by users!\n');
+

package/scripts/verify-installation.js

@@ -1,119 +1,119 @@
-#!/usr/bin/env node
-
-/**
- * Installation Verification Script
- * 
- * Checks if librats was installed correctly and all components are working.
- */
-
-const fs = require('fs');
-const path = require('path');
-
-console.log('🔍 Verifying librats installation...\n');
-
-let allChecksPassed = true;
-
-// Check 1: Can we load the module?
-console.log('1. Loading librats module...');
-try {
-    const librats = require('../lib/index.js');
-    console.log('   ✅ Module loaded successfully\n');
-    
-    // Check 2: Version info
-    console.log('2. Checking version info...');
-    try {
-        const versionString = librats.getVersionString();
-        const version = librats.getVersion();
-        console.log(`   ✅ Version: ${versionString}`);
-        console.log(`   ✅ Components: ${version.major}.${version.minor}.${version.patch}.${version.build}\n`);
-    } catch (err) {
-        console.log('   ❌ Failed to get version info:', err.message);
-        allChecksPassed = false;
-    }
-    
-    // Check 3: Constants
-    console.log('3. Checking constants...');
-    try {
-        if (typeof librats.ConnectionStrategy.DIRECT_ONLY === 'number') {
-            console.log('   ✅ ConnectionStrategy constants defined');
-        }
-        if (typeof librats.ErrorCodes.SUCCESS === 'number') {
-            console.log('   ✅ ErrorCodes constants defined\n');
-        }
-    } catch (err) {
-        console.log('   ❌ Constants check failed:', err.message);
-        allChecksPassed = false;
-    }
-    
-    // Check 4: Can we create a client?
-    console.log('4. Testing client creation...');
-    try {
-        const RatsClient = librats.RatsClient;
-        const testPort = 19999;
-        const client = new RatsClient(testPort);
-        console.log('   ✅ Client created successfully\n');
-        
-        // Check 5: Can we start and stop?
-        console.log('5. Testing start/stop...');
-        try {
-            const started = client.start();
-            if (started) {
-                console.log('   ✅ Client started successfully');
-                
-                const peerId = client.getOurPeerId();
-                if (peerId && typeof peerId === 'string') {
-                    console.log(`   ✅ Got peer ID: ${peerId}`);
-                }
-                
-                const peerCount = client.getPeerCount();
-                console.log(`   ✅ Peer count: ${peerCount}`);
-                
-                client.stop();
-                console.log('   ✅ Client stopped successfully\n');
-            } else {
-                console.log('   ⚠️  Warning: Client failed to start (port may be in use)\n');
-            }
-        } catch (err) {
-            console.log('   ❌ Start/stop test failed:', err.message);
-            allChecksPassed = false;
-        }
-    } catch (err) {
-        console.log('   ❌ Client creation failed:', err.message);
-        allChecksPassed = false;
-    }
-    
-    // Check 6: TypeScript definitions
-    console.log('6. Checking TypeScript definitions...');
-    const tsDefsPath = path.join(__dirname, '..', 'lib', 'index.d.ts');
-    if (fs.existsSync(tsDefsPath)) {
-        console.log('   ✅ TypeScript definitions found\n');
-    } else {
-        console.log('   ⚠️  Warning: TypeScript definitions not found\n');
-    }
-    
-} catch (err) {
-    console.log('   ❌ Failed to load module:', err.message);
-    console.log('\nError details:');
-    console.log(err.stack);
-    allChecksPassed = false;
-}
-
-// Summary
-console.log('━'.repeat(60));
-if (allChecksPassed) {
-    console.log('✅ All checks passed! Librats is installed correctly.\n');
-    console.log('You can now use librats in your project:');
-    console.log("  const { RatsClient } = require('librats');");
-    console.log('  const client = new RatsClient(8080);');
-    console.log('  client.start();\n');
-    process.exit(0);
-} else {
-    console.log('❌ Some checks failed. Installation may be incomplete.\n');
-    console.log('Troubleshooting:');
-    console.log('  1. Try rebuilding: npm rebuild librats');
-    console.log('  2. Check build tools are installed (CMake, C++ compiler)');
-    console.log('  3. Check the logs above for specific errors');
-    console.log('  4. See: https://github.com/librats/librats/tree/main/nodejs\n');
-    process.exit(1);
-}
-
+#!/usr/bin/env node
+
+/**
+ * Installation Verification Script
+ * 
+ * Checks if librats was installed correctly and all components are working.
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+console.log('🔍 Verifying librats installation...\n');
+
+let allChecksPassed = true;
+
+// Check 1: Can we load the module?
+console.log('1. Loading librats module...');
+try {
+    const librats = require('../lib/index.js');
+    console.log('   ✅ Module loaded successfully\n');
+    
+    // Check 2: Version info
+    console.log('2. Checking version info...');
+    try {
+        const versionString = librats.getVersionString();
+        const version = librats.getVersion();
+        console.log(`   ✅ Version: ${versionString}`);
+        console.log(`   ✅ Components: ${version.major}.${version.minor}.${version.patch}.${version.build}\n`);
+    } catch (err) {
+        console.log('   ❌ Failed to get version info:', err.message);
+        allChecksPassed = false;
+    }
+    
+    // Check 3: Constants
+    console.log('3. Checking constants...');
+    try {
+        if (typeof librats.ConnectionStrategy.DIRECT_ONLY === 'number') {
+            console.log('   ✅ ConnectionStrategy constants defined');
+        }
+        if (typeof librats.ErrorCodes.SUCCESS === 'number') {
+            console.log('   ✅ ErrorCodes constants defined\n');
+        }
+    } catch (err) {
+        console.log('   ❌ Constants check failed:', err.message);
+        allChecksPassed = false;
+    }
+    
+    // Check 4: Can we create a client?
+    console.log('4. Testing client creation...');
+    try {
+        const RatsClient = librats.RatsClient;
+        const testPort = 19999;
+        const client = new RatsClient(testPort);
+        console.log('   ✅ Client created successfully\n');
+        
+        // Check 5: Can we start and stop?
+        console.log('5. Testing start/stop...');
+        try {
+            const started = client.start();
+            if (started) {
+                console.log('   ✅ Client started successfully');
+                
+                const peerId = client.getOurPeerId();
+                if (peerId && typeof peerId === 'string') {
+                    console.log(`   ✅ Got peer ID: ${peerId}`);
+                }
+                
+                const peerCount = client.getPeerCount();
+                console.log(`   ✅ Peer count: ${peerCount}`);
+                
+                client.stop();
+                console.log('   ✅ Client stopped successfully\n');
+            } else {
+                console.log('   ⚠️  Warning: Client failed to start (port may be in use)\n');
+            }
+        } catch (err) {
+            console.log('   ❌ Start/stop test failed:', err.message);
+            allChecksPassed = false;
+        }
+    } catch (err) {
+        console.log('   ❌ Client creation failed:', err.message);
+        allChecksPassed = false;
+    }
+    
+    // Check 6: TypeScript definitions
+    console.log('6. Checking TypeScript definitions...');
+    const tsDefsPath = path.join(__dirname, '..', 'lib', 'index.d.ts');
+    if (fs.existsSync(tsDefsPath)) {
+        console.log('   ✅ TypeScript definitions found\n');
+    } else {
+        console.log('   ⚠️  Warning: TypeScript definitions not found\n');
+    }
+    
+} catch (err) {
+    console.log('   ❌ Failed to load module:', err.message);
+    console.log('\nError details:');
+    console.log(err.stack);
+    allChecksPassed = false;
+}
+
+// Summary
+console.log('━'.repeat(60));
+if (allChecksPassed) {
+    console.log('✅ All checks passed! Librats is installed correctly.\n');
+    console.log('You can now use librats in your project:');
+    console.log("  const { RatsClient } = require('librats');");
+    console.log('  const client = new RatsClient(8080);');
+    console.log('  client.start();\n');
+    process.exit(0);
+} else {
+    console.log('❌ Some checks failed. Installation may be incomplete.\n');
+    console.log('Troubleshooting:');
+    console.log('  1. Try rebuilding: npm rebuild librats');
+    console.log('  2. Check build tools are installed (CMake, C++ compiler)');
+    console.log('  3. Check the logs above for specific errors');
+    console.log('  4. See: https://github.com/librats/librats/tree/main/nodejs\n');
+    process.exit(1);
+}
+