librats 1.0.2 → 2.2.0

package/scripts/postinstall.js

@@ -43,9 +43,9 @@ if (!process.env.CI && !process.env.npm_config_global) {
   console.log('  npm run verify\n');
   console.log('Quick start:');
   console.log('```javascript');
-  console.log("const { RatsClient } = require('librats');");
-  console.log('const client = new RatsClient(8080);');
-  console.log('client.start();');
+  console.log("const { RatsNode } = require('librats');");
+  console.log('const node = new RatsNode(8080);');
+  console.log('node.start();');
   console.log('```\n');
   console.log('Documentation: https://github.com/librats/librats/tree/main/nodejs\n');
 }

package/scripts/prepare-package.js

@@ -157,10 +157,10 @@ const criticalFiles = [
     { path: path.join(nodejsRoot, 'scripts', 'build-librats.js'), desc: 'Build script' },
     { path: path.join(nodejsRoot, 'scripts', 'postinstall.js'), desc: 'Post-install script' },
     { path: path.join(nativeSrcDir, 'CMakeLists.txt'), desc: 'CMake configuration (copied)' },
-    { path: path.join(nativeSrcDir, 'src', 'librats.cpp'), desc: 'Librats main source (copied)' },
-    { path: path.join(nativeSrcDir, 'src', 'librats.h'), desc: 'Librats main header (copied)' },
-    { path: path.join(nativeSrcDir, 'src', 'librats_c.cpp'), desc: 'Librats C API (copied)' },
-    { path: path.join(nativeSrcDir, 'src', 'librats_c.h'), desc: 'Librats C API header (copied)' },
+    { path: path.join(nativeSrcDir, 'src', 'librats', 'node', 'node.cpp'), desc: 'Librats node core (copied)' },
+    { path: path.join(nativeSrcDir, 'src', 'librats', 'node', 'node.h'), desc: 'Librats node header (copied)' },
+    { path: path.join(nativeSrcDir, 'src', 'librats', 'bindings', 'rats.cpp'), desc: 'Librats C ABI (copied)' },
+    { path: path.join(nativeSrcDir, 'src', 'librats', 'bindings', 'rats.h'), desc: 'Librats C ABI header (copied)' },
 ];
 
 let allFilesPresent = true;

package/scripts/verify-installation.js

@@ -1,119 +1,77 @@
 #!/usr/bin/env node
 
 /**
- * Installation Verification Script
- * 
- * Checks if librats was installed correctly and all components are working.
+ * Installation verification.
+ *
+ * Loads the built addon and exercises the smallest end-to-end path — create a
+ * node, start it, read its identity, stop it — so a broken native build is
+ * reported here rather than in the user's first program.
  */
 
-const fs = require('fs');
-const path = require('path');
+const checks = [];
 
-console.log('🔍 Verifying librats installation...\n');
+function check(name, fn) {
+  try {
+    const detail = fn();
+    checks.push({ name, ok: true, detail });
+  } catch (err) {
+    checks.push({ name, ok: false, detail: err.message });
+  }
+}
 
-let allChecksPassed = true;
+console.log('Verifying librats installation...\n');
 
-// 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...');
+let librats;
+check('load the module', () => {
+  librats = require('../lib/index.js');
+  return 'ok';
+});
+
+if (librats) {
+  check('version info', () => {
+    const v = librats.versionInfo();
+    return `${librats.version()} (${v.major}.${v.minor}.${v.patch}.${v.build})`;
+  });
+
+  check('enums', () => {
+    const need = ['Security', 'Transport', 'TransportMask', 'NatMapping', 'LogLevel'];
+    const missing = need.filter((k) => typeof librats[k] !== 'object');
+    if (missing.length) throw new Error(`missing: ${missing.join(', ')}`);
+    return need.join(', ');
+  });
+
+  check('create, start and stop a node', () => {
+    const node = new librats.RatsNode(0); // ephemeral port — never collides
     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');
+      node.start();
+      const id = node.localId;
+      if (!id || id.length !== 64) throw new Error(`bad peer id: ${id}`);
+      const port = node.listenPort;
+      if (!port) throw new Error('no listen port');
+      if (node.peerCount !== 0) throw new Error('unexpected peers');
+      node.stop();
+      return `peer ${id.slice(0, 16)}… on port ${port}`;
+    } finally {
+      node.destroy();
     }
-    
-} catch (err) {
-    console.log('   ❌ Failed to load module:', err.message);
-    console.log('\nError details:');
-    console.log(err.stack);
-    allChecksPassed = false;
+  });
+}
+
+for (const { name, ok, detail } of checks) {
+  console.log(`${ok ? '✅' : '❌'} ${name}${detail ? ` — ${detail}` : ''}`);
 }
 
-// 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);
+const failed = checks.filter((c) => !c.ok);
+if (failed.length === 0) {
+  console.log('\nAll checks passed. Use it like this:\n');
+  console.log("  const { RatsNode } = require('librats');");
+  console.log('  const node = new RatsNode(8080);');
+  console.log('  node.start();\n');
+  process.exit(0);
 }
 
+console.log('\nSome checks failed. Try:');
+console.log('  1. npm rebuild librats');
+console.log('  2. check that CMake and a C++17 compiler are installed');
+console.log('  3. re-read the errors above\n');
+process.exit(1);