@iobroker/dm-utils 0.5.0 → 0.6.1

package/README.md

@@ -295,6 +295,15 @@ This method returns a promise that resolves to a `ProgressDialog` object.
 	### **WORK IN PROGRESS**
 -->
 ## Changelog
+### 0.6.1 (2024-11-18)
+
+* (@GermanBluefox) Added configurable buttons for form
+
+### 0.6.0 (2024-11-17)
+
+* (@GermanBluefox) used new ioBroker/eslint-config lib and changed prettifier settings
+* (@GermanBluefox) updated JsonConfig types
+
 ### 0.5.0 (2024-08-30)
 * (bluefox) Migrated to eslint 9
 

package/build/ActionContext.d.ts

@@ -1,11 +1,12 @@
-import { JsonFormData, JsonFormSchema } from ".";
-import { ProgressDialog } from "./ProgressDialog";
+import type { ActionButton, JsonFormData, JsonFormSchema } from '.';
+import type { ProgressDialog } from './ProgressDialog';
 export interface ActionContext {
     showMessage(text: ioBroker.StringOrTranslated): Promise<void>;
     showConfirmation(text: ioBroker.StringOrTranslated): Promise<boolean>;
     showForm(schema: JsonFormSchema, options?: {
         data?: JsonFormData;
         title?: ioBroker.StringOrTranslated;
+        buttons?: ActionButton[];
     }): Promise<JsonFormData | undefined>;
     openProgress(title: string, options?: {
         indeterminate?: boolean;

package/build/DeviceManagement.d.ts

@@ -1,8 +1,8 @@
-import { AdapterInstance } from "@iobroker/adapter-core";
-import { ActionContext } from "./ActionContext";
-import { ProgressDialog } from "./ProgressDialog";
-import { DeviceDetails, DeviceInfo, ErrorResponse, InstanceDetails, JsonFormData, JsonFormSchema, RefreshResponse, RetVal } from "./types";
-import { ControlState } from "./types/base";
+import type { AdapterInstance } from '@iobroker/adapter-core';
+import type { ActionContext } from './ActionContext';
+import type { ProgressDialog } from './ProgressDialog';
+import { type DeviceDetails, type DeviceInfo, type ErrorResponse, type InstanceDetails, type JsonFormData, type JsonFormSchema, type RefreshResponse, type RetVal } from './types';
+import type { ControlState } from './types/base';
 export declare abstract class DeviceManagement<T extends AdapterInstance = AdapterInstance> {
     protected readonly adapter: T;
     private instanceInfo?;

package/build/DeviceManagement.js

@@ -6,13 +6,13 @@ class DeviceManagement {
     constructor(adapter) {
         this.adapter = adapter;
         this.contexts = new Map();
-        adapter.on("message", this.onMessage.bind(this));
+        adapter.on('message', this.onMessage.bind(this));
     }
     get log() {
         return this.adapter.log;
     }
     getInstanceInfo() {
-        return { apiVersion: "v1" };
+        return { apiVersion: 'v1' };
     }
     getDeviceDetails(id) {
         return { id, schema: {} };
@@ -21,17 +21,30 @@ class DeviceManagement {
         var _a;
         if (!this.instanceInfo) {
             this.log.warn(`Instance action ${actionId} was called before getInstanceInfo()`);
-            return { error: { code: types_1.ErrorCodes.E_INSTANCE_ACTION_NOT_INITIALIZED, message: `Instance action ${actionId} was called before getInstanceInfo()` } };
+            return {
+                error: {
+                    code: types_1.ErrorCodes.E_INSTANCE_ACTION_NOT_INITIALIZED,
+                    message: `Instance action ${actionId} was called before getInstanceInfo()`,
+                },
+            };
         }
-        const action = (_a = this.instanceInfo.actions) === null || _a === void 0 ? void 0 : _a.find((a) => a.id === actionId);
+        const action = (_a = this.instanceInfo.actions) === null || _a === void 0 ? void 0 : _a.find(a => a.id === actionId);
         if (!action) {
             this.log.warn(`Instance action ${actionId} is unknown`);
-            return { error: { code: types_1.ErrorCodes.E_INSTANCE_ACTION_UNKNOWN, message: `Instance action ${actionId} is unknown` } };
+            return {
+                error: {
+                    code: types_1.ErrorCodes.E_INSTANCE_ACTION_UNKNOWN,
+                    message: `Instance action ${actionId} is unknown`,
+                },
+            };
         }
         if (!action.handler) {
             this.log.warn(`Instance action ${actionId} is disabled because it has no handler`);
             return {
-                error: { code: types_1.ErrorCodes.E_INSTANCE_ACTION_NO_HANDLER, message: `Instance action ${actionId} is disabled because it has no handler` },
+                error: {
+                    code: types_1.ErrorCodes.E_INSTANCE_ACTION_NO_HANDLER,
+                    message: `Instance action ${actionId} is disabled because it has no handler`,
+                },
             };
         }
         return action.handler(context, options);
@@ -40,19 +53,32 @@ class DeviceManagement {
         var _a;
         if (!this.devices) {
             this.log.warn(`Device action ${actionId} was called before listDevices()`);
-            return { error: { code: types_1.ErrorCodes.E_DEVICE_ACTION_NOT_INITIALIZED, message: `Device action ${actionId} was called before listDevices()` } };
+            return {
+                error: {
+                    code: types_1.ErrorCodes.E_DEVICE_ACTION_NOT_INITIALIZED,
+                    message: `Device action ${actionId} was called before listDevices()`,
+                },
+            };
         }
         const device = this.devices.get(deviceId);
         if (!device) {
             this.log.warn(`Device action ${actionId} was called on unknown device: ${deviceId}`);
             return {
-                error: { code: types_1.ErrorCodes.E_DEVICE_ACTION_DEVICE_UNKNOWN, message: `Device action ${actionId} was called on unknown device: ${deviceId}` },
+                error: {
+                    code: types_1.ErrorCodes.E_DEVICE_ACTION_DEVICE_UNKNOWN,
+                    message: `Device action ${actionId} was called on unknown device: ${deviceId}`,
+                },
             };
         }
-        const action = (_a = device.actions) === null || _a === void 0 ? void 0 : _a.find((a) => a.id === actionId);
+        const action = (_a = device.actions) === null || _a === void 0 ? void 0 : _a.find(a => a.id === actionId);
         if (!action) {
             this.log.warn(`Device action ${actionId} doesn't exist on device ${deviceId}`);
-            return { error: { code: types_1.ErrorCodes.E_DEVICE_ACTION_UNKNOWN, message: `Device action ${actionId} doesn't exist on device ${deviceId}` } };
+            return {
+                error: {
+                    code: types_1.ErrorCodes.E_DEVICE_ACTION_UNKNOWN,
+                    message: `Device action ${actionId} doesn't exist on device ${deviceId}`,
+                },
+            };
         }
         if (!action.handler) {
             this.log.warn(`Device action ${actionId} on ${deviceId} is disabled because it has no handler`);
@@ -69,19 +95,32 @@ class DeviceManagement {
         var _a;
         if (!this.devices) {
             this.log.warn(`Device control ${controlId} was called before listDevices()`);
-            return { error: { code: types_1.ErrorCodes.E_DEVICE_CONTROL_NOT_INITIALIZED, message: `Device control ${controlId} was called before listDevices()` } };
+            return {
+                error: {
+                    code: types_1.ErrorCodes.E_DEVICE_CONTROL_NOT_INITIALIZED,
+                    message: `Device control ${controlId} was called before listDevices()`,
+                },
+            };
         }
         const device = this.devices.get(deviceId);
         if (!device) {
             this.log.warn(`Device control ${controlId} was called on unknown device: ${deviceId}`);
             return {
-                error: { code: types_1.ErrorCodes.E_DEVICE_CONTROL_DEVICE_UNKNOWN, message: `Device control ${controlId} was called on unknown device: ${deviceId}` },
+                error: {
+                    code: types_1.ErrorCodes.E_DEVICE_CONTROL_DEVICE_UNKNOWN,
+                    message: `Device control ${controlId} was called on unknown device: ${deviceId}`,
+                },
             };
         }
-        const control = (_a = device.controls) === null || _a === void 0 ? void 0 : _a.find((a) => a.id === controlId);
+        const control = (_a = device.controls) === null || _a === void 0 ? void 0 : _a.find(a => a.id === controlId);
         if (!control) {
             this.log.warn(`Device control ${controlId} doesn't exist on device ${deviceId}`);
-            return { error: { code: types_1.ErrorCodes.E_DEVICE_CONTROL_UNKNOWN, message: `Device control ${controlId} doesn't exist on device ${deviceId}` } };
+            return {
+                error: {
+                    code: types_1.ErrorCodes.E_DEVICE_CONTROL_UNKNOWN,
+                    message: `Device control ${controlId} doesn't exist on device ${deviceId}`,
+                },
+            };
         }
         if (!control.handler) {
             this.log.warn(`Device control ${controlId} on ${deviceId} is disabled because it has no handler`);
@@ -99,19 +138,32 @@ class DeviceManagement {
         var _a;
         if (!this.devices) {
             this.log.warn(`Device get state ${controlId} was called before listDevices()`);
-            return { error: { code: types_1.ErrorCodes.E_DEVICE_GET_STATE_NOT_INITIALIZED, message: `Device control ${controlId} was called before listDevices()` } };
+            return {
+                error: {
+                    code: types_1.ErrorCodes.E_DEVICE_GET_STATE_NOT_INITIALIZED,
+                    message: `Device control ${controlId} was called before listDevices()`,
+                },
+            };
         }
         const device = this.devices.get(deviceId);
         if (!device) {
             this.log.warn(`Device get state ${controlId} was called on unknown device: ${deviceId}`);
             return {
-                error: { code: types_1.ErrorCodes.E_DEVICE_GET_STATE_DEVICE_UNKNOWN, message: `Device control ${controlId} was called on unknown device: ${deviceId}` },
+                error: {
+                    code: types_1.ErrorCodes.E_DEVICE_GET_STATE_DEVICE_UNKNOWN,
+                    message: `Device control ${controlId} was called on unknown device: ${deviceId}`,
+                },
             };
         }
-        const control = (_a = device.controls) === null || _a === void 0 ? void 0 : _a.find((a) => a.id === controlId);
+        const control = (_a = device.controls) === null || _a === void 0 ? void 0 : _a.find(a => a.id === controlId);
         if (!control) {
             this.log.warn(`Device get state ${controlId} doesn't exist on device ${deviceId}`);
-            return { error: { code: types_1.ErrorCodes.E_DEVICE_GET_STATE_UNKNOWN, message: `Device control ${controlId} doesn't exist on device ${deviceId}` } };
+            return {
+                error: {
+                    code: types_1.ErrorCodes.E_DEVICE_GET_STATE_UNKNOWN,
+                    message: `Device control ${controlId} doesn't exist on device ${deviceId}`,
+                },
+            };
         }
         if (!control.getStateHandler) {
             this.log.warn(`Device get state ${controlId} on ${deviceId} is disabled because it has no handler`);
@@ -125,20 +177,20 @@ class DeviceManagement {
         return control.getStateHandler(deviceId, controlId, context);
     }
     onMessage(obj) {
-        if (!obj.command.startsWith("dm:")) {
+        if (!obj.command.startsWith('dm:')) {
             return;
         }
-        this.handleMessage(obj).catch(this.log.error);
+        void this.handleMessage(obj).catch(this.log.error);
     }
     async handleMessage(msg) {
         this.log.debug(`DeviceManagement received: ${JSON.stringify(msg)}`);
         switch (msg.command) {
-            case "dm:instanceInfo": {
+            case 'dm:instanceInfo': {
                 this.instanceInfo = await this.getInstanceInfo();
                 this.sendReply(Object.assign(Object.assign({}, this.instanceInfo), { actions: this.convertActions(this.instanceInfo.actions) }), msg);
                 return;
             }
-            case "dm:listDevices": {
+            case 'dm:listDevices': {
                 const deviceList = await this.listDevices();
                 this.devices = deviceList.reduce((map, value) => {
                     if (map.has(value.id)) {
@@ -147,17 +199,17 @@ class DeviceManagement {
                     map.set(value.id, value);
                     return map;
                 }, new Map());
-                const apiDeviceList = deviceList.map((d) => (Object.assign(Object.assign({}, d), { actions: this.convertActions(d.actions), controls: this.convertControls(d.controls) })));
+                const apiDeviceList = deviceList.map(d => (Object.assign(Object.assign({}, d), { actions: this.convertActions(d.actions), controls: this.convertControls(d.controls) })));
                 this.sendReply(apiDeviceList, msg);
                 this.adapter.sendTo(msg.from, msg.command, this.devices, msg.callback);
                 return;
             }
-            case "dm:deviceDetails": {
+            case 'dm:deviceDetails': {
                 const details = await this.getDeviceDetails(msg.message);
                 this.adapter.sendTo(msg.from, msg.command, details, msg.callback);
                 return;
             }
-            case "dm:instanceAction": {
+            case 'dm:instanceAction': {
                 const action = msg.message;
                 const context = new MessageContext(msg, this.adapter);
                 this.contexts.set(msg._id, context);
@@ -166,16 +218,18 @@ class DeviceManagement {
                 context.sendFinalResult(result);
                 return;
             }
-            case "dm:deviceAction": {
+            case 'dm:deviceAction': {
                 const action = msg.message;
                 const context = new MessageContext(msg, this.adapter);
                 this.contexts.set(msg._id, context);
-                const result = await this.handleDeviceAction(action.deviceId, action.actionId, context, { value: action.value });
+                const result = await this.handleDeviceAction(action.deviceId, action.actionId, context, {
+                    value: action.value,
+                });
                 this.contexts.delete(msg._id);
                 context.sendFinalResult(result);
                 return;
             }
-            case "dm:deviceControl": {
+            case 'dm:deviceControl': {
                 const control = msg.message;
                 const context = new MessageContext(msg, this.adapter);
                 this.contexts.set(msg._id, context);
@@ -184,7 +238,7 @@ class DeviceManagement {
                 context.sendControlResult(control.deviceId, control.controlId, result);
                 return;
             }
-            case "dm:deviceControlState": {
+            case 'dm:deviceControlState': {
                 const control = msg.message;
                 const context = new MessageContext(msg, this.adapter);
                 this.contexts.set(msg._id, context);
@@ -193,12 +247,12 @@ class DeviceManagement {
                 context.sendControlResult(control.deviceId, control.controlId, result);
                 return;
             }
-            case "dm:actionProgress": {
+            case 'dm:actionProgress': {
                 const { origin } = msg.message;
                 const context = this.contexts.get(origin);
                 if (!context) {
                     this.log.warn(`Unknown message origin: ${origin}`);
-                    this.sendReply({ error: "Unknown action origin" }, msg);
+                    this.sendReply({ error: 'Unknown action origin' }, msg);
                     return;
                 }
                 context.handleProgress(msg);
@@ -212,7 +266,7 @@ class DeviceManagement {
         }
         // detect duplicate IDs
         const ids = new Set();
-        actions.forEach((a) => {
+        actions.forEach(a => {
             if (ids.has(a.id)) {
                 throw new Error(`Action ID ${a.id} is used twice, this would lead to unexpected behavior`);
             }
@@ -227,7 +281,7 @@ class DeviceManagement {
         }
         // detect duplicate IDs
         const ids = new Set();
-        controls.forEach((a) => {
+        controls.forEach(a => {
             if (ids.has(a.id)) {
                 throw new Error(`Control ID ${a.id} is used twice, this would lead to unexpected behavior`);
             }
@@ -249,30 +303,30 @@ class MessageContext {
     }
     showMessage(text) {
         this.checkPreconditions();
-        const promise = new Promise((resolve) => {
+        const promise = new Promise(resolve => {
             this.progressHandler = () => resolve();
         });
-        this.send("message", {
+        this.send('message', {
             message: text,
         });
         return promise;
     }
     showConfirmation(text) {
         this.checkPreconditions();
-        const promise = new Promise((resolve) => {
-            this.progressHandler = (msg) => resolve(!!msg.confirm);
+        const promise = new Promise(resolve => {
+            this.progressHandler = msg => resolve(!!msg.confirm);
         });
-        this.send("confirm", {
+        this.send('confirm', {
             confirm: text,
         });
         return promise;
     }
     showForm(schema, options) {
         this.checkPreconditions();
-        const promise = new Promise((resolve) => {
-            this.progressHandler = (msg) => resolve(msg.data);
+        const promise = new Promise(resolve => {
+            this.progressHandler = msg => resolve(msg.data);
         });
-        this.send("form", {
+        this.send('form', {
             form: Object.assign({ schema }, options),
         });
         return promise;
@@ -282,43 +336,43 @@ class MessageContext {
         this.hasOpenProgressDialog = true;
         const dialog = {
             update: (update) => {
-                const promise = new Promise((resolve) => {
+                const promise = new Promise(resolve => {
                     this.progressHandler = () => resolve();
                 });
-                this.send("progress", {
+                this.send('progress', {
                     progress: Object.assign(Object.assign(Object.assign({ title }, options), update), { open: true }),
                 });
                 return promise;
             },
             close: () => {
-                const promise = new Promise((resolve) => {
+                const promise = new Promise(resolve => {
                     this.progressHandler = () => {
                         this.hasOpenProgressDialog = false;
                         resolve();
                     };
                 });
-                this.send("progress", {
+                this.send('progress', {
                     progress: { open: false },
                 });
                 return promise;
             },
         };
-        const promise = new Promise((resolve) => {
+        const promise = new Promise(resolve => {
             this.progressHandler = () => resolve(dialog);
         });
-        this.send("progress", {
+        this.send('progress', {
             progress: Object.assign(Object.assign({ title }, options), { open: true }),
         });
         return promise;
     }
     sendFinalResult(result) {
-        this.send("result", {
+        this.send('result', {
             result,
         });
     }
     sendControlResult(deviceId, controlId, result) {
-        if (typeof result === "object" && "error" in result) {
-            this.send("result", {
+        if (typeof result === 'object' && 'error' in result) {
+            this.send('result', {
                 result: {
                     error: result.error,
                     deviceId,
@@ -327,7 +381,7 @@ class MessageContext {
             });
         }
         else {
-            this.send("result", {
+            this.send('result', {
                 result: {
                     state: result,
                     deviceId,
@@ -338,7 +392,7 @@ class MessageContext {
     }
     handleProgress(message) {
         const currentHandler = this.progressHandler;
-        if (currentHandler && typeof message.message !== "string") {
+        if (currentHandler && typeof message.message !== 'string') {
             this.lastMessage = message;
             this.progressHandler = undefined;
             currentHandler(message.message);

package/build/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./ActionContext";
-export * from "./DeviceManagement";
-export * from "./types";
+export type * from './ActionContext';
+export * from './DeviceManagement';
+export * from './types';

package/build/index.js

@@ -14,7 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ActionContext"), exports);
 __exportStar(require("./DeviceManagement"), exports);
 // don't export * from "./MessageContext" as it is private
 __exportStar(require("./types"), exports);

package/build/types/adapter.d.ts

@@ -1,7 +1,7 @@
-import * as base from "./base";
-export type ActionBase = base.ActionBase<"adapter">;
-export type InstanceAction = base.InstanceAction<"adapter">;
-export type DeviceAction = base.DeviceAction<"adapter">;
-export type InstanceDetails = base.InstanceDetails<"adapter">;
-export type DeviceInfo = base.DeviceInfo<"adapter">;
-export type DeviceControl = base.DeviceControl<"adapter">;
+import type * as base from './base';
+export type ActionBase = base.ActionBase<'adapter'>;
+export type InstanceAction = base.InstanceAction<'adapter'>;
+export type DeviceAction = base.DeviceAction<'adapter'>;
+export type InstanceDetails = base.InstanceDetails<'adapter'>;
+export type DeviceInfo = base.DeviceInfo<'adapter'>;
+export type DeviceControl = base.DeviceControl<'adapter'>;

package/build/types/api.d.ts

@@ -1,7 +1,7 @@
-import * as base from "./base";
-export type ActionBase = base.ActionBase<"api">;
-export type InstanceAction = base.InstanceAction<"api">;
-export type DeviceAction = base.DeviceAction<"api">;
-export type InstanceDetails = base.InstanceDetails<"api">;
-export type DeviceInfo = base.DeviceInfo<"api">;
-export type DeviceControl = base.DeviceControl<"api">;
+import type * as base from './base';
+export type ActionBase = base.ActionBase<'api'>;
+export type InstanceAction = base.InstanceAction<'api'>;
+export type DeviceAction = base.DeviceAction<'api'>;
+export type InstanceDetails = base.InstanceDetails<'api'>;
+export type DeviceInfo = base.DeviceInfo<'api'>;
+export type DeviceControl = base.DeviceControl<'api'>;

package/build/types/base.d.ts

@@ -1,16 +1,16 @@
-import { ActionContext, ErrorResponse, MessageContext } from "..";
-import { ApiVersion, DeviceRefresh, DeviceStatus, RetVal } from "./common";
-type ActionType = "api" | "adapter";
-export type Color = "primary" | "secondary" | string & {};
+import type { ActionContext, ErrorResponse, MessageContext } from '..';
+import type { ApiVersion, DeviceRefresh, DeviceStatus, RetVal } from './common';
+type ActionType = 'api' | 'adapter';
+export type Color = 'primary' | 'secondary' | (string & {});
 export type ControlState = string | number | boolean | null;
 export interface ActionBase<T extends ActionType> {
     id: string;
     /**
      * This can either be base64 or the URL to an icon.
      */
-    icon?: "edit" | "rename" | "delete" | "refresh" | "newDevice" | "new" | "add" | "discover" | "search" | "unpairDevice" | "pairDevice" | "identify" | "play" | "stop" | "pause" | "forward" | "next" | "rewind" | "previous" | "lamp" | "light" | "backlight" | "dimmer" | "socket" | "settings" | "users" | "group" | "user" | string;
+    icon?: 'edit' | 'rename' | 'delete' | 'refresh' | 'newDevice' | 'new' | 'add' | 'discover' | 'search' | 'unpairDevice' | 'pairDevice' | 'identify' | 'play' | 'stop' | 'pause' | 'forward' | 'next' | 'rewind' | 'previous' | 'lamp' | 'light' | 'backlight' | 'dimmer' | 'socket' | 'settings' | 'users' | 'group' | 'user' | string;
     description?: ioBroker.StringOrTranslated;
-    disabled?: T extends "api" ? boolean : never;
+    disabled?: T extends 'api' ? boolean : never;
     color?: Color;
     backgroundColor?: Color;
     /** If true, the user will be asked for confirmation before executing the action */
@@ -20,7 +20,7 @@ export interface ActionBase<T extends ActionType> {
         /** This label will be shown for the text input */
         label: ioBroker.StringOrTranslated;
         /** This type of input will be shown. Default is type */
-        type?: "text" | "number" | "checkbox" | "select" | "slider" | "color";
+        type?: 'text' | 'number' | 'checkbox' | 'select' | 'slider' | 'color';
         /** If a type is "select", the options must be defined */
         options?: {
             label: ioBroker.StringOrTranslated;
@@ -48,7 +48,7 @@ export interface ChannelInfo {
 }
 export interface ControlBase {
     id: string;
-    type: "button" | "switch" | "slider" | "select" | "icon" | "color" | "text" | "number" | "info";
+    type: 'button' | 'switch' | 'slider' | 'select' | 'icon' | 'color' | 'text' | 'number' | 'info';
     state?: ioBroker.State;
     stateId?: string;
     icon?: string;
@@ -70,26 +70,26 @@ export interface ControlBase {
     }[];
     channel?: ChannelInfo;
 }
-export interface DeviceControl<T extends ActionType = "api"> extends ControlBase {
-    handler?: T extends "api" ? never : (deviceId: string, actionId: string, state: ControlState, context: MessageContext) => RetVal<ErrorResponse | ioBroker.State>;
-    getStateHandler?: T extends "api" ? never : (deviceId: string, actionId: string, context: MessageContext) => RetVal<ErrorResponse | ioBroker.State>;
+export interface DeviceControl<T extends ActionType = 'api'> extends ControlBase {
+    handler?: T extends 'api' ? never : (deviceId: string, actionId: string, state: ControlState, context: MessageContext) => RetVal<ErrorResponse | ioBroker.State>;
+    getStateHandler?: T extends 'api' ? never : (deviceId: string, actionId: string, context: MessageContext) => RetVal<ErrorResponse | ioBroker.State>;
 }
-export interface InstanceAction<T extends ActionType = "api"> extends ActionBase<T> {
-    handler?: T extends "api" ? never : (context: ActionContext, options?: Record<string, any>) => RetVal<{
+export interface InstanceAction<T extends ActionType = 'api'> extends ActionBase<T> {
+    handler?: T extends 'api' ? never : (context: ActionContext, options?: Record<string, any>) => RetVal<{
         refresh: boolean;
     }>;
     title: ioBroker.StringOrTranslated;
 }
-export interface DeviceAction<T extends ActionType = "api"> extends ActionBase<T> {
-    handler?: T extends "api" ? never : (deviceId: string, context: ActionContext, options?: Record<string, any>) => RetVal<{
+export interface DeviceAction<T extends ActionType = 'api'> extends ActionBase<T> {
+    handler?: T extends 'api' ? never : (deviceId: string, context: ActionContext, options?: Record<string, any>) => RetVal<{
         refresh: DeviceRefresh;
     }>;
 }
-export interface InstanceDetails<T extends ActionType = "api"> {
+export interface InstanceDetails<T extends ActionType = 'api'> {
     apiVersion: ApiVersion;
     actions?: InstanceAction<T>[];
 }
-export interface DeviceInfo<T extends ActionType = "api"> {
+export interface DeviceInfo<T extends ActionType = 'api'> {
     id: string;
     icon?: string;
     manufacturer?: ioBroker.StringOrTranslated;

package/build/types/common.d.ts

@@ -1,15 +1,23 @@
-export type ApiVersion = "v1";
-export type DeviceStatus = "connected" | "disconnected" | {
+export type ApiVersion = 'v1';
+export type DeviceStatus = 'connected' | 'disconnected' | {
     /**
      * This can either be the name of a font awesome icon (e.g. "fa-signal") or the URL to an icon.
      */
     icon?: string;
-    battery?: number | boolean | "charging" | string;
-    connection?: "connected" | "disconnected";
+    battery?: number | boolean | 'charging';
+    connection?: 'connected' | 'disconnected';
     rssi?: number;
     warning?: ioBroker.StringOrTranslated | boolean;
 };
-export type DeviceRefresh = "device" | "instance" | false | true;
+export type ActionButton = {
+    label: ioBroker.StringOrTranslated;
+    type: 'apply' | 'cancel';
+    icon?: string;
+    variant?: 'contained' | 'outlined' | 'text';
+    style?: Record<string, number | string>;
+    color: 'primary' | 'secondary';
+} | 'ok' | 'cancel';
+export type DeviceRefresh = 'device' | 'instance' | false | true;
 export type RefreshResponse = {
     refresh: DeviceRefresh;
 };
@@ -30,7 +38,7 @@ interface ObjectBrowserCustomFilter {
     };
 }
 export type ObjectBrowserType = 'state' | 'instance' | 'channel' | 'device' | 'chart';
-export type ConfigItemType = 'tabs' | 'panel' | 'text' | 'number' | 'color' | 'checkbox' | 'slider' | 'ip' | 'user' | 'room' | 'func' | 'select' | 'autocomplete' | 'image' | 'objectId' | 'password' | 'instance' | 'chips' | 'alive' | 'pattern' | 'sendto' | 'setState' | 'staticText' | 'staticLink' | 'staticImage' | 'table' | 'accordion' | 'jsonEditor' | 'language' | 'certificate' | 'certificates' | 'certCollection' | 'custom' | 'datePicker' | 'timePicker' | 'divider' | 'header' | 'cron' | 'fileSelector' | 'file' | 'imageSendTo' | 'selectSendTo' | 'autocompleteSendTo' | 'textSendTo' | 'coordinates' | 'interface' | 'license' | 'checkLicense' | 'uuid' | 'port' | 'deviceManager' | 'topic' | 'qrCode' | 'state';
+export type ConfigItemType = 'tabs' | 'panel' | 'text' | 'number' | 'color' | 'checkbox' | 'slider' | 'ip' | 'user' | 'room' | 'func' | 'select' | 'autocomplete' | 'image' | 'objectId' | 'password' | 'instance' | 'chips' | 'alive' | 'pattern' | 'sendto' | 'setState' | 'staticInfo' | 'staticText' | 'staticLink' | 'staticImage' | 'table' | 'accordion' | 'jsonEditor' | 'language' | 'certificate' | 'certificates' | 'certCollection' | 'custom' | 'datePicker' | 'timePicker' | 'divider' | 'header' | 'cron' | 'fileSelector' | 'file' | 'imageSendTo' | 'selectSendTo' | 'autocompleteSendTo' | 'textSendTo' | 'coordinates' | 'interface' | 'license' | 'checkLicense' | 'uuid' | 'port' | 'deviceManager' | 'topic' | 'qrCode' | 'state';
 type ConfigIconType = 'edit' | 'auth' | 'send' | 'web' | 'warning' | 'error' | 'info' | 'search' | 'book' | 'help' | 'upload' | 'user' | 'group' | 'delete' | 'refresh' | 'add' | 'unpair' | 'pair' | string;
 export interface ConfigItemConfirmData {
     condition: string;
@@ -42,19 +50,33 @@ export interface ConfigItemConfirmData {
     alsoDependsOn?: string[];
 }
 export interface ConfigItem {
+    /** Type of the JSON config item */
     type: ConfigItemType;
+    /** Width of the control on "extra small" displays */
+    xs?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+    /** Width of the control on "small" displays */
     sm?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+    /** Width of the control on "medium" displays */
     md?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+    /** Width of the control on "large" displays */
     lg?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
-    xs?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+    /** Width of the control on "extra large" displays */
+    xl?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+    /** If the control should be shown in a new line */
     newLine?: boolean;
+    /** Label of the control */
     label?: ioBroker.StringOrTranslated;
     /** @deprecated use label */
     text?: ioBroker.StringOrTranslated;
+    /** Formula or false to hide the control: "data.attr === 5" */
     hidden?: string | boolean;
+    /** If true and the control is hidden, the place of the control will be still reserved for it */
     hideOnlyControl?: boolean;
+    /** JS function to calculate if the control is disabled. You can write "true" too */
     disabled?: string | boolean;
+    /** Help text of the control */
     help?: ioBroker.StringOrTranslated;
+    /** Link that will be opened by clicking on the help text */
     helpLink?: string;
     style?: CustomCSSProperties;
     darkStyle?: CustomCSSProperties;
@@ -65,6 +87,8 @@ export interface ConfigItem {
     default?: boolean | number | string;
     defaultFunc?: string;
     defaultSendTo?: string;
+    /** Allow saving of configuration even with error */
+    allowSaveWithError?: boolean;
     data?: string | number | boolean;
     jsonData?: string;
     button?: ioBroker.StringOrTranslated;
@@ -162,6 +186,8 @@ export interface ConfigItemText extends ConfigItem {
     max?: number;
     /** read-only field */
     readOnly?: boolean;
+    /** show copy to clipboard button, but only if disabled or read-only */
+    copyToClipboard?: boolean;
     /** default is true. Set this attribute to `false` if trim is not desired. */
     trim?: boolean;
     /** default is 1. Set this attribute to `2` or more if you want to have a textarea with more than one row. */
@@ -184,6 +210,8 @@ export interface ConfigItemColor extends ConfigItem {
 }
 export interface ConfigItemCheckbox extends ConfigItem {
     type: 'checkbox';
+    /** Same as disabled */
+    readOnly?: boolean;
 }
 export interface ConfigItemNumber extends ConfigItem {
     type: 'number';
@@ -224,7 +252,8 @@ export interface ConfigItemObjectId extends ConfigItem {
     types?: ObjectBrowserType | ObjectBrowserType[];
     /** Show only this root object and its children */
     root?: string;
-    /** Cannot be used together with `type` settings. It is an object and not a JSON string. Examples
+    /**
+     * Cannot be used together with `type` settings. It is an object and not a JSON string. Examples
      *  - `{common: {custom: true}}` - show only objects with some custom settings
      *  - `{common: {custom: 'sql.0'}}` - show only objects with sql.0 custom settings (only of the specific instance)
      *  - `{common: {custom: '_dataSources'}}` - show only objects of adapters `influxdb` or `sql` or `history`
@@ -298,7 +327,7 @@ export interface ConfigItemStaticImage extends ConfigItem {
 export interface ConfigItemStaticText extends Omit<ConfigItem, 'button'> {
     type: 'staticText';
     /** multi-language text */
-    text: string;
+    text: ioBroker.StringOrTranslated;
     /** @deprecated use text */
     label?: ioBroker.StringOrTranslated;
     /** link. Link could be dynamic like `#tab-objects/customs/${data.parentId} */
@@ -316,7 +345,34 @@ export interface ConfigItemStaticText extends Omit<ConfigItem, 'button'> {
     /** if icon should be shown: `auth`, `send`, `web`, `warning`, `error`, `info`, `search`, `book`, `help`, `upload`. You can use `base64` icons (it starts with `data:image/svg+xml;base64,...`) or `jpg/png` images (ends with `.png`) . (Request via issue if you need more icons) */
     icon?: ConfigIconType;
     /** styles for the button */
-    controlStyle: CustomCSSProperties;
+    controlStyle?: CustomCSSProperties;
+}
+export interface ConfigItemStaticInfo extends Omit<ConfigItem, 'data'> {
+    type: 'staticInfo';
+    /** multi-language text or value */
+    data: ioBroker.StringOrTranslated | number | boolean;
+    /** Base64 icon */
+    labelIcon?: string;
+    /** Unit */
+    unit?: ioBroker.StringOrTranslated;
+    /** Normally the title and value are shown on the left and right of the line. With this flag, the value will appear just after the label*/
+    narrow?: boolean;
+    /** Add to label the colon at the end if not exist in label */
+    addColon?: boolean;
+    /** Value should blink when updated (true or color) */
+    blinkOnUpdate?: boolean | string;
+    /** Value should blink continuously (true or color) */
+    blink?: boolean | string;
+    /** Show copy to clipboard button for value */
+    copyToClipboard?: boolean;
+    /** Label style */
+    styleLabel?: CustomCSSProperties;
+    /** Value style */
+    styleValue?: CustomCSSProperties;
+    /** Unit style */
+    styleUnit?: CustomCSSProperties;
+    /** Font size */
+    size?: number | 'small' | 'normal' | 'large';
 }
 export interface ConfigItemRoom extends ConfigItem {
     type: 'room';
@@ -330,8 +386,9 @@ export interface ConfigItemFunc extends ConfigItem {
 }
 export interface ConfigItemSelect extends ConfigItem {
     type: 'select';
-    /** `[{label: {en: "option 1"}, value: 1}, ...]` or
-     `[{"items": [{"label": "Val1", "value": 1}, {"label": "Val2", value: "2}], "name": "group1"}, {"items": [{"label": "Val3", "value": 3}, {"label": "Val4", value: "4}], "name": "group2"}, {"label": "Val5", "value": 5}]`
+    /**
+     * `[{label: {en: "option 1"}, value: 1}, ...]` or
+     * `[{"items": [{"label": "Val1", "value": 1}, {"label": "Val2", value: "2}], "name": "group1"}, {"items": [{"label": "Val3", "value": 3}, {"label": "Val4", value: "4}], "name": "group2"}, {"label": "Val5", "value": 5}]`
      */
     options: (ConfigItemSelectOption | {
         items: ConfigItemSelectOption[];
@@ -480,7 +537,7 @@ export interface ConfigItemSendTo extends Omit<ConfigItem, 'data'> {
 }
 export interface ConfigItemState extends ConfigItem {
     type: 'state';
-    /** Which object ID should be taken for the controlling. The ID is without "adapter.X." prefix */
+    /** Describes, which object ID should be taken for the controlling. The ID is without "adapter.X." prefix */
     oid: string;
     /** If true, the state will be taken from system.adapter.XX.I. and not from XX.I */
     system?: boolean;
@@ -512,6 +569,8 @@ export interface ConfigItemState extends ConfigItem {
     controlDelay?: number;
     /** Variant of button */
     variant?: 'contained' | 'outlined' | 'text';
+    /** Defines if the control is read-only. Applied only to 'input', 'slider', 'select', 'button', 'switch', 'number' */
+    readOnly?: boolean;
 }
 export interface ConfigItemTextSendTo extends Omit<ConfigItem, 'data'> {
     type: 'textSendTo';
@@ -656,11 +715,11 @@ export interface ConfigItemInterface extends ConfigItem {
 }
 export interface ConfigItemImageUpload extends ConfigItem {
     type: 'image';
-    /** name of file is structure name. In the below example `login-bg.png` is file name for `writeFile("myAdapter.INSTANCE", "login-bg.png")` */
+    /** name of a file is structure name. In the below example `login-bg.png` is file name for `writeFile("myAdapter.INSTANCE", "login-bg.png")` */
     filename?: string;
-    /** html accept attribute, like `{ 'image/**': [], 'application/pdf': ['.pdf'] }`, default `{ 'image/*': [] }` */
+    /** HTML accept attribute, like `{ 'image/**': [], 'application/pdf': ['.pdf'] }`, default `{ 'image/*': [] }` */
     accept?: Record<string, string[]>;
-    /** maximal size of file to upload */
+    /** maximal size of a file to upload */
     maxSize?: number;
     /** if true, the image will be saved as data-url in attribute, elsewise as binary in file storage */
     base64?: boolean;
@@ -734,8 +793,44 @@ export interface ConfigItemFileSelector extends ConfigItem {
     /** Do not show the size of files */
     noSize?: boolean;
 }
-export type ConfigItemAny = ConfigItemAlive | ConfigItemAutocomplete | ConfigItemAutocompleteSendTo | ConfigItemPanel | ConfigItemTabs | ConfigItemText | ConfigItemNumber | ConfigItemColor | ConfigItemCheckbox | ConfigItemSlider | ConfigItemIP | ConfigItemUser | ConfigItemRoom | ConfigItemFunc | ConfigItemSelect | ConfigItemAccordion | ConfigItemCoordinates | ConfigItemDivider | ConfigItemHeader | ConfigItemCustom | ConfigItemDatePicker | ConfigItemDeviceManager | ConfigItemLanguage | ConfigItemPort | ConfigItemSendTo | ConfigItemState | ConfigItemTable | ConfigItemTimePicker | ConfigItemTextSendTo | ConfigItemSelectSendTo | ConfigItemCertCollection | ConfigItemCertificateSelect | ConfigItemCertificates | ConfigItemUUID | ConfigItemCheckLicense | ConfigItemPattern | ConfigItemChip | ConfigItemCRON | ConfigItemFile | ConfigItemFileSelector | ConfigItemImageSendTo | ConfigItemInstanceSelect | ConfigItemImageUpload | ConfigItemInterface | ConfigItemJsonEditor | ConfigItemLicense | ConfigItemPassword | ConfigItemSetState | ConfigItemStaticDivider | ConfigItemStaticHeader | ConfigItemStaticImage | ConfigItemStaticText | ConfigItemTopic | ConfigItemObjectId | ConfigItemQrCode;
-export type JsonFormSchema = ConfigItemPanel;
+export type ConfigItemAny = ConfigItemAlive | ConfigItemAutocomplete | ConfigItemAutocompleteSendTo | ConfigItemPanel | ConfigItemTabs | ConfigItemText | ConfigItemNumber | ConfigItemColor | ConfigItemCheckbox | ConfigItemSlider | ConfigItemIP | ConfigItemUser | ConfigItemRoom | ConfigItemFunc | ConfigItemSelect | ConfigItemAccordion | ConfigItemCoordinates | ConfigItemDivider | ConfigItemHeader | ConfigItemCustom | ConfigItemDatePicker | ConfigItemDeviceManager | ConfigItemLanguage | ConfigItemPort | ConfigItemSendTo | ConfigItemState | ConfigItemTable | ConfigItemTimePicker | ConfigItemTextSendTo | ConfigItemSelectSendTo | ConfigItemCertCollection | ConfigItemCertificateSelect | ConfigItemCertificates | ConfigItemUUID | ConfigItemCheckLicense | ConfigItemPattern | ConfigItemChip | ConfigItemCRON | ConfigItemFile | ConfigItemFileSelector | ConfigItemImageSendTo | ConfigItemInstanceSelect | ConfigItemImageUpload | ConfigItemInterface | ConfigItemJsonEditor | ConfigItemLicense | ConfigItemPassword | ConfigItemSetState | ConfigItemStaticDivider | ConfigItemStaticHeader | ConfigItemStaticInfo | ConfigItemStaticImage | ConfigItemStaticText | ConfigItemTopic | ConfigItemObjectId | ConfigItemQrCode;
+export type BackEndCommandType = 'nop' | 'refresh' | 'link' | 'message';
+export interface BackEndCommandGeneric {
+    command: BackEndCommandType;
+    /** New GUI schema */
+    schema?: ConfigItemPanel;
+    /** New GUI data */
+    data?: Record<string, any>;
+    refresh?: boolean;
+}
+export interface BackEndCommandNoOperation extends BackEndCommandGeneric {
+    command: 'nop';
+}
+export interface BackEndCommandRefresh extends BackEndCommandGeneric {
+    command: 'refresh';
+    /** If refresh the GUI */
+    fullRefresh?: boolean;
+}
+export interface BackEndCommandOpenLink extends BackEndCommandGeneric {
+    command: 'link';
+    /** Link url. Could be relative ('#blabla') or absolute ('https://blabla') */
+    url: string;
+    /** Target of the link. Default is `_self` for relative and '_blank' for absolute links */
+    target?: '_self' | '_blank' | string;
+    /** If GUI should be closed after the link was opened (Only for target='_self') */
+    close?: boolean;
+}
+export interface BackEndCommandMessage extends BackEndCommandGeneric {
+    command: 'message';
+    /** Message text */
+    message: ioBroker.StringOrTranslated;
+    /** If GUI should be closed after the message shown */
+    close?: boolean;
+    /** Type of message. Default is 'popup' */
+    variant: 'popup' | 'dialog';
+}
+export type BackEndCommand = BackEndCommandMessage | BackEndCommandOpenLink | BackEndCommandRefresh;
+export type JsonFormSchema = ConfigItemPanel | ConfigItemTabs;
 export type JsonFormData = Record<string, any>;
 export interface DeviceDetails {
     id: string;

package/build/types/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./adapter";
-export * from "./common";
-export * from "./errorCodes";
-export { ChannelInfo, Color, ControlState, ControlBase } from "./base";
+export type * from './adapter';
+export type * from './common';
+export * from './errorCodes';
+export type { ChannelInfo, Color, ControlState, ControlBase } from './base';

package/build/types/index.js

@@ -14,6 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./adapter"), exports);
-__exportStar(require("./common"), exports);
 __exportStar(require("./errorCodes"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/dm-utils",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "description": "ioBroker Device Manager utilities for backend",
   "main": "build/index.js",
   "publishConfig": {
@@ -10,6 +10,7 @@
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "lint": "eslint .",
+    "updateCommonTs": "node tasks.js",
     "prettier": "prettier -u -w examples src",
     "release": "release-script",
     "release-patch": "release-script patch --yes",
@@ -21,18 +22,15 @@
   "author": "UncleSamSwiss",
   "license": "MIT",
   "dependencies": {
-    "@iobroker/adapter-core": "^3.1.6"
+    "@iobroker/adapter-core": "^3.2.2"
   },
   "devDependencies": {
     "@alcalzone/release-script": "^3.8.0",
     "@alcalzone/release-script-plugin-license": "^3.7.0",
-    "@types/node": "^22.5.1",
-    "@typescript-eslint/eslint-plugin": "^8.3.0",
-    "@typescript-eslint/parser": "^8.3.0",
-    "eslint": "^9.9.1",
-    "eslint-config-prettier": "^9.1.0",
-    "prettier": "^3.3.3",
-    "typescript": "^5.5.4"
+    "@iobroker/eslint-config": "^1.0.0",
+    "@types/node": "^22.9.0",
+    "axios": "^1.7.7",
+    "typescript": "^5.6.3"
   },
   "files": [
     "LICENSE",