@iobroker/dm-utils 1.0.2 → 1.0.5

package/README.md

@@ -301,9 +301,9 @@ This method returns a promise that resolves to a `ProgressDialog` object.
 	### **WORK IN PROGRESS**
 -->
 ## Changelog
-### 1.0.2 (2025-01-09)
+### 1.0.5 (2025-01-11)
 
-* (@GermanBluefox) Added description for `disabled` control and `status` action.
+* (@GermanBluefox) Added action ENABLE_DISABLE and `enabled` status
 
 ### 1.0.0 (2025-01-08)
 
@@ -320,11 +320,11 @@ This method returns a promise that resolves to a `ProgressDialog` object.
 
 ### 0.6.9 (2024-11-22)
 
-* (@GermanBluefox) Added max-width option for form
+* (@GermanBluefox) Added a max-width option for form
 
 ### 0.6.8 (2024-11-22)
 
-* (@GermanBluefox) Allow grouping of devices
+* (@GermanBluefox) Allowed grouping of devices
 
 ### 0.6.7 (2024-11-20)
 

package/build/types/base.d.ts

@@ -7,9 +7,8 @@ export type ControlState = string | number | boolean | null;
 export declare const ACTIONS: {
     /** This action will be called when user clicks on connection icon */
     STATUS: string;
-    /** This action will be called when user clicks on connection icon */
-    DISABLE: string;
-    ENABLE: 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 */
+    ENABLE_DISABLE: string;
 };
 export interface ActionBase<T extends ActionType> {
     /** Unique (for this adapter) action ID. It could be the name from ACTIONS too, but in this case some predefined appearance will be applied */
@@ -99,16 +98,26 @@ export interface InstanceDetails<T extends ActionType = 'api'> {
     actions?: InstanceAction<T>[];
 }
 export interface DeviceInfo<T extends ActionType = 'api'> {
+    /** ID of the action. Should be unique only in one adapter. Other adapters could have same names */
     id: string;
+    /** Name of the device. It will be shown in the card header */
+    name: ioBroker.StringOrTranslated;
+    /** base64 or url icon for device card */
     icon?: string;
     manufacturer?: ioBroker.StringOrTranslated;
     model?: ioBroker.StringOrTranslated;
+    /** Color or 'primary', 'secondary' for the text in the card header */
     color?: Color;
+    /** Background color of card header (you can use primary, secondary or color rgb value or hex) */
     backgroundColor?: Color;
-    name: ioBroker.StringOrTranslated;
     status?: DeviceStatus | DeviceStatus[];
+    /** 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 */
+    enabled?: boolean;
+    /** List of actions on the card */
     actions?: DeviceAction<T>[];
+    /** List of controls on the card. The difference of controls and actions is that the controls can show status (e.g. on/off) and can work directly with states */
     controls?: DeviceControl<T>[];
+    /** If true, the button `more` will be shown on the card and called `dm:deviceDetails` action to get the details  */
     hasDetails?: boolean;
     /** Device type for grouping */
     group?: {

package/build/types/base.js

@@ -5,7 +5,6 @@ exports.ACTIONS = void 0;
 exports.ACTIONS = {
     /** This action will be called when user clicks on connection icon */
     STATUS: 'status',
-    /** This action will be called when user clicks on connection icon */
-    DISABLE: 'disable',
-    ENABLE: 'enable',
+    /** 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 */
+    ENABLE_DISABLE: 'enable/disable',
 };

package/build/types/common.d.ts

@@ -1,9 +1,6 @@
 export type ApiVersion = 'v1';
+export type ConfigIconType = 'add' | 'backlight' | 'delete' | 'dimmer' | 'edit' | 'group' | 'identify' | 'info' | 'light' | 'lines' | 'next' | 'pair' | 'pause' | 'play' | 'previous' | 'qrcode' | 'refresh' | 'search' | 'settings' | 'socket' | 'stop' | 'unpair' | 'user' | string;
 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';
     rssi?: number;
@@ -13,7 +10,8 @@ export type ActionButton = {
     label: ioBroker.StringOrTranslated;
     type: 'apply' | 'cancel';
     noTranslation?: boolean;
-    icon?: string;
+    /** base64 or icon name */
+    icon?: ConfigIconType;
     variant?: 'contained' | 'outlined' | 'text';
     style?: Record<string, number | string>;
     color?: 'primary' | 'secondary';
@@ -40,7 +38,6 @@ 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' | '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;
     text?: ioBroker.StringOrTranslated;
@@ -358,7 +355,7 @@ export interface ConfigItemStaticInfo extends Omit<ConfigItem, 'data'> {
     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*/
+    /** 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;

package/build/types/index.d.ts

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

package/build/types/index.js

@@ -14,4 +14,7 @@ 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 });
+exports.ACTIONS = void 0;
 __exportStar(require("./errorCodes"), exports);
+var base_1 = require("./base");
+Object.defineProperty(exports, "ACTIONS", { enumerable: true, get: function () { return base_1.ACTIONS; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/dm-utils",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "description": "ioBroker Device Manager utilities for backend",
   "main": "build/index.js",
   "publishConfig": {