@iobroker/dm-utils 1.0.9 → 1.0.13

package/README.md

@@ -301,6 +301,14 @@ This method returns a promise that resolves to a `ProgressDialog` object.
 	### **WORK IN PROGRESS**
 -->
 ## Changelog
+### 1.0.13 (2025-10-21)
+* (@GermanBluefox) Updated packages
+
+### 1.0.10 (2025-05-05)
+
+* (@GermanBluefox) Added timeout property to actions
+* (@GermanBluefox) Updated packages
+
 ### 1.0.9 (2025-01-25)
 
 * (@GermanBluefox) Added copyToClipboard dialog button

package/build/types/base.d.ts

@@ -45,6 +45,8 @@ export interface ActionBase<T extends ActionType> {
         /** Step value for the input (number or slider) */
         step?: number;
     };
+    /** Timeout in ms for waiting an answer from backend */
+    timeout?: number;
 }
 export interface ChannelInfo {
     name: ioBroker.StringOrTranslated;

package/build/types/common.d.ts

@@ -1,25 +1,11 @@
 export type ApiVersion = 'v1';
 export type ConfigConnectionType = 'lan' | 'wifi' | 'bluetooth' | 'thread' | 'z-wave' | 'zigbee' | 'other';
-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' | {
     battery?: number | boolean | 'charging' | string;
     connection?: 'connected' | 'disconnected';
     rssi?: number;
     warning?: ioBroker.StringOrTranslated | boolean;
 };
