improve exported types

ioBroker · Jun 4, 2024 · 47c8390 · 47c8390
1 parent 75860ec
commit 47c8390
Show file tree

Hide file tree

Showing 5 changed files with 877 additions and 4,411 deletions.
diff --git a/README.md b/README.md
@@ -114,6 +114,9 @@ If you find errors in the definitions, e.g., function calls that should be allow
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### **WORK IN PROGRESS**
+* (foxriver76) improve exported types
+
 ### 3.1.5 (2024-06-03)
 * (foxriver76) provide up-to-date types
 

diff --git a/build/cjs/controllerTools.d.ts b/build/cjs/controllerTools.d.ts
@@ -20,26 +20,13 @@ declare function pattern2RegEx(pattern: string): string;
  * @returns path to adapter directory or null if no directory found
  */
 declare function getAdapterDir(adapter: string): string | null;
-interface Multilingual {
-    en: string;
-    de?: string;
-    ru?: string;
-    pt?: string;
-    nl?: string;
-    fr?: string;
-    it?: string;
-    es?: string;
-    pl?: string;
-    uk?: string;
-    "zh-cn"?: string;
-}
-export interface GetInstalledInfoReponse {
+export interface InstalledInfo {
     controller?: boolean;
     version?: string;
     icon?: string;
     title?: string;
-    titleLang?: Multilingual;
-    desc?: Multilingual;
+    titleLang?: ioBroker.Translated;
+    desc?: ioBroker.Translated;
     platform?: string;
     keywords?: string[];
     readme?: string;
@@ -52,7 +39,7 @@ export interface GetInstalledInfoReponse {
  * @param hostJsControllerVersion Version of the running js-controller, will be included in the returned information if provided
  * @returns object containing information about installed host
  */
-declare function getInstalledInfo(hostJsControllerVersion?: string): GetInstalledInfoReponse;
+declare function getInstalledInfo(hostJsControllerVersion?: string): Record<string, InstalledInfo>;
 /**
  * Checks if we are running inside a docker container
  */

diff --git a/build/esm/controllerTools.d.ts b/build/esm/controllerTools.d.ts
@@ -20,26 +20,13 @@ declare function pattern2RegEx(pattern: string): string;
  * @returns path to adapter directory or null if no directory found
  */
 declare function getAdapterDir(adapter: string): string | null;
-interface Multilingual {
-    en: string;
-    de?: string;
-    ru?: string;
-    pt?: string;
-    nl?: string;
-    fr?: string;
-    it?: string;
-    es?: string;
-    pl?: string;
-    uk?: string;
-    "zh-cn"?: string;
-}
-export interface GetInstalledInfoReponse {
+export interface InstalledInfo {
     controller?: boolean;
     version?: string;
     icon?: string;
     title?: string;
-    titleLang?: Multilingual;
-    desc?: Multilingual;
+    titleLang?: ioBroker.Translated;
+    desc?: ioBroker.Translated;
     platform?: string;
     keywords?: string[];
     readme?: string;
@@ -52,7 +39,7 @@ export interface GetInstalledInfoReponse {
  * @param hostJsControllerVersion Version of the running js-controller, will be included in the returned information if provided
  * @returns object containing information about installed host
  */
-declare function getInstalledInfo(hostJsControllerVersion?: string): GetInstalledInfoReponse;
+declare function getInstalledInfo(hostJsControllerVersion?: string): Record<string, InstalledInfo>;
 /**
  * Checks if we are running inside a docker container
  */