@iobroker/dm-utils 0.1.9 → 0.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 ioBroker Community Developers
+Copyright (c) 2023-2024 ioBroker Community Developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -294,6 +294,10 @@ This method returns a promise that resolves to a `ProgressDialog` object.
 	### **WORK IN PROGRESS**
 -->
 ## Changelog
+### 0.2.0 (2024-05-29)
+* (bluefox) enhanced type exports
+* (bluefox) added confirmation and input text options
+
 ### 0.1.9 (2023-12-25)
 * (foxriver76) enhanced type exports
 
@@ -316,7 +320,7 @@ This method returns a promise that resolves to a `ProgressDialog` object.
 ## License
 MIT License
 
-Copyright (c) 2023 ioBroker Community Developers
+Copyright (c) 2023-2024 ioBroker Community Developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/build/DeviceManagement.d.ts

@@ -15,8 +15,14 @@ export declare abstract class DeviceManagement<T extends AdapterInstance = Adapt
     protected getDeviceDetails(id: string): RetVal<DeviceDetails | null | {
         error: string;
     }>;
-    protected handleInstanceAction(actionId: string, context?: ActionContext): RetVal<ErrorResponse> | RetVal<RefreshResponse>;
-    protected handleDeviceAction(deviceId: string, actionId: string, context?: ActionContext): RetVal<ErrorResponse> | RetVal<RefreshResponse>;
+    protected handleInstanceAction(actionId: string, context?: ActionContext, options?: {
+        value?: number | string | boolean;
+        [key: string]: any;
+    }): RetVal<ErrorResponse> | RetVal<RefreshResponse>;
+    protected handleDeviceAction(deviceId: string, actionId: string, context?: ActionContext, options?: {
+        value?: number | string | boolean;
+        [key: string]: any;
+    }): RetVal<ErrorResponse> | RetVal<RefreshResponse>;
     protected handleDeviceControl(deviceId: string, controlId: string, newState: ControlState, context?: MessageContext): RetVal<ErrorResponse | ioBroker.State>;
     protected handleDeviceControlState(deviceId: string, controlId: string, context?: MessageContext): RetVal<ErrorResponse | ioBroker.State>;
     private onMessage;

package/build/DeviceManagement.js

@@ -17,7 +17,7 @@ class DeviceManagement {
     getDeviceDetails(id) {
         return { id, schema: {} };
     }
-    handleInstanceAction(actionId, context) {
+    handleInstanceAction(actionId, context, options) {
         var _a;
         if (!this.instanceInfo) {
             this.log.warn(`Instance action ${actionId} was called before getInstanceInfo()`);
@@ -34,9 +34,9 @@ class DeviceManagement {
                 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);
+        return action.handler(context, options);
     }
-    handleDeviceAction(deviceId, actionId, context) {
+    handleDeviceAction(deviceId, actionId, context, options) {
         var _a;
         if (!this.devices) {
             this.log.warn(`Device action ${actionId} was called before listDevices()`);
@@ -63,7 +63,7 @@ class DeviceManagement {
                 },
             };
         }
-        return action.handler(deviceId, context);
+        return action.handler(deviceId, context, options);
     }
     handleDeviceControl(deviceId, controlId, newState, context) {
         var _a;
@@ -161,7 +161,7 @@ class DeviceManagement {
                 const action = msg.message;
                 const context = new MessageContext(msg, this.adapter);
                 this.contexts.set(msg._id, context);
-                const result = await this.handleInstanceAction(action.actionId, context);
+                const result = await this.handleInstanceAction(action.actionId, context, { value: action.value });
                 this.contexts.delete(msg._id);
                 context.sendFinalResult(result);
                 return;
@@ -170,7 +170,7 @@ class DeviceManagement {
                 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);
+                const result = await this.handleDeviceAction(action.deviceId, action.actionId, context, { value: action.value });
                 this.contexts.delete(msg._id);
                 context.sendFinalResult(result);
                 return;

package/build/types/base.d.ts

@@ -8,11 +8,35 @@ export interface ActionBase<T extends ActionType> {
     /**
      * This can either be base64 or the URL to an icon.
      */
-    icon: string;
+    icon?: string;
     description?: ioBroker.StringOrTranslated;
     disabled?: T extends "api" ? boolean : never;
     color?: Color;
     backgroundColor?: Color;
+    /** If true, the user will be asked for confirmation before executing the action */
+    confirmation: boolean | ioBroker.StringOrTranslated;
+    /** If defined, before the action is triggered, the non-empty text or number or checkbox will be asked */
+    inputBefore: {
+        /** 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";
+        /** If a type is "select", the options must be defined */
+        options?: {
+            label: ioBroker.StringOrTranslated;
+            value: string;
+        }[];
+        /** Default value for the input */
+        defaultValue?: string | number | boolean;
+        /** If true, the input could be empty */
+        allowEmptyValue?: boolean;
+        /** Minimum value for the input (number or slider) */
+        min?: number;
+        /** Maximum value for the input (number or slider) */
+        max?: number;
+        /** Step value for the input (number or slider) */
+        step?: number;
+    };
 }
 export interface ChannelInfo {
     name: ioBroker.StringOrTranslated;
@@ -51,13 +75,13 @@ export interface DeviceControl<T extends ActionType = "api"> extends ControlBase
     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) => RetVal<{
+    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) => RetVal<{
+    handler?: T extends "api" ? never : (deviceId: string, context: ActionContext, options?: Record<string, any>) => RetVal<{
         refresh: DeviceRefresh;
     }>;
 }

package/build/types/common.d.ts

@@ -20,10 +20,81 @@ export type ErrorResponse = {
     };
 };
 export type RetVal<T> = T | Promise<T>;
-export type JsonFormSchema = Record<string, any>;
+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';
+export interface ConfigItemConfirmData {
+    condition: string;
+    text?: ioBroker.StringOrTranslated;
+    title?: ioBroker.StringOrTranslated;
+    ok?: ioBroker.StringOrTranslated;
+    cancel?: ioBroker.StringOrTranslated;
+    type?: 'info' | 'warning' | 'error' | 'none';
+    alsoDependsOn?: string[];
+}
+type CustomCSSProperties = Record<string, any>;
+export interface ConfigItem {
+    type: ConfigItemType;
+    sm?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+    md?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+    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;
+    newLine?: boolean;
+    label?: ioBroker.StringOrTranslated;
+    /** @deprecated use label */
+    text?: ioBroker.StringOrTranslated;
+    hidden?: string | boolean;
+    hideOnlyControl?: boolean;
+    disabled?: string | boolean;
+    help?: ioBroker.StringOrTranslated;
+    helpLink?: string;
+    style?: CustomCSSProperties;
+    darkStyle?: CustomCSSProperties;
+    validator?: string;
+    validatorErrorText?: string;
+    validatorNoSaveOnError?: boolean;
+    tooltip?: ioBroker.StringOrTranslated;
+    default?: boolean | number | string;
+    defaultFunc?: string;
+    defaultSendTo?: string;
+    data?: string | number | boolean;
+    jsonData?: string;
+    button?: ioBroker.StringOrTranslated;
+    buttonTooltip?: ioBroker.StringOrTranslated;
+    buttonTooltipNoTranslation?: boolean;
+    placeholder?: ioBroker.StringOrTranslated;
+    noTranslation?: boolean;
+    onChange?: {
+        alsoDependsOn: string[];
+        calculateFunc: string;
+        ignoreOwnChanges?: boolean;
+    };
+    doNotSave?: boolean;
+    noMultiEdit?: boolean;
+    confirm?: ConfigItemConfirmData;
+    icon?: 'auth' | 'send' | 'web' | 'warning' | 'error' | 'info' | 'search' | 'book' | 'help' | 'upload' | string;
+    width?: string | number;
+    confirmDependsOn?: ConfigItemIndexed[];
+    onChangeDependsOn?: ConfigItemIndexed[];
+    hiddenDependsOn?: ConfigItemIndexed[];
+    labelDependsOn?: ConfigItemIndexed[];
+    helpDependsOn?: ConfigItemIndexed[];
+}
+interface ConfigItemIndexed extends ConfigItem {
+    attr?: string;
+}
+export interface ConfigItemPanel extends ConfigItem {
+    type: 'panel' | never;
+    label?: ioBroker.StringOrTranslated;
+    items: Record<string, ConfigItem>;
+    collapsable?: boolean;
+    color?: 'primary' | 'secondary';
+    innerStyle?: CustomCSSProperties;
+    i18n?: boolean | string | Record<string, Record<ioBroker.Languages, string>>;
+}
+export type JsonFormSchema = ConfigItemPanel;
 export type JsonFormData = Record<string, any>;
 export interface DeviceDetails {
     id: string;
     schema: JsonFormSchema;
     data?: JsonFormData;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/dm-utils",
-  "version": "0.1.9",
+  "version": "0.2.0",
   "description": "ioBroker Device Manager utilities for backend",
   "main": "build/index.js",
   "publishConfig": {
@@ -16,23 +16,23 @@
     "release-minor": "release-script minor --yes",
     "release-major": "release-script major --yes",
     "update-packages": "ncu --upgrade",
-    "npm": "npm i"
+    "npm": "npm i -f"
   },
   "author": "UncleSamSwiss",
   "license": "MIT",
   "dependencies": {
-    "@iobroker/adapter-core": "^3.0.4"
+    "@iobroker/adapter-core": "^3.1.4"
   },
   "devDependencies": {
     "@alcalzone/release-script": "^3.7.0",
     "@alcalzone/release-script-plugin-license": "^3.7.0",
-    "@types/node": "^20.10.4",
-    "@typescript-eslint/eslint-plugin": "^6.14.0",
-    "@typescript-eslint/parser": "^6.14.0",
-    "eslint": "^8.56.0",
+    "@types/node": "^20.12.12",
+    "@typescript-eslint/eslint-plugin": "^7.11.0",
+    "@typescript-eslint/parser": "^7.11.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
-    "prettier": "^3.1.1",
-    "typescript": "^5.3.3"
+    "prettier": "^3.2.5",
+    "typescript": "^5.4.5"
   },
   "files": [
     "LICENSE",