@remotelinker/reverse-ws-tunnel 1.0.4 → 1.0.5

package/README.md

@@ -36,13 +36,39 @@ Reverse WebSocket Tunnel is a library that enables you to expose local services
 npm install @remotelinker/reverse-ws-tunnel
 ```
 
+## 📦 Module Compatibility
+
+This library supports both **CommonJS** (`require()`) and **ES Modules** (`import`) for maximum compatibility:
+
+### CommonJS (Traditional)
+```javascript
+const { startClient } = require('@remotelinker/reverse-ws-tunnel/client');
+const { startWebSocketServer } = require('@remotelinker/reverse-ws-tunnel/server');
+const { loadConfig } = require('@remotelinker/reverse-ws-tunnel/utils');
+```
+
+### ES Modules (Modern)
+```javascript
+import { startClient } from '@remotelinker/reverse-ws-tunnel/client';
+import { startWebSocketServer } from '@remotelinker/reverse-ws-tunnel/server';
+import { loadConfig } from '@remotelinker/reverse-ws-tunnel/utils';
+```
+
 ## 🚀 Quick Start
 
 ### Server Setup
 
+**CommonJS:**
 ```javascript
 const { startWebSocketServer } = require('@remotelinker/reverse-ws-tunnel/server');
+```
 
+**ES Modules:**
+```javascript
+import { startWebSocketServer } from '@remotelinker/reverse-ws-tunnel/server';
+```
+
+```javascript
 // Start the WebSocket tunnel server
 startWebSocketServer({
   port: 443,
@@ -54,9 +80,17 @@ startWebSocketServer({
 
 ### Client Setup
 
+**CommonJS:**
 ```javascript
 const { startClient } = require('@remotelinker/reverse-ws-tunnel/client');
+```
 
+**ES Modules:**
+```javascript
+import { startClient } from '@remotelinker/reverse-ws-tunnel/client';
+```
+
+```javascript
 // Connect to the tunnel server and expose local service
 const client = startClient({
   tunnelId: '1cf2755f-c151-4281-b3f0-55c399035f87',
@@ -96,8 +130,12 @@ _Configuration priority: JavaScript parameters > config.toml > environment varia
 #### JavaScript API
 
 ```javascript
+// CommonJS
 const { startWebSocketServer } = require('@remotelinker/reverse-ws-tunnel/server');
 
+// ES Modules
+// import { startWebSocketServer } from '@remotelinker/reverse-ws-tunnel/server';
+
 startWebSocketServer({
   port: 443, // WebSocket server port
   host: '0.0.0.0', // Host to bind (optional)
@@ -138,8 +176,12 @@ npm run example:server
 #### JavaScript API
 
 ```javascript
+// CommonJS
 const { startClient } = require('@remotelinker/reverse-ws-tunnel/client');
 
+// ES Modules
+// import { startClient } from '@remotelinker/reverse-ws-tunnel/client';
+
 const client = startClient({
   tunnelId: '1cf2755f-c151-4281-b3f0-55c399035f87', // Unique tunnel identifier (UUID)
   wsUrl: 'wss://example.com/tunnel', // WebSocket server URL

package/client/index.mjs

@@ -0,0 +1,2 @@
+import cjsModule from './index.js';
+export const { startClient } = cjsModule;

package/cookbook.md

@@ -48,7 +48,12 @@ npm install @remotelinker/reverse-ws-tunnel
 
 **Step 3: Create tunnel configuration**
 ```javascript
-// tunnel-config.js
+// tunnel-config.js (CommonJS)
+// const { startClient } = require('@remotelinker/reverse-ws-tunnel/client');
+
+// tunnel-config.mjs (ES Modules)
+// import { startClient } from '@remotelinker/reverse-ws-tunnel/client';
+
 const { startClient } = require('@remotelinker/reverse-ws-tunnel/client');
 
 const client = startClient({
@@ -261,6 +266,8 @@ const secureClient = startClient({
 **Server-side SSL termination:**
 ```javascript
 const https = require('https');
+// const { startWebSocketServer } = require('@remotelinker/reverse-ws-tunnel/server'); // CommonJS
+// import { startWebSocketServer } from '@remotelinker/reverse-ws-tunnel/server'; // ES Modules
 const { startWebSocketServer } = require('@remotelinker/reverse-ws-tunnel/server');
 
 const sslOptions = {
@@ -448,6 +455,8 @@ client.on('disconnected', (reason) => {
 process.env.LOG_LEVEL = 'debug';
 
 // Or programmatically
+// const { setLogLevel } = require('@remotelinker/reverse-ws-tunnel/utils'); // CommonJS
+// import { setLogLevel } from '@remotelinker/reverse-ws-tunnel/utils'; // ES Modules
 const { setLogLevel } = require('@remotelinker/reverse-ws-tunnel/utils');
 setLogLevel('trace');
 ```
@@ -486,6 +495,8 @@ clients.forEach((client, index) => {
 
 ```javascript
 // Server-side auth validation
+// const { startWebSocketServer } = require('@remotelinker/reverse-ws-tunnel/server'); // CommonJS
+// import { startWebSocketServer } from '@remotelinker/reverse-ws-tunnel/server'; // ES Modules
 const { startWebSocketServer } = require('@remotelinker/reverse-ws-tunnel/server');
 
 const authenticateTunnel = (headers) => {
@@ -512,6 +523,8 @@ startWebSocketServer({
 ```javascript
 // Handle WebSocket connections through tunnel
 const WebSocket = require('ws');
+// const { startClient } = require('@remotelinker/reverse-ws-tunnel/client'); // CommonJS
+// import { startClient } from '@remotelinker/reverse-ws-tunnel/client'; // ES Modules
 const { startClient } = require('@remotelinker/reverse-ws-tunnel/client');
 
 const client = startClient({

package/index.cjs

@@ -0,0 +1,9 @@
+const server = require('./server');
+const client = require('./client');
+const utils = require('./utils');
+
+module.exports = {
+  ...server,
+  ...client,
+  ...utils
+};

package/index.mjs

@@ -0,0 +1,3 @@
+export * from './server/index.mjs';
+export * from './client/index.mjs';
+export * from './utils/index.mjs';

package/jest.config.cjs

@@ -0,0 +1,5 @@
+module.exports = {
+  testEnvironment: 'node',
+  testTimeout: 30000,
+  verbose: true,
+};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@remotelinker/reverse-ws-tunnel",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "",
-  "main": "index.js",
+  "main": "index.cjs",
   "config": {
     "dockerRegistry": {
       "prod": "",
@@ -18,13 +18,28 @@
     "docker:build": "cross-conf-env docker image build -f Dockerfile . -t $npm_package_config_dockerRegistry_prodremotelinker/reverse-ws-tunnel:$npm_package_version",
     "docker:deploy": "docker-compose up -d",
     "example:server": "node examples/server/server-example.js",
+    "example:server:esm": "node examples/server/server-example.mjs",
     "example:client": "node examples/client/client-example.js",
+    "example:client:esm": "node examples/client/client-example.mjs",
     "example:webserver": "node examples/webserver/webserver-example.js"
   },
   "exports": {
-    "./server": "./server/index.js",
-    "./client": "./client/index.js",
-    "./utils": "./utils/index.js"
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.cjs"
+    },
+    "./server": {
+      "import": "./server/index.mjs",
+      "require": "./server/index.js"
+    },
+    "./client": {
+      "import": "./client/index.mjs",
+      "require": "./client/index.js"
+    },
+    "./utils": {
+      "import": "./utils/index.mjs",
+      "require": "./utils/index.js"
+    }
   },
   "keywords": [],
   "author": "Andrea Trentin <at30in@gmail.com>",

package/server/index.mjs

@@ -0,0 +1,2 @@
+import cjsModule from './index.js';
+export const { startWebSocketServer, setLogContext } = cjsModule;

package/utils/index.mjs

@@ -0,0 +1,2 @@
+import cjsModule from './index.js';
+export const { setLogLevel, getLogLevel, loadConfig } = cjsModule;