New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@iobroker/types
Advanced tools
@iobroker/types - npm Package Compare versions
Comparing version 6.0.12-alpha.0-20240827-34e3febb4 to 6.0.12-alpha.0-20240903-dbd1caae0
@@ -433,3 +433,3 @@ import type * as os from 'node:os'; | ||
| /** The username */ | ||
| name: string; | ||
| name: StringOrTranslated; | ||
| /** The hashed password */ | ||
@@ -446,3 +446,3 @@ password: string; | ||
| /** The name of this group */ | ||
| name: string; | ||
| name: StringOrTranslated; | ||
| /** The users of this group */ | ||
@@ -600,2 +600,5 @@ members: ObjectIDs.User[]; // system.user.name, ... | ||
| /** Format for local and global dependencies */ | ||
| type Depdendencies = { [adapterName: string]: string }[] | string[]; | ||
| interface AdapterCommon extends ObjectCommon { | ||
@@ -638,5 +641,5 @@ /** Custom attributes to be shown in admin in the object browser */ | ||
| /** A record of ioBroker adapters (including "js-controller") and version ranges which are required for this adapter on the same host. */ | ||
| dependencies?: Array<Record<string, string>>; | ||
| dependencies?: Depdendencies; | ||
| /** A record of ioBroker adapters (including "js-controller") and version ranges which are required for this adapter in the whole system. */ | ||
| globalDependencies?: Array<Record<string, string>>; | ||
| globalDependencies?: Depdendencies; | ||
| /** Which files outside the README.md have documentation for the adapter */ | ||
@@ -736,3 +739,31 @@ docs?: Partial<Record<Languages, string | string[]>>; | ||
| /** The type of this adapter */ | ||
| type?: string; | ||
| type?: | ||
| | 'alarm' | ||
| | 'climate-control' | ||
| | 'communication' | ||
| | 'date-and-time' | ||
| | 'energy' | ||
| | 'garden' | ||
| | 'general' | ||
| | 'geoposition' | ||
| | 'hardware' | ||
| | 'health' | ||
| | 'household' | ||
| | 'infrastructure' | ||
| | 'iot-systems' | ||
| | 'lighting' | ||
| | 'logic' | ||
| | 'messaging' | ||
| | 'metering' | ||
| | 'misc-data' | ||
| | 'multimedia' | ||
| | 'network' | ||
| | 'protocols' | ||
| | 'storage' | ||
| | 'utility' | ||
| | 'vehicle' | ||
| | 'visualization' | ||
| | 'visualization-icons' | ||
| | 'visualization-widgets' | ||
| | 'weather'; | ||
| /** If `true`, the `npm` package must be installed with the `--unsafe-perm` flag */ | ||
@@ -802,2 +833,4 @@ unsafePerm?: true; | ||
| dateFormat: string; | ||
| /** This name will be shown in admin's header. Just to identify the whole installation */ | ||
| siteName?: string; | ||
| /** Default acl for new objects */ | ||
@@ -846,5 +879,5 @@ defaultNewAcl: { | ||
| /** | ||
| * ioBroker has built-in protection for specific attributes of objects. If this protection is installed in the object, then the protected attributes of object cannot be changed by the user without valid password. | ||
| * ioBroker has built-in protection for specific attributes of objects. If this protection is installed in the object, then the protected attributes of an object cannot be changed by the user without a valid password. | ||
| * To protect the properties from change, the special attribute "nonEdit" must be added to the object. This attribute contains the password, which is required to change the object. | ||
| * If object does not have "nonEdit" attribute, so the hash will be saved into "nonEdit.passHash". After that if someone will change the object, he must provide the password in "nonEdit.password". | ||
| * If an object does not have "nonEdit" attribute, so the hash will be saved into "nonEdit.passHash". After that, if someone changes the object, he must provide the password in "nonEdit.password". | ||
| * If the password is correct, the object attributes will be updated. If the password is wrong, the object will not be changed. | ||
@@ -994,2 +1027,4 @@ * Note, that all properties outside "nonEdit" can be updated without providing the password. Furthermore, do not confuse e.g. "nonEdit.common" with "obj.common" they are not linked in any way. | ||
| time?: string; | ||
| /** If this repository stable */ | ||
| stable?: boolean; | ||
| } | ||
@@ -1031,9 +1066,43 @@ | ||
| /** TODO: To be defined */ | ||
| type NotificationCategory = any; | ||
| // it is defined in notificationHandler.ts | ||
| type NotificationCategory = { | ||
| /** The unique category identifier */ | ||
| category: | ||
| | 'memIssues' | ||
| | 'fsIoErrors' | ||
| | 'noDiskSpace' | ||
| | 'accessErrors' | ||
| | 'nonExistingFileErrors' | ||
| | 'remoteHostErrors' | ||
| | 'restartLoop' | ||
| | 'fileToJsonl' | ||
| | 'automaticAdapterUpgradeFailed' | ||
| | 'automaticAdapterUpgradeSuccessful' | ||
| | 'blockedVersions' | ||
| | 'databaseErrors' | ||
| | 'securityIssues' | ||
| | 'packageUpdates' | ||
| | 'systemRebootRequired' | ||
| | 'diskSpaceIssues' | ||
| | string; | ||
| /** The human-readable category name */ | ||
| name: Translated; | ||
| /** The human-readable category description */ | ||
| description: Translated; | ||
| /** Allows to define the severity of the notification with `info` being the lowest `notify` representing middle priority, `alert` representing high priority and often containing critical information */ | ||
| severity: 'info' | 'notify' | 'alert'; | ||
| /** If a regex is specified, the js-controller will check error messages on adapter crashes against this regex and will generate a notification of this category */ | ||
| regex: string[]; | ||
| /** Deletes older messages if more than the specified amount is present for this category */ | ||
| limit: number; | ||
| }; | ||
| interface Notification { | ||
| /** Each adapter can define its own "scopes" for own notifications with its own categories which then will be available in the system. Adapters should only register one scope which matches the name of the adapter. */ | ||
| scope: string; | ||
| /** The human-readable name of this scope */ | ||
| name: Translated; | ||
| /** The human-readable description of this scope */ | ||
| description: Translated; | ||
| /** All notification categories of this scope */ | ||
| categories: NotificationCategory[]; | ||
@@ -1040,0 +1109,0 @@ } |
@@ -28,3 +28,3 @@ // Types which are safe to share within this repository AND publicly | ||
| CONNECTION_PROBLEM: 0x02; | ||
| /** Substitute value from controller, do not set this in adapters */ | ||
| /** Substitute value from controller. Do not set this in adapters */ | ||
| SUBSTITUTE_FROM_CONTROLLER: 0x10; | ||
@@ -208,11 +208,11 @@ /** Quality for default values */ | ||
| interface Logger { | ||
| /** log message with silly level */ | ||
| /** log a message with silly level */ | ||
| silly(message: string): void; | ||
| /** log message with debug level */ | ||
| /** log a message with debug level */ | ||
| debug(message: string): void; | ||
| /** log message with info level (default output level for all adapters) */ | ||
| /** log a message with info level (default output level for all adapters) */ | ||
| info(message: string): void; | ||
| /** log message with warning severity */ | ||
| /** log a message with warning severity */ | ||
| warn(message: string): void; | ||
| /** log message with error severity */ | ||
| /** log a message with error severity */ | ||
| error(message: string): void; | ||
@@ -241,3 +241,3 @@ | ||
| id: number; | ||
| // ??? | ||
| /** If ack is false, it means the message is a request. If ack is true, it means the message is a response */ | ||
| ack: boolean; | ||
@@ -299,3 +299,3 @@ /** Timestamp of this message */ | ||
| interface DelObjectOptions { | ||
| /** Whether all child objects should be deleted aswell */ | ||
| /** Whether all child objects should be deleted as well */ | ||
| recursive?: boolean; | ||
@@ -485,3 +485,3 @@ // Allow non-documented properties | ||
| /** The ID of this object */ | ||
| id: string; | ||
| id: T['_id']; | ||
| /** A copy of the object from the DB */ | ||
@@ -488,0 +488,0 @@ value: T; |
| { | ||
| "name": "@iobroker/types", | ||
| "version": "6.0.12-alpha.0-20240827-34e3febb4", | ||
| "version": "6.0.12-alpha.0-20240903-dbd1caae0", | ||
| "engines": { | ||
@@ -44,3 +44,3 @@ "node": ">=12.0.0" | ||
| }, | ||
| "gitHead": "03fa620a4591c945e1eb146713e594ccd1ade6b4" | ||
| "gitHead": "1c4df5be6023b832092c8f6d51d6463b87734211" | ||
| } |
Sorry, the diff of this file is too big to display
No alert changes
Improved metrics
- Total package byte prevSize
- increased by1.92%
171186
- Lines of code
- increased by2.11%
3297
No dependency changes