[TYPING] Added types for session (#3025)

* Added types for session

* Update packages/common-db/src/lib/common/session.ts

Co-authored-by: Copilot <[email protected]>

* Fixing typing

* Update build ubuntu to 22.04 (from 20.04)

---------

Co-authored-by: Copilot <[email protected]>

Author: GermanBluefox

packages/common-db/src/lib/common/session.ts

@@ -1,24 +1,33 @@
-type Session = any;
+type SessionData = Record<string, any>;
+
+type Session = {
+    Store: any;
+};
 
 // TODO: in the long term move this file somewhere where we have types access it is nowhere used in controller itself and just exported for adapters so it should go to js-controller-adapter package
 interface AdapterStoreOptions {
     /** The ioBroker adapter */
     adapter: any;
     /** The cookie */
-    cookie: any;
+    cookie?: {
+        maxAge?: number;
+        originalMaxAge?: number;
+    };
 }
 
 /**
  * Function to create an AdapterStore constructor
  *
- * @param session The session object
- * @param defaultTtl the default time to live
+ * @param session The session object, like "express-session"
+ * @param defaultTtl the default time to live in seconds
  * @returns the constructor to create a new AdapterStore
  */
 export function createAdapterStore(session: Session, defaultTtl = 3600): any {
     const Store = session.Store;
 
     class AdapterStore extends Store {
+        private readonly adapter: any;
+
         constructor(options: AdapterStoreOptions) {
             super(options);
 
@@ -37,20 +46,36 @@ export function createAdapterStore(session: Session, defaultTtl = 3600): any {
          * @param sid Session ID
          * @param fn callback
          */
-        get(sid: string, fn: (err?: any, obj?: any) => void): void {
-            this.adapter.getSession(sid, (obj: any) => {
+        get(sid: string, fn: (err?: Error | string | null, obj?: SessionData) => void): void {
+            this.adapter.getSession(sid, (obj: SessionData): void => {
                 if (obj) {
                     if (fn) {
                         return fn(null, obj);
                     }
-                } else {
-                    if (fn) {
-                        return fn();
-                    }
+                } else if (fn) {
+                    return fn();
                 }
             });
         }
 
+        /**
+         * Commit the given `sess` object associated with the given `sid`.
+         *
+         * @param sid Session ID
+         * @param sess the session
+         * @param fn callback
+         */
+        set(sid: string, sess: SessionData, fn: (err?: Error | null) => void): void;
+        /**
+         * Commit the given `sess` object associated with the given `sid`.
+         *
+         * @param sid Session ID
+         * @param ttl Time to live
+         * @param sess the session
+         * @param fn callback
+         */
+        set(sid: string, ttl: number, sess: SessionData, fn: (err?: Error | null) => void): void;
+
         /**
          * Commit the given `sess` object associated with the given `sid`.
          *
@@ -59,22 +84,25 @@ export function createAdapterStore(session: Session, defaultTtl = 3600): any {
          * @param sess the session
          * @param fn callback
          */
-        set(sid: string, ttl: number, sess: Session, fn: (args: any) => void): void {
-            if (typeof ttl === 'object') {
-                fn = sess;
+        set(sid: unknown, ttl: unknown, sess: unknown, fn?: unknown): void {
+            if (typeof sess === 'function') {
+                fn = sess as (err?: Error | null) => void;
                 sess = ttl;
                 // analyse if the session is stored directly from express session
-                ttl =
-                    sess && sess.cookie && sess.cookie.originalMaxAge
-                        ? Math.round(sess.cookie.originalMaxAge / 1000)
-                        : defaultTtl;
+                ttl = (sess as SessionData)?.cookie?.originalMaxAge
+                    ? Math.round((sess as SessionData).cookie.originalMaxAge / 1000)
+                    : defaultTtl;
             }
             ttl = ttl || defaultTtl;
-            this.adapter.setSession(sid, ttl, sess, function () {
-                // @ts-expect-error fix later
-                // eslint-disable-next-line prefer-rest-params
-                fn && fn.apply(this, arguments);
-            }); // do not use here => !!!
+            this.adapter.setSession(
+                sid as string,
+                ttl as number,
+                sess as SessionData,
+                function (err?: Error | null): void {
+                    // @ts-expect-error fix later
+                    fn?.call(this, err);
+                },
+            ); // do not use here => !!!
         }
 
         /**

packages/types-dev/index.d.ts

@@ -138,7 +138,7 @@ declare global {
         interface Permission {
             /** The type of the permission */
             type: string;
-            /** Which kind of operation is required */
+            /** Defines which kind of operation is required */
             operation: string;
         }
         interface ObjectOrStatePermission extends Permission {

tsconfig.json

@@ -10,7 +10,7 @@
     "declaration": true, // generate .d.ts files
     "declarationMap": true, // generate .map files for .d.ts files
     "sourceMap": true, // generate .map files for .js files
-    "inlineSourceMap": false, // Alternatively inline the source maps
+    "inlineSourceMap": false, // Alternatively, inline the source maps
     // Don't emit anything by default. This will be turned on in the subprojects
     "noEmit": true,
     // Avoid TS errors in external dependencies