@iobroker/types 6.0.8 → 6.0.9

package/build/config.d.ts

@@ -9,7 +9,7 @@ interface DatabaseBackupOptions {
     /** by default backup every 2 hours. Time is in minutes. To disable backup set the value to 0 */
     period: number;
     '// period': string;
-    /** Absolute path to backup directory or empty to backup in data directory */
+    /** Absolute path to back-up directory or empty to back-up in data directory */
     path: string;
     '// path': string;
 }
@@ -33,7 +33,7 @@ interface JsonlOptions {
     '// throttleFS (1)': string;
     '// throttleFS (2)': string;
     /**
-     * By default, the database immediately writes to the database file. Write accesses can be reduced using the throttleFS option.
+     * By default, the database immediately writes to the database file. Write access can be reduced using the throttleFS option.
      * Be aware that buffered changes will be lost in case the process crashes
      */
     throttleFS: {
@@ -41,7 +41,7 @@ interface JsonlOptions {
         /** Write to the database file no more than every intervalMs milliseconds. */
         intervalMs: number;
         '// maxBufferedCommands': string;
-        /** Force writing after this many changes have been buffered. This reduces memory consumption and data loss in case of a crash. */
+        /** Force writing of buffered commands after so many changes. This reduces memory consumption and data loss in case of a crash. */
         maxBufferedCommands: number;
     };
 }

package/build/objects.d.ts

@@ -574,6 +574,27 @@ declare global {
 
         type ConnectionType = 'local' | 'cloud';
 
+        type LocalLink = {
+            /** Link to the web service of this adapter, like: "%web_protocol%://%ip%:%web_port%/vis-2/edit.html" */
+            link: string;
+            /** Name of the link. Could be multi-language */
+            name?: ioBroker.StringOrTranslated;
+            /** Color */
+            color?: string;
+            /** Link to icon, like "vis-2/img/favicon.png" */
+            icon?: string;
+            /** Link to the adapter if it could be shown in the free cloud, like: vis-2/index.html according to "https://iobroker.net/" */
+            cloud?: string;
+            /** Link to the adapter if it could be shown in the pro-cloud, like: vis-2/edit.html according to "https://iobroker.pro/" */
+            pro?: string;
+            /** If this link should be shown on the intro tab in admin. false = do not show */
+            intro?: boolean;
+            /** Order of the card. Used on "intro" and cloud tabs to sort the links */
+            order?: number;
+            /** Description of the link. Could be multi-language */
+            description?: ioBroker.StringOrTranslated;
+        };
+
         interface AdapterCommon extends ObjectCommon {
             /** Custom attributes to be shown in admin in the object browser */
             adminColumns?: string | (string | CustomAdminColumn)[];
@@ -604,7 +625,7 @@ declare global {
             blockly?: boolean;
             /** Where the adapter will get its data from. Set this together with @see dataSource */
             connectionType?: ConnectionType;
-            /** If true, this adapter can be started in compact mode (in the same process as other adpaters) */
+            /** If true, this adapter can be started in compact mode (in the same process as other adapters) */
             compact?: boolean;
             /** The directory relative to iobroker-data where the adapter stores the data. Supports the placeholder `%INSTANCE%`. This folder will be backed up and restored automatically. */
             dataFolder?: string;
@@ -626,7 +647,7 @@ declare global {
             getHistory?: boolean;
             /** Filename of the local icon which is shown for installed adapters. Should be located in the `admin` directory */
             icon?: string;
-            /** The adapter will be executed once additionally after installation and the `install` event will be emitted during this run. This allows for executing one time installation code. */
+            /** The adapter will be executed once additionally after installation, and the `install` event will be emitted during this run. This allows for executing one time installation code. */
             install?: boolean;
             /** Source, where this adapter has been installed from, to enable reinstalling on e.g., backup restore */
             installedFrom?: InstalledFrom;
@@ -634,17 +655,17 @@ declare global {
             installedVersion: string;
             keywords?: string[];
             /** A dictionary of links to web services this adapter provides */
-            localLinks?: Record<string, string>;
+            localLinks?: Record<string, string | LocalLink>;
             /** @deprecated Use @see localLinks */
             localLink?: string;
             loglevel?: LogLevel;
-            /** Whether this adapter receives logs from other hosts and adapters (e.g., to strore them somewhere) */
+            /** Whether this adapter receives logs from other hosts and adapters (e.g., to store them somewhere) */
             logTransporter?: boolean;
             /** Path to the start file of the adapter. Should be the same as in `package.json` */
             main?: string;
-            /** Whether the admin tab is written in materialize style. Required for Admin 3+ */
+            /** Whether the admin tab is written in materialized style. Required for Admin 3+ */
             materializeTab?: boolean;
-            /** Whether the admin configuration dialog is written in materialize style. Required for Admin 3+ */
+            /** Whether the admin configuration dialog is written in materialized style. Required for Admin 3+ */
             materialize: boolean;
             /** @deprecated Use @see supportedMessages up from controller v5 */
             messagebox?: true;
@@ -720,9 +741,9 @@ declare global {
             webExtension?: string;
             webPreSettings?: any; // ?
             webservers?: any; // ?
-            /** A list of pages that should be shown on the "web" index page */
+            /** @deprecated (use localLinks) A list of pages that should be shown on the "web" index page */
             welcomeScreen?: WelcomeScreenEntry[];
-            /** A list of pages that should be shown on the ioBroker cloud index page */
+            /** @deprecated (use localLinks) A list of pages that should be shown on the ioBroker cloud index page */
             welcomeScreenPro?: WelcomeScreenEntry[];
             wwwDontUpload?: boolean;
             /** @deprecated Use 'common.licenseInformation' instead */

package/build/types.d.ts

@@ -402,6 +402,12 @@ export declare class AdapterClass extends EventEmitter {
     /** Controller for messaging related functionality */
     private readonly uiMessagingController;
     constructor(options: AdapterOptions | string);
+    /**
+     * Get the adapter scoped package identifier of a node module
+     *
+     * @param moduleName name of the node module
+     */
+    getAdapterScopedPackageIdentifier(moduleName: string): string;
     installNodeModule(moduleName: string, options: InstallNodeModuleOptions): Promise<CommandResult>;
     private _installNodeModule;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@iobroker/types",
-    "version": "6.0.8",
+    "version": "6.0.9",
     "engines": {
         "node": ">=12.0.0"
     },
@@ -41,5 +41,5 @@
             ]
         }
     },
-    "gitHead": "a0c733082b4f9f8118a9a3922b663bd93630c790"
+    "gitHead": "5120e61da9a6864aa443f79f12ac447589ea6147"
 }