Convert the project to use ESM and be type "module"

CHANGELOG.md

@@ -6,6 +6,7 @@
   In practice this was confusing and not common.
   * `websocket` option is deprecated, but still respected. Please use       the new `transports` option.
   * Node.js `>= 18.0.0` is required.
+  * Project now uses ESM and is type "module".
 
 ## Other Fixes/Changes
   * Convert from coffeescript to ES6.

README.md

@@ -30,7 +30,7 @@ Work in progress:
   * [SockJS-go](https://github.com/igm/sockjs-go/)
   * [actix/sockjs](https://github.com/actix/sockjs) for Rust
 
-⚠️️ **ATTENTION** This is pre-release documentation. The documentation for the 
+⚠️️ **ATTENTION** This is pre-release documentation. The documentation for the
 latest stable release is at: https://github.com/sockjs/sockjs-node/tree/v0.3.19 ️⚠️
 
 # What is SockJS?
@@ -54,8 +54,8 @@ To install `sockjs-node` run:
 A simplified echo SockJS server could look more or less like:
 
 ```javascript
-const http = require('http');
-const sockjs = require('sockjs');
+import http from 'node:http';
+import sockjs from 'sockjs';
 
 const echo = sockjs.createServer({ prefix:'/echo' });
 echo.on('connection', function(conn) {
@@ -133,7 +133,7 @@ Where `options` is a hash which can contain:
 
 <dt>transports (Array of strings)</dt>
 <dd>List of transports to enable. Select from `eventsource`, `htmlfile`,
-`jsonp-polling`, `websocket`, `websocket-raw`, `xhr-polling`, 
+`jsonp-polling`, `websocket`, `websocket-raw`, `xhr-polling`,
 and `xhr-streaming`.</dd>
 
 <dt>jsessionid (boolean or function)</dt>
@@ -169,7 +169,7 @@ and `xhr-streaming`.</dd>
 <dd>Enabling this option will prevent
   <a href="https://en.wikipedia.org/wiki/Cross-origin_resource_sharing">CORS</a>
   headers from being included in the HTTP response. Can be used when the
-  sockjs client is known to be connecting from the same origin as the 
+  sockjs client is known to be connecting from the same origin as the
   sockjs server. This also disables the iframe HTML endpoint.</dd>
 </dl>
 

examples/echo/package.json

@@ -1,9 +1,10 @@
 {
   "name": "sockjs-echo",
   "version": "0.0.1",
+  "type": "module",
   "dependencies": {
     "node-static": "^0.7.11",
-    "sockjs": "^0.4.0"
+    "sockjs": "../../"
   },
   "private": true
 }

examples/echo/server.js

@@ -1,8 +1,10 @@
-'use strict';
+import http from 'node:http';
+import path from 'node:path';
+import url from 'node:url';
+import sockjs from 'sockjs';
+import node_static from 'node-static';
 
-const http = require('http');
-const sockjs = require('sockjs');
-const node_static = require('node-static');
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
 // 1. Echo sockjs server
 const sockjs_opts = {

examples/express/package.json

@@ -1,9 +1,10 @@
 {
   "name": "sockjs-express",
   "version": "0.0.1",
+  "type": "module",
   "dependencies": {
     "express": "^4.16.3",
-    "sockjs": "^0.4.0"
+    "sockjs": "../.."
   },
   "private": true
 }

examples/express/server.js

@@ -1,8 +1,10 @@
-'use strict';
+import path from 'node:path';
+import http from 'node:http';
+import url from 'node:url';
+import express from 'express';
+import sockjs from 'sockjs';
 
-const http = require('http');
-const express = require('express');
-const sockjs = require('sockjs');
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
 const sockjs_opts = {
   prefix: '/echo'
@@ -14,7 +16,7 @@ sockjs_echo.on('connection', (conn) => {
 });
 
 const app = express();
-app.get('/', (req, res) => res.sendFile(__dirname + '/index.html'));
+app.get('/', (req, res) => res.sendFile(path.join(__dirname, 'index.html')));
 
 const server = http.createServer(app);
 sockjs_echo.attach(server);

examples/hapi/package.json

@@ -1,10 +1,11 @@
 {
   "name": "sockjs-hapi",
   "version": "0.0.1",
+  "type": "module",
   "dependencies": {
     "hapi": "^17.6.0",
     "inert": "^5.1.0",
-    "sockjs": "^0.4.0"
+    "sockjs": "../.."
   },
   "private": true
 }

examples/hapi/server.js

@@ -1,8 +1,6 @@
-'use strict';
-
-const sockjs = require('sockjs');
-const Hapi = require('hapi');
-const Inert = require('inert');
+import sockjs from 'sockjs';
+import Hapi from 'hapi';
+import Inert from 'inert';
 
 // 1. Echo sockjs server
 const sockjs_opts = {

examples/koa/package.json

@@ -1,9 +1,10 @@
 {
   "name": "sockjs-koa",
   "version": "0.0.1",
+  "type": "module",
   "dependencies": {
     "koa": "^2.5.3",
-    "sockjs": "^0.4.0"
+    "sockjs": "../.."
   },
   "private": true
 }

examples/koa/server.js

@@ -1,10 +1,11 @@
-'use strict';
+import Koa from 'koa';
+import sockjs from 'sockjs';
+import http from 'node:http';
+import fs from 'node:fs';
+import path from 'node:path';
+import url from 'node:url';
 
-const Koa = require('koa');
-const sockjs = require('sockjs');
-const http = require('http');
-const fs = require('fs');
-const path = require('path');
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
 // 1. Echo sockjs server
 const sockjs_opts = {
@@ -22,7 +23,7 @@ const app = new Koa();
 
 app.use(function (ctx, next) {
   return next().then(() => {
-    const filePath = __dirname + '/index.html';
+    const filePath = path.join(__dirname, 'index.html');
     ctx.response.type = path.extname(filePath);
     ctx.response.body = fs.createReadStream(filePath);
   });

examples/multiplex/package.json

@@ -1,9 +1,10 @@
 {
   "name": "sockjs-multiplex",
   "version": "0.0.1",
+  "type": "module",
   "dependencies": {
     "express": "^4.16.3",
-    "sockjs": "^0.4.0",
+    "sockjs": "../..",
     "websocket-multiplex": "^0.1.0"
   },
   "private": true

examples/multiplex/server.js

@@ -1,9 +1,11 @@
-'use strict';
+import path from 'node:path';
+import http from 'node:http';
+import url from 'node:url';
+import express from 'express';
+import sockjs from 'sockjs';
+import websocket_multiplex from 'websocket-multiplex';
 
-const http = require('http');
-const express = require('express');
-const sockjs = require('sockjs');
-const websocket_multiplex = require('websocket-multiplex');
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
 // 1. Setup SockJS server
 const sockjs_opts = {
@@ -40,7 +42,7 @@ carl.on('connection', function (conn) {
 // 3. Express server
 const app = express();
 app.get('/', function (req, res) {
-  res.sendFile(__dirname + '/index.html');
+  res.sendFile(path.join(__dirname, 'index.html'));
 });
 
 const server = http.createServer(app);

index.js

@@ -1,15 +1,16 @@
-'use strict';
+import Server from './lib/server.js';
 
-const Server = require('./lib/server');
-
-module.exports.createServer = function createServer(options) {
+function createServer(options) {
   return new Server(options);
-};
+}
 
-module.exports.listen = function listen(http_server, options) {
-  const srv = exports.createServer(options);
+function listen(http_server, options) {
+  const srv = createServer(options);
   if (http_server) {
     srv.attach(http_server);
   }
   return srv;
-};
+}
+
+export default { createServer, listen };
+export { createServer, listen };

lib/handlers.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = {
+export default {
   welcome_screen(req, res) {
     res.setHeader('Content-Type', 'text/plain; charset=UTF-8');
     res.writeHead(200);

lib/iframe.js

@@ -1,7 +1,5 @@
-'use strict';
-
-const utils = require('./utils');
-const middleware = require('./middleware');
+import * as utils from './utils.js';
+import middleware from './middleware.js';
 
 const iframe_template = `<!DOCTYPE html>
 <html>
@@ -20,7 +18,7 @@ const iframe_template = `<!DOCTYPE html>
 </body>
 </html>`;
 
-module.exports = {
+export default {
   iframe(req, res, _head, next) {
     const context = {
       '{{ sockjs_url }}': this.options.sockjs_url

lib/info.js

@@ -1,9 +1,7 @@
-'use strict';
+import * as utils from './utils.js';
+import middleware from './middleware.js';
 
-const utils = require('./utils');
-const middleware = require('./middleware');
-
-module.exports = {
+export default {
   info(req, res) {
     const info = {
       // deprecated option, but useful for old clients

lib/listener.js

@@ -1,13 +1,13 @@
-'use strict';
+import createDebug from 'debug';
+import transportList from './transport/list.js';
+import middleware from './middleware.js';
+import handlers from './handlers.js';
+import info from './info.js';
+import iframe from './iframe.js';
 
-const debug = require('debug')('sockjs:listener');
-const transportList = require('./transport/list');
-const middleware = require('./middleware');
-const handlers = require('./handlers');
-const info = require('./info');
-const iframe = require('./iframe');
+const debug = createDebug('sockjs:listener');
 
-module.exports.generateDispatcher = function generateDispatcher(options) {
+export function generateDispatcher(options) {
   const p = (s) => new RegExp(`^${options.prefix}${s}[/]?$`);
   const t = (s) => [p(`/([^/.]+)/([^/.]+)${s}`), 'server', 'session'];
   const prefix_dispatcher = [
@@ -38,4 +38,4 @@ module.exports.generateDispatcher = function generateDispatcher(options) {
     }
   }
   return prefix_dispatcher.concat(transport_dispatcher);
-};
+}

lib/middleware.js

@@ -1,10 +1,8 @@
-'use strict';
+import FayeWebsocket from 'faye-websocket';
+import * as utils from './utils.js';
+import querystring from 'querystring';
 
-const FayeWebsocket = require('faye-websocket');
-const utils = require('./utils');
-const querystring = require('querystring');
-
-module.exports = {
+const middleware = {
   h_no_cache(req, res, _head, next) {
     res.setHeader('Cache-Control', 'no-store, no-cache, no-transform, must-revalidate, max-age=0');
     next();
@@ -101,7 +99,7 @@ module.exports = {
 
   xhr_options(req, res, _head, next) {
     res.statusCode = 204; // No content
-    module.exports.cache_for(res);
+    middleware.cache_for(res);
     res.setHeader('Access-Control-Allow-Methods', 'OPTIONS, POST');
     res.setHeader('Access-Control-Max-Age', res.cache_for);
     res.end();
@@ -129,3 +127,5 @@ module.exports = {
     next();
   }
 };
+
+export default middleware;

lib/server.js

@@ -1,11 +1,16 @@
-'use strict';
+import events from 'node:events';
+import fs from 'node:fs';
+import path from 'node:path';
+import url from 'node:url';
+import createDebug from 'debug';
+import * as listener from './listener.js';
+import * as webjs from './webjs.js';
 
-const events = require('events');
-const url = require('url');
-const debug = require('debug')('sockjs:server');
-const listener = require('./listener');
-const webjs = require('./webjs');
-const pkg = require('../package.json');
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+const pkgPath = path.join(__dirname, '../package.json');
+const pkg = JSON.parse(fs.readFileSync(pkgPath));
+
+const debug = createDebug('sockjs:server');
 
 class Server extends events.EventEmitter {
   constructor(user_options) {
@@ -91,4 +96,4 @@ class Server extends events.EventEmitter {
   }
 }
 
-module.exports = Server;
+export default Server;

lib/session.js

@@ -1,8 +1,8 @@
-'use strict';
+import createDebug from 'debug';
+import Transport from './transport/transport.js';
+import SockJSConnection from './sockjs-connection.js';
 
-const debug = require('debug')('sockjs:session');
-const Transport = require('./transport/transport');
-const SockJSConnection = require('./sockjs-connection');
+const debug = createDebug('sockjs:session');
 
 const MAP = new Map();
 function closeFrame(status, reason) {
@@ -268,4 +268,4 @@ class Session {
   }
 }
 
-module.exports = Session;
+export default Session;