@iobroker/dm-utils 1.0.1 → 1.0.3

package/README.md

@@ -206,9 +206,6 @@ The returned object must contain:
 
 This method can be implemented asynchronously and can take a lot of time to complete.
 
-Reserved control names:
-- `disabled` - The disabled control has its own pre-defined place on the device card and is used to disable the device. The state of this control is boolean.
-
 ### `handleDeviceControlState(deviceId: string, controlId: string, context: MessageContext)
 
 This method is called when GUI requests the update of the state.
@@ -234,6 +231,8 @@ For interactions, there are methods you can call on `context`:
 
 There are some reserved action names, you can find the list below:
 - `status` - This action is called when the user clicks on the status icon. So to implement the "click-on-status" functionality, the developer has to implement this action.
+- `disable` - This action will be called when the user clicks on the `enabled` icon. `disable` and `enable` actions cannot be together.
+- `enable` - This action will be called when the user clicks on the `disabled` icon. `disable` and `enable` actions cannot be together.
 
 ### `showMessage(text: ioBroker.StringOrTranslated)`
 
@@ -302,7 +301,7 @@ This method returns a promise that resolves to a `ProgressDialog` object.
 	### **WORK IN PROGRESS**
 -->
 ## Changelog
-### 1.0.1 (2025-01-09)
+### 1.0.3 (2025-01-09)
 
 * (@GermanBluefox) Added description for `disabled` control and `status` action.
 

package/build/types/base.d.ts

@@ -3,7 +3,16 @@ 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;
+/** Reserved action names */
+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;
+};
 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 */
     id: string;
     /**
      * This can either be base64 or the URL to an icon.

package/build/types/base.js

@@ -1,2 +1,11 @@
 "use strict";
 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 */
+    STATUS: 'status',
+    /** This action will be called when user clicks on connection icon */
+    DISABLE: 'disable',
+    ENABLE: 'enable',
+};

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.1",
+  "version": "1.0.3",
   "description": "ioBroker Device Manager utilities for backend",
   "main": "build/index.js",
   "publishConfig": {