iobroker.javascript 9.0.10 → 9.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/README.md +7 -10
  2. package/admin/assets/OpenAiDialog-Db5nBWtV.js +36 -0
  3. package/admin/assets/{Save--0ldNXLf.js → Save-DXaUpIPM.js} +1 -1
  4. package/admin/assets/{ScriptEditor-MKyboaPj.js → ScriptEditor-CuzI8bbK.js} +1 -1
  5. package/admin/assets/{ScriptEditorVanillaMonaco-CkDzb80s.js → ScriptEditorVanillaMonaco-LjlfPO8c.js} +1 -1
  6. package/admin/assets/{createSvgIcon-C_ElRFrf.js → createSvgIcon-DlIk-fDn.js} +3 -3
  7. package/admin/assets/hostInit-OBG53iVO.js +2 -0
  8. package/admin/assets/index-BCK6q-N6.css +1 -0
  9. package/admin/assets/{index-Dr_ZFwru.css → index-BTsjunTt.css} +1 -1
  10. package/admin/assets/{index-CMttI-gM.js → index-BWM5lJbO.js} +4 -4
  11. package/admin/assets/index-Cjl4b70e.js +5 -0
  12. package/admin/assets/{index-DmpUKunr.js → index-CpvUlHhu.js} +5 -5
  13. package/admin/assets/index-CtB5rga_.js +16 -0
  14. package/admin/assets/{index-BompUVvy.js → index-DoG44L1P.js} +1 -1
  15. package/admin/assets/index-DzAZ7TKU.js +1 -0
  16. package/admin/assets/index-XLsd8FZV.js +942 -0
  17. package/admin/assets/index-ee1BGSYh.js +1294 -0
  18. package/admin/assets/{inheritsLoose-CLw44UEv.js → inheritsLoose-DNrhibGS.js} +1 -1
  19. package/admin/assets/{iobroker_javascript__loadShare__react__loadShare__-B-pIv4x_.js → iobroker_javascript__loadShare__react__loadShare__-i8pXne9X.js} +1 -1
  20. package/admin/assets/iobroker_javascript__mf_v__runtimeInit__mf_v__-DZdFIfoQ.js +5 -0
  21. package/admin/assets/preload-helper-BDBacUwf.js +1 -0
  22. package/admin/assets/useTheme-DakN8Abq.js +1 -0
  23. package/admin/custom/assets/{Components-za_0yG9W.js → Components-DJLwk8Py.js} +1 -1
  24. package/admin/custom/assets/{ConfigCustomJavascriptSet__loadShare___mf_0_iobroker_mf_1_adapter_mf_2_react_mf_2_v5__loadShare__-BHJt30My.js → ConfigCustomJavascriptSet__loadShare___mf_0_iobroker_mf_1_adapter_mf_2_react_mf_2_v5__loadShare__-DaN0pfsw.js} +1 -1
  25. package/admin/custom/assets/{ConfigCustomJavascriptSet__loadShare___mf_0_mui_mf_1_material__loadShare__-WrqdT1Hz.js → ConfigCustomJavascriptSet__loadShare___mf_0_mui_mf_1_material__loadShare__-BqzgglHd.js} +1 -1
  26. package/admin/custom/assets/{ConfigCustomJavascriptSet__loadShare__react__loadShare__-B_YWmFeG.js → ConfigCustomJavascriptSet__loadShare__react__loadShare__-BNbscXK6.js} +1 -1
  27. package/admin/custom/assets/{ConfigCustomJavascriptSet__loadShare__react_mf_2_dom__loadShare__-DYzjQQsF.js → ConfigCustomJavascriptSet__loadShare__react_mf_2_dom__loadShare__-N2_tx_mJ.js} +1 -1
  28. package/admin/custom/assets/ConfigCustomJavascriptSet__mf_v__runtimeInit__mf_v__-jdUmHa_i.js +5 -0
  29. package/admin/custom/assets/DefaultPropsProvider-B6-0SEtV.js +7 -0
  30. package/admin/custom/assets/DefaultPropsProvider-BbFDEnmq.js +1 -0
  31. package/admin/custom/assets/{FilledInput-BGGUNS4j.js → FilledInput-CX9v1cwN.js} +2 -2
  32. package/admin/custom/assets/{Tabs-DjdFNknI.js → Tabs-bjxmjZcg.js} +6 -6
  33. package/admin/custom/assets/{ThemeProvider-Uan4kCQd.js → ThemeProvider-CeD4z8mE.js} +2 -2
  34. package/admin/custom/assets/_commonjsHelpers-CE1G-McA.js +1 -0
  35. package/admin/custom/assets/{createSvgIcon-BxCMHFh5.js → createSvgIcon-DAmSzHRD.js} +1 -1
  36. package/admin/custom/assets/{createTheme-Ajie0adn.js → createTheme-LEFpI6rM.js} +2 -2
  37. package/admin/custom/assets/defaultTheme-2suHr_rQ.js +1 -0
  38. package/admin/custom/assets/{hostInit-CrAs5YZS.js → hostInit-BJ6gSofk.js} +2 -2
  39. package/admin/custom/assets/{index-7YkEnLQM.js → index-1hRrucfm.js} +1 -1
  40. package/admin/custom/assets/{index-yiPj_-Rb.js → index-BM9YMTul.js} +1 -1
  41. package/admin/custom/assets/{index-Co3YA5NW.js → index-BgpTxVrG.js} +1 -1
  42. package/admin/custom/assets/index-CJimub3l.js +1399 -0
  43. package/admin/custom/assets/index-CPZpQ2Mb.js +916 -0
  44. package/admin/custom/assets/{index-UhQfKbTz.js → index-CrVgzaLe.js} +1 -1
  45. package/admin/custom/assets/{index-ClFSKKDu.js → index-CznMGPgM.js} +2 -2
  46. package/admin/custom/assets/{index-bxilEzdP.js → index-D-RbixT9.js} +5 -5
  47. package/admin/custom/assets/{index-DXg_kRe6.js → index-DMiiPxNM.js} +1 -1
  48. package/admin/custom/assets/{index-B2rBO0oC.js → index-DcK0RDrH.js} +1 -1
  49. package/admin/custom/assets/{index-DOnIDI_a.js → index-Dx7rDE4p.js} +1 -1
  50. package/admin/custom/assets/index-EogeheIH.js +31 -0
  51. package/admin/custom/assets/{jsx-runtime-lE4rOet2.js → jsx-runtime-CJ3ByJW3.js} +1 -1
  52. package/admin/custom/assets/leaflet-src-Dnh7srds.js +4 -0
  53. package/admin/custom/assets/preload-helper-BDBacUwf.js +1 -0
  54. package/admin/custom/assets/{useEnhancedEffect-DSK35Rma.js → useEnhancedEffect-COBJo-Ex.js} +2 -2
  55. package/admin/custom/assets/useTheme-52mADBCy.js +1 -0
  56. package/admin/custom/assets/{useTheme-DWmRkwMP.js → useTheme-Y8PztM11.js} +1 -1
  57. package/admin/custom/assets/virtualExposes-BMbgFEvP.js +2 -0
  58. package/admin/custom/customComponents.js +2 -2
  59. package/admin/i18n/de.json +1 -1
  60. package/admin/mf-manifest.json +1 -1
  61. package/admin/remoteEntry.js +2 -2
  62. package/admin/tab.html +10 -13
  63. package/build/lib/crypto.js +32 -0
  64. package/build/lib/crypto.js.map +1 -0
  65. package/{build-backend → build}/lib/javascript.d.ts +1507 -147
  66. package/{build-backend → build}/lib/protectFs.js +111 -104
  67. package/build/lib/protectFs.js.map +1 -0
  68. package/{build-backend → build}/lib/utils.js.map +1 -1
  69. package/{build-backend → build}/main.js +20 -12
  70. package/build/main.js.map +1 -0
  71. package/{build-backend → build}/types.d.ts +1 -0
  72. package/docs/en/javascript.md +1 -1
  73. package/io-package.json +26 -26
  74. package/package.json +22 -21
  75. package/admin/assets/OpenAiDialog-B4P-N63e.js +0 -36
  76. package/admin/assets/hostInit-fzxL8JAx.js +0 -2
  77. package/admin/assets/index-Bjydl5_6.js +0 -16
  78. package/admin/assets/index-DJdd5j6E.js +0 -930
  79. package/admin/assets/index-DUBaHZ92.css +0 -1
  80. package/admin/assets/index-DaagTm0N.js +0 -27
  81. package/admin/assets/index-DeFm7TiX.js +0 -5
  82. package/admin/assets/index-vw185EVR.js +0 -1294
  83. package/admin/assets/iobroker_javascript__mf_v__runtimeInit__mf_v__-CmuPLb0X.js +0 -5
  84. package/admin/assets/preload-helper-Dp1pzeXC.js +0 -1
  85. package/admin/assets/useTheme-CpAj0H76.js +0 -1
  86. package/admin/custom/assets/ConfigCustomJavascriptSet__mf_v__runtimeInit__mf_v__-Cib3-eWa.js +0 -5
  87. package/admin/custom/assets/DefaultPropsProvider-B41fRCEO.js +0 -1
  88. package/admin/custom/assets/DefaultPropsProvider-CfXkmG16.js +0 -7
  89. package/admin/custom/assets/_commonjsHelpers-D6-XlEtG.js +0 -1
  90. package/admin/custom/assets/defaultTheme-C_aSR-NR.js +0 -1
  91. package/admin/custom/assets/index-BkKMt4bp.js +0 -31
  92. package/admin/custom/assets/index-Bw5ZKbIF.js +0 -1399
  93. package/admin/custom/assets/index-K4NodPhU.js +0 -904
  94. package/admin/custom/assets/leaflet-src-A2ZHl6nF.js +0 -4
  95. package/admin/custom/assets/preload-helper-Dp1pzeXC.js +0 -1
  96. package/admin/custom/assets/useTheme-CpiJlUE9.js +0 -1
  97. package/admin/custom/assets/virtualExposes-4pgHXHfp.js +0 -2
  98. package/build-backend/lib/protectFs.js.map +0 -1
  99. package/build-backend/main.js.map +0 -1
  100. /package/{build-backend → build}/lib/consts.js +0 -0
  101. /package/{build-backend → build}/lib/consts.js.map +0 -0
  102. /package/{build-backend → build}/lib/convert.js +0 -0
  103. /package/{build-backend → build}/lib/convert.js.map +0 -0
  104. /package/{build-backend → build}/lib/debug.js +0 -0
  105. /package/{build-backend → build}/lib/debug.js.map +0 -0
  106. /package/{build-backend → build}/lib/debugger.js +0 -0
  107. /package/{build-backend → build}/lib/debugger.js.map +0 -0
  108. /package/{build-backend → build}/lib/eventObj.js +0 -0
  109. /package/{build-backend → build}/lib/eventObj.js.map +0 -0
  110. /package/{build-backend → build}/lib/inspect.js +0 -0
  111. /package/{build-backend → build}/lib/inspect.js.map +0 -0
  112. /package/{build-backend → build}/lib/mirror.js +0 -0
  113. /package/{build-backend → build}/lib/mirror.js.map +0 -0
  114. /package/{build-backend → build}/lib/nodeModulesManagement.js +0 -0
  115. /package/{build-backend → build}/lib/nodeModulesManagement.js.map +0 -0
  116. /package/{build-backend → build}/lib/patternCompareFunctions.js +0 -0
  117. /package/{build-backend → build}/lib/patternCompareFunctions.js.map +0 -0
  118. /package/{build-backend → build}/lib/request.js +0 -0
  119. /package/{build-backend → build}/lib/request.js.map +0 -0
  120. /package/{build-backend → build}/lib/sandbox.js +0 -0
  121. /package/{build-backend → build}/lib/sandbox.js.map +0 -0
  122. /package/{build-backend → build}/lib/scheduler.js +0 -0
  123. /package/{build-backend → build}/lib/scheduler.js.map +0 -0
  124. /package/{build-backend → build}/lib/tools.js +0 -0
  125. /package/{build-backend → build}/lib/tools.js.map +0 -0
  126. /package/{build-backend → build}/lib/typescriptSettings.js +0 -0
  127. /package/{build-backend → build}/lib/typescriptSettings.js.map +0 -0
  128. /package/{build-backend → build}/lib/typescriptTools.js +0 -0
  129. /package/{build-backend → build}/lib/typescriptTools.js.map +0 -0
  130. /package/{build-backend → build}/lib/utils.js +0 -0
  131. /package/{build-backend → build}/lib/words.js +0 -0
  132. /package/{build-backend → build}/lib/words.js.map +0 -0
@@ -2,7 +2,44 @@
2
2
  // this has a nice side effect that we may augment the global scope
3
3
  import type * as os from 'node:os';
4
4
  import type { ChildProcess, ExecException } from 'node:child_process';
5
- import type { SubscribeObject } from '../types';
5
+
6
+ export interface FsStats {
7
+ isFile(): boolean;
8
+ isDirectory(): boolean;
9
+ isBlockDevice(): boolean;
10
+ isCharacterDevice(): boolean;
11
+ isSymbolicLink(): boolean;
12
+ isFIFO(): boolean;
13
+ isSocket(): boolean;
14
+ dev: number;
15
+ ino: number;
16
+ mode: number;
17
+ nlink: number;
18
+ uid: number;
19
+ gid: number;
20
+ rdev: number;
21
+ size: number;
22
+ blksize: number;
23
+ blocks: number;
24
+ atimeMs: number;
25
+ mtimeMs: number;
26
+ ctimeMs: number;
27
+ birthtimeMs: number;
28
+ atime: Date;
29
+ mtime: Date;
30
+ ctime: Date;
31
+ birthtime: Date;
32
+ }
33
+
34
+ declare const __brand: unique symbol;
35
+ type Brand<B> = { [__brand]: B };
36
+ export type Branded<T, B> = T & Brand<B>;
37
+
38
+ type SubscribeObject = {
39
+ name: string;
40
+ pattern: string;
41
+ callback: (id: string, obj?: iobJS.Object | null) => void;
42
+ };
6
43
 
7
44
  type EmptyCallback = () => void | Promise<void>;
8
45
  type ErrorCallback = (err?: Error) => void | Promise<void>;