-export type ActionButton = {
-    label: ioBroker.StringOrTranslated;
-    type: 'apply' | 'cancel' | 'copyToClipboard';
-    noTranslation?: boolean;
-    /** base64 or icon name */
-    icon?: ConfigIconType;
-    variant?: 'contained' | 'outlined' | 'text';
-    style?: Record<string, number | string>;
-    /** Name of the attribute in data that should be copied to clipboard */
-    color?: 'primary' | 'secondary';
-    /** Name of the attribute in data that should be copied to clipboard */
-    copyToClipboardAttr?: string;
-};
 export type DeviceRefresh = 'device' | 'instance' | false | true;
 export type RefreshResponse = {
     refresh: DeviceRefresh;
@@ -41,7 +27,8 @@ 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';
+export type ConfigItemType = 'accordion' | 'alive' | 'autocomplete' | 'autocompleteSendTo' | 'certCollection' | 'certificate' | 'certificates' | 'checkDocker' | 'checkLicense' | 'checkbox' | 'chips' | 'color' | 'coordinates' | 'cron' | 'custom' | 'datePicker' | 'deviceManager' | 'divider' | 'file' | 'fileSelector' | 'func' | 'header' | 'image' | 'imageSendTo' | 'infoBox' | 'instance' | 'interface' | 'ip' | 'jsonEditor' | 'language' | 'license' | 'number' | 'oauth2' | 'objectId' | 'panel' | 'password' | 'pattern' | 'port' | 'qrCode' | 'room' | 'select' | 'selectSendTo' | 'sendto' | 'setState' | 'slider' | 'state' | 'staticImage' | 'staticInfo' | 'staticLink' | 'staticText' | 'table' | 'tabs' | 'text' | 'textSendTo' | 'timePicker' | 'topic' | 'user' | 'uuid';
+export type ConfigIconType = 'add' | 'backlight' | 'book' | 'delete' | 'dimmer' | 'edit' | 'error' | 'group' | 'help' | 'identify' | 'info' | 'light' | 'lines' | 'next' | 'pair' | 'pause' | 'play' | 'previous' | 'qrcode' | 'refresh' | 'search' | 'send' | 'settings' | 'socket' | 'stop' | 'unpair' | 'upload' | 'user' | 'warning' | 'web' | string;
 export interface ConfigItemConfirmData {
     condition: string;
     text?: ioBroker.StringOrTranslated;
@@ -142,6 +129,8 @@ export interface ConfigItemSelectOption {
     label: ioBroker.StringOrTranslated;
     /** Value of option */
     value: number | string;
+    /** Color of value */
+    color?: string;
     /** Formula or boolean value to show or hide the option */
     hidden?: string | boolean;
 }
@@ -158,6 +147,7 @@ export interface ConfigItemPanel extends ConfigItem {
     innerStyle?: CustomCSSProperties;
     /** i18n definitions: true - load from a file, string - name of subdirectory, object - translations */
     i18n?: boolean | string | Record<string, Record<ioBroker.Languages, string>>;
+    command?: string;
 }
 export interface ConfigItemPattern extends ConfigItem {
     type: 'pattern';
@@ -181,6 +171,7 @@ export interface ConfigItemTabs extends ConfigItem {
     tabsStyle?: CustomCSSProperties;
     /** i18n definitions: true - load from a file, string - name of subdirectory, object - translations */
     i18n?: boolean | string | Record<string, Record<ioBroker.Languages, string>>;
+    command?: string;
 }
 export interface ConfigItemText extends ConfigItem {
     type: 'text';
@@ -223,6 +214,15 @@ export interface ConfigItemNumber extends ConfigItem {
     max?: number;
     step?: number;
     readOnly?: boolean;
+    /** Unit */
+    unit?: string;
+}
+export interface ConfigItemOAuth2 extends ConfigItem {
+    type: 'oauth2';
+    saveTokenIn?: string;
+    identifier: 'spotify' | 'google' | 'dropbox' | 'microsoft' | string;
+    scope?: string;
+    refreshLabel?: ioBroker.StringOrTranslated;
 }
 export interface ConfigItemQrCode extends ConfigItem {
     type: 'qrCode';
@@ -274,11 +274,11 @@ export interface ConfigItemObjectId extends ConfigItem {
     filters?: {
         id?: string;
         name?: string;
-        room?: string;
-        func?: string;
-        role?: string;
-        type?: string;
-        custom?: string;
+        room?: string[];
+        func?: string[];
+        role?: string[];
+        type?: string[];
+        custom?: string[];
     };
     /** Cannot be used together with `type` settings. It is a function that will be called for every object and must return true or false. Example: `obj.common.type === 'number'` */
     filterFunc?: (obj: ioBroker.Object) => boolean;
@@ -384,6 +384,21 @@ export interface ConfigItemStaticInfo extends Omit<ConfigItem, 'data'> {
     /** Show string values as HTML */
     html?: boolean;
 }
+export interface ConfigItemInfoBox extends ConfigItem {
+    type: 'infoBox';
+    /** multi-language text */
+    text: ioBroker.StringOrTranslated;
+    /** multi-language title */
+    title?: ioBroker.StringOrTranslated;
+    /** The type determines the color and symbol */
+    boxType?: 'warning' | 'info' | 'error' | 'ok';
+    /** If the box is closeable */
+    closeable?: boolean;
+    /** Use together with `closeable: true`. If the box is closed or not. In this case, it will be controlled from outside */
+    closed?: boolean;
+    /** Icon position */
+    iconPosition?: 'top' | 'middle';
+}
 export interface ConfigItemRoom extends ConfigItem {
     type: 'room';
     short?: boolean;
@@ -404,9 +419,14 @@ export interface ConfigItemSelect extends ConfigItem {
         items: ConfigItemSelectOption[];
         label: ioBroker.StringOrTranslated;
         value?: number | string;
+        color?: string;
         hidden?: string | boolean;
     })[];
     attr?: string;
+    /** If multiple selection is possible. In this case, the value will be an array */
+    multiple?: boolean;
+    /** show item even if no label was found for it (by multiple), default=`true` */
+    showAllValues?: boolean;
 }
 export interface ConfigItemAutocomplete extends ConfigItem {
     type: 'autocomplete';
@@ -485,12 +505,16 @@ export interface ConfigItemCustom extends ConfigItem {
     type: 'custom';
     /** location of Widget, like "custom/customComponents.js" */
     url: string;
+    /** New format for components written in TypeScript */
+    bundlerType?: 'module';
     /** Component name, like "ConfigCustomBackItUpSet/Components/AdapterExist" */
     name: string;
     /** i18n */
     i18n: boolean | Record<string, string>;
     /** custom properties */
-    [prop: string]: any;
+    custom?: {
+        [prop: string]: any;
+    };
 }
 export interface ConfigItemDatePicker extends ConfigItem {
     type: 'datePicker';
@@ -585,7 +609,7 @@ export interface ConfigItemState extends ConfigItem {
     readOnly?: boolean;
     /** Base64 icon */
     labelIcon?: string;
-    /** 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;
@@ -593,6 +617,14 @@ export interface ConfigItemState extends ConfigItem {
     blinkOnUpdate?: boolean | string;
     /** Font size */
     size?: number | 'small' | 'normal' | 'large';
+    /** Optional value, that will be sent for button */
+    buttonValue?: ioBroker.StateValue;
+    /** Show SET button. The value in this case will be sent only when the button is pressed. You can define the text of the button. Default text is "Set" */
+    showEnterButton?: boolean | ioBroker.StringOrTranslated;
+    /** The value in this case will be sent only when the "Enter" button is pressed. It can be combined with `showEnterButton` */
+    setOnEnterKey?: boolean;
+    /** Options for `select`. If not defiled, the `common.states` in the object must exist. */
+    options?: (string | ConfigItemSelectOption)[];
 }
 export interface ConfigItemTextSendTo extends Omit<ConfigItem, 'data'> {
     type: 'textSendTo';
@@ -654,6 +686,8 @@ export interface ConfigItemTable extends ConfigItem {
     uniqueColumns?: string[];
     /** These items will be encrypted before saving with simple (not SHA) encryption method */
     encryptedAttributes?: string[];
+    /** Breakpoint that will be rendered as cards */
+    useCardFor?: ('xs' | 'sm' | 'md' | 'lg' | 'xl')[];
 }
 export interface ConfigItemTimePicker extends ConfigItem {
     type: 'timePicker';
@@ -718,6 +752,11 @@ export interface ConfigItemCheckLicense extends ConfigItem {
     variant?: 'text' | 'outlined' | 'contained';
     color?: 'primary' | 'secondary';
 }
+export interface ConfigItemCheckDocker extends ConfigItem {
+    type: 'checkDocker';
+    /** Hide the version of docker */
+    hideVersion?: boolean;
+}
 export interface ConfigItemUUID extends ConfigItem {
     type: 'uuid';
 }
@@ -727,6 +766,12 @@ export interface ConfigItemJsonEditor extends ConfigItem {
     validateJson?: boolean;
     /** if true, the JSON will be validated only if the value is not empty */
     allowEmpty?: boolean;
+    /** Allow JSON5 format. Default is disabled */
+    json5?: boolean;
+    /** Do not allow to save the value if error in JSON or JSON5 */
+    doNotApplyWithError?: boolean;
+    /** Open the editor in read-only mode - editor can be opened but content cannot be modified */
+    readOnly?: boolean;
 }
 export interface ConfigItemInterface extends ConfigItem {
     type: 'interface';
@@ -815,7 +860,7 @@ 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 | ConfigItemStaticInfo | ConfigItemStaticImage | ConfigItemStaticText | ConfigItemTopic | ConfigItemObjectId | ConfigItemQrCode;
+export type ConfigItemAny = ConfigItemAlive | ConfigItemAutocomplete | ConfigItemAutocompleteSendTo | ConfigItemPanel | ConfigItemTabs | ConfigItemText | ConfigItemNumber | ConfigItemOAuth2 | ConfigItemColor | ConfigItemCheckbox | ConfigItemSlider | ConfigItemIP | ConfigItemInfoBox | ConfigItemUser | ConfigItemRoom | ConfigItemFunc | ConfigItemSelect | ConfigItemAccordion | ConfigItemCoordinates | ConfigItemDivider | ConfigItemHeader | ConfigItemCustom | ConfigItemDatePicker | ConfigItemDeviceManager | ConfigItemLanguage | ConfigItemPort | ConfigItemSendTo | ConfigItemState | ConfigItemTable | ConfigItemTimePicker | ConfigItemTextSendTo | ConfigItemSelectSendTo | ConfigItemCertCollection | ConfigItemCertificateSelect | ConfigItemCertificates | ConfigItemUUID | ConfigItemCheckDocker | 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;
@@ -852,6 +897,19 @@ export interface BackEndCommandMessage extends BackEndCommandGeneric {
     variant: 'popup' | 'dialog';
 }
 export type BackEndCommand = BackEndCommandMessage | BackEndCommandOpenLink | BackEndCommandRefresh;
+export type ActionButton = {
+    label: ioBroker.StringOrTranslated;
+    type: 'apply' | 'cancel' | 'copyToClipboard';
+    noTranslation?: boolean;
+    /** base64 or icon name */
+    icon?: ConfigIconType;
+    variant?: 'contained' | 'outlined' | 'text';
+    style?: Record<string, number | string>;
+    /** Name of the attribute in data that should be copied to clipboard */
+    color?: 'primary' | 'secondary';
+    /** Name of the attribute in data that should be copied to clipboard */
+    copyToClipboardAttr?: string;
+};
 export type BackEndCommandJsonFormOptions = {
     data?: JsonFormData;
     title?: ioBroker.StringOrTranslated;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/dm-utils",
-  "version": "1.0.9",
+  "version": "1.0.13",
   "description": "ioBroker Device Manager utilities for backend",
   "main": "build/index.js",
   "publishConfig": {
@@ -22,15 +22,15 @@
   "author": "UncleSamSwiss",
   "license": "MIT",
   "dependencies": {
-    "@iobroker/adapter-core": "^3.2.3"
+    "@iobroker/adapter-core": "^3.3.2"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^3.8.0",
-    "@alcalzone/release-script-plugin-license": "^3.7.0",
-    "@iobroker/eslint-config": "^1.0.0",
-    "@types/node": "^22.10.10",
-    "axios": "^1.7.9",
-    "typescript": "^5.7.3"
+    "@alcalzone/release-script": "^5.0.0",
+    "@alcalzone/release-script-plugin-license": "^4.0.0",
+    "@iobroker/eslint-config": "^2.2.0",
+    "@types/node": "^24.9.1",
+    "axios": "^1.12.2",
+    "typescript": "~5.9.3"
   },
   "files": [
     "LICENSE",