Migrated to TypeScript

.github/workflows/test-and-release.yml

@@ -97,10 +97,10 @@ jobs:
             - name: Checkout code
               uses: actions/checkout@v4
 
-            - name: Use Node.js 18.x
+            - name: Use Node.js 20.x
               uses: actions/setup-node@v4
               with:
-                  node-version: 18.x
+                  node-version: 20.x
 
             - name: Extract the version and commit body from the tag
               id: extract_release

dist/lib/SimpleAPI.d.ts

@@ -0,0 +1,95 @@
+import type { Server as HttpServer } from 'node:http';
+import type { Server as HttpsServer } from 'node:https';
+import { Express, type Request, type Response } from 'express';
+export type Server = HttpServer | HttpsServer;
+declare const commandsPermissions: {
+    [operation: string]: {
+        type: 'state' | 'object' | '';
+        operation: 'read' | 'write' | 'list' | '';
+    };
+};
+type CommandName = keyof typeof commandsPermissions;
+/**
+ * SimpleAPI class
+ *
+ * From settings used only secure, auth and crossDomain
+ *
+ * @class
+ * @param webSettings settings of the web server, like <pre><code>{secure: settings.secure, port: settings.port}</code></pre>
+ * @param adapter web adapter object
+ * @param instanceSettings instance object with common and native
+ * @param app express application
+ * @return object instance
+ */
+export declare class SimpleAPI {
+    private readonly adapter;
+    private readonly settings;
+    private readonly config;
+    private readonly namespace;
+    private readonly app?;
+    private readonly cachedNames;
+    private readonly cachedIds;
+    private readonly restApiDelayed;
+    constructor(_server: Server, webSettings: {
+        secure: boolean;
+        port: number | string;
+        defaultUser?: string;
+        auth?: boolean;
+        language?: ioBroker.Languages;
+    }, adapter: ioBroker.Adapter, instanceSettings: ioBroker.InstanceObject, app?: Express);
+    isAuthenticated(query: {
+        user?: string;
+        pass?: string;
+    }): Promise<boolean>;
+    stateChange(id: string, state: ioBroker.State | null | undefined): void;
+    objectChange(id: string, _obj: ioBroker.Object | null | undefined): void;
+    static parseQuery(input: string | undefined, query: {
+        user?: string;
+        pass?: string;
+        prettyPrint?: boolean;
+        json?: boolean;
+        noStringify?: boolean;
+        wait?: number;
+        ack: boolean;
+    }, values: Record<string, string | null>): void;
+    setStates(values: Record<string, string | null>, query: {
+        user?: string;
+        pass?: string;
+        prettyPrint?: boolean;
+        json?: boolean;
+        noStringify?: boolean;
+        wait?: number;
+        ack: boolean;
+    }): Promise<{
+        id?: string;
+        val?: boolean | string | number;
+        error?: string;
+    }[]>;
+    restApiPost(req: Request, res: Response, command: CommandName, oId: string[], values: Record<string, string | null>, query: {
+        user?: string;
+        pass?: string;
+        prettyPrint?: boolean;
+        json?: boolean;
+        noStringify?: boolean;
+        wait?: number;
+        ack: boolean;
+    }): Promise<void>;
+    findState(idOrName: string, user: `system.user.${string}`): Promise<{
+        id: string;
+        name: string;
+    }>;
+    getState(idOrName: string, user: `system.user.${string}`): Promise<{
+        state: ioBroker.State | null | undefined;
+        id: string;
+    }>;
+    doResponse(res: Response, type: 'json' | 'plain', content?: any, pretty?: boolean): void;
+    doErrorResponse(res: Response, type: 'json' | 'plain', status: 401 | 403 | 404 | 422 | 500, error?: string): void;
+    checkPermissions(user: `system.user.${string}`, command: CommandName): Promise<boolean>;
+    setValue(id: string, value: ioBroker.StateValue, res: Response, wait: number, query: {
+        ack: boolean;
+        user?: string;
+        prettyPrint?: boolean;
+    }, responseType: 'json' | 'plain'): Promise<void>;
+    restApi(req: Request, res: Response, overwriteUrl?: string): Promise<void>;
+}
+export {};