@iobroker/json-config 9.0.19 → 9.0.21

package/build/types.d.ts

@@ -17,6 +17,40 @@ declare module '@mui/material/Button' {
 
 type CustomCSSProperties = React.CSSProperties;
 
+/**
+ * Operating system of the ioBroker host, on which the instance runs.
+ * These are the values of the node.js `process.platform`, like in `common.os` of `io-package.json`.
+ */
+export type ConfigItemOs =
+    'aix' | 'android' | 'cygwin' | 'darwin' | 'freebsd' | 'haiku' | 'linux' | 'netbsd' | 'openbsd' | 'sunos' | 'win32';
+
+/** Information about the ioBroker host, on which the configured instance runs */
+export interface JsonConfigHostInfo {
+    /** Name of the host without `system.host.` prefix, e.g. `iobroker-raspi`. Empty if unknown */
+    id: string;
+    /** Operating system of the host (`process.platform`), e.g. `linux`. Empty if unknown */
+    os: ConfigItemOs | '';
+    /** Type of the operating system (`os.type()`), e.g. `Linux`, `Windows_NT`, `Darwin` */
+    osType: string;
+    /** Architecture of the host (`os.arch()`), e.g. `x64`, `arm64` */
+    arch: string;
+    /** Release of the operating system (`os.release()`) */
+    release: string;
+    /** Node.js version of the js-controller, e.g. `22.18.0` */
+    nodeVersion: string;
+    /** Installed js-controller version, e.g. `7.0.7` */
+    controllerVersion: string;
+    /**
+     * True if the ioBroker runs in a docker container.
+     *
+     * It is `undefined` if the docker state could not be detected: it is only requested if the configuration
+     * uses it (`docker` attribute or `_host.docker`) and it requires a running host.
+     */
+    docker?: boolean;
+    /** Version of the official ioBroker docker image. It is `undefined` for a not official image */
+    dockerVersion?: string;
+}
+
 export type ConfigItemType =
     | 'accordion'
     | 'alive'
@@ -164,6 +198,22 @@ export interface ConfigItem {
     hidden?: string | boolean;
     /** If true and the control is hidden, the place of the control will be still reserved for it */
     hideOnlyControl?: boolean;
+    /**
+     * Show this element only on the given operating system(s) of the host, on which the instance runs:
+     * e.g. `"win32"` or `["linux", "darwin"]`. If the OS cannot be detected, the element will be shown.
+     */
+    os?: ConfigItemOs | ConfigItemOs[];
+    /**
+     * Do not show this element on the given operating system(s) of the host, on which the instance runs:
+     * e.g. `"win32"` or `["linux", "darwin"]`. If the OS cannot be detected, the element will be shown.
+     */
+    notOs?: ConfigItemOs | ConfigItemOs[];
+    /**
+     * Show this element only if the ioBroker runs in a docker container (`true`) or only if it does not
+     * run in a docker container (`false`). If the docker state cannot be detected (the host must run for
+     * that), the element will be shown.
+     */
+    docker?: boolean;
     /** JS function to calculate if the control is disabled. You can write "true" too */
     disabled?: string | boolean;
     /** Help text of the control */
@@ -247,6 +297,12 @@ export interface ConfigItemSelectOption {
     color?: string;
     /** Formula or boolean value to show or hide the option */
     hidden?: string | boolean;
+    /** Show this option only on the given operating system(s) of the host, on which the instance runs */
+    os?: ConfigItemOs | ConfigItemOs[];
+    /** Do not show this option on the given operating system(s) of the host, on which the instance runs */
+    notOs?: ConfigItemOs | ConfigItemOs[];
+    /** Show this option only if the ioBroker runs (`true`) or does not run (`false`) in a docker container */
+    docker?: boolean;
     /** Description for the value */
     description?: ioBroker.StringOrTranslated;
     /** Icon URL or base64 to display next to the option */
@@ -614,6 +670,12 @@ export interface ConfigItemSelect extends ConfigItem {
               value?: number | string;
               color?: string;
               hidden?: string | boolean;
+              /** Show this group only on the given operating system(s) of the host, on which the instance runs */
+              os?: ConfigItemOs | ConfigItemOs[];
+              /** Do not show this group on the given operating system(s) of the host, on which the instance runs */
+              notOs?: ConfigItemOs | ConfigItemOs[];
+              /** Show this group only if the ioBroker runs (`true`) or does not run (`false`) in a docker container */
+              docker?: boolean;
               description?: ioBroker.StringOrTranslated;
               noTranslation?: boolean;
               icon?: string;
@@ -1250,6 +1312,8 @@ export type JsonConfigContext = {
     onValueChange?: (attr: string, value: any, saveConfig: boolean) => void;
     registerOnForceUpdate?: (attr: string, cb?: (data: any) => void) => void;
     getCachedObject?: (id: string) => Promise<ioBroker.Object | null>;
+    /** Information about the host, on which the configured instance runs */
+    hostInfo?: JsonConfigHostInfo;
 };
 
 // Notification GUI

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@iobroker/json-config",
   "description": "This package contains the ioBroker JSON config UI components",
-  "version": "9.0.19",
+  "version": "9.0.21",
   "author": {
     "name": "bluefox",
     "email": "dogafox@gmail.com"
@@ -37,7 +37,7 @@
   "dependencies": {
     "@emotion/react": "^11.14.0",
     "@emotion/styled": "^11.14.1",
-    "@iobroker/gui-components": "^10.0.15",
+    "@iobroker/gui-components": "^10.1.0",
     "@module-federation/runtime": "^2.8.2",
     "@mui/icons-material": "^9.3.1",
     "@mui/material": "^9.3.1",
@@ -47,7 +47,7 @@
     "react": "^19.2.8",
     "react-ace": "^15.0.0",
     "react-dom": "^19.2.8",
-    "react-dropzone": "^20.0.0",
+    "react-dropzone": "^20.1.0",
     "react-qr-code": "^2.2.0",
     "yaml": "^2.9.0"
   },
@@ -65,7 +65,7 @@
     "ajv": "^8.20.0",
     "date-fns": "^4.4.0",
     "react-color": "^2.19.3",
-    "tsc-alias": "^1.9.1",
+    "tsc-alias": "^1.9.2",
     "typescript": "~6.0.3"
   },
   "overrides": {