@iobroker/socket-classes 1.5.6 → 1.6.2

package/README.md

@@ -1,6 +1,6 @@
 # @iobroker/socket-classes
 
-This library is used for following adapters:
+This library is used at least for the following adapters:
 - [iobroker.admin](https://github.com/ioBroker/ioBroker.admin)
 - [iobroker.cloud](https://github.com/ioBroker/ioBroker.cloud)
 - [iobroker.socketio](https://github.com/ioBroker/ioBroker.socketio)
@@ -9,7 +9,7 @@ This library is used for following adapters:
 - [iobroker.iot](https://github.com/ioBroker/ioBroker.iot)
 
 ## Usage as admin
-```
+```js
 const TTL_SEC      = 3600;
 
 const SocketAdmin  = require('@iobroker/socket-classes').SocketAdmin;
@@ -40,7 +40,7 @@ io.close();
 ```
 
 ## Usage as socket (ws or socketio)
-```
+```js
 const TTL_SEC      = 3600;
 
 const ws           = require('@iobroker/ws-server');
@@ -65,12 +65,12 @@ io.close();
 
 ## GUI subscribes
 GUI client can send to desired instance the `subscribe` message
-```
+```js
     socket.emit('clientSubscribe', 'cameras.0', 'startCamera', {width: 640, height: 480}, result => console.log('Started: ' + result));
 ```
 
 The instance 'cameras.0' will receive message `clientSubscribe` with information who want to receive messages.
-```
+```js
 adapter.on('message', obj => {
     if (obj?.command === 'clientSubscribe') {
         if (obj?.message.type && obj.message.type.startsWith('startCamera/')) {
@@ -103,7 +103,7 @@ adapter.on('message', obj => {
 
 and after that client will receive messages from instance
 
-```
+```js
 function sendImage(camera, data) {
     this.subscribes.forEach(it => {
         if (it.camera !== camera) {
@@ -979,32 +979,38 @@ Read all instances of the given adapter, or all instances of all adapters if ada
 -->
 
 ## Changelog
+### 1.6.2 (2024-12-01)
+* (@GermanBluefox) Caught the error if no authentication and logout called
+
+### 1.6.1 (2024-10-05)
+* (@GermanBluefox) Added support of iobroker.SocketIO with typescript
+
 ### 1.5.6 (2024-06-26)
-* (bluefox) Corrected call of getObjectView with null parameter
+* (@GermanBluefox) Corrected call of getObjectView with null parameter
 
 ### 1.5.5 (2024-06-26)
-* (bluefox) updated packages
+* (@GermanBluefox) updated packages
 
 ### 1.5.4 (2024-06-02)
-* (bluefox) extend `getCompactInstances`method with version information
+* (@GermanBluefox) extend `getCompactInstances`method with version information
 
 ### 1.5.2 (2024-05-28)
 * (foxriver76) ensure compatible `adapter-core` version
 
 ### 1.5.0 (2024-02-22)
-* (bluefox) Extended getObjects function with the possibility to read the list of IDs in admin
+* (@GermanBluefox) Extended getObjects function with the possibility to read the list of IDs in admin
 
 ### 1.4.6 (2023-10-19)
-* (bluefox) Added `publishInstanceMessageAll` command
+* (@GermanBluefox) Added `publishInstanceMessageAll` command
 
 ### 1.4.4 (2023-10-11)
-* (bluefox) Caught errors by subscribe/unsubscribe
+* (@GermanBluefox) Caught errors by subscribe/unsubscribe
 
 ### 1.4.3 (2023-10-07)
 * (foxriver76) do not await the subscribes anymore
 
 ### 1.4.2 (2023-09-28)
-* (bluefox) Corrected error by unsubscribing on client disconnect
+* (@GermanBluefox) Corrected error by unsubscribing on client disconnect
 
 ### 1.4.1 (2023-09-12)
 * (foxriver76) do not cancel follow subscribes if one subscribe has an error
@@ -1013,126 +1019,126 @@ Read all instances of the given adapter, or all instances of all adapters if ada
 * (foxriver76) fixed crash on invalid patterns with js-controller version 5
 
 ### 1.3.3 (2023-08-01)
-* (bluefox) Implemented subscribing of a client on messages from specific instance
-* (bluefox) Moved checkFeatureSupported to regular connection and not only admin
+* (@GermanBluefox) Implemented subscribing of a client on messages from specific instance
+* (@GermanBluefox) Moved checkFeatureSupported to regular connection and not only admin
 
 ### 1.2.0 (2023-07-07)
 * (foxriver76) fixed crash on invalid patterns with js-controller version 5
-* (bluefox) extended the getObjects function with the possibility to read the list of IDs
+* (@GermanBluefox) extended the getObjects function with the possibility to read the list of IDs
 
 ### 1.1.5 (2023-03-13)
-* (bluefox) Added command `name`
+* (@GermanBluefox) Added command `name`
 
 ### 1.1.3 (2023-03-12)
-* (bluefox) Treat `json5` as `json`
+* (@GermanBluefox) Treat `json5` as `json`
 
 ### 1.1.2 (2023-03-03)
-* (bluefox) Allow deletion of fullcalendar objects
+* (@GermanBluefox) Allow deletion of fullcalendar objects
 
 ### 1.1.1 (2022-12-22)
-* (bluefox) Corrected error with subscribe
+* (@GermanBluefox) Corrected error with subscribe
 
 ### 1.1.0 (2022-12-22)
-* (bluefox) Added user check to many commands
-* (bluefox) Downgrade axios to 0.27.2
+* (@GermanBluefox) Added user check to many commands
+* (@GermanBluefox) Downgrade axios to 0.27.2
 
 ### 1.0.2 (2022-11-08)
-* (bluefox) Function `getObjects`for web was extended by devices, channels and enums
+* (@GermanBluefox) Function `getObjects`for web was extended by devices, channels and enums
 
 ### 1.0.1 (2022-10-10)
-* (bluefox) Fixed error with delObject
+* (@GermanBluefox) Fixed error with delObject
 
 ### 0.5.5 (2022-10-09)
 * (Apollon77) Prepare for future js-controller versions
 
 ### 0.5.4 (2022-09-23)
-* (bluefox) Fixed error in `delObjects` method
+* (@GermanBluefox) Fixed error in `delObjects` method
 
 ### 0.5.3 (2022-08-24)
-* (bluefox) Caught error by subscribing
+* (@GermanBluefox) Caught error by subscribing
 
 ### 0.5.2 (2022-08-19)
-* (bluefox) Added command `getCompactSystemRepositories`
+* (@GermanBluefox) Added command `getCompactSystemRepositories`
 
 ### 0.5.0 (2022-07-20)
-* (bluefox) Buffer conversion errors caught and handled
+* (@GermanBluefox) Buffer conversion errors caught and handled
 
 ### 0.4.12 (2022-07-08)
-* (bluefox) Corrected getAdapterInstances method
+* (@GermanBluefox) Corrected getAdapterInstances method
 
 ### 0.4.11 (2022-07-05)
-* (bluefox) Corrected log transportation
+* (@GermanBluefox) Corrected log transportation
 
 ### 0.4.10 (2022-06-22)
-* (bluefox) Corrected getAdapterInstances
+* (@GermanBluefox) Corrected getAdapterInstances
 
 ### 0.4.9 (2022-06-20)
-* (bluefox) Do not show error with failed authentication
+* (@GermanBluefox) Do not show error with failed authentication
 
 ### 0.4.7 (2022-06-20)
-* (bluefox) Allowed overloading system language
+* (@GermanBluefox) Allowed overloading system language
 
 ### 0.4.6 (2022-06-20)
-* (bluefox) updated `passport`
+* (@GermanBluefox) updated `passport`
 
 ### 0.4.5 (2022-06-20)
-* (bluefox) allowed running socket.io behind reverse proxy
+* (@GermanBluefox) allowed running socket.io behind reverse proxy
 
 ### 0.4.4 (2022-06-09)
-* (bluefox) Do not show requireLog message
+* (@GermanBluefox) Do not show requireLog message
 
 ### 0.4.3 (2022-06-03)
-* (bluefox) Allowed call of getAdapterInstances for non admin
+* (@GermanBluefox) Allowed call of getAdapterInstances for non admin
 
 ### 0.4.2 (2022-05-23)
-* (bluefox) Corrected renameFile command for admin
+* (@GermanBluefox) Corrected renameFile command for admin
 
 ### 0.4.1 (2022-05-23)
-* (bluefox) Corrected changePassword command for admin
+* (@GermanBluefox) Corrected changePassword command for admin
 
 ### 0.4.0 (2022-05-19)
-* (bluefox) Added support of socket.io 4.x
+* (@GermanBluefox) Added support of socket.io 4.x
 
 ### 0.3.2 (2022-05-19)
-* (bluefox) Hide warn messages
+* (@GermanBluefox) Hide warn messages
 
 ### 0.3.1 (2022-05-16)
-* (bluefox) Added back compatibility with js-controller@4.0  for `writeDirAsZip`
+* (@GermanBluefox) Added back compatibility with js-controller@4.0  for `writeDirAsZip`
 
 ### 0.3.0 (2022-05-16)
-* (bluefox) Process `writeDirAsZip` locally
+* (@GermanBluefox) Process `writeDirAsZip` locally
 
 ### 0.2.1 (2022-05-12)
-* (bluefox) fixed `getObjects` command
+* (@GermanBluefox) fixed `getObjects` command
 
 ### 0.2.0 (2022-05-09)
-* (bluefox) fixed `delObjects` command
+* (@GermanBluefox) fixed `delObjects` command
 
 ### 0.1.10 (2022-05-09)
-* (bluefox) Added support for fileChanges
+* (@GermanBluefox) Added support for fileChanges
 
 ### 0.1.9 (2022-05-07)
-* (bluefox) Corrected readLogs command and implement file subscriptions
+* (@GermanBluefox) Corrected readLogs command and implement file subscriptions
 
 ### 0.1.7 (2022-05-05)
-* (bluefox) Caught some sentry errors
+* (@GermanBluefox) Caught some sentry errors
 
 ### 0.1.6 (2022-05-05)
-* (bluefox) fixed `delObject` command
+* (@GermanBluefox) fixed `delObject` command
 
 ### 0.1.5 (2022-04-25)
-* (bluefox) added updateRatings
+* (@GermanBluefox) added updateRatings
 
 ### 0.1.4 (2022-04-24)
-* (bluefox) added passportSocket
+* (@GermanBluefox) added passportSocket
 
 ### 0.1.2 (2022-04-24)
-* (bluefox) initial commit
+* (@GermanBluefox) initial commit
 
 ## License
 The MIT License (MIT)
 
-Copyright (c) 2020-2024 Bluefox <dogafox@gmail.com>
+Copyright (c) 2020-2024 @GermanBluefox <dogafox@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/socketAdmin.js

@@ -72,7 +72,9 @@ class SocketAdmin extends SocketCommon {
             // Get user for session
             return this.adapter.getSession(socket.conn.request.sessionID, obj => {
                 if (!obj || !obj.passport) {
-                    socket._acl.user = '';
+                    if (socket._acl) {
+                        socket._acl.user = '';
+                    }
                     socket.emit(SocketCommon.COMMAND_RE_AUTHENTICATE);
                     callback('Cannot detect user');
                 } else {

package/lib/socketCommands.js

@@ -886,7 +886,9 @@ class SocketCommands {
         this.commands['logout'] = (socket, callback) => {
             // Logout user
             // @param {function} callback - function (error)
-            this.adapter.destroySession(socket._sessionID, callback);
+            if (socket.id) {
+                this.adapter.destroySession(socket.id, callback);
+            }
         };
 
         this.commands['listPermissions'] = (socket, callback) => {

package/lib/socketCommon.js

@@ -1,7 +1,7 @@
 /**
  *      Class Socket
  *
- *      Copyright 2014-2023 bluefox <dogafox@gmail.com>,
+ *      Copyright 2014-2024 bluefox <dogafox@gmail.com>,
  *      MIT License
  *
  */
@@ -71,6 +71,9 @@ class SocketCommon {
                 if (typeof socketClass.listen === 'function') {
                     // old socket.io@2.x and ws
                     this.server = socketClass.listen(server, socketOptions);
+                } else if (socketClass.constructor) {
+                    // iobroker socket
+                    this.server = new socketClass(server, socketOptions);
                 } else {
                     // socket.io 4.x
                     this.server = socketClass(server, socketOptions);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/socket-classes",
-  "version": "1.5.6",
+  "version": "1.6.2",
   "description": "ioBroker server-side web sockets",
   "author": {
     "name": "bluefox",
@@ -21,19 +21,19 @@
     "url": "https://github.com/ioBroker/ioBroker.socket-classes"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^3.1.6",
-    "axios": "^1.7.2",
-    "cookie-parser": "^1.4.6",
+    "@iobroker/adapter-core": "^3.2.2",
+    "axios": "^1.7.8",
+    "cookie-parser": "^1.4.7",
     "passport": "^0.7.0"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^3.7.0",
+    "@alcalzone/release-script": "^3.8.0",
     "@alcalzone/release-script-plugin-license": "^3.7.0",
-    "@foxriver76/eslint-config": "^1.0.4",
-    "chai": "^4.4.1",
+    "@foxriver76/eslint-config": "^1.0.5",
+    "chai": "^4.5.0",
     "gulp": "^4.0.2",
-    "iobroker.js-controller": "^6.0.6-alpha.0-20240624-92c3310c8",
-    "mocha": "^10.5.2"
+    "iobroker.js-controller": "^6.0.11",
+    "mocha": "^10.8.2"
   },
   "bugs": {
     "url": "https://github.com/ioBroker/ioBroker.web/issues"
@@ -54,6 +54,7 @@
     "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"
   },
   "license": "MIT",
@@ -62,8 +63,5 @@
       "name": "bluefox",
       "email": "dogafox@gmail.com"
     }
-  ],
-  "overrides": {
-    "@iobroker/adapter-core": "^3.1.6"
-  }
+  ]
 }