@iobroker/socket-classes 1.6.1 → 2.0.0

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import passport from 'passport';
+import cookieParser from 'cookie-parser';
+export { SocketCommandsAdmin } from './lib/socketCommandsAdmin';
+export { SocketCommands, type SupportedFeature } from './lib/socketCommands';
+export { SocketCommon } from './lib/socketCommon';
+import { authorize as passportSocket } from './lib/passportSocket';
+export { passport, cookieParser, passportSocket };

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.passportSocket = exports.cookieParser = exports.passport = exports.SocketCommon = exports.SocketCommands = exports.SocketCommandsAdmin = void 0;
+const passport_1 = __importDefault(require("passport"));
+exports.passport = passport_1.default;
+const cookie_parser_1 = __importDefault(require("cookie-parser"));
+exports.cookieParser = cookie_parser_1.default;
+var socketCommandsAdmin_1 = require("./lib/socketCommandsAdmin");
+Object.defineProperty(exports, "SocketCommandsAdmin", { enumerable: true, get: function () { return socketCommandsAdmin_1.SocketCommandsAdmin; } });
+var socketCommands_1 = require("./lib/socketCommands");
+Object.defineProperty(exports, "SocketCommands", { enumerable: true, get: function () { return socketCommands_1.SocketCommands; } });
+var socketCommon_1 = require("./lib/socketCommon");
+Object.defineProperty(exports, "SocketCommon", { enumerable: true, get: function () { return socketCommon_1.SocketCommon; } });
+const passportSocket_1 = require("./lib/passportSocket");
+Object.defineProperty(exports, "passportSocket", { enumerable: true, get: function () { return passportSocket_1.authorize; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAMvB,mBANF,kBAAQ,CAME;AALjB,kEAAyC;AAKtB,uBALZ,uBAAY,CAKY;AAJ/B,iEAAgE;AAAvD,0HAAA,mBAAmB,OAAA;AAC5B,uDAA6E;AAApE,gHAAA,cAAc,OAAA;AACvB,mDAAkD;AAAzC,4GAAA,YAAY,OAAA;AACrB,yDAAmE;AAClC,+FADX,0BAAc,OACW"}

package/dist/lib/passportSocket.d.ts

@@ -0,0 +1,37 @@
+interface AuthRequest {
+    signedCookies?: Record<string, string>;
+    cookies?: Record<string, string>;
+    headers: {
+        cookie: string;
+    };
+}
+export interface Store {
+    get: (key: string, cb: (err: Error, session: Record<string, {
+        user: {
+            logged_in: boolean;
+        };
+    }>) => void) => void;
+}
+export declare function authorize(options: {
+    passport: {
+        _key: string;
+    };
+    cookieParser: (secret: string | null) => (req: AuthRequest, options: Record<string, any>, cb: (err: string) => void) => void;
+    checkUser?: (user: string, pass: string, cb: (error: Error | null, result?: {
+        logged_in: boolean;
+    }) => void) => void;
+    fail: (data: any, message: string, critical: boolean, accept: (err: Error | null) => void) => void;
+    success: (data: any, accept: (err: Error | null) => void) => void;
+}): (data: {
+    headers: {
+        cookie: string;
+    };
+    url: string;
+    query: Record<string, string>;
+    cookie: Record<string, string> | undefined;
+    sessionID: string;
+    user: {
+        logged_in: boolean;
+    };
+}, accept: (err: Error | null) => void) => void;
+export {};

package/{lib → dist/lib}/passportSocket.js

@@ -1,26 +1,24 @@
+"use strict";
 // 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.
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authorize = authorize;
 function parseCookie(auth, cookieHeader) {
     const cookieParser = auth.cookieParser(auth.secret);
     const req = {
         headers: {
-            cookie: cookieHeader
-        }
+            cookie: cookieHeader,
+        },
     };
-
     let result;
-
     cookieParser(req, {}, err => {
         if (err) {
-            throw err;
+            throw new Error(err);
         }
         result = req.signedCookies || req.cookies;
     });
-
     return result;
 }
-
 function getQuery(url) {
     const query = url.split('?')[1] || '';
     const parts = query.split('&');
@@ -31,75 +29,60 @@ function getQuery(url) {
     }
     return result;
 }
-
 function authorize(options) {
     const defaults = {
         key: 'connect.sid',
         secret: null,
         store: null,
-        userProperty: 'user'
+        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"
-        );
+        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) {
+                }
+                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[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] || '';
+        if (data.cookie) {
+            data.sessionID = data.cookie[auth.key] || '';
+        }
         data[auth.userProperty] = {
-            logged_in: false
+            logged_in: false,
         };
-
-        auth.store.get(data.sessionID, (err, session) => {
+        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, `Error in session store:\n${err.message}`, true, accept);
+            }
+            if (!session) {
                 return auth.fail(data, 'No session found', false, accept);
-            } else if (!session[auth.passport._key]) {
+            }
+            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
-                );
+                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;
+//# sourceMappingURL=passportSocket.js.map

package/dist/lib/passportSocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"passportSocket.js","sourceRoot":"","sources":["../../src/lib/passportSocket.ts"],"names":[],"mappings":";AAAA,yGAAyG;AACzG,0EAA0E;;AAqD1E,8BAiHC;AAxJD,SAAS,WAAW,CAChB,IAKC,EACD,YAAoB;IAEpB,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,MAAM,GAAG,GAAgB;QACrB,OAAO,EAAE;YACL,MAAM,EAAE,YAAY;SACvB;KACJ,CAAC;IAEF,IAAI,MAA0C,CAAC;IAE/C,YAAY,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE;QACxB,IAAI,GAAG,EAAE,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QACD,MAAM,GAAG,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,OAAO,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,QAAQ,CAAC,GAAW;IACzB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACtC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC/B,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAgB,SAAS,CAAC,OAYzB;IAaG,MAAM,QAAQ,GAAsF;QAChG,GAAG,EAAE,aAAa;QAClB,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,IAAI;QACX,YAAY,EAAE,MAAM;KACvB,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAElD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;IAChG,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CACX,qGAAqG,CACxG,CAAC;IACN,CAAC;IAED,OAAO,UACH,IASC,EACD,MAAmC;QAEnC,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEhC,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAC1D,OAAO,OAAO,CAAC,SAAS,CACpB,IAAI,CAAC,KAAK,CAAC,IAAI,EACf,IAAI,CAAC,KAAK,CAAC,IAAI,EACf,CAAC,KAAmB,EAAE,MAA+B,EAAE,EAAE;gBACrD,IAAI,KAAK,EAAE,CAAC;oBACR,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,mBAAmB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;gBAC/D,CAAC;gBACD,IAAI,CAAC,MAAM,EAAE,CAAC;oBACV,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;gBAC5D,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC;gBACjC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;gBACzC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC/B,CAAC,CACJ,CAAC;QACN,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QAC3D,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG;YACtB,SAAS,EAAE,KAAK;SACnB,CAAC;QAEF,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAU,EAAE,OAAyD,EAAE,EAAE;YACtG,IAAI,GAAG,EAAE,CAAC;gBACN,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,4BAA4B,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YACpF,CAAC;YACD,IAAI,CAAC,OAAO,EAAE,CAAC;gBACX,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YAC9D,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,8BAA8B,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YACzE,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;YAEjD,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;gBACjC,OAAO,IAAI,CAAC,IAAI,CACZ,IAAI,EACJ,iEAAiE,EACjE,KAAK,EACL,MAAM,CACT,CAAC;YACN,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;YACzC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC"}

package/dist/lib/socketCommands.d.ts

@@ -0,0 +1,83 @@
+import type { Socket as WebSocketClient } from '@iobroker/ws-server';
+import { type PermissionCommands, type SocketSubscribeTypes, type SocketOperation, type SocketCallback } from '../types';
+export declare const COMMANDS_PERMISSIONS: Record<PermissionCommands, {
+    type: 'object' | 'state' | 'users' | 'other' | 'file' | '';
+    operation: SocketOperation;
+}>;
+export type AdapterRating = {
+    rating: {
+        r: number;
+        c: number;
+    };
+    [version: string]: {
+        r: number;
+        c: number;
+    };
+};
+export type Ratings = {
+    [adapterName: string]: AdapterRating;
+} & {
+    uuid: string;
+};
+export type SupportedFeature = 'ALIAS' | 'ALIAS_SEPARATE_READ_WRITE_ID' | 'ADAPTER_GETPORT_BIND' | 'ADAPTER_DEL_OBJECT_RECURSIVE' | 'ADAPTER_SET_OBJECT_SETS_DEFAULT_VALUE' | 'ADAPTER_AUTO_DECRYPT_NATIVE' | 'PLUGINS' | 'CONTROLLER_NPM_AUTO_REBUILD' | 'CONTROLLER_READWRITE_BASE_SETTINGS' | 'CONTROLLER_MULTI_REPO' | 'CONTROLLER_LICENSE_MANAGER' | 'CONTROLLER_OS_PACKAGE_UPGRADE' | 'DEL_INSTANCE_CUSTOM' | 'CUSTOM_FULL_VIEW' | 'ADAPTER_GET_OBJECTS_BY_ARRAY' | 'CONTROLLER_UI_UPGRADE' | 'ADAPTER_WEBSERVER_UPGRADE' | 'INSTANCE_MESSAGES' | 'PARTIAL_OBJECT_TREE';
+export interface SocketDataContext {
+    language: ioBroker.Languages;
+    ratings: Ratings | null;
+    ratingTimeout: NodeJS.Timeout | null;
+}
+export declare class SocketCommands {
+    #private;
+    static ERROR_PERMISSION: string;
+    static COMMANDS_PERMISSIONS: Record<string, {
+        type: 'object' | 'state' | 'users' | 'other' | 'file' | '';
+        operation: SocketOperation;
+    }>;
+    protected adapter: ioBroker.Adapter;
+    protected context: SocketDataContext;
+    protected commands: Record<string, (socket: WebSocketClient, ...args: any[]) => void>;
+    protected subscribes: Record<string, Record<string, number>>;
+    adapterName: string | undefined;
+    protected _sendToHost: ((id: string, command: string, data: any, callback: (result: {
+        error?: string;
+        result?: any;
+    }) => void) => void) | null;
+    states: Record<string, ioBroker.State> | null;
+    constructor(adapter: ioBroker.Adapter, updateSession: (socket: WebSocketClient) => boolean, context: SocketDataContext);
+    /**
+     * Convert errors into strings and then call cb
+     *
+     * @param callback Callback function
+     * @param error Error
+     * @param args Arguments passed to callback
+     */
+    static _fixCallback(callback: SocketCallback | null | undefined, error: string | Error | null | undefined, ...args: any[]): void;
+    _checkPermissions(socket: WebSocketClient, command: PermissionCommands, callback: ((error: string | null, ...args: any[]) => void) | undefined, ...args: any[]): boolean;
+    publish(socket: WebSocketClient, type: SocketSubscribeTypes, id: string, obj: ioBroker.Object | ioBroker.State): boolean;
+    publishFile(socket: WebSocketClient, id: string, fileName: string, size: number): boolean;
+    publishInstanceMessage(socket: WebSocketClient, sourceInstance: string, messageType: string, data: any): boolean;
+    _showSubscribes(socket: WebSocketClient, type: SocketSubscribeTypes): void;
+    isLogEnabled(): boolean;
+    subscribe(socket: WebSocketClient, type: SocketSubscribeTypes, pattern: string, patternFile?: string): void;
+    unsubscribe(socket: WebSocketClient, type: SocketSubscribeTypes, pattern: string, patternFile?: string): void;
+    subscribeSocket(socket: WebSocketClient, type?: SocketSubscribeTypes): void;
+    unsubscribeSocket(socket: WebSocketClient, type?: SocketSubscribeTypes): void;
+    _unsubscribeFiles(socket: WebSocketClient, id: string, pattern: string | string[], callback?: (error: string | null) => void): void;
+    addCommandHandler(command: string, handler: (socket: WebSocketClient, ...args: any[]) => void): void;
+    getCommandHandler(command: string): (socket: WebSocketClient, ...args: any[]) => void;
+    /**
+     * Converts old structures of config definitions into new one - `adminUI`
+     *
+     * @param obj Instance or adapter object to be converted
+     */
+    protected fixAdminUI(obj: ioBroker.AdapterObject | ioBroker.InstanceObject): void;
+    protected _initCommandsCommon(): void;
+    /** Init commands for files */
+    protected _initCommandsFiles(): void;
+    /** Init commands for states */
+    protected _initCommandsStates(): void;
+    /** Init commands for objects */
+    protected _initCommandsObjects(): void;
+    applyCommands(socket: WebSocketClient): void;
+    disableEventThreshold(): void;
+    destroy(): void;
+}