@iobroker/dm-utils 3.0.0 → 3.0.3

package/README.md

@@ -131,7 +131,7 @@ Every item is an object of type `DeviceInfo` which has the following properties:
 - `identifier` (optional): a human-readable identifier of the device
 - `name` (string or translations): the human-readable name of this device
 - `status` (optional): the current status of the device, which has to be an object containing:
-    - `connection` (string): alowed values are: `"connected"` / `"disconnected"`
+    - `connection` (string): allowed values are: `"connected"` / `"disconnected"`
     - `rssi` (number): rssi value of the connection
     - `battery` (boolean / number): if boolean: false - the battery is empty. If number: the battery level of the device (shows also a battery symbol on the card)
     - `warning` (boolean / string): if boolean: true indicates a warning. If a string: shows also the warning with mouseover
@@ -214,6 +214,9 @@ The returned object must contain:
     - `"device"`: if you want the device details to be reloaded after this action
     - `"instance"`: if you want the entire device list to be reloaded after this action
     - `false`: if you don't want anything to be refreshed (important: this is a boolean, not a string!)
+or  
+- `url` (string) This URL must be opened
+- `target` (string) Target window for url (`_blank` is default)
 
 This method can be implemented asynchronously and can take a lot of time to complete.
 
@@ -361,14 +364,14 @@ class MyAdapterDeviceManagement extends DeviceManagement<MyAdapter> {
 }
 ```
 
-## Migration from 1.x to 2.x
+## Migration from 2.x to 3.x
 
-Between versions 1.x and 2.x, there are some breaking changes. Please also have a look at the changelog below for more information.
+Between versions 2.x and 3.x, there are some breaking changes. Please also have a look at the changelog below for more information.
 
 ### Incremental loading of devices
 
-In version 1.x, the `listDevices()` method had to return the full list of devices.
-In version 2.x, this method was replaced by `loadDevices(context: DeviceLoadContext)` that allows incremental loading of devices.
+In versions 1.x and 2.x, the `listDevices()` method had to return the full list of devices.
+In version 3.x, this method was replaced by `loadDevices(context: DeviceLoadContext)` that allows incremental loading of devices.
 
 Instead of creating and returning an array of `DeviceInfo` objects, you have to call `context.addDevice(deviceInfo)` for each device you want to add to the list.
 
@@ -376,14 +379,14 @@ You may also call `context.setTotalDevices(count: number)` as soon as possible t
 
 ### Refresh response of device actions
 
-In version 2.x, the refresh response of device actions has changed.
+In version 3.x, the refresh response of device actions has changed.
 
-| Version 1.x  | Version 2.x  | Description                                                                 |
-| ------------ | ------------ | --------------------------------------------------------------------------- |
-| `true`       | `'all'`      | the instance information as well as the entire device list will be reloaded |
-| `false`      | `'none'`     | nothing will be reloaded                                                    |
-| `'device'`   | `'devices'`  | the entire device list will be reloaded                                     |
-| `'instance'` | `'instance'` | (unchanged) only the instance information will be reloaded                  |
+| Version 1.x/2.x | Version 3.x  | Description                                                                 |
+|-----------------|--------------|-----------------------------------------------------------------------------|
+| `true`          | `'all'`      | the instance information as well as the entire device list will be reloaded |
+| `false`         | `'none'`     | nothing will be reloaded                                                    |
+| `'device'`      | `'devices'`  | the entire device list will be reloaded                                     |
+| `'instance'`    | `'instance'` | (unchanged) only the instance information will be reloaded                  |
 
 ## Changelog
 
@@ -391,7 +394,7 @@ In version 2.x, the refresh response of device actions has changed.
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
-### 3.0.0 (2026-03-01)
+### 3.0.3 (2026-03-26)
 
 - (@UncleSamSwiss) Enabled incremental loading of devices
 - (@UncleSamSwiss) Removed direct access to `DeviceManagement.handleXxx()` methods (use `handler` and similar properties instead)

package/build/DeviceManagement.js

@@ -520,7 +520,7 @@ function convertActions(actions) {
         }
         ids.add(a.id);
     });
-    // remove handler function to send it as JSON
+    // remove a handler function to send it as JSON
     return actions.map((a) => (Object.assign(Object.assign({}, a), { handler: undefined, disabled: !a.handler && !a.url })));
 }
 function convertControls(controls) {

package/build/index.d.ts

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

package/build/index.js

@@ -15,5 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./DeviceManagement"), exports);
-// don't export * from "./MessageContext" as it is private
-__exportStar(require("./types"), exports);

package/build/types/api.d.ts

@@ -49,7 +49,7 @@ export interface CommunicationForm {
     maxWidth?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
     /** Minimal width of the dialog */
     minWidth?: number;
-    /** Always allow the apply button. Even when nothing was changed */
+    /** Always allow the Apply button. Even when nothing was changed */
     ignoreApplyDisabled?: boolean;
 }
 export type DmActionFormResponse = DmResponseBase & {

package/build/types/base.d.ts

@@ -5,9 +5,9 @@ export type Color = 'primary' | 'secondary' | (string & {});
 export type ControlState = string | number | boolean | null;
 /** Reserved action names */
 export declare const ACTIONS: {
-    /** This action will be called when user clicks on connection icon */
+    /** This action will be called when the user clicks on the connection icon */
     STATUS: string;
-    /** This action will be called when the user clicks on enabled/disabled icon. The enabled/disabled icon will be shown only if the node status has "enabled" flag set to false or true */
+    /** This action will be called when the user clicks on the enabled / disabled icon. The enabled/disabled icon will be shown only if the node status has the "enabled" flag set to false or true */
     ENABLE_DISABLE: string;
 };
 export interface ActionBase<T extends ActionType> {
@@ -117,7 +117,7 @@ export interface InstanceDetails<T extends ActionType = 'api'> {
     identifierLabel?: ioBroker.StringOrTranslated;
 }
 export interface DeviceInfo<T extends ActionType = 'api', TId extends DeviceId = DeviceId> {
-    /** ID of the device. Must be unique only in one adapter. Other adapters could have same IDs */
+    /** ID of the device. Must be unique only in one adapter. Other adapters could have the same IDs */
     id: TId;
     /** Human-readable identifier of the device */
     identifier?: ValueOrObject<string>;
@@ -134,7 +134,7 @@ export interface DeviceInfo<T extends ActionType = 'api', TId extends DeviceId =
     status?: DeviceStatus | DeviceStatus[];
     /** Connection type, how the device is connected */
     connectionType?: ValueOrStateOrObject<ConfigConnectionType>;
-    /** If this flag is true or false, the according indication will be shown. Additionally, if ACTIONS.ENABLE_DISABLE is implemented, this action will be sent to backend by clicking on this indication */
+    /** If this flag is true or false, the according indication will be shown. Additionally, if ACTIONS.ENABLE_DISABLE is implemented, this action will be sent to the backend by clicking on this indication */
     enabled?: ValueOrState<boolean>;
     /** List of actions on the card */
     actions?: DeviceAction<T, TId>[];
@@ -150,19 +150,19 @@ export interface DeviceInfo<T extends ActionType = 'api', TId extends DeviceId =
     };
 }
 export interface BackendToGuiCommandDeviceInfoUpdate<TId extends DeviceId = DeviceId> {
-    /** Used for updating and for adding new device */
+    /** Used for updating and for adding a new device */
     command: 'infoUpdate';
     /** Device ID */
     deviceId: TId;
-    /** Backend can send directly new information about device to avoid extra request from GUI */
+    /** Backend can directly send new information about a device to avoid extra request from GUI */
     info?: DeviceInfo;
 }
 export interface BackendToGuiCommandDeviceStatusUpdate<TId extends DeviceId = DeviceId> {
-    /** Status of device was updated */
+    /** Status of a device was updated */
     command: 'statusUpdate';
     /** Device ID */
     deviceId: TId;
-    /** Backend can send directly new status to avoid extra request from GUI */
+    /** Backend can directly send new status to avoid extra request from GUI */
     status?: DeviceStatus;
 }
 export interface BackendToGuiCommandDeviceDelete<TId extends DeviceId = DeviceId> {

package/build/types/base.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ACTIONS = void 0;
 /** Reserved action names */
 exports.ACTIONS = {
-    /** This action will be called when user clicks on connection icon */
+    /** This action will be called when the user clicks on the connection icon */
     STATUS: 'status',
-    /** This action will be called when the user clicks on enabled/disabled icon. The enabled/disabled icon will be shown only if the node status has "enabled" flag set to false or true */
+    /** This action will be called when the user clicks on the enabled / disabled icon. The enabled/disabled icon will be shown only if the node status has the "enabled" flag set to false or true */
     ENABLE_DISABLE: 'enable/disable',
 };

package/build/types/index.d.ts

@@ -1,4 +1,4 @@
 export type * from './adapter';
-export { ACTIONS, type ChannelInfo, type Color, type ControlBase, type ControlState, type BackendToGuiCommand, type BackendToGuiCommandAllUpdate, type BackendToGuiCommandDeviceDelete, type BackendToGuiCommandDeviceStatusUpdate, type BackendToGuiCommandDeviceInfoUpdate, } from './base';
+export { ACTIONS, type ChannelInfo, type Color, type ControlBase, type ControlState, type BackendToGuiCommand, type BackendToGuiCommandAllUpdate, type BackendToGuiCommandDeviceDelete, type BackendToGuiCommandDeviceStatusUpdate, type BackendToGuiCommandDeviceInfoUpdate, type DeviceRefresh, } from './base';
 export type * from './common';
 export * from './errorCodes';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/dm-utils",
-  "version": "3.0.0",
+  "version": "3.0.3",
   "description": "ioBroker Device Manager utilities for backend",
   "main": "build/index.js",
   "publishConfig": {
@@ -34,7 +34,7 @@
     "@alcalzone/release-script": "^5.1.1",
     "@alcalzone/release-script-plugin-license": "^5.1.1",
     "@iobroker/eslint-config": "^2.2.0",
-    "@types/node": "^25.3.3",
+    "@types/node": "^25.5.0",
     "axios": "^1.13.6",
     "typescript": "~5.9.3"
   },