@sawa-siemens/socket.io-stream 0.10.1 → 1.0.0

package/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+      - name: Build
+        run: npm run build

package/README.md

@@ -1,13 +1,17 @@
-# Socket.IO stream
+# @sawa-siemens/socket.io-stream
 
-[![Build Status](https://travis-ci.org/nkzawa/socket.io-stream.png?branch=master)](https://travis-ci.org/nkzawa/socket.io-stream)
-[![NPM version](https://badge.fury.io/js/socket.io-stream.png)](http://badge.fury.io/js/socket.io-stream)
+[![Tests](https://github.com/sawa-siemens/socket.io-stream/actions/workflows/test.yml/badge.svg)](https://github.com/sawa-siemens/socket.io-stream/actions/workflows/test.yml)
+[![NPM version](https://img.shields.io/npm/v/%40sawa-siemens%2Fsocket.io-stream?style=flat-square&color=%23099)](https://www.npmjs.com/package/@sawa-siemens/socket.io-stream)
 
-This is the module for bidirectional binary data transfer with Stream API through [Socket.IO](https://github.com/socketio/socket.io).
+This is the module for bidirectional binary data transfer with Stream API through [Socket.IO](https://github.com/socketio/socket.io).  
+🚨 The purpose of fork @sawa-siemens/socket-io.stream:
+
+1. Add support for Typescript type interface
+2. Original package is lack of maintenance in security auditing. Aim at free npm audit vulnerabilities for it's dependency.
 
 ## Installation
 
-    npm install socket.io-stream
+    npm install @sawa-siemens/socket.io-stream
 
 ## Usage
 
@@ -20,12 +24,12 @@ To receive streams, you just wrap `socket` with `socket.io-stream`, then listen
 Server:
 
 ```js
-var io = require('socket.io').listen(80);
-var ss = require('socket.io-stream');
-var path = require('path');
+var io = require("socket.io").listen(80);
+var ss = require("@sawa-siemens/socket.io-stream");
+var path = require("path");
 
-io.of('/user').on('connection', function(socket) {
-  ss(socket).on('profile-image', function(stream, data) {
+io.of("/user").on("connection", function (socket) {
+  ss(socket).on("profile-image", function (stream, data) {
     var filename = path.basename(data.name);
     stream.pipe(fs.createWriteStream(filename));
   });
@@ -37,14 +41,14 @@ io.of('/user').on('connection', function(socket) {
 Client:
 
 ```js
-var io = require('socket.io-client');
-var ss = require('socket.io-stream');
+var io = require("socket.io-client");
+var ss = require("@sawa-siemens/socket.io-stream");
 
-var socket = io.connect('http://example.com/user');
+var socket = io.connect("http://example.com/user");
 var stream = ss.createStream();
-var filename = 'profile.jpg';
+var filename = "profile.jpg";
 
-ss(socket).emit('profile-image', stream, {name: filename});
+ss(socket).emit("profile-image", stream, { name: filename });
 fs.createReadStream(filename).pipe(stream);
 ```
 
@@ -52,25 +56,34 @@ You can stream data from a client to server, and vice versa.
 
 ```js
 // send data
-ss(socket).on('file', function(stream) {
-  fs.createReadStream('/path/to/file').pipe(stream);
+ss(socket).on("file", function (stream) {
+  fs.createReadStream("/path/to/file").pipe(stream);
 });
 
 // receive data
-ss(socket).emit('file', stream);
-stream.pipe(fs.createWriteStream('file.txt'));
+ss(socket).emit("file", stream);
+stream.pipe(fs.createWriteStream("file.txt"));
+```
+
+## Support ESM import style
+
+```js
+import ss from "@sawa-siemens/socket.io-stream";
+// ...
+const stream = ss.createStream({ highWaterMark: 512 * 1024 });
+//...
 ```
 
 ### Browser
 
 This module can be used on the browser. To do so, just copy a file to a public directory.
 
-    $ cp node_modules/socket.io-stream/socket.io-stream.js somewhere/public/
+    $ cp node_modules/@sawa-siemens/socket.io-stream/socket.io-stream.js somewhere/public/
 
 You can also use [browserify](http://github.com/substack/node-browserify) to create your own bundle.
 
     $ npm install browserify -g
-    $ cd node_modules/socket.io-stream
+    $ cd node_modules/@sawa-siemens/socket.io-stream
     $ browserify index.js -s ss > socket.io-stream.js
 
 ```html
@@ -80,18 +93,18 @@ You can also use [browserify](http://github.com/substack/node-browserify) to cre
 <script src="/js/socket.io-stream.js"></script>
 <script src="/js/jquery.js"></script>
 <script>
-$(function() {
-  var socket = io.connect('/foo');
+  $(function () {
+    var socket = io.connect("/foo");
 
-  $('#file').change(function(e) {
-    var file = e.target.files[0];
-    var stream = ss.createStream();
+    $("#file").change(function (e) {
+      var file = e.target.files[0];
+      var stream = ss.createStream();
 
-    // upload a file to the server.
-    ss(socket).emit('file', stream, {size: file.size});
-    ss.createBlobReadStream(file).pipe(stream);
+      // upload a file to the server.
+      ss(socket).emit("file", stream, { size: file.size });
+      ss.createBlobReadStream(file).pipe(stream);
+    });
   });
-});
 </script>
 ```
 
@@ -103,9 +116,9 @@ You can track upload progress like the following:
 var blobStream = ss.createBlobReadStream(file);
 var size = 0;
 
-blobStream.on('data', function(chunk) {
+blobStream.on("data", function (chunk) {
   size += chunk.length;
-  console.log(Math.floor(size / file.size * 100) + '%');
+  console.log(Math.floor((size / file.size) * 100) + "%");
   // -> e.g. '42%'
 });
 
@@ -120,7 +133,6 @@ You have to set `forceBase64` option `true` when using the library with socket.i
 ss.forceBase64 = true;
 ```
 
-
 ## Documentation
 
 ### ss(sio)
@@ -171,11 +183,11 @@ ss(socket).on('foo', function(stream) {
 ### ss.createStream([options])
 
 - options `Object`
-    - highWaterMark `Number`
-    - encoding `String`
-    - decodeStrings `Boolean`
-    - objectMode `Boolean`
-    - allowHalfOpen `Boolean` if `true`, then the stream won't automatically close when the other endpoint ends. Default to `false`.
+  - highWaterMark `Number`
+  - encoding `String`
+  - decodeStrings `Boolean`
+  - objectMode `Boolean`
+  - allowHalfOpen `Boolean` if `true`, then the stream won't automatically close when the other endpoint ends. Default to `false`.
 - return `Duplex Stream`
 
 Create a new duplex stream. See [the docs](http://nodejs.org/api/stream.html) for the details of stream and `options`.
@@ -187,16 +199,16 @@ var stream = ss.createStream();
 var stream = ss.createStream({
   highWaterMark: 1024,
   objectMode: true,
-  allowHalfOpen: true
+  allowHalfOpen: true,
 });
 ```
 
 ### ss.createBlobReadStream(blob, [options])
 
 - options `Object`
-    - highWaterMark `Number`
-    - encoding `String`
-    - objectMode `Boolean`
+  - highWaterMark `Number`
+  - encoding `String`
+  - objectMode `Boolean`
 - return `Readable Stream`
 
 Create a new readable stream for [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) and [File](https://developer.mozilla.org/en-US/docs/Web/API/File) on browser. See [the docs](http://nodejs.org/api/stream.html) for the details of stream and `options`.

package/esbuild.config.js

@@ -0,0 +1,29 @@
+const esbuild = require('esbuild');
+const { polyfillNode } = require('esbuild-plugin-polyfill-node');
+
+esbuild.build({
+  entryPoints: ['index.js'],
+  bundle: true,
+  minify: true,
+  globalName: 'ss',
+  platform: 'browser',
+  target: 'es2018',
+  outfile: 'socket.io-stream.js',
+  plugins: [
+    polyfillNode({
+      // Polyfills needed for this library
+      polyfills: {
+        util: true,
+        events: true,
+        buffer: true,
+        stream: true,
+        crypto: true,
+      },
+    }),
+  ],
+}).then(() => {
+  console.log('Build complete: socket.io-stream.js');
+}).catch((err) => {
+  console.error('Build failed:', err);
+  process.exit(1);
+});

package/lib/iostream.js

@@ -184,6 +184,39 @@ IOStream.prototype._done = function() {
   return this.push(null);
 };
 
+/**
+ * Helper to check if readable side has ended.
+ * Uses public API (readableEnded) with fallback to internal state for compatibility.
+ *
+ * @api private
+ */
+IOStream.prototype._isReadableEnded = function() {
+  // Use public API if available (readable-stream v3.6+, v4.x, Node.js 12.9+)
+  if (typeof this.readableEnded === 'boolean') {
+    return this.readableEnded;
+  }
+  // Fallback to internal state
+  return this._readableState && this._readableState.ended;
+};
+
+/**
+ * Helper to check if writable side has finished.
+ * Uses public API (writableFinished/writableEnded) with fallback to internal state.
+ *
+ * @api private
+ */
+IOStream.prototype._isWritableFinished = function() {
+  // Use public API if available (readable-stream v3.6+, v4.x, Node.js 12.9+)
+  if (typeof this.writableFinished === 'boolean') {
+    return this.writableFinished;
+  }
+  if (typeof this.writableEnded === 'boolean') {
+    return this.writableEnded;
+  }
+  // Fallback to internal state
+  return this._writableState && this._writableState.finished;
+};
+
 /**
  * the user has called .end(), and all the bytes have been
  * sent out to the other side.
@@ -203,10 +236,12 @@ IOStream.prototype._onfinish = function() {
   }
 
   this.writable = false;
-  this._writableState.ended = true;
+  if (this._writableState) {
+    this._writableState.ended = true;
+  }
 
-  if (!this.readable || this._readableState.ended) {
-    debug('_onfinish: ended, destroy %s', this._readableState);
+  if (!this.readable || this._isReadableEnded()) {
+    debug('_onfinish: ended, destroy');
     return this.destroy();
   }
 
@@ -216,7 +251,8 @@ IOStream.prototype._onfinish = function() {
     this.push(null);
 
     // just in case we're waiting for an EOF.
-    if (this.readable && !this._readableState.endEmitted) {
+    var endEmitted = this._readableState && this._readableState.endEmitted;
+    if (this.readable && !endEmitted) {
       this.read(0);
     }
   }
@@ -232,17 +268,24 @@ IOStream.prototype._onfinish = function() {
 IOStream.prototype._onend = function() {
   debug('_onend');
   this.readable = false;
-  this._readableState.ended = true;
+  if (this._readableState) {
+    this._readableState.ended = true;
+  }
 
-  if (!this.writable || this._writableState.finished) {
-    debug('_onend: %s', this._writableState);
+  if (!this.writable || this._isWritableFinished()) {
+    debug('_onend: finished, destroy');
     return this.destroy();
   }
 
   debug('_onend: not finished');
 
   if (!this.allowHalfOpen) {
+    // When allowHalfOpen is false, we should clean up immediately
+    // after the readable side ends. Call end() to signal writable end,
+    // then destroy to clean up. This ensures synchronous cleanup
+    // which is expected by the tests and maintains v3.x behavior.
     this.end();
+    return this.destroy();
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sawa-siemens/socket.io-stream",
-  "version": "0.10.1",
+  "version": "1.0.0",
   "description": "stream for socket.io",
   "author": "Naoyuki Kanezawa <naoyuki.kanezawa@gmail.com>",
   "contributors": [
@@ -37,24 +37,28 @@
     "./package.json": "./package.json"
   },
   "engines": {
-    "node": ">=0.10.0"
+    "node": ">=18.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/sawa-siemens/socket.io-stream.git"
+    "url": "git+https://github.com/sawa-siemens/socket.io-stream.git"
   },
   "scripts": {
-    "prepublish": "make build",
-    "test": "make test"
+    "build": "node esbuild.config.js",
+    "prepare": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest"
   },
   "dependencies": {
     "component-bind": "~1.0.0",
-    "debug": "^4.3.4"
+    "debug": "^4.3.4",
+    "readable-stream": "^4.5.2"
   },
   "devDependencies": {
-    "browserify": "^17.0.0",
-    "expect.js": "~0.3.1",
+    "esbuild": "^0.27.2",
+    "esbuild-plugin-polyfill-node": "^0.3.0",
     "socket.io": "^4.8.3",
-    "socket.io-client": "^4.8.3"
+    "socket.io-client": "^4.8.3",
+    "vitest": "^3.0.4"
   }
 }