@@ -66,39 +103,80 @@ type AnyOf<
66
103
  // tslint:disable:no-namespace
67
104
  declare global {
68
105
  namespace iobJS {
69
- enum StateQuality {
70
- good = 0x00, // or undefined or null
71
- bad = 0x01,
72
- general_device_problem = 0x41,
73
- general_sensor_problem = 0x81,
74
- device_not_connected = 0x42,
75
- sensor_not_connected = 0x82,
76
- device_reports_error = 0x44,
77
- sensor_reports_error = 0x84,
78
- }
106
+ /** Two-way mapping for state quality ("q" attribute of a state) */
107
+ interface STATE_QUALITY {
108
+ /** The default value for a state */
109
+ GOOD: 0x00;
110
+ /** General problem */
111
+ BAD: 0x01;
112
+ /** The instance cannot establish a connection */
113
+ CONNECTION_PROBLEM: 0x02;
114
+ /** Substitute value from controller. Do not set this in adapters */
115
+ SUBSTITUTE_FROM_CONTROLLER: 0x10;
116
+ /** Quality for default values */
117
+ SUBSTITUTE_INITIAL_VALUE: 0x20;
118
+ /** Substitute value from instance or device */
119
+ SUBSTITUTE_DEVICE_INSTANCE_VALUE: 0x40;
120
+ /** Substitute value from a sensor */
121
+ SUBSTITUTE_SENSOR_VALUE: 0x80;
122
+ /** General problem by instance */
123
+ GENERAL_INSTANCE_PROBLEM: 0x11;
124
+ /** General problem by device */
125
+ GENERAL_DEVICE_PROBLEM: 0x41;
126
+ /** General problem by sensor */
127
+ GENERAL_SENSOR_PROBLEM: 0x81;
128
+ /** The instance is not connected */
129
+ INSTANCE_NOT_CONNECTED: 0x12;
130
+ /** The device is not connected */
131
+ DEVICE_NOT_CONNECTED: 0x42;
132
+ /** The sensor is not connected */
133
+ SENSOR_NOT_CONNECTED: 0x82;
134
+ /** The device has reported an error */
135
+ DEVICE_ERROR_REPORT: 0x44;
136
+ /** The sensor has reported an error */
137
+ SENSOR_ERROR_REPORT: 0x84;
138
+ }
139
+
140
+ type StateValue = string | number | boolean | null;
141
+
142
+ interface State {
143
+ /** The value of the state. */
144
+ val: StateValue;
79
145
 
80
- type SettableState = AtLeastOne<ioBroker.State>;
146
+ /** Direction flag: false for desired value and true for actual value. Default: false. */
147
+ ack: boolean;
81
148
 
82
- interface TypedState<T extends ioBroker.StateValue = any> extends ioBroker.State {
83
- val: T;
149
+ /** Unix timestamp. Default: current time */
150
+ ts: number;
151
+
152
+ /** Unix timestamp of the last time the value changed */
153
+ lc: number;
154
+
155
+ /** Name of the adapter instance which set the value, e.g. "system.adapter.web.0" */
156
+ from: string;
157
+
158
+ /** The user who set this value */
159
+ user?: string;
160
+
161
+ /** Optional time in seconds after which the state is reset to null */
162
+ expire?: number;
163
+
164
+ /** Optional quality of the state value */
165
+ q?: STATE_QUALITY[keyof STATE_QUALITY];
166
+
167
+ /** Optional comment */
168
+ c?: string;
84
169
  }
85
170
 
86
- interface AbsentState extends Omit<ioBroker.State, 'ack' | 'from' | 'ts' | 'lc'> {
87
- val: null;
88
- notExist: true;
171
+ type SettableState = AtLeastOne<State>;
89
172
 
90
- ack: undefined;
91
- ts: undefined;
92
- lc: undefined;
93
- from: undefined;
94
- expire: undefined;
95
- q: undefined;
96
- c: undefined;
173
+ interface IdObject {
174
+ device?: string;
175
+ channel?: string;
176
+ state?: string;
97
177
  }
98
178
 
99
- type Languages = 'en' | 'de' | 'ru' | 'pt' | 'nl' | 'fr' | 'it' | 'es' | 'pl' | 'uk' | 'zh-cn';
100
- type StringOrTranslated = string | { [lang in Languages]?: string };
101
- type CommonType = 'number' | 'string' | 'boolean' | 'array' | 'object' | 'mixed' | 'file';
179
+ type Session = any; // TODO: implement
102
180
 
103
181
  /** Defines access rights for a single object type */
104
182
  interface ObjectOperationPermissions {
@@ -139,6 +217,462 @@ declare global {
139
217
  };
140
218
  }
141
219
 
220
+ interface Permission {
221
+ /** The type of the permission */
222
+ type: string;
223
+ /** Defines which kind of operation is required */
224
+ operation: string;
225
+ }
226
+ interface ObjectOrStatePermission extends Permission {
227
+ type: 'object' | 'file' | 'users' | 'state';
228
+ operation: 'list' | 'read' | 'write' | 'create' | 'delete';
229
+ }
230
+ interface OtherPermission extends Permission {
231
+ type: 'other';
232
+ operation: 'execute' | 'http' | 'sendto';
233
+ }
234
+ interface CommandsPermissions {
235
+ // TODO: Are all properties required or is a partial object ok?
236
+ getObject: ObjectOrStatePermission;
237
+ getObjects: ObjectOrStatePermission;
238
+ getObjectView: ObjectOrStatePermission;
239
+ setObject: ObjectOrStatePermission;
240
+ subscribeObjects: ObjectOrStatePermission;
241
+ unsubscribeObjects: ObjectOrStatePermission;
242
+ getStates: ObjectOrStatePermission;
243
+ getState: ObjectOrStatePermission;
244
+ setState: ObjectOrStatePermission;
245
+ getStateHistory: ObjectOrStatePermission;
246
+ subscribe: ObjectOrStatePermission;
247
+ unsubscribe: ObjectOrStatePermission;
248
+ getVersion: Permission;
249
+ httpGet: OtherPermission;
250
+ sendTo: OtherPermission;
251
+ sendToHost: OtherPermission;
252
+ readFile: ObjectOrStatePermission;
253
+ readFile64: ObjectOrStatePermission;
254
+ writeFile: ObjectOrStatePermission;
255
+ writeFile64: ObjectOrStatePermission;
256
+ unlink: ObjectOrStatePermission;
257
+ rename: ObjectOrStatePermission;
258
+ mkdir: ObjectOrStatePermission;
259
+ readDir: ObjectOrStatePermission;
260
+ chmodFile: ObjectOrStatePermission;
261
+ authEnabled: Permission;
262
+ disconnect: Permission;
263
+ listPermissions: Permission;
264
+ getUserPermissions: ObjectOrStatePermission;
265
+ }
266
+
267
+ type UserGroup = any; // TODO find out how this looks like
268
+ // interface UserGroup { }
269
+
270
+ /** Contains information about a user */
271
+ interface User {
272
+ /** Which groups this user belongs to */
273
+ groups: UserGroup[];
274
+ /** Access rights of this user */
275
+ acl: ObjectPermissions;
276
+ }
277
+
278
+ /** Parameters for adapter.getObjectView */
279
+ interface GetObjectViewParams {
280
+ /** First id to include in the return list */
281
+ startkey?: string;
282
+ /** Last id to include in the return list */
283
+ endkey?: string;
284
+ /** Whether docs should be included in the return list */ // TODO: What are docs?
285
+ include_docs?: boolean;
286
+ }
287
+
288
+ /** Parameters for adapter.getObjectList */
289
+ type GetObjectListParams = GetObjectViewParams;
290
+
291
+ interface Logger {
292
+ /** log a message with silly level */
293
+ silly(message: string): void;
294
+ /** log a message with debug level */
295
+ debug(message: string): void;
296
+ /** log a message with info level (default output level for all adapters) */
297
+ info(message: string): void;
298
+ /** log a message with warning severity */
299
+ warn(message: string): void;
300
+ /** log a message with error severity */
301
+ error(message: string): void;
302
+
303
+ /** Verbosity of the log output */
304
+ level: LogLevel;
305
+ }
306
+
307
+ /** Log message */
308
+ interface LogMessage {
309
+ /** unique ID */
310
+ _id: number;
311
+ /** id of the source instance */
312
+ from: string;
313
+ /** log level */
314
+ severity: string;
315
+ /** timestamp */
316
+ ts: number;
317
+ /** actual content */
318
+ message: string;
319
+ }
320
+
321
+ interface Certificates {
322
+ /** private key file */
323
+ key: string;
324
+ /** public certificate */
325
+ cert: string;
326
+ /** chained CA certificates */
327
+ ca?: string;
328
+ }
329
+
330
+ type MessagePayload = any;
331
+
332
+ /** Callback information for a passed message */
333
+ interface MessageCallbackInfo {
334
+ /** The original message payload */
335
+ message: MessagePayload;
336
+ /** ID of this callback */
337
+ id: number;
338
+ /** If ack is false, it means the message is a request. If ack is true, it means the message is a response */
339
+ ack: boolean;
340
+ /** Timestamp of this message */
341
+ time: number;
342
+ }
343
+
344
+ interface SendableMessage {
345
+ /** The command to be executed */
346
+ command: string;
347
+ /** The message payload */
348
+ message: MessagePayload;
349
+ /** The source of this message */
350
+ from: string;
351
+ /** Callback information. This is set when the source expects a response */
352
+ callback?: MessageCallbackInfo;
353
+ }
354
+
355
+ /** A message being passed between adapter instances */
356
+ interface Message extends SendableMessage {
357
+ /** ID of this message */
358
+ _id: number;
359
+ }
360
+
361
+ type Log = any; // TODO: define this https://github.com/ioBroker/ioBroker.js-controller/blob/master/lib/states/statesInMemServer.js#L873
362
+
363
+ type EnumList = string | string[];
364
+
365
+ type Plugin = Record<string, any>; // TODO: Add definition
366
+
367
+ interface DirectoryEntry {
368
+ file: string;
369
+ stats: FsStats;
370
+ isDir: boolean;
371
+ acl: any; // access control list object
372
+ modifiedAt: number;
373
+ createdAt: number;
374
+ }
375
+
376
+ interface GetHistoryOptions {
377
+ instance?: string;
378
+ /** Start time in ms */
379
+ start?: number;
380
+ /** End time in ms. If not defined, it is "now" */
381
+ end?: number;
382
+ /** Step in ms of intervals. Used in aggregate (max, min, average, total, ...) */
383
+ step?: number;
384
+ /** number of values if aggregate is 'onchange' or number of intervals if other aggregate method. Count will be ignored if step is set, else default is 500 if not set */
385
+ count?: number;
386
+ /** if `from` field should be included in answer */
387
+ from?: boolean;
388
+ /** if `ack` field should be included in answer */
389
+ ack?: boolean;
390
+ /** if `q` field should be included in answer */
391
+ q?: boolean;
392
+ /** if `id` field should be included in answer */
393
+ addId?: boolean;
394
+ /** do not return more entries than limit */
395
+ limit?: number;
396
+ /** round result to number of digits after decimal point */
397
+ round?: number;
398
+ /** if null values should be included (false), replaced by last not null value (true) or replaced with 0 (0) */
399
+ ignoreNull?: boolean | 0;
400
+ /** This number will be returned in answer, so the client can assign the request for it */
401
+ sessionId?: number;
402
+ /** aggregate method (Default: 'average') */
403
+ aggregate?:
404
+ | 'onchange'
405
+ | 'minmax'
406
+ | 'min'
407
+ | 'max'
408
+ | 'average'
409
+ | 'total'
410
+ | 'count'
411
+ | 'none'
412
+ | 'percentile'
413
+ | 'quantile'
414
+ | 'integral'
415
+ | 'integralTotal';
416
+ /** Returned data is normally sorted ascending by date, this option lets you return the newest instead of the oldest values if the number of returned points is limited */
417
+ returnNewestEntries?: boolean;
418
+ /** By default, the additional border values are returned to optimize charting. Set this option to true if this is not wanted (e.g., for script data processing) */
419
+ removeBorderValues?: boolean;
420
+ /** when using aggregate method `percentile` defines the percentile level (0..100)(defaults to 50) */
421
+ percentile?: number;
422
+ /** when using aggregate method `quantile` defines the quantile level (0..1)(defaults to 0.5) */
423
+ quantile?: number;
424
+ /** when using aggregate method `integral` defines the unit in seconds (defaults to 60 seconds). E.g., to get integral in hours for Wh or such, set to 3600. */
425
+ integralUnit?: number;
426
+ /** when using aggregate method `integral` defines the interpolation method (defaults to `none`). */
427
+ integralInterpolation?: 'none' | 'linear';
428
+ /** If user is set, it will be checked if this user may read the variable */
429
+ user?: `system.user.${string}`;
430
+ }
431
+
432
+ interface DelObjectOptions {
433
+ /** Whether all child objects should be deleted as well */
434
+ recursive?: boolean;
435
+ // Allow non-documented properties
436
+ [other: string]: unknown;
437
+ }
438
+
439
+ interface ExtendObjectOptionsPreserve {
440
+ [prop: string]: ExtendObjectOptionsPreserve | boolean | string[];
441
+ }
442
+
443
+ interface ExtendObjectOptions {
444
+ /** Which properties of the original object should be preserved */
445
+ preserve?: ExtendObjectOptionsPreserve;
446
+ // Allow non-documented properties
447
+ [other: string]: unknown;
448
+ }
449
+
450
+ /** Predefined notification scopes and their categories */
451
+ interface NotificationScopes {
452
+ system:
453
+ | 'memIssues'
454
+ | 'fsIoErrors'
455
+ | 'noDiskSpace'
456
+ | 'accessErrors'
457
+ | 'nonExistingFileErrors'
458
+ | 'remoteHostErrors'
459
+ | 'restartLoop'
460
+ | 'fileToJsonl';
461
+ [other: string]: string;
462
+ }
463
+
464
+ /** Additional context for the notification which can be used by notification processing adapters */
465
+ interface NotificationContextData {
466
+ /** Use a `key` specific to the adapter or if a feature is supported by all adapters of a type, the type (e.g. `messaging`) is also fine. */
467
+ [adapterNameOrAdapterType: string]: unknown;
468
+ }
469
+
470
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
471
+ interface AdapterConfig {
472
+ // This is a stub to be augmented in every adapter
473
+ }
474
+
475
+ type ReadyHandler = () => void | Promise<void>;
476
+ type ObjectChangeHandler = (id: string, obj: iobJS.Object | null | undefined) => void | Promise<void>;
477
+ type OriginalStateChangeHandler = (id: string, obj: State | null | undefined) => void | Promise<void>;
478
+ type OriginalFileChangeHandler = (id: string, fileName: string, size: number | null) => void;
479
+ type MessageHandler = (obj: Message) => void | Promise<void>;
480
+ type UnloadHandler = (callback: EmptyCallback) => void | Promise<void>;
481
+ type ErrorHandler = (err: Error) => boolean;
482
+
483
+ type EmptyCallback = () => void;
484
+ type ErrorCallback = (err?: Error | null) => void;
485
+ /** Special variant of ErrorCallback for methods where Node.js returns an ErrnoException */
486
+ type ErrnoCallback = (err?: NodeJS.ErrnoException | null) => void;
487
+ // TODO: Redefine callbacks as subclass of GenericCallback
488
+ type GenericCallback<T> = (err?: Error | null, result?: T) => void;
489
+
490
+ /** Due to backward compatibility first param can be result or error */
491
+ type OriginalMessageCallback = (response?: Message | Error) => void;
492
+
493
+ type OriginalSetObjectCallback = (err?: Error | null, obj?: { id: string }) => void;
494
+ type OriginalSetObjectPromise = Promise<NonNullCallbackReturnTypeOf<OriginalSetObjectCallback>>;
495
+
496
+ type GetEnumCallback = (err?: Error | null, enums?: Record<string, EnumObject>, requestedEnum?: string) => void;
497
+ type GetEnumsCallback = (
498
+ err?: Error | null,
499
+ result?: {
500
+ [groupName: string]: Record<string, EnumObject>;
501
+ },
502
+ ) => void;
503
+ type GetEnumsPromise = Promise<NonNullCallbackReturnTypeOf<GetEnumsCallback>>;
504
+
505
+ type GetObjectsCallback = (err?: Error | null, objects?: Record<string, iobJS.Object>) => void;
506
+ type GetObjectsPromise = Promise<NonNullCallbackReturnTypeOf<GetObjectsCallback>>;
507
+
508
+ type GetObjectsCallbackTyped<T extends ObjectType> = (
509
+ err?: Error | null,
510
+ objects?: Record<string, iobJS.AnyObject & { type: T }>,
511
+ ) => void;
512
+ type GetObjectsPromiseTyped<T extends ObjectType> = Promise<
513
+ NonNullCallbackReturnTypeOf<GetObjectsCallbackTyped<T>>
514
+ >;
515
+
516
+ type FindObjectCallback = (
517
+ /** If an error happened, this contains the message */
518
+ err?: Error | null,
519
+ /** If an object was found, this contains the ID */
520
+ id?: string,
521
+ /** If an object was found, this contains the common.name */
522
+ name?: StringOrTranslated,
523
+ ) => void;
524
+
525
+ // This is a version used by GetDevices/GetChannelsOf/GetStatesOf
526
+ type GetObjectsCallback3<T extends BaseObject> = (err?: Error | null, result?: T[]) => void;
527
+
528
+ type SecondParameterOf<T extends (...args: any[]) => any> = T extends (
529
+ arg0: any,
530
+ arg1: infer R,
531
+ ...args: any[]
532
+ ) => any
533
+ ? R
534
+ : never;
535
+ /** Infers the return type from a callback-style API and strips out null and undefined */
536
+ type NonNullCallbackReturnTypeOf<T extends (...args: any[]) => any> = Exclude<
537
+ SecondParameterOf<T>,
538
+ null | undefined
539
+ >;
540
+ /** Infers the return type from a callback-style API and leaves null and undefined in */
541
+ type CallbackReturnTypeOf<T extends (...args: any[]) => any> = SecondParameterOf<T>;
542
+
543
+ type OriginalGetStateCallback = (err?: Error | null, state?: State | null) => void;
544
+ type GetStatePromise = Promise<CallbackReturnTypeOf<OriginalGetStateCallback>>;
545
+
546
+ type GetStatesCallback = (err?: Error | null, states?: Record<string, State>) => void;
547
+ type GetStatesPromise = Promise<NonNullCallbackReturnTypeOf<GetStatesCallback>>;
548
+
549
+ type SetStateCallback = (err?: Error | null, id?: string) => void;
550
+ type SetStatePromise = Promise<NonNullCallbackReturnTypeOf<SetStateCallback>>;
551
+
552
+ type SetStateChangedCallback = (err?: Error | null, id?: string, notChanged?: boolean) => void;
553
+ type SetStateChangedPromise = Promise<NonNullCallbackReturnTypeOf<SetStateChangedCallback>>;
554
+
555
+ type DeleteStateCallback = (err?: Error | null, id?: string) => void;
556
+
557
+ type GetHistoryResult = Array<State & { id?: string }>;
558
+ type GetHistoryCallback = (
559
+ err: Error | null,
560
+ result?: GetHistoryResult,
561
+ step?: number,
562
+ sessionId?: number,
563
+ ) => void;
564
+
565
+ /** Contains the return values of readDir */
566
+ interface ReadDirResult {
567
+ /** Name of the file or directory */
568
+ file: string;
569
+ /** File system stats */
570
+ stats: Partial<FsStats>;
571
+ /** Whether this is a directory or a file */
572
+ isDir: boolean;
573
+ /** Access rights */
574
+ acl?: EvaluatedFileACL;
575
+ /** Date of last modification */
576
+ modifiedAt?: number;
577
+ /** Date of creation */
578
+ createdAt?: number;
579
+ }
580
+ type ReadDirCallback = (err?: NodeJS.ErrnoException | null, entries?: ReadDirResult[]) => void;
581
+ type ReadDirPromise = Promise<ReadDirResult[]>;
582
+
583
+ type OriginalReadFileCallback = (
584
+ err?: NodeJS.ErrnoException | null,
585
+ data?: Buffer | string,
586
+ mimeType?: string,
587
+ ) => void;
588
+ type OriginalReadFilePromise = Promise<{ file: string | Buffer; mimeType?: string }>;
589
+
590
+ /** Contains the return values of chownFile */
591
+ interface ChownFileResult {
592
+ /** The parent directory of the processed file or directory */
593
+ path: string;
594
+ /** Name of the file or directory */
595
+ file: string;
596
+ /** File system stats */
597
+ stats: FsStats;
598
+ /** Whether this is a directory or a file */
599
+ isDir: boolean;
600
+ /** Access rights */
601
+ acl: FileACL;
602
+ /** Date of last modification */
603
+ modifiedAt: number;
604
+ /** Date of creation */
605
+ createdAt: number;
606
+ }
607
+ type ChownFileCallback = (err?: NodeJS.ErrnoException | null, processed?: ChownFileResult[]) => void;
608
+
609
+ /** Contains the return values of rm */
610
+ interface RmResult {
611
+ /** The parent directory of the deleted file or directory */
612
+ path: string;
613
+ /** The name of the deleted file or directory */
614
+ file: string;
615
+ }
616
+ type RmCallback = (err?: NodeJS.ErrnoException | null, entries?: RmResult[]) => void;
617
+
618
+ type ChownObjectCallback = (err?: NodeJS.ErrnoException | null, list?: iobJS.Object[]) => void;
619
+
620
+ type GetKeysCallback = (err?: Error | null, list?: string[]) => void;
621
+
622
+ interface GetObjectViewItem<T extends AnyObject> {
623
+ /** The ID of this object */
624
+ id: T['_id'];
625
+ /** A copy of the object from the DB */
626
+ value: T;
627
+ }
628
+ type GetObjectViewCallback<T extends AnyObject> = (
629
+ err?: Error | null,
630
+ result?: { rows: Array<GetObjectViewItem<T>> },
631
+ ) => void;
632
+ type GetObjectViewPromise<T extends AnyObject> = Promise<NonNullCallbackReturnTypeOf<GetObjectViewCallback<T>>>;
633
+
634
+ interface GetObjectListItem<T extends AnyObject> extends GetObjectViewItem<T> {
635
+ /** A copy of the object */
636
+ value: T;
637
+ /** The same as @link{value} */
638
+ doc: T;
639
+ }
640
+ type GetObjectListCallback<T extends iobJS.AnyObject> = (
641
+ err?: Error | null,
642
+ result?: { rows: GetObjectListItem<T>[] },
643
+ ) => void;
644
+ type GetObjectListPromise = Promise<NonNullCallbackReturnTypeOf<GetObjectListCallback<iobJS.Object>>>;
645
+
646
+ type ExtendObjectCallback = (
647
+ err?: Error | null,
648
+ result?: { id: string; value: iobJS.Object },
649
+ id?: string,
650
+ ) => void;
651
+
652
+ type GetSessionCallback = (session: Session) => void;
653
+
654
+ type Timeout = Branded<number, 'Timeout'> | null; // or null to not allow native clearTimeout
655
+ type Interval = Branded<number, 'Interval'> | null; // or null to not allow native clearInterval
656
+
657
+ /** Defines access rights for a single file */
658
+ interface FileACL {
659
+ /** Full name of the user who owns this file, e.g. "system.user.admin" */
660
+ owner: string;
661
+ /** Full name of the group who owns this file, e.g. "system.group.administrator" */
662
+ ownerGroup: string;
663
+ /** Linux-type permissions defining access to this file */
664
+ permissions: number;
665
+ }
666
+
667
+ /** Defines access rights for a single file, applied to a user or group */
668
+ interface EvaluatedFileACL extends FileACL {
669
+ /** Whether the user may read the file */
670
+ read: boolean;
671
+ /** Whether the user may write the file */
672
+ write: boolean;
673
+ }
674
+
675
+ /** Defines access rights for a single object */
142
676
  interface ObjectACL {
143
677
  /** Full name of the user who owns this object, e.g. "system.user.admin" */
144
678
  owner: string;
@@ -147,6 +681,7 @@ declare global {
147
681
  /** Linux-type permissions defining access to this object */
148
682
  object: number;
149
683
  }
684
+
150
685
  /** Defines access rights for a single state object */
151
686
  interface StateACL extends ObjectACL {
152
687
  /** Linux-type permissions defining access to this state */
@@ -168,7 +703,9 @@ declare global {
168
703
  | 'meta'
169
704
  | 'script'
170
705
  | 'user'
171
- | 'chart';
706
+ | 'chart'
707
+ | 'schedule'
708
+ | 'design';
172
709
 
173
710
  // Define the naming schemes for objects, so we can provide more specific types for get/setObject
174
711
  namespace ObjectIDs {
@@ -194,15 +731,21 @@ declare global {
194
731
  // Guaranteed instance objects
195
732
  type Instance = `system.adapter.${string}.${number}`;
196
733
  // Guaranteed adapter objects
197
- type Adapter = `system.adapter.${string}`;
734
+ type Adapter = `system.adapter.${string}` | `system.host.${string}.adapter.${string}`;
198
735
  // Guaranteed group objects
199
736
  type Group = `system.group.${string}`;
200
737
  // Guaranteed user objects
201
738
  type User = `system.user.${string}`;
202
739
  // Guaranteed host objects
203
740
  type Host = `system.host.${string}`;
741
+ // Guaranteed repository object
742
+ type Repository = 'system.repositories';
204
743
  // Guaranteed config objects
205
- type Config = `system.${'certificates' | 'config' | 'repositories'}`;
744
+ type Config = 'system.certificates';
745
+ // Guaranteed system config objects
746
+ type SystemConfig = 'system.config';
747
+ // Guaranteed design objects
748
+ type Design = `_design/${string}`;
206
749
 
207
750
  // Unsure, can be folder, device, channel or state (or whatever an adapter does)
208
751
  type AdapterScoped = `${string}.${number}.${string}`;
@@ -224,10 +767,9 @@ declare global {
224
767
  | AdapterScoped;
225
768
  }
226
769
 
227
- type ObjectIdToObjectType<
228
- T extends string,
229
- Read extends 'read' | 'write' = 'read',
230
- O = T extends ObjectIDs.State // State must come before Adapter or system.adapter.admin.0.foobar will resolve to AdapterObject
770
+ type ObjectIdToObjectType<T extends string, Read extends 'read' | 'write' = 'read'> =
771
+ // State must come before Adapter or system.adapter.admin.0.foobar will resolve to AdapterObject
772
+ T extends ObjectIDs.State
231
773
  ? StateObject
232
774
  : // Instance and Adapter must come before meta or `system.adapter.admin` will resolve to MetaObject
233
775
  T extends ObjectIDs.Instance
@@ -250,23 +792,42 @@ declare global {
250
792
  ? UserObject
251
793
  : T extends ObjectIDs.Host
252
794
  ? HostObject
253
- : T extends ObjectIDs.Config
254
- ? OtherObject & { type: 'config' }
255
- : T extends ObjectIDs.AdapterScoped
256
- ? AdapterScopedObject
257
- : iobJS.AnyObject,
258
- // When reading objects, we should be less strict, so working with the return type is less of a pain to work with
259
- > = Read extends 'read' ? AnyOf<O> : O;
795
+ : T extends ObjectIDs.Design
796
+ ? DesignObject
797
+ : T extends ObjectIDs.Repository
798
+ ? RepositoryObject
799
+ : T extends ObjectIDs.SystemConfig
800
+ ? SystemConfigObject
801
+ : T extends ObjectIDs.Config
802
+ ? OtherObject & { type: 'config' }
803
+ : T extends ObjectIDs.AdapterScoped
804
+ ? AdapterScopedObject
805
+ : Read extends 'read'
806
+ ? iobJS.Object
807
+ : AnyObject;
808
+
809
+ type Languages = 'en' | 'de' | 'ru' | 'pt' | 'nl' | 'fr' | 'it' | 'es' | 'pl' | 'uk' | 'zh-cn';
810
+ type Translated = { en: string } & { [lang in Languages]?: string };
811
+
812
+ /** For objects, we require the English language to be present */
813
+ type StringOrTranslated = string | Translated;
814
+
815
+ type CommonType = 'number' | 'string' | 'boolean' | 'array' | 'object' | 'mixed';
260
816
 
261
817
  interface ObjectCommon {
262
818
  /** The name of this object as a simple string or an object with translations */
263
819
  name: StringOrTranslated;
264
820
 
821
+ /** Description of this object */
822
+ desc?: StringOrTranslated;
823
+
265
824
  /** When set to true, this object may not be deleted */
266
825
  dontDelete?: true;
267
826
 
268
827
  /** When set to true, this object is only visible when expert mode is turned on in admin */
269
828
  expert?: true;
829
+ /** Color attribute used in UI */
830
+ color?: string;
270
831
 
271
832
  // Icon and role aren't defined in SCHEMA.md,
272
833
  // but they are being used by some adapters
@@ -276,18 +837,9 @@ declare global {
276
837
  role?: string;
277
838
  }
278
839
 
279
- interface StateCommonAlias {
280
- /** The target state id or two target states used for reading and writing values */
281
- id: string | { read: string; write: string };
282
- /** An optional conversion function when reading, e.g. `"(val − 32) * 5/9"` */
283
- read?: string;
284
- /** An optional conversion function when reading, e.g. `"(val * 9/5) + 32"` */
285
- write?: string;
286
- }
287
-
288
840
  interface StateCommon extends ObjectCommon {
289
841
  /** Type of this state. See https://github.com/ioBroker/ioBroker/blob/master/doc/SCHEMA.md#state-commonrole for a detailed description */
290
- type?: CommonType;
842
+ type: CommonType;
291
843
  /** minimum value */
292
844
  min?: number;
293
845
  /** maximum value */
@@ -296,8 +848,6 @@ declare global {
296
848
  step?: number;
297
849
  /** unit of the value */
298
850
  unit?: string;
299
- /** description of this state */
300
- desc?: StringOrTranslated;
301
851
 
302
852
  /** if this state is readable */
303
853
  read: boolean;
@@ -307,62 +857,114 @@ declare global {
307
857
  role: string;
308
858
 
309
859
  /** the default value */
310
- def?: ioBroker.StateValue;
860
+ def?: any;
311
861
  /** the default status of the ack flag */
312
862
  defAck?: boolean;
313
863
 
314
864
  /** Configures this state as an alias for another state */
315
- alias?: StateCommonAlias;
865
+ alias?: {
866
+ /** The target state id */
867
+ id:
868
+ | string
869
+ | {
870
+ read: string;
871
+ write: string;
872
+ };
873
+ /** An optional conversion function when reading, e.g. `"(val − 32) * 5/9"` */
874
+ read?: string;
875
+ /** An optional conversion function when reading, e.g. `"(val * 9/5) + 32"` */
876
+ write?: string;
877
+ };
316
878
 
317
879
  /**
318
880
  * Dictionary of possible values for this state in the form
319
- * <pre>
881
+ * ```jsonc
320
882
  * {
321
883
  * "internal value 1": "displayed value 1",
322
884
  * "internal value 2": "displayed value 2",
323
- * ...
885
+ * // ...
324
886
  * }
325
- * </pre>
887
+ * ```
888
+ *
889
+ * or as an array:
890
+ * ```jsonc
891
+ * [ "value 1", "value 2", // ... ]
892
+ * ```
893
+ *
326
894
  * In old ioBroker versions, this could also be a string of the form
327
- * "val1:text1;val2:text2" (now deprecated)
895
+ * `"val1:text1;val2:text2"` (now deprecated)
328
896
  */
329
- states?: Record<string, string> | string;
897
+ states?: Record<string, string> | string[] | string;
330
898
 
331
899
  /** ID of a helper state indicating if the handler of this state is working */
332
900
  workingID?: string;
333
901
 
334
- /** @deprecated moved to `custom.history´ - attached history information */
902
+ /** attached history information */
335
903
  history?: any;
336
904
 
337
905
  /** Custom settings for this state */
338
906
  custom?: Record<string, any>;
339
907
 
908
+ /** Custom defined properties for backward compatibility of material adapter */
909
+ material?: any;
910
+
911
+ /** Custom defined properties for backward compatibility of habpanel adapter */
912
+ habpanel?: any;
913
+
914
+ /** Custom defined properties for backward compatibility of habpanel adapter */
915
+ mobile?: any;
916
+
340
917
  /**
341
918
  * Settings for IOT adapters and how the state should be named in e.g., Alexa.
342
- * The string "ignore" is a special case, causing the state to be ignored.
919
+ * The string "ignore" (deprecated please use boolean `false` instead) or boolean value `false` is a special case, causing the state to be ignored.
920
+ * A value of `null` means that the device should be removed by the IOT adapters
343
921
  */
344
922
  smartName?:
923
+ | null
924
+ | false
345
925
  | string
346
926
  | ({ [lang in Languages]?: string } & {
347
- /** Which kind of device this it is */
927
+ /** Which kind of device it is */
348
928
  smartType?: string | null;
349
929
  /** Which value to set when the ON command is issued */
350
- byOn?: string | null;
930
+ byON?: string | null;
351
931
  });
352
932
  }
353
- interface ChannelCommon extends ObjectCommon {
354
- /** description of this channel */
355
- desc?: string;
356
933
 
934
+ interface ChannelCommon extends ObjectCommon {
357
935
  // Make it possible to narrow the object type using the custom property
358
936
  custom?: undefined;
359
937
  }
938
+
360
939
  interface DeviceCommon extends ObjectCommon {
361
- // TODO: any other definition for device?
940
+ statusStates?: {
941
+ /** State, which is truthy if a device is online */
942
+ onlineId?: string;
943
+ /** State, which is truthy if a device is offline */
944
+ offlineId?: string;
945
+ /** State, which is truthy if a device is in error state */
946
+ errorId?: string;
947
+ };
948
+ // Make it possible to narrow the object type using the custom property
949
+ custom?: undefined;
950
+ }
362
951
 
952
+ interface ScheduleCommon extends ObjectCommon {
953
+ enabled?: boolean;
363
954
  // Make it possible to narrow the object type using the custom property
364
955
  custom?: undefined;
365
956
  }
957
+
958
+ interface RepositoryCommon extends ObjectCommon {
959
+ custom?: undefined;
960
+ }
961
+
962
+ interface ChartCommon extends ObjectCommon {
963
+ enabled?: boolean;
964
+ // Make it possible to narrow the object type using the custom property
965
+ custom?: undefined;
966
+ }
967
+
366
968
  interface EnumCommon extends ObjectCommon {
367
969
  /** The IDs of the enum members */
368
970
  members?: string[];
@@ -372,21 +974,59 @@ declare global {
372
974
  }
373
975
 
374
976
  interface MetaCommon extends ObjectCommon {
375
- // Meta-objects have to additional CommonTypes
376
- type: CommonType | 'meta.user' | 'meta.folder';
977
+ // Can be of type `user` for folders, where a user can store files or `folder` for adapter internal structures
978
+ type: 'meta.user' | 'meta.folder';
377
979
 
378
980
  // Make it possible to narrow the object type using the custom property
379
981
  custom?: undefined;
380
982
  }
381
983
 
382
- type InstanceMode = 'none' | 'daemon' | 'subscribe' | 'schedule' | 'once' | 'extension';
383
- interface InstanceCommon extends ObjectCommon {
984
+ type InstanceMode = 'none' | 'daemon' | 'schedule' | 'once' | 'extension';
985
+
986
+ interface AdminUi {
987
+ /** UI type of config page inside admin UI */
988
+ config: 'html' | 'json' | 'materialize' | 'none';
989
+ /** UI type of custom tab inside admin UI */
990
+ custom?: 'json';
991
+ /** UI type of tab inside admin UI */
992
+ tab?: 'html' | 'json' | 'materialize';
993
+ }
994
+
995
+ /** Installed from attribute of instance/adapter object */
996
+ type InstalledFrom = Branded<string, 'InstalledFrom'>;
997
+
998
+ interface InstanceCommon extends AdapterCommon {
999
+ version: string;
384
1000
  /** The name of the host where this instance is running */
385
1001
  host: string;
386
1002
  enabled: boolean;
387
1003
  /** How and when this instance should be started */
388
1004
  mode: InstanceMode;
389
-
1005
+ /**
1006
+ * The starting priority of this adapter:
1007
+ * - **1:** Logic adapters
1008
+ * - **2:** Data providers
1009
+ * - **3:** All other adapters
1010
+ */
1011
+ tier?: 1 | 2 | 3;
1012
+ /** Variables of this adapter must be subscribed with sendTo to enable updates */
1013
+ subscribable?: boolean;
1014
+ /** If compact mode is supported */
1015
+ compact?: boolean;
1016
+ /** If compact mode is active */
1017
+ runAsCompactMode?: boolean;
1018
+ /** Active compact group, instances in this group will be started in one process */
1019
+ compactGroup?: number;
1020
+ /** String (or array) with names of attributes in common of instance, which will not be deleted. */
1021
+ preserveSettings?: string | string[];
1022
+ /** Source, where this adapter has been installed from, to enable reinstalling on e.g., backup restore */
1023
+ installedFrom?: InstalledFrom;
1024
+ /** Arguments passed to the adapter process, this disables compact mode */
1025
+ nodeProcessParams?: string[];
1026
+ /** If adapter can consume log messages, like admin, javascript or logparser */
1027
+ logTransporter?: boolean;
1028
+ /** Optional memory limit for this instance */
1029
+ memoryLimitMB?: number;
390
1030
  // Make it possible to narrow the object type using the custom property
391
1031
  custom?: undefined;
392
1032
  }
@@ -394,7 +1034,10 @@ declare global {
394
1034
  interface HostCommon extends ObjectCommon {
395
1035
  /** The display name of this host */
396
1036
  name: string;
1037
+ /** Changeable name of the host */
397
1038
  title: string;
1039
+ /** base64 encoded icon */
1040
+ icon?: string;
398
1041
  installedVersion: string; // e.g. 1.2.3 (following semver)
399
1042
  /** The command line of the executable */
400
1043
  cmd: string;
@@ -413,7 +1056,7 @@ declare global {
413
1056
  process: {
414
1057
  title: string;
415
1058
  versions: NodeJS.ProcessVersions;
416
- env: Record<string, string>;
1059
+ env: NodeJS.ProcessEnv;
417
1060
  };
418
1061
  os: {
419
1062
  hostname: string;
@@ -425,19 +1068,472 @@ declare global {
425
1068
  tmpdir: ReturnType<(typeof os)['tmpdir']>;
426
1069
  };
427
1070
  hardware: {
428
- cpus: ReturnType<(typeof os)['cpus']>;
1071
+ /** Return value of os.cpu but property `times` could be removed from every entry */
1072
+ cpus: (Omit<ReturnType<(typeof os)['cpus']>[number], 'times'> &
1073
+ Partial<Pick<ReturnType<(typeof os)['cpus']>[number], 'times'>>)[];
429
1074
  totalmem: ReturnType<(typeof os)['totalmem']>;
430
1075
  networkInterfaces: ReturnType<(typeof os)['networkInterfaces']>;
431
1076
  };
432
1077
  }
433
1078
 
434
- type UserCommon = ioBroker.UserCommon;
1079
+ interface UserCommon extends ObjectCommon {
1080
+ /** The username */
1081
+ name: StringOrTranslated;
1082
+ /** The hashed password */
1083
+ password: string;
1084
+ /** Whether this user is enabled */
1085
+ enabled: boolean;
1086
+
1087
+ // Make it possible to narrow the object type using the custom property
1088
+ custom?: undefined;
1089
+ }
1090
+
1091
+ interface GroupCommon extends ObjectCommon {
1092
+ /** The name of this group */
1093
+ name: StringOrTranslated;
1094
+ /** The users of this group */
1095
+ members: ObjectIDs.User[]; // system.user.name, ...
1096
+ /** The default permissions of this group */
1097
+ acl: Omit<PermissionSet, 'user' | 'groups'>;
1098
+ /** A group can be disabled, if missing, a group is active */
1099
+ enabled?: boolean;
1100
+ // Make it possible to narrow the object type using the custom property
1101
+ custom?: undefined;
1102
+ }
435
1103
 
436
- type GroupCommon = ioBroker.GroupCommon;
1104
+ interface ScriptCommon extends ObjectCommon {
1105
+ name: string;
1106
+ /** Defines the type of the script, e.g., TypeScript/ts, Javascript/js or Blockly */
1107
+ engineType: 'TypeScript/ts' | 'Blockly' | 'Rules' | 'Javascript/js';
1108
+ /** The instance id of the instance which executes this script */
1109
+ engine: string;
1110
+ /** The source code of this script */
1111
+ source: string;
1112
+ debug: boolean;
1113
+ verbose: boolean;
1114
+ /** Whether this script should be executed */
1115
+ enabled: boolean;
1116
+ /** Is used to determine whether a script has changed and needs to be recompiled */
1117
+ sourceHash?: string;
1118
+ /** If the script uses a compiled language like TypeScript, this contains the compilation output */
1119
+ compiled?: string;
1120
+ /** If the script uses a compiled language like TypeScript, this contains the generated declarations (global scripts only) */
1121
+ declarations?: string;
437
1122
 
438
- type ScriptCommon = ioBroker.ScriptCommon;
1123
+ // Make it possible to narrow the object type using the custom property
1124
+ custom?: undefined;
1125
+ }
439
1126
 
440
- type AdapterCommon = ioBroker.AdapterCommon;
1127
+ type WelcomeScreenEntry =
1128
+ | string
1129
+ | {
1130
+ link: string;
1131
+ name: string;
1132
+ img: string;
1133
+ color: string;
1134
+ order?: number;
1135
+ };
1136
+
1137
+ /**
1138
+ * Object which defines if the adapter supports receiving messages via sendTo.
1139
+ * Additionally, it defines if specific messages are supported.
1140
+ * If one property is enabled, the object `system.adapter.<adapterName>.<adapterInstance>.messagebox will be created to send messages to the adapter (used for email, pushover, etc...)
1141
+ */
1142
+ interface SupportedMessages {
1143
+ /** If custom messages are supported (same as legacy messagebox) */
1144
+ custom?: boolean;
1145
+ /** If notification handling is supported, for information, see https://github.com/foxriver76/ioBroker.notification-manager#requirements-for-messaging-adapters */
1146
+ notifications?: boolean;
1147
+ /** If adapter supports signal stopInstance. Use number if you need more than 1000 ms for stop routine. The signal will be sent before stop to the adapter. (used if problems occurred with SIGTERM). */
1148
+ stopInstance?: boolean | number;
1149
+ /** If adapter supports the device manager and thus responds to the corresponding messages */
1150
+ deviceManager?: boolean;
1151
+ /** If adapter supports getHistory message. */
1152
+ getHistory?: boolean;
1153
+ }
1154
+
1155
+ type AutoUpgradePolicy = 'none' | 'patch' | 'minor' | 'major';
1156
+
1157
+ interface VisWidget {
1158
+ i18n: 'component' | true | Translated;
1159
+ name: string;
1160
+ url: string;
1161
+ components: string[];
1162
+ /** The vis widget does not support the listed major versions of vis */
1163
+ ignoreInVersions: number[];
1164
+ }
1165
+
1166
+ type PaidLicenseType = 'paid' | 'commercial' | 'limited';
1167
+
1168
+ interface LicenseInformationFree {
1169
+ /** License of the software */
1170
+ license?: string;
1171
+ /** Use 'paid' for adapters which do not work without a paid license. Use 'commercial' for adapters which require a license for commercial use only. Use 'limited' if some functionalities are not available without a paid license. */
1172
+ type: 'free';
1173
+ /**
1174
+ * Hyperlink, where information about the license can be found. For non-free licenses, the linked page should contain information about free features (if applicable), time of validity, link to shop and seller information.
1175
+ * This is required if the license type is different from 'free'. For 'free' licenses, an optional link to the license file can be placed here.
1176
+ */
1177
+ link?: string;
1178
+ }
1179
+
1180
+ interface LicenseInformationWithPayment {
1181
+ /** License of the software */
1182
+ license?: string;
1183
+ /** Use 'paid' for adapters which do not work without a paid license. Use 'commercial' for adapters which require a license for commercial use only. Use 'limited' if some functionalities are not available without a paid license. */
1184
+ type: PaidLicenseType;
1185
+ /**
1186
+ * Hyperlink, where information about the license can be found. For non-free licenses, the linked page should contain information about free features (if applicable), time of validity, link to shop and seller information.
1187
+ * This is required if the license type is different from 'free'. For 'free' licenses, an optional link to the license file can be placed here.
1188
+ */
1189
+ link: string;
1190
+ }
1191
+
1192
+ type LicenseInformation = LicenseInformationFree | LicenseInformationWithPayment;
1193
+
1194
+ interface MessageRule {
1195
+ /** The message title */
1196
+ title: iobJS.Translated;
1197
+ /** The message content */
1198
+ text: iobJS.Translated;
1199
+ /** Optional link */
1200
+ link?: string;
1201
+ /** Text of the link */
1202
+ linkText?: iobJS.Translated;
1203
+ /** The severity level of the message */
1204
+ level: 'warn' | 'error' | 'info';
1205
+ /** The buttons which should be shown on the message dialog */
1206
+ buttons?: ('agree' | 'cancel' | 'ok')[];
1207
+ /** The condition which needs to be met to display the message */
1208
+ condition: {
1209
+ operand: 'and' | 'or';
1210
+ rules: string[];
1211
+ };
1212
+ }
1213
+
1214
+ interface CustomAdminColumn {
1215
+ path: string;
1216
+ name?: iobJS.StringOrTranslated;
1217
+ objTypes?: ObjectType | ObjectType[];
1218
+ width?: number;
1219
+ edit?: boolean;
1220
+ type?: CommonType;
1221
+ align?: 'left' | 'center' | 'right';
1222
+ }
1223
+
1224
+ type ConnectionType = 'local' | 'cloud';
1225
+
1226
+ type LocalLink = {
1227
+ /** Link to the web service of this adapter, like: "%web_protocol%://%ip%:%web_port%/vis-2/edit.html" */
1228
+ link: string;
1229
+ /** Name of the link. Could be multi-language */
1230
+ name?: iobJS.StringOrTranslated;
1231
+ /** Color */
1232
+ color?: string;
1233
+ /** Link to icon, like "vis-2/img/favicon.png" */
1234
+ icon?: string;
1235
+ /** Link to the adapter if it could be shown in the free cloud, like: vis-2/index.html according to "https://iobroker.net/" */
1236
+ cloud?: string;
1237
+ /** Link to the adapter if it could be shown in the pro-cloud, like: vis-2/edit.html according to "https://iobroker.pro/" */
1238
+ pro?: string;
1239
+ /** If this link should be shown on the intro tab in admin. false = do not show */
1240
+ intro?: boolean;
1241
+ /** Order of the card. Used on "intro" and cloud tabs to sort the links */
1242
+ order?: number;
1243
+ /** Description of the link. Could be multi-language */
1244
+ description?: iobJS.StringOrTranslated;
1245
+ };
1246
+
1247
+ /** Format for local and global dependencies */
1248
+ type Dependencies = { [adapterName: string]: string }[] | string[];
1249
+
1250
+ interface AdapterCommon extends ObjectCommon {
1251
+ /** Custom attributes to be shown in admin in the object browser */
1252
+ adminColumns?: string | (string | CustomAdminColumn)[];
1253
+ /** Type of the admin UI */
1254
+ adminUI?: AdminUi;
1255
+ /** Settings for custom Admin Tabs */
1256
+ adminTab?: {
1257
+ name?: StringOrTranslated;
1258
+ /** Base 64 icon for the tab */
1259
+ icon?: string;
1260
+ /** @deprecated icon name for FontAwesome (works only in admin 4)*/
1261
+ 'fa-icon'?: string;
1262
+ /** If true, the Tab is not reloaded when the configuration changes */
1263
+ ignoreConfigUpdate?: boolean;
1264
+ /** Describes which URL should be loaded in the tab. Supports placeholders like http://%ip%:%port% or JSON(5) configs. If empty `adapter/ADAPTERNAME/tab(_m).html` will be taken. JSON config file must be defined relative to "admin" folder, like "jsonTab.json" */
1265
+ link?: string;
1266
+ /** If true, only one instance of this tab will be created for all instances */
1267
+ singleton?: boolean;
1268
+ /** Order number in admin tabs */
1269
+ order?: number;
1270
+ };
1271
+ /** If the mode is `schedule`, start one time adapter by ioBroker start, or by the configuration changes */
1272
+ allowInit?: boolean;
1273
+ /** If the adapter should be automatically upgraded and which version ranges are supported */
1274
+ automaticUpgrade?: AutoUpgradePolicy;
1275
+ /** Possible values for the instance mode (if more than one is possible) */
1276
+ availableModes?: InstanceMode[];
1277
+ /** Array which lists all blocked versions. Blocked versions will not be started. Use semver notation to specify the version ranges. The information is always used from the io-package.json in the GitHub repository. */
1278
+ blockedVersions?: string[];
1279
+ /** Whether this adapter includes custom blocks for Blockly. If true, `admin/blockly.js` must exist. */
1280
+ blockly?: boolean;
1281
+ /** Where the adapter will get its data from. Set this together with @see dataSource */
1282
+ connectionType?: ConnectionType;
1283
+ /** If true, this adapter can be started in compact mode (in the same process as other adapters) */
1284
+ compact?: boolean;
1285
+ /** 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. */
1286
+ dataFolder?: string;
1287
+ /** How the adapter will mainly receive its data. Set this together with @see connectionType */
1288
+ dataSource?: 'poll' | 'push' | 'assumption';
1289
+ /** A record of ioBroker adapters (including "js-controller") and version ranges which are required for this adapter on the same host. */
1290
+ dependencies?: Dependencies;
1291
+ /** A record of ioBroker adapters (including "js-controller") and version ranges which are required for this adapter in the whole system. */
1292
+ globalDependencies?: Dependencies;
1293
+ /** Similar to `dependencies`, but only checked if the specified adapter is already installed. If the adapter is not installed, the version check will pass */
1294
+ ifInstalledDependencies?: { [adapterName: string]: string };
1295
+ /** Which files outside the README.md have documentation for the adapter */
1296
+ docs?: Partial<Record<Languages, string | string[]>>;
1297
+ /** Whether new instances should be enabled by default. *Should* be `false`! */
1298
+ enabled: boolean;
1299
+ /** If true, all previous data in the target directory (web) should be deleted before uploading */
1300
+ eraseOnUpload?: boolean;
1301
+ /** URL of an external icon that is shown for adapters that are not installed */
1302
+ extIcon?: string;
1303
+ /** Whether this adapter responds to `getHistory` messages */
1304
+ getHistory?: boolean;
1305
+ /** Filename of the local icon which is shown for installed adapters. Should be located in the `admin` directory */
1306
+ icon?: string;
1307
+ /** 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. */
1308
+ install?: boolean;
1309
+ /** Source, where this adapter has been installed from, to enable reinstalling on e.g., backup restore */
1310
+ installedFrom?: InstalledFrom;
1311
+ /** Shows which version of this adapter is installed */
1312
+ installedVersion: string;
1313
+ /** Keywords are used by search in admin. Do not write ioBroker here */
1314
+ keywords?: string[];
1315
+ /** A dictionary of links to web services this adapter provides */
1316
+ localLinks?: Record<string, string | LocalLink>;
1317
+ /** @deprecated Use @see localLinks */
1318
+ localLink?: string;
1319
+ /** Default log level for this adapter. It can be changed for every instance separately */
1320
+ loglevel?: LogLevel;
1321
+ /** Whether this adapter receives logs from other hosts and adapters (e.g., to store them somewhere) */
1322
+ logTransporter?: boolean;
1323
+ /** Path to the start file of the adapter. Should be the same as in `package.json` */
1324
+ main?: string;
1325
+ /** Whether the admin tab is written in materialized style. Required for Admin 3+ */
1326
+ materializeTab?: boolean;
1327
+ /** Whether the admin configuration dialog is written in materialized style. Required for Admin 3+ */
1328
+ materialize: boolean;
1329
+ /** @deprecated Use @see supportedMessages up from controller v5 */
1330
+ messagebox?: true;
1331
+ /** Messages which are supported by the adapter, supportedMessages.custom: true is the equivalent to messagebox: true */
1332
+ supportedMessages?: SupportedMessages;
1333
+ /** Running mode: `none`, `daemon`, `schedule`, `once`, `extension` */
1334
+ mode: InstanceMode;
1335
+ /** Name of the adapter (without leading `ioBroker.`) */
1336
+ name: string;
1337
+ /** News per version in i18n */
1338
+ news?: { [version: string]: Translated };
1339
+ /** If `true`, no configuration dialog will be shown */
1340
+ noConfig?: true;
1341
+ /** If `true`, this adapter's instances will not be shown in the admin overview screen. Useful for icon sets and widgets... */
1342
+ noIntro?: true;
1343
+ /** Set to `true` if the adapter is not available in the official ioBroker repositories. */
1344
+ noRepository?: true;
1345
+ /** If `true`, manual installation from GitHub is not possible */
1346
+ nogit?: true;
1347
+ /** If `true`, this adapter cannot be deleted or updated manually. */
1348
+ nondeletable?: true;
1349
+ /** If `true`, this "adapter" only contains HTML files and no main executable */
1350
+ onlyWWW?: boolean;
1351
+ /** Used to configure native (OS) dependencies of this adapter that need to be installed with system package manager before installing the adapter */
1352
+ osDependencies?: {
1353
+ /** For OSX */
1354
+ darwin: string[];
1355
+ /** For Linux */
1356
+ linux: string[];
1357
+ /** For Windows */
1358
+ win32: string[];
1359
+ };
1360
+ /** Which OSes this adapter supports */
1361
+ os?: 'linux' | 'darwin' | 'win32' | Array<'linux' | 'darwin' | 'win32'>;
1362
+ /** Constant */
1363
+ platform: 'Javascript/Node.js';
1364
+ /** The keys of common attributes (e.g. `history`) which are not deleted in a `setObject` call even if they are not present. Deletion must be done explicitly by setting them to `null`. */
1365
+ preserveSettings?: string | string[];
1366
+ /** Url of the ReadMe file */
1367
+ readme?: string;
1368
+ /** Which adapters must be restarted after installing or updating this adapter. */
1369
+ restartAdapters?: string[];
1370
+ /** CRON schedule to restart mode `daemon` adapters */
1371
+ restartSchedule?: string;
1372
+ /** If the adapter runs in `schedule` mode, this contains the CRON */
1373
+ schedule?: string;
1374
+ /** Whether this adapter may only be installed once per host */
1375
+ singletonHost?: boolean;
1376
+ /** Whether this adapter may only be installed once in the whole system */
1377
+ singleton?: boolean;
1378
+ /** Whether the adapter must be stopped before an update */
1379
+ stopBeforeUpdate?: boolean;
1380
+ /** Overrides the default timeout that ioBroker will wait before force-stopping the adapter */
1381
+ stopTimeout?: number;
1382
+ /** This adapter supports a special mode: if someone subscribes on its states, it starts to read them. It is done to save the bandwidth or load of the slave device */
1383
+ subscribable?: boolean;
1384
+ /** If `true`, this adapter provides custom per-state settings. Requires a `custom_m.html` file in the `admin` directory. */
1385
+ supportCustoms?: boolean;
1386
+ /** @deprecated Use @see supportedMessages up from controller v5 */
1387
+ supportStopInstance?: boolean;
1388
+ /** The translated names of this adapter to be shown in the admin UI */
1389
+ titleLang?: StringOrTranslated;
1390
+ /** @deprecated The name of this adapter to be shown in the admin UI. Use @see titleLang instead. */
1391
+ title?: string;
1392
+ /** The type of this adapter */
1393
+ type?:
1394
+ | 'alarm'
1395
+ | 'climate-control'
1396
+ | 'communication'
1397
+ | 'date-and-time'
1398
+ | 'energy'
1399
+ | 'garden'
1400
+ | 'general'
1401
+ | 'geoposition'
1402
+ | 'hardware'
1403
+ | 'health'
1404
+ | 'household'
1405
+ | 'infrastructure'
1406
+ | 'iot-systems'
1407
+ | 'lighting'
1408
+ | 'logic'
1409
+ | 'messaging'
1410
+ | 'metering'
1411
+ | 'misc-data'
1412
+ | 'multimedia'
1413
+ | 'network'
1414
+ | 'protocols'
1415
+ | 'storage'
1416
+ | 'utility'
1417
+ | 'vehicle'
1418
+ | 'visualization'
1419
+ | 'visualization-icons'
1420
+ | 'visualization-widgets'
1421
+ | 'weather';
1422
+ /** If `true`, the `npm` package must be installed with the `--unsafe-perm` flag */
1423
+ unsafePerm?: true;
1424
+ /** The available version in the ioBroker repo. */
1425
+ version: string;
1426
+ /** Definition of the vis-2 widgets */
1427
+ visWidgets?: Record<string, VisWidget>;
1428
+ /** Include the adapter version in the URL of the web adapter, e.g. `http://ip:port/1.2.3/material` instead of `http://ip:port/material` */
1429
+ webByVersion?: boolean;
1430
+ /** Whether the web server in this adapter can be extended with plugin/extensions */
1431
+ webExtendable?: boolean;
1432
+ /** Relative path to a module that contains an extension for the web adapter. Use together with @see native.webInstance to configure which instances this affects */
1433
+ webExtension?: string;
1434
+ /** List of parameters that must be included in info.js by webServer adapter. (Example material: `"webPreSettings": { "materialBackground": "native.loadingBackground" }`). Web adapter uses this setting to create a customized info.js file to provide some essential settings for index.html file before the socket connection is established to provide e.g., background color of the loading screen. */
1435
+ webPreSettings?: Record<string, any>;
1436
+ /** @deprecated (where is it necessary?) Array of web server's instances that should serve content from the adapter's www folder */
1437
+ webservers?: string[];
1438
+ /** @deprecated (use localLinks) A list of pages that should be shown on the "web" index page */
1439
+ welcomeScreen?: WelcomeScreenEntry[];
1440
+ /** @deprecated (use localLinks) A list of pages that should be shown on the ioBroker cloud index page */
1441
+ welcomeScreenPro?: WelcomeScreenEntry[];
1442
+ /** @deprecated (rename the `www` folder in e.g. `adminWww`) If true, the `www` folder will be not uploaded into DB */
1443
+ wwwDontUpload?: boolean;
1444
+ /** @deprecated Use 'common.licenseInformation' instead */
1445
+ license?: string;
1446
+ /** An object representing information with the license details */
1447
+ licenseInformation?: LicenseInformation;
1448
+ /** Messages, that will be shown (if condition evaluates to true) by upgrade or installation */
1449
+ messages?: MessageRule[];
1450
+ /** If a specific update of this adapter should be ignored, specifies version number to be ignored */
1451
+ ignoreVersion?: string;
1452
+ /** Sentry and other plugins */
1453
+ plugins?: { [pluginName: string]: Record<string, any> };
1454
+ /** Rules blocks for JavaScript rules */
1455
+ javascriptRules?: {
1456
+ /** Translations */
1457
+ i18n?: boolean | Record<string, Record<iobJS.Languages, string>> | Record<string, string>;
1458
+ /** Where to load the blocks, like "rules/customRuleBlocks.js" */
1459
+ url: string;
1460
+ /** Rules block name, like "ActionTelegram" */
1461
+ name: string;
1462
+ /** Load it as TypeScript module */
1463
+ type?: 'module';
1464
+ };
1465
+
1466
+ // Make it possible to narrow the object type using the custom property
1467
+ custom?: undefined;
1468
+ }
1469
+
1470
+ interface SystemConfigCommon extends ObjectCommon {
1471
+ /** Name of all active repositories */
1472
+ activeRepo: string[];
1473
+ /** Current configured language */
1474
+ language: Languages;
1475
+ /** If floating comma is used instead of dot */
1476
+ isFloatComma: boolean;
1477
+ /** Configured longitude */
1478
+ longitude?: number;
1479
+ /** Configured latitude */
1480
+ latitude?: number;
1481
+ /** Optional user's city (only for diagnostics) */
1482
+ city?: string;
1483
+ /** Optional user's country (only for diagnostics) */
1484
+ country?: string;
1485
+ /** User-defined temperature unit */
1486
+ tempUnit?: '°C' | '°F';
1487
+ /** User-defined currency */
1488
+ currency?: string;
1489
+ /** User-defined first day of the week */
1490
+ firstDayOfWeek?: 'monday' | 'sunday';
1491
+ /** Default history instance */
1492
+ defaultHistory: string;
1493
+ /** Which diag data is allowed to be sent */
1494
+ diag: 'none' | 'extended' | 'no-city';
1495
+ /** If license has already been confirmed */
1496
+ licenseConfirmed: boolean;
1497
+ /** System wide default log level */
1498
+ defaultLogLevel?: LogLevel;
1499
+ /** Used date format for formatting */
1500
+ dateFormat: string;
1501
+ /** This name will be shown in admin's header. Just to identify the whole installation */
1502
+ siteName?: string;
1503
+ /** Default acl for new objects */
1504
+ defaultNewAcl: {
1505
+ object: number;
1506
+ state: number;
1507
+ file: number;
1508
+ owner: ObjectIDs.User;
1509
+ ownerGroup: ObjectIDs.Group;
1510
+ };
1511
+ /** Configured auto upgrade policy */
1512
+ adapterAutoUpgrade?: {
1513
+ /** Configuration for each repository */
1514
+ repositories: {
1515
+ [repoName: string]: boolean;
1516
+ };
1517
+ /** Default policy, if none has been set explicit for the adapter */
1518
+ defaultPolicy: AutoUpgradePolicy;
1519
+ };
1520
+ /** Deactivated instances, that should not be shown in admin/Intro page */
1521
+ intro?: string[];
1522
+ /** Defines which tabs are visible in the left menu of the admin */
1523
+ tabsVisible?: {
1524
+ /** Name of the tab */
1525
+ name: string;
1526
+ /** If the tab should be visible */
1527
+ visible: boolean;
1528
+ /** Optional color of the tab */
1529
+ color?: string;
1530
+ }[];
1531
+ /** Global saved expert mode for admin */
1532
+ expertMode?: boolean;
1533
+
1534
+ // Make it possible to narrow the object type using the custom property
1535
+ custom?: undefined;
1536
+ }
441
1537
 
442
1538
  interface OtherCommon extends ObjectCommon {
443
1539
  [propName: string]: any;
@@ -446,6 +1542,24 @@ declare global {
446
1542
  custom?: undefined;
447
1543
  }
448
1544
 
1545
+ /**
1546
+ * 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.
1547
+ * 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.
1548
+ * 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".
1549
+ * If the password is correct, the object attributes will be updated. If the password is wrong, the object will not be changed.
1550
+ * 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.
1551
+ */
1552
+ interface NonEditable {
1553
+ /** Password needed to edit non-editable information */
1554
+ password?: string;
1555
+ /** Hashed version of current password */
1556
+ passHash?: string;
1557
+ /** These properties can only be changed by providing the password, else they stay on the initial value */
1558
+ common?: Record<string, any>;
1559
+ /** These properties can only be changed by providing the password, else they stay on the initial value */
1560
+ native?: Record<string, any>;
1561
+ }
1562
+
449
1563
  /* Base type for Objects. Should not be used directly */
450
1564
  interface BaseObject {
451
1565
  /** The ID of this object */
@@ -455,12 +1569,14 @@ declare global {
455
1569
  // without bugging users to change their code --> https://github.com/microsoft/TypeScript/issues/15300
456
1570
  native: Record<string, any>;
457
1571
  common: Record<string, any>;
458
- enums?: Record<string, string>;
1572
+ enums?: Record<string, string | Translated>;
459
1573
  acl?: ObjectACL;
460
1574
  from?: string;
461
1575
  /** The user who created or updated this object */
462
1576
  user?: string;
463
1577
  ts?: number;
1578
+ /** These properties can only be edited if the correct password is provided */
1579
+ nonEdit?: NonEditable;
464
1580
  }
465
1581
 
466
1582
  interface StateObject extends BaseObject {
@@ -472,6 +1588,7 @@ declare global {
472
1588
  /** The names of enums this state is assigned to. For example ["Licht","Garten"] */
473
1589
  enumNames?: Array<iobJS.StringOrTranslated>;
474
1590
  }
1591
+
475
1592
  interface PartialStateObject extends Partial<Omit<StateObject, 'common' | 'acl'>> {
476
1593
  common?: Partial<StateCommon>;
477
1594
  acl?: Partial<StateACL>;
@@ -481,6 +1598,7 @@ declare global {
481
1598
  type: 'channel';
482
1599
  common: ChannelCommon;
483
1600
  }
1601
+
484
1602
  interface PartialChannelObject extends Partial<Omit<ChannelObject, 'common'>> {
485
1603
  common?: Partial<ChannelCommon>;
486
1604
  }
@@ -489,6 +1607,7 @@ declare global {
489
1607
  type: 'device';
490
1608
  common: DeviceCommon;
491
1609
  }
1610
+
492
1611
  interface PartialDeviceObject extends Partial<Omit<DeviceObject, 'common'>> {
493
1612
  common?: Partial<DeviceCommon>;
494
1613
  }
@@ -498,6 +1617,7 @@ declare global {
498
1617
  // Nothing is set in stone here, so start with allowing every property
499
1618
  common: OtherCommon;
500
1619
  }
1620
+
501
1621
  interface PartialFolderObject extends Partial<Omit<FolderObject, 'common'>> {
502
1622
  common?: Partial<OtherCommon>;
503
1623
  }
@@ -506,6 +1626,7 @@ declare global {
506
1626
  type: 'enum';
507
1627
  common: EnumCommon;
508
1628
  }
1629
+
509
1630
  interface PartialEnumObject extends Partial<Omit<EnumObject, 'common'>> {
510
1631
  common?: Partial<EnumCommon>;
511
1632
  }
@@ -514,52 +1635,190 @@ declare global {
514
1635
  type: 'meta';
515
1636
  common: MetaCommon;
516
1637
  }
1638
+
517
1639
  interface PartialMetaObject extends Partial<Omit<MetaObject, 'common'>> {
518
1640
  common?: Partial<MetaCommon>;
519
1641
  }
520
1642
 
521
- interface InstanceObject extends BaseObject {
1643
+ interface ChartObject extends BaseObject {
1644
+ type: 'chart';
1645
+ common: ChartCommon;
1646
+ }
1647
+
1648
+ type PartialChartObject = ChartObject;
1649
+
1650
+ interface ScheduleObject extends BaseObject {
1651
+ type: 'schedule';
1652
+ common: ScheduleCommon;
1653
+ }
1654
+
1655
+ interface PartialScheduleObject extends Partial<Omit<ScheduleObject, 'common'>> {
1656
+ common?: Partial<ScheduleCommon>;
1657
+ }
1658
+
1659
+ interface PartialRepositoryObject extends Partial<Omit<RepositoryObject, 'common'>> {
1660
+ common?: Partial<RepositoryCommon>;
1661
+ }
1662
+
1663
+ interface RepositoryJsonAdapterContent {
1664
+ /** Adapter name */
1665
+ name: string;
1666
+ /** Newest available version */
1667
+ version: string;
1668
+ /** Array of blocked versions, each entry represents a semver range */
1669
+ blockedVersions: string[];
1670
+ /** If true, the unsafe perm flag is needed on install */
1671
+ unsafePerm?: boolean;
1672
+ /** If given, the packet name differs from the adapter name, e.g. because it is a scoped package */
1673
+ packetName?: string;
1674
+
1675
+ /** Other Adapter related properties, not important for this implementation */
1676
+ [other: string]: unknown;
1677
+ }
1678
+
1679
+ interface RepoInfo {
1680
+ /** If it is the official stable repository */
1681
+ stable?: boolean;
1682
+ /** i18n name of the repository */
1683
+ name: Required<iobJS.Translated>;
1684
+ /** Time of repository update */
1685
+ repoTime: string;
1686
+ }
1687
+
1688
+ interface RepositoryJson {
1689
+ /** Information about the repository: creation time, name, is it stable */
1690
+ _repoInfo: RepoInfo;
1691
+
1692
+ /** Information about each adapter */
1693
+ [adapter: string]: RepositoryJsonAdapterContent | RepoInfo;
1694
+ }
1695
+
1696
+ interface RepositoryInformation {
1697
+ /** Url to the repository */
1698
+ link: string;
1699
+ json: RepositoryJson | null;
1700
+ hash?: string;
1701
+ time?: string;
1702
+ /** If this repository stable */
1703
+ stable?: boolean;
1704
+ }
1705
+
1706
+ interface RepositoryObject extends BaseObject {
1707
+ _id: ObjectIDs.Repository;
1708
+ type: 'config';
1709
+ native: {
1710
+ repositories: {
1711
+ [repoName: string]: RepositoryInformation;
1712
+ };
1713
+ oldRepositories?: {
1714
+ [repoName: string]: RepositoryInformation;
1715
+ };
1716
+ };
1717
+ common: RepositoryCommon;
1718
+ }
1719
+
1720
+ interface InstanceObject extends Omit<AdapterObject, 'type'>, BaseObject {
1721
+ _id: ObjectIDs.Instance;
522
1722
  type: 'instance';
523
1723
  common: InstanceCommon;
524
1724
  }
1725
+
525
1726
  interface PartialInstanceObject extends Partial<Omit<InstanceObject, 'common'>> {
526
1727
  common?: Partial<InstanceCommon>;
527
1728
  }
528
1729
 
1730
+ // it is defined in notificationHandler.ts
1731
+ type NotificationCategory = {
1732
+ /** The unique category identifier */
1733
+ category:
1734
+ | 'memIssues'
1735
+ | 'fsIoErrors'
1736
+ | 'noDiskSpace'
1737
+ | 'accessErrors'
1738
+ | 'nonExistingFileErrors'
1739
+ | 'remoteHostErrors'
1740
+ | 'restartLoop'
1741
+ | 'fileToJsonl'
1742
+ | 'automaticAdapterUpgradeFailed'
1743
+ | 'automaticAdapterUpgradeSuccessful'
1744
+ | 'blockedVersions'
1745
+ | 'databaseErrors'
1746
+ | 'securityIssues'
1747
+ | 'packageUpdates'
1748
+ | 'systemRebootRequired'
1749
+ | 'diskSpaceIssues'
1750
+ | (string & {});
1751
+ /** The human-readable category name */
1752
+ name: Translated;
1753
+ /** The human-readable category description */
1754
+ description: Translated;
1755
+ /** 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 */
1756
+ severity: 'info' | 'notify' | 'alert';
1757
+ /** 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 */
1758
+ regex: string[];
1759
+ /** Deletes older messages if more than the specified amount is present for this category */
1760
+ limit: number;
1761
+ };
1762
+
1763
+ interface Notification {
1764
+ /** E.g., `system`. 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. */
1765
+ scope: string;
1766
+ /** The human-readable name of this scope */
1767
+ name: Translated;
1768
+ /** The human-readable description of this scope */
1769
+ description: Translated;
1770
+ /** All notification categories of this scope */
1771
+ categories: NotificationCategory[];
1772
+ }
1773
+
529
1774
  interface AdapterObject extends BaseObject {
1775
+ _id: ObjectIDs.Adapter;
530
1776
  type: 'adapter';
531
1777
  common: AdapterCommon;
532
1778
  /** An array of `native` properties which cannot be accessed from outside the defining adapter */
533
1779
  protectedNative?: string[];
534
1780
  /** Like protectedNative, but the properties are also encrypted and decrypted automatically */
535
1781
  encryptedNative?: string[];
1782
+ /** Register notifications for the built-in notification system */
1783
+ notifications?: Notification[];
1784
+ /** Objects created for each instance, inside the namespace of this adapter */
1785
+ instanceObjects: (StateObject | DeviceObject | ChannelObject | FolderObject | MetaObject)[];
1786
+ /** Objects created for the adapter, anywhere in the global namespace */
1787
+ objects: iobJS.AnyObject[];
536
1788
  }
1789
+
537
1790
  interface PartialAdapterObject extends Partial<Omit<AdapterObject, 'common'>> {
538
1791
  common?: Partial<AdapterCommon>;
539
1792
  }
540
1793
 
541
1794
  interface HostObject extends BaseObject {
1795
+ _id: ObjectIDs.Host;
542
1796
  type: 'host';
543
1797
  common: HostCommon;
544
1798
  native: HostNative;
545
1799
  }
1800
+
546
1801
  interface PartialHostObject extends Partial<Omit<HostObject, 'common' | 'native'>> {
547
1802
  common?: Partial<HostCommon>;
548
1803
  native?: Partial<HostNative>;
549
1804
  }
550
1805
 
551
1806
  interface UserObject extends BaseObject {
1807
+ _id: ObjectIDs.User;
552
1808
  type: 'user';
553
1809
  common: UserCommon;
554
1810
  }
1811
+
555
1812
  interface PartialUserObject extends Partial<Omit<UserObject, 'common'>> {
556
1813
  common?: Partial<UserCommon>;
557
1814
  }
558
1815
 
559
1816
  interface GroupObject extends BaseObject {
1817
+ _id: ObjectIDs.Group;
560
1818
  type: 'group';
561
1819
  common: GroupCommon;
562
1820
  }
1821
+
563
1822
  interface PartialGroupObject extends Partial<Omit<GroupObject, 'common'>> {
564
1823
  common?: Partial<GroupCommon>;
565
1824
  }
@@ -567,19 +1826,46 @@ declare global {
567
1826
  interface ScriptObject extends BaseObject {
568
1827
  type: 'script';
569
1828
  common: ScriptCommon;
1829
+ native: {
1830
+ encrypted?: boolean;
1831
+ };
570
1832
  }
1833
+
571
1834
  interface PartialScriptObject extends Partial<Omit<ScriptObject, 'common'>> {
572
1835
  common?: Partial<ScriptCommon>;
573
1836
  }
574
1837
 
1838
+ interface SystemConfigObject extends BaseObject {
1839
+ type: 'config';
1840
+ common: SystemConfigCommon;
1841
+ }
1842
+
1843
+ interface PartialSystemConfigObject extends Partial<Omit<SystemConfigObject, 'common'>> {
1844
+ common?: Partial<SystemConfigCommon>;
1845
+ }
1846
+
575
1847
  interface OtherObject extends BaseObject {
576
1848
  type: 'config' | 'chart';
577
1849
  common: OtherCommon;
578
1850
  }
1851
+
579
1852
  interface PartialOtherObject extends Partial<Omit<OtherObject, 'common'>> {
580
1853
  common?: Partial<OtherCommon>;
581
1854
  }
582
1855
 
1856
+ interface DesignObject extends Omit<BaseObject, 'common'> {
1857
+ // allow narrowing the type without making it a pain
1858
+ type: 'design';
1859
+ _id: ObjectIDs.Design;
1860
+ language: 'javascript';
1861
+ common?: OtherCommon;
1862
+ views: Record<string, { map: string }>;
1863
+ }
1864
+
1865
+ interface PartialDesignObject extends Partial<Omit<DesignObject, 'common'>> {
1866
+ common?: Partial<OtherCommon>;
1867
+ }
1868
+
583
1869
  type AnyObject =
584
1870
  | StateObject
585
1871
  | ChannelObject
@@ -593,7 +1879,11 @@ declare global {
593
1879
  | UserObject
594
1880
  | GroupObject
595
1881
  | ScriptObject
596
- | OtherObject;
1882
+ | ChartObject
1883
+ | ScheduleObject
1884
+ | RepositoryObject
1885
+ | OtherObject
1886
+ | DesignObject;
597
1887
 
598
1888
  type AnyPartialObject =
599
1889
  | PartialStateObject
@@ -608,14 +1898,22 @@ declare global {
608
1898
  | PartialUserObject
609
1899
  | PartialGroupObject
610
1900
  | PartialScriptObject
611
- | PartialOtherObject;
1901
+ | PartialChartObject
1902
+ | PartialScheduleObject
1903
+ | PartialRepositoryObject
1904
+ | PartialSystemConfigObject
1905
+ | PartialOtherObject
1906
+ | PartialDesignObject;
612
1907
 
613
1908
  /** All objects that usually appear in an adapter scope */
614
1909
  type AdapterScopedObject = FolderObject | DeviceObject | ChannelObject | StateObject;
615
1910
 
616
- // For all objects that are exposed to the user we need to tone the strictness down.
1911
+ // For all objects that are exposed to the user, we need to tone the strictness down.
617
1912
  // Otherwise, every operation on objects becomes a pain to work with
618
- type Object = AnyObject;
1913
+ type Object = AnyObject & {
1914
+ common: Record<string, any>;
1915
+ native: Record<string, any>;
1916
+ };
619
1917
 
620
1918
  // In set[Foreign]Object[NotExists] methods, the ID and acl of the object is optional
621
1919
  type SettableObjectWorker<T> = T extends AnyObject
@@ -629,6 +1927,86 @@ declare global {
629
1927
 
630
1928
  type PartialObject<T extends AnyObject = AnyObject> = PartialObjectWorker<T>;
631
1929
 
1930
+ // Used to infer the return type of GetObjectView
1931
+ type InferGetObjectViewItemType<Design extends string, View extends string> = Design extends 'system'
1932
+ ? View extends 'host'
1933
+ ? HostObject
1934
+ : View extends 'adapter'
1935
+ ? AdapterObject
1936
+ : View extends 'instance'
1937
+ ? InstanceObject
1938
+ : View extends 'meta'
1939
+ ? MetaObject
1940
+ : View extends 'device'
1941
+ ? DeviceObject
1942
+ : View extends 'channel'
1943
+ ? ChannelObject
1944
+ : View extends 'state'
1945
+ ? StateObject
1946
+ : View extends 'folder'
1947
+ ? FolderObject
1948
+ : View extends 'enum'
1949
+ ? EnumObject
1950
+ : View extends 'script'
1951
+ ? ScriptObject
1952
+ : View extends 'group'
1953
+ ? GroupObject
1954
+ : View extends 'user'
1955
+ ? UserObject
1956
+ : View extends 'chart'
1957
+ ? ChartObject
1958
+ : View extends 'schedule'
1959
+ ? ScheduleObject
1960
+ : View extends 'config'
1961
+ ?
1962
+ | RepositoryObject
1963
+ | SystemConfigObject
1964
+ | (OtherObject & {
1965
+ type: 'config';
1966
+ })
1967
+ : View extends 'custom'
1968
+ ? NonNullable<StateObject['common']['custom']>
1969
+ : iobJS.Object
1970
+ : any;
1971
+
1972
+ enum StateQuality {
1973
+ good = 0x00, // or undefined or null
1974
+ bad = 0x01,
1975
+ general_device_problem = 0x41,
1976
+ general_sensor_problem = 0x81,
1977
+ device_not_connected = 0x42,
1978
+ sensor_not_connected = 0x82,
1979
+ device_reports_error = 0x44,
1980
+ sensor_reports_error = 0x84,
1981
+ }
1982
+
1983
+ interface TypedState<T extends iobJS.StateValue = any> extends iobJS.State {
1984
+ val: T;
1985
+ notExist?: true;
1986
+ }
1987
+
1988
+ interface AbsentState extends Omit<iobJS.State, 'ack' | 'from' | 'ts' | 'lc'> {
1989
+ val: null;
1990
+ notExist: true;
1991
+
1992
+ ack: undefined;
1993
+ ts: undefined;
1994
+ lc: undefined;
1995
+ from: undefined;
1996
+ expire: undefined;
1997
+ q: undefined;
1998
+ c: undefined;
1999
+ }
2000
+
2001
+ interface StateCommonAlias {
2002
+ /** The target state id or two target states used for reading and writing values */
2003
+ id: string | { read: string; write: string };
2004
+ /** An optional conversion function when reading, e.g. `"(val − 32) * 5/9"` */
2005
+ read?: string;
2006
+ /** An optional conversion function when reading, e.g. `"(val * 9/5) + 32"` */
2007
+ write?: string;
2008
+ }
2009
+
632
2010
  // Convenient definitions for manually specifying settable object types
633
2011
  type SettableObject<T extends AnyObject = AnyObject> = SettableObjectWorker<T>;
634
2012
  type SettableStateObject = SettableObject<StateObject>;
@@ -646,7 +2024,7 @@ declare global {
646
2024
  type SettableOtherObject = SettableObject<OtherObject>;
647
2025
 
648
2026
  /** Represents the change of a state */
649
- interface ChangedStateObject<TOld extends ioBroker.StateValue = any, TNew extends ioBroker.StateValue = TOld>
2027
+ interface ChangedStateObject<TOld extends iobJS.StateValue = any, TNew extends iobJS.StateValue = TOld>
650
2028
  extends StateObject {
651
2029
  common: StateCommon;
652
2030
  native: Record<string, any>;
@@ -682,13 +2060,9 @@ declare global {
682
2060
  ) => void | Promise<void>;
683
2061
  type ExistsStateCallback = (err?: Error | null, exists?: boolean) => void | Promise<void>;
684
2062
 
685
- type SetStateCallback = (err?: Error | null, id?: string) => void | Promise<void>;
686
- type SetStatePromise = Promise<NonNullCallbackReturnTypeOf<SetStateCallback>>;
687
-
688
2063
  type StateChangeHandler<TOld extends ioBroker.StateValue = any, TNew extends TOld = any> = (
689
2064
  obj: ChangedStateObject<TOld, TNew>,
690
2065
  ) => void | Promise<void>;
691
- type ObjectChangeHandler = (id: string, obj: iobJS.Object) => void | Promise<void>;
692
2066
 
693
2067
  type FileChangeHandler<WithFile extends boolean> =
694
2068
  // Variant 1: WithFile is false, data/mimeType is definitely not there
@@ -732,17 +2106,6 @@ declare global {
732
2106
  type ReadFileCallback = (err?: Error | null, file?: Buffer | string, mimeType?: string) => void | Promise<void>;
733
2107
  type ReadFilePromise = Promise<NonNullCallbackReturnTypeOf<ReadFileCallback>>;
734
2108
 
735
- /** Callback information for a passed message */
736
- interface MessageCallbackInfo {
737
- /** The original message payload */
738
- message: string | object;
739
- /** ID of this callback */
740
- id: number;
741
- // ???
742
- ack: boolean;
743
- /** Timestamp of this message */
744
- time: number;
745
- }
746
2109
  type MessageCallback = (result?: any) => void | Promise<void>;
747
2110
 
748
2111
  interface SendToOptions {
@@ -763,10 +2126,10 @@ declare global {
763
2126
  /** name is equal or matches to given one */
764
2127
  name?: string | string[] | RegExp;
765
2128
  /** type of change */
766
- change?: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le' | 'any';
767
- val?: ioBroker.StateValue;
2129
+ change?: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le' | 'any' | '*';
2130
+ val?: iobJS.StateValue;
768
2131
  /** New value must not be equal to given one */
769
- valNe?: ioBroker.StateValue;
2132
+ valNe?: iobJS.StateValue;
770
2133
  /** New value must be greater than given one */
771
2134
  valGt?: number;
772
2135
  /** New value must be greater or equal to given one */
@@ -778,9 +2141,9 @@ declare global {
778
2141
  /** The acknowledged state of new value is equal to given one */
779
2142
  ack?: boolean;
780
2143
  /** Previous value must be equal to given one */
781
- oldVal?: ioBroker.StateValue;
2144
+ oldVal?: iobJS.StateValue;
782
2145
  /** Previous value must be not equal to given one */
783
- oldValNe?: ioBroker.StateValue;
2146
+ oldValNe?: iobJS.StateValue;
784
2147
  /** The previous value must be greater than given one */
785
2148
  oldValGt?: number;
786
2149
  /** Previous value must be greater or equal given one */
@@ -878,9 +2241,9 @@ declare global {
878
2241
  * this can be called synchronously and immediately returns the state.
879
2242
  * Otherwise, you need to provide a callback.
880
2243
  */
881
- getState<T extends ioBroker.StateValue = any>(callback: GetStateCallback<T>): void;
882
- getState<T extends ioBroker.StateValue = any>(): TypedState<T> | null | undefined;
883
- getStateAsync<T extends ioBroker.StateValue = any>(): Promise<
2244
+ getState<T extends iobJS.StateValue = any>(callback: GetStateCallback<T>): void;
2245
+ getState<T extends iobJS.StateValue = any>(): TypedState<T> | iobJS.AbsentState | null | undefined;
2246
+ getStateAsync<T extends iobJS.StateValue = any>(): Promise<
884
2247
  TypedState<T> | iobJS.AbsentState | null | undefined
885
2248
  >;
886
2249
 
@@ -888,16 +2251,16 @@ declare global {
888
2251
  * Sets all queried states to the given value.
889
2252
  */
890
2253
  setState(
891
- state: ioBroker.StateValue | ioBroker.SettableState,
2254
+ state: iobJS.StateValue | iobJS.SettableState,
892
2255
  ack?: boolean | 'true' | 'false' | SetStateCallback,
893
2256
  callback?: SetStateCallback,
894
2257
  ): this;
895
2258
  setStateAsync(
896
- state: ioBroker.StateValue | ioBroker.SettableState,
2259
+ state: iobJS.StateValue | iobJS.SettableState,
897
2260
  ack?: boolean | 'true' | 'false',
898
2261
  ): Promise<void>;
899
2262
  setStateDelayed(
900
- state: ioBroker.StateValue | ioBroker.SettableState,
2263
+ state: iobJS.StateValue | iobJS.SettableState,
901
2264
  isAck: boolean | number | undefined,
902
2265
  delay?: number | boolean,
903
2266
  clearRunning?: boolean | (() => void),
@@ -908,11 +2271,11 @@ declare global {
908
2271
  * Sets all queried states to the given value only if the value really changed.
909
2272
  */
910
2273
  setStateChanged(
911
- state: ioBroker.StateValue | ioBroker.SettableState,
2274
+ state: iobJS.StateValue | iobJS.SettableState,
912
2275
  ack?: boolean,
913
2276
  callback?: SetStateCallback,
914
2277
  ): this;
915
- setStateChangedAsync(state: ioBroker.StateValue | ioBroker.SettableState, ack?: boolean): Promise<void>;
2278
+ setStateChangedAsync(state: iobJS.StateValue | iobJS.SettableState, ack?: boolean): Promise<void>;
916
2279
 
917
2280
  /**
918
2281
  * Subscribes the given callback to changes of the matched states.
@@ -1046,13 +2409,6 @@ declare global {
1046
2409
  id: string;
1047
2410
  }
1048
2411
 
1049
- interface LogMessage {
1050
- severity: LogLevel; // severity
1051
- ts: number; // timestamp as Date.now()
1052
- message: string; // message
1053
- from: string; // origin of the message
1054
- }
1055
-
1056
2412
  type SchedulePattern = ScheduleRule | ScheduleRuleConditional | Date | string | number;
1057
2413
 
1058
2414
  interface SubscribeTime {
@@ -1359,19 +2715,19 @@ declare global {
1359
2715
  */
1360
2716
  function setState(
1361
2717
  id: string,
1362
- state: ioBroker.StateValue | ioBroker.SettableState,
2718
+ state: iobJS.StateValue | iobJS.SettableState,
1363
2719
  callback?: iobJS.SetStateCallback,
1364
2720
  ): void;
1365
2721
  function setState(
1366
2722
  id: string,
1367
- state: ioBroker.StateValue | ioBroker.SettableState,
2723
+ state: iobJS.StateValue | iobJS.SettableState,
1368
2724
  ack: boolean,
1369
2725
  callback?: iobJS.SetStateCallback,
1370
2726
  ): void;
1371
2727
 
1372
2728
  function setStateAsync(
1373
2729
  id: string,
1374
- state: ioBroker.StateValue | ioBroker.SettableState,
2730
+ state: iobJS.StateValue | iobJS.SettableState,
1375
2731
  ack?: boolean,
1376
2732
  ): iobJS.SetStatePromise;
1377
2733
 
@@ -1384,19 +2740,19 @@ declare global {
1384
2740
  */
1385
2741
  function setStateChanged(
1386
2742
  id: string,
1387
- state: ioBroker.StateValue | ioBroker.SettableState,
2743
+ state: iobJS.StateValue | iobJS.SettableState,
1388
2744
  callback?: iobJS.SetStateCallback,
1389
2745
  ): void;
1390
2746
  function setStateChanged(
1391
2747
  id: string,
1392
- state: ioBroker.StateValue | ioBroker.SettableState,
2748
+ state: iobJS.StateValue | iobJS.SettableState,
1393
2749
  ack: boolean,
1394
2750
  callback?: iobJS.SetStateCallback,
1395
2751
  ): void;
1396
2752
 
1397
2753
  function setStateChangedAsync(
1398
2754
  id: string,
1399
- state: ioBroker.StateValue | ioBroker.SettableState,
2755
+ state: iobJS.StateValue | iobJS.SettableState,
1400
2756
  ack?: boolean,
1401
2757
  ): iobJS.SetStatePromise;
1402
2758
 
@@ -1413,39 +2769,39 @@ declare global {
1413
2769
  */
1414
2770
  function setStateDelayed(
1415
2771
  id: string,
1416
- state: ioBroker.StateValue | ioBroker.SettableState,
2772
+ state: iobJS.StateValue | iobJS.SettableState,
1417
2773
  delay: number,
1418
2774
  clearRunning: boolean,
1419
2775
  callback?: iobJS.SetStateCallback,
1420
2776
  ): number | null;
1421
2777
  function setStateDelayed(
1422
2778
  id: string,
1423
- state: ioBroker.StateValue | ioBroker.SettableState,
2779
+ state: iobJS.StateValue | iobJS.SettableState,
1424
2780
  ack: boolean,
1425
2781
  clearRunning: boolean,
1426
2782
  callback?: iobJS.SetStateCallback,
1427
2783
  ): number | null;
1428
2784
  function setStateDelayed(
1429
2785
  id: string,
1430
- state: ioBroker.StateValue | ioBroker.SettableState,
2786
+ state: iobJS.StateValue | iobJS.SettableState,
1431
2787
  ack: boolean,
1432
2788
  delay: number,
1433
2789
  callback?: iobJS.SetStateCallback,
1434
2790
  ): number | null;
1435
2791
  function setStateDelayed(
1436
2792
  id: string,
1437
- state: ioBroker.StateValue | ioBroker.SettableState,
2793
+ state: iobJS.StateValue | iobJS.SettableState,
1438
2794
  delay: number,
1439
2795
  callback?: iobJS.SetStateCallback,
1440
2796
  ): number | null;
1441
2797
  function setStateDelayed(
1442
2798
  id: string,
1443
- state: ioBroker.StateValue | ioBroker.SettableState,
2799
+ state: iobJS.StateValue | iobJS.SettableState,
1444
2800
  callback?: iobJS.SetStateCallback,
1445
2801
  ): number | null;
1446
2802
  function setStateDelayed(
1447
2803
  id: string,
1448
- state: ioBroker.StateValue | ioBroker.SettableState,
2804
+ state: iobJS.StateValue | iobJS.SettableState,
1449
2805
  ack: boolean,
1450
2806
  delay: number,
1451
2807
  clearRunning: boolean,
@@ -1479,9 +2835,9 @@ declare global {
1479
2835
  * this can be called synchronously and immediately returns the state.
1480
2836
  * Otherwise, you need to provide a callback.
1481
2837
  */
1482
- function getState<T extends ioBroker.StateValue = any>(id: string, callback: iobJS.GetStateCallback<T>): void;
1483
- function getState<T extends ioBroker.StateValue = any>(id: string): iobJS.TypedState<T> | iobJS.AbsentState;
1484
- function getStateAsync<T extends ioBroker.StateValue = any>(id: string): Promise<iobJS.TypedState<T>>;
2838
+ function getState<T extends iobJS.StateValue = any>(id: string, callback: iobJS.GetStateCallback<T>): void;
2839
+ function getState<T extends iobJS.StateValue = any>(id: string): iobJS.TypedState<T> | iobJS.AbsentState;
2840
+ function getStateAsync<T extends iobJS.StateValue = any>(id: string): Promise<iobJS.TypedState<T>>;
1485
2841
 
1486
2842
  /**
1487
2843
  * Checks if the state with the given ID exists
@@ -1509,7 +2865,7 @@ declare global {
1509
2865
  * @param id Object ID
1510
2866
  * @param enumName Which enum should be included in the returned object. `true` to return all enums.
1511
2867
  */
1512
- function getObject<T extends string>(id: T, enumName?: string | true): iobJS.ObjectIdToObjectType<T, 'read'>;
2868
+ function getObject<T extends string>(id: T, enumName?: string | true): iobJS.ObjectIdToObjectType<T>;
1513
2869
  function getObject<T extends string>(id: T, callback: iobJS.GetObjectCallback<T>): void;
1514
2870
  function getObject<T extends string>(id: T, enumName: string | true, callback: iobJS.GetObjectCallback<T>): void;
1515
2871
  function getObjectAsync<T extends string>(id: T, enumName?: string | true): iobJS.GetObjectPromise<T>;
@@ -1526,7 +2882,7 @@ declare global {
1526
2882
  function deleteObject(id: string, recursive: boolean, callback?: ErrorCallback): void;
1527
2883
  function deleteObjectAsync(id: string, recursive?: boolean): Promise<void>;
1528
2884
 
1529
- function getEnums(enumName?: string): { id: string; members: string[]; name: ioBroker.StringOrTranslated }[];
2885
+ function getEnums(enumName?: string): { id: string; members: string[]; name: iobJS.StringOrTranslated }[];
1530
2886
 
1531
2887
  /**
1532
2888
  * Creates a state and the corresponding object under the JavaScript namespace.
@@ -1540,7 +2896,7 @@ declare global {
1540
2896
  */
1541
2897
  function createState(
1542
2898
  name: string,
1543
- initValue: ioBroker.StateValue,
2899
+ initValue: iobJS.StateValue,
1544
2900
  forceCreation: boolean,
1545
2901
  common: Partial<iobJS.StateCommon>,
1546
2902
  native: any,
@@ -1548,24 +2904,24 @@ declare global {
1548
2904
  ): void;
1549
2905
  function createState(
1550
2906
  name: string,
1551
- initValue: ioBroker.StateValue,
2907
+ initValue: iobJS.StateValue,
1552
2908
  forceCreation: boolean,
1553
2909
  common: Partial<iobJS.StateCommon>,
1554
2910
  callback?: iobJS.SetStateCallback,
1555
2911
  ): void;
1556
2912
  function createState(
1557
2913
  name: string,
1558
- initValue: ioBroker.StateValue,
2914
+ initValue: iobJS.StateValue,
1559
2915
  forceCreation: boolean,
1560
2916
  callback?: iobJS.SetStateCallback,
1561
2917
  ): void;
1562
2918
  function createState(name: string, callback?: iobJS.SetStateCallback): void;
1563
- function createState(name: string, initValue: ioBroker.StateValue, callback?: iobJS.SetStateCallback): void;
2919
+ function createState(name: string, initValue: iobJS.StateValue, callback?: iobJS.SetStateCallback): void;
1564
2920
 
1565
2921
  function createState(name: string, common: Partial<iobJS.StateCommon>, callback?: iobJS.SetStateCallback): void;
1566
2922
  function createState(
1567
2923
  name: string,
1568
- initValue: ioBroker.StateValue,
2924
+ initValue: iobJS.StateValue,
1569
2925
  common: Partial<iobJS.StateCommon>,
1570
2926
  callback?: iobJS.SetStateCallback,
1571
2927
  ): void;
@@ -1577,7 +2933,7 @@ declare global {
1577
2933
  ): void;
1578
2934
  function createState(
1579
2935
  name: string,
1580
- initValue: ioBroker.StateValue,
2936
+ initValue: iobJS.StateValue,
1581
2937
  common: Partial<iobJS.StateCommon>,
1582
2938
  native: any,
1583
2939
  callback?: iobJS.SetStateCallback,
@@ -1585,7 +2941,7 @@ declare global {
1585
2941
 
1586
2942
  function createStateAsync(
1587
2943
  name: string,
1588
- initValue?: ioBroker.StateValue,
2944
+ initValue?: iobJS.StateValue,
1589
2945
  forceCreation?: boolean,
1590
2946
  common?: Partial<iobJS.StateCommon>,
1591
2947
  native?: any,
@@ -1594,12 +2950,12 @@ declare global {
1594
2950
  function createStateAsync(name: string, common: Partial<iobJS.StateCommon>, native?: any): iobJS.SetStatePromise;
1595
2951
  function createStateAsync(
1596
2952
  name: string,
1597
- initValue: ioBroker.StateValue,
2953
+ initValue: iobJS.StateValue,
1598
2954
  common: Partial<iobJS.StateCommon>,
1599
2955
  ): iobJS.SetStatePromise;
1600
2956
  function createStateAsync(
1601
2957
  name: string,
1602
- initValue: ioBroker.StateValue,
2958
+ initValue: iobJS.StateValue,
1603
2959
  common: Partial<iobJS.StateCommon>,
1604
2960
  native?: any,
1605
2961
  ): iobJS.SetStatePromise;
@@ -1662,6 +3018,7 @@ declare global {
1662
3018
  /**
1663
3019
  * Deletes the state with the given ID
1664
3020
  *
3021
+ * @param id The ID of the state to be deleted
1665
3022
  * @param callback (optional) Is called after the state was deleted (or not).
1666
3023
  */
1667
3024
  function deleteState(id: string, callback?: GenericCallback<boolean>): void;
@@ -1748,6 +3105,9 @@ declare global {
1748
3105
  /**
1749
3106
  * Compares two or more times
1750
3107
  *
3108
+ * @param startTime - The start time to compare with
3109
+ * @param endTime - The end time to compare with
3110
+ * @param operation - The operation to use for comparison. Possible values:
1751
3111
  * @param timeToCompare - The time to compare with startTime and/or endTime. If none is given, the current time is used
1752
3112
  */
1753
3113
  function compareTime(