@iobroker/socket-classes 1.6.2 → 2.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/socket-classes",
-  "version": "1.6.2",
+  "version": "2.0.2",
   "description": "ioBroker server-side web sockets",
   "author": {
     "name": "bluefox",
@@ -21,41 +21,47 @@
     "url": "https://github.com/ioBroker/ioBroker.socket-classes"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^3.2.2",
-    "axios": "^1.7.8",
+    "@iobroker/adapter-core": "^3.2.3",
+    "axios": "^1.7.9",
     "cookie-parser": "^1.4.7",
     "passport": "^0.7.0"
   },
   "devDependencies": {
     "@alcalzone/release-script": "^3.8.0",
     "@alcalzone/release-script-plugin-license": "^3.7.0",
-    "@foxriver76/eslint-config": "^1.0.5",
+    "@iobroker/eslint-config": "^1.0.0",
+    "@iobroker/js-controller-common-db": "^7.0.6",
+    "@iobroker/ws-server": "^4.2.3",
+    "@iobroker/types": "^7.0.6",
+    "@types/axios": "^0.14.4",
+    "@types/cookie-parser": "^1.4.8",
+    "@types/node": "^22.13.1",
+    "@types/passport": "^1.0.17",
     "chai": "^4.5.0",
-    "gulp": "^4.0.2",
-    "iobroker.js-controller": "^6.0.11",
-    "mocha": "^10.8.2"
+    "iobroker.js-controller": "^7.0.6",
+    "mocha": "^11.1.0",
+    "typescript": "^5.7.3"
   },
   "bugs": {
     "url": "https://github.com/ioBroker/ioBroker.web/issues"
   },
-  "main": "index.js",
+  "main": "dist/index.js",
   "files": [
     "LICENSE",
-    "lib/",
-    "index.js",
-    "lib/socketCommon.js",
-    "lib/socketAdmin.js"
+    "dist/"
   ],
   "scripts": {
-    "lint": "eslint .",
-    "test": "node node_modules/mocha/bin/mocha --exit",
+    "lint": "eslint -c eslint.config.mjs",
+    "test": "mocha --exit",
+    "build": "npm run build-backend && npm run docs",
+    "build-backend": "tsc -p tsconfig.build.json && node tasks --prebuild",
     "release": "release-script",
     "release-patch": "release-script patch --no-update-lockfile --yes",
     "release-minor": "release-script minor --no-update-lockfile --yes",
     "release-major": "release-script major --no-update-lockfile --yes",
-    "update-packages": "ncu --upgrade",
-    "npm": "npm install --ignore-script",
-    "docs": "gulp"
+    "update-packages": "npx -y npm-check-updates --upgrade",
+    "docs": "node tasks",
+    "npm": "npm i -f"
   },
   "license": "MIT",
   "maintainers": [

package/index.js

@@ -1,19 +0,0 @@
-const SocketAdmin = require('./lib/socketAdmin');
-const SocketCommon = require('./lib/socketCommon');
-const SocketCommands = require('./lib/socketCommands');
-const SocketCommandsAdmin = require('./lib/socketCommandsAdmin');
-const passportSocket = require('./lib/passportSocket');
-
-module.exports = {
-    SocketAdmin,
-    SocketCommon,
-    SocketCommands,
-    SocketCommandsAdmin,
-    passportSocket,
-    get passport() {
-        return require('passport');
-    },
-    get cookieParser() {
-        return require('cookie-parser');
-    }
-};

package/lib/passportSocket.js

@@ -1,105 +0,0 @@
-// Originally taken from here: https://github.com/jfromaniello/passport.socketio/blob/master/lib/index.js
-// Copyright Licensed under the MIT-License. 2012-2013 José F. Romaniello.
-
-function parseCookie(auth, cookieHeader) {
-    const cookieParser = auth.cookieParser(auth.secret);
-    const req = {
-        headers: {
-            cookie: cookieHeader
-        }
-    };
-
-    let result;
-
-    cookieParser(req, {}, err => {
-        if (err) {
-            throw err;
-        }
-        result = req.signedCookies || req.cookies;
-    });
-
-    return result;
-}
-
-function getQuery(url) {
-    const query = url.split('?')[1] || '';
-    const parts = query.split('&');
-    const result = {};
-    for (let p = 0; p < parts.length; p++) {
-        const parts1 = parts[p].split('=');
-        result[parts1[0]] = parts1[1];
-    }
-    return result;
-}
-
-function authorize(options) {
-    const defaults = {
-        key: 'connect.sid',
-        secret: null,
-        store: null,
-        userProperty: 'user'
-    };
-
-    const auth = Object.assign({}, defaults, options);
-
-    if (!auth.passport) {
-        throw new Error("passport is required to use require('passport'), please install passport");
-    }
-
-    if (!auth.cookieParser) {
-        throw new Error(
-            "cookieParser is required use require('cookie-parser'), connect.cookieParser or express.cookieParser"
-        );
-    }
-
-    return function (data, accept) {
-        data.query = getQuery(data.url);
-
-        if (options.checkUser && data.query.user && data.query.pass) {
-            return options.checkUser(data.query.user, data.query.pass, (error, result) => {
-                if (error) {
-                    return auth.fail(data, 'Cannot check user', false, accept);
-                } else if (!result) {
-                    return auth.fail(data, 'User not found', false, accept);
-                } else {
-                    data[auth.userProperty] = result;
-                    data[auth.userProperty].logged_in = true;
-                    auth.success(data, accept);
-                }
-            });
-        }
-
-        data.cookie = parseCookie(auth, data.headers.cookie || '');
-        data.sessionID = data.cookie[auth.key] || '';
-        data[auth.userProperty] = {
-            logged_in: false
-        };
-
-        auth.store.get(data.sessionID, (err, session) => {
-            if (err) {
-                return auth.fail(data, 'Error in session store:\n' + err.message, true, accept);
-            } else if (!session) {
-                return auth.fail(data, 'No session found', false, accept);
-            } else if (!session[auth.passport._key]) {
-                return auth.fail(data, 'Passport was not initialized', true, accept);
-            }
-
-            const userKey = session[auth.passport._key].user;
-
-            if (typeof userKey === 'undefined') {
-                return auth.fail(
-                    data,
-                    'User not authorized through passport. (User Property not found)',
-                    false,
-                    accept
-                );
-            }
-
-            data[auth.userProperty] = userKey;
-            data[auth.userProperty].logged_in = true;
-            auth.success(data, accept);
-        });
-    };
-}
-
-exports.authorize = authorize;

package/lib/socketAdmin.js

@@ -1,203 +0,0 @@
-/**
- *      Class Socket
- *
- *      Copyright 2014-2022 bluefox <dogafox@gmail.com>,
- *      MIT License
- *
- */
-const SocketCommon = require('./socketCommon');
-const SocketCommandsAdmin = require('./socketCommandsAdmin');
-let passport; // require('passport') - only if auth is activated
-let cookieParser; // require('cookie-parser') - only if auth is activated
-let passportSocketIo; // require('./passportSocket') - only if auth is activated
-
-class SocketAdmin extends SocketCommon {
-    constructor(settings, adapter, objects) {
-        super(settings, adapter);
-
-        // user another set of commands for admin
-        this.commands = new SocketCommandsAdmin(adapter, socket => this.__updateSession(socket), objects);
-    }
-
-    __getIsNoDisconnect() {
-        // ws does not require disconnect
-        return true;
-    }
-
-    _onAuthorizeSuccess = (data, accept) => {
-        this.adapter.log.debug(`successful connection to socket.io from ${data.connection.remoteAddress}`);
-        accept();
-    };
-
-    _onAuthorizeFail = (data, message, error, accept) => {
-        setTimeout(() => data.socket.emit(SocketCommon.COMMAND_RE_AUTHENTICATE), 100);
-
-        error &&
-            this.adapter.log.info(`failed connection to socket.io from ${data.connection.remoteAddress}: ${message}`);
-
-        if (error) {
-            accept(new Error(message));
-        } else {
-            accept(new Error(`failed connection to socket.io: ${message}`)); //null, false);
-        }
-        // this error will be sent to the user as a special error-package
-        // see: http://socket.io/docs/client-api/#socket > error-object
-    };
-
-    __initAuthentication(authOptions) {
-        passportSocketIo = passportSocketIo || require('./passportSocket');
-        passport = passport || require('passport');
-        cookieParser = cookieParser || require('cookie-parser');
-
-        this.store = authOptions.store;
-
-        this.server.use(
-            passportSocketIo.authorize({
-                passport,
-                cookieParser,
-                key: authOptions.userKey, // the name of the cookie where express/connect stores its session_id
-                secret: authOptions.secret, // the session_secret to parse the cookie
-                store: authOptions.store, // we NEED to use a sessionstore. no memorystore please
-                success: this._onAuthorizeSuccess, // *optional* callback on success - read more below
-                fail: this._onAuthorizeFail // *optional* callback on fail/error - read more below
-            })
-        );
-    }
-
-    // Extract username from socket
-    __getUserFromSocket(socket, callback) {
-        if (socket.conn.request.sessionID) {
-            socket._secure = true;
-            socket._sessionID = socket.conn.request.sessionID;
-            // Get user for session
-            return this.adapter.getSession(socket.conn.request.sessionID, obj => {
-                if (!obj || !obj.passport) {
-                    if (socket._acl) {
-                        socket._acl.user = '';
-                    }
-                    socket.emit(SocketCommon.COMMAND_RE_AUTHENTICATE);
-                    callback('Cannot detect user');
-                } else {
-                    callback(null, obj.passport.user ? `system.user.${obj.passport.user}` : '');
-                }
-            });
-        }
-        callback('Cannot detect user');
-    }
-
-    __getClientAddress(socket) {
-        let address;
-        if (socket.connection) {
-            address = socket.connection && socket.connection.remoteAddress;
-        } else {
-            address = socket.ws._socket.remoteAddress;
-        }
-
-        if (!address && socket.handshake) {
-            address = socket.handshake.address;
-        }
-        if (!address && socket.conn.request && socket.conn.request.connection) {
-            address = socket.conn.request.connection.remoteAddress;
-        }
-        return address;
-    }
-
-    // update session ID, but not ofter than 60 seconds
-    __updateSession(socket) {
-        if (socket._sessionID) {
-            const time = Date.now();
-            if (socket._lastActivity && time - socket._lastActivity > this.settings.ttl * 1000) {
-                this.adapter.log.warn('REAUTHENTICATE!');
-                socket.emit(SocketCommon.COMMAND_RE_AUTHENTICATE);
-                return false;
-            }
-            socket._lastActivity = time;
-            socket._sessionTimer =
-                socket._sessionTimer ||
-                setTimeout(() => {
-                    socket._sessionTimer = null;
-                    this.adapter.getSession(socket._sessionID, obj => {
-                        if (obj) {
-                            this.adapter.setSession(socket._sessionID, this.settings.ttl, obj);
-                        } else {
-                            this.adapter.log.warn('REAUTHENTICATE!');
-                            socket.emit(SocketCommon.COMMAND_RE_AUTHENTICATE);
-                        }
-                    });
-                }, 60_000);
-        }
-
-        return true;
-    }
-
-    __getSessionID(socket) {
-        return this.settings.auth && socket.conn.request.sessionID;
-    }
-
-    start(server, socketClass, authOptions, socketOptions) {
-        super.start(server, socketClass, authOptions, socketOptions);
-
-        this.commands.start(thresholdEnabled => this.onThresholdChanged(thresholdEnabled));
-    }
-
-    onThresholdChanged(enabled) {
-        this.server && this.server.sockets && this.server.sockets.emit('eventsThreshold', enabled);
-    }
-
-    stateChange(id, state) {
-        this.commands.stateChange(id, state);
-
-        const sockets = this.getSocketsList();
-        if (sockets) {
-            sockets.forEach(socket => this.commands.publish(socket, 'stateChange', id, state));
-        }
-    }
-
-    fileChange(id, fileName, size) {
-        const sockets = this.getSocketsList();
-        if (sockets) {
-            sockets.forEach(socket => this.commands.publishFile(socket, id, fileName, size));
-        }
-    }
-
-    repoUpdated() {
-        const sockets = this.getSocketsList();
-        if (sockets) {
-            sockets.forEach(socket => this.__updateSession(socket));
-
-            this.server.sockets.emit('repoUpdated');
-        }
-    }
-
-    objectChange(id, obj) {
-        const sockets = this.getSocketsList();
-        if (sockets) {
-            sockets.forEach(socket => this.commands.publish(socket, 'objectChange', id, obj));
-        }
-    }
-
-    subscribe(type, pattern) {
-        this.commands.subscribe(null, type, pattern);
-    }
-
-    subscribeFile(id, pattern) {
-        this.commands.subscribe(null, 'fileChange', id, pattern);
-    }
-
-    sendCommand(obj) {
-        if (this.commands.sendCommand(obj)) {
-            const sockets = this.getSocketsList();
-            if (sockets) {
-                sockets.forEach(socket => this.__updateSession(socket));
-
-                this.server.sockets.emit(obj.command, obj.message.id, obj.message.data);
-            }
-        }
-    }
-
-    updateRatings(uuid, isAutoUpdate) {
-        return this.commands.updateRatings(uuid, isAutoUpdate);
-    }
-}
-
-module.exports = SocketAdmin;