@3e/sqa-common 6.17.0-20 → 6.17.0-21

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 (4) hide show
  1. package/index.d.ts +39 -1231
  2. package/package.json +6 -2
  3. package/sqa_common.js +56 -56
  4. package/types.ts +1230 -0
package/index.d.ts CHANGED
@@ -1,1237 +1,45 @@
1
- import * as Highcharts from 'highcharts'
2
-
1
+ import {
2
+ ApiFn,
3
+ ColorScheme,
4
+ ColorSettings,
5
+ ColorSchemeValue,
6
+ DashboardLevel,
7
+ EmptyViewOptions,
8
+ Granularity,
9
+ InitialisationConfig,
10
+ Level,
11
+ MeasurementsTable,
12
+ Period,
13
+ SQView,
14
+ Timezone,
15
+ TimezoneValue,
16
+ TokenThunk,
17
+ ViewType,
18
+ VisualisationOptions,
19
+ Visualization,
20
+ StackingOption,
21
+ TimezoneMode,
22
+ Representation,
23
+ LdTypeOption,
24
+ LevelValue,
25
+ Container,
26
+ ContainerValue,
27
+ Template,
28
+ ISODateString,
29
+ PeriodTimeMode,
30
+ Dataset,
31
+ SaveDataJobResponse,
32
+ LdTypeValue,
33
+ DatasetOptions,
34
+ DatasetTemplateSpec,
35
+ PacoViewParameters,
36
+ Parameter,
37
+ } from './types'
3
38
  /**
4
39
  * Type declarations for the @3e/sqa-common module
5
40
  */
6
41
  declare module '@3e/sqa-common' {
7
- export type TimezoneValue =
8
- | 'Asia/Aden'
9
- | 'America/Cuiaba'
10
- | 'Etc/GMT+9'
11
- | 'Etc/GMT+8'
12
- | 'Africa/Nairobi'
13
- | 'America/Marigot'
14
- | 'Asia/Aqtau'
15
- | 'Pacific/Kwajalein'
16
- | 'America/El_Salvador'
17
- | 'Asia/Pontianak'
18
- | 'Africa/Cairo'
19
- | 'Pacific/Pago_Pago'
20
- | 'Africa/Mbabane'
21
- | 'Asia/Kuching'
22
- | 'Pacific/Honolulu'
23
- | 'Pacific/Rarotonga'
24
- | 'America/Guatemala'
25
- | 'Australia/Hobart'
26
- | 'Europe/London'
27
- | 'America/Belize'
28
- | 'America/Panama'
29
- | 'Asia/Chungking'
30
- | 'America/Managua'
31
- | 'America/Indiana/Petersburg'
32
- | 'Asia/Yerevan'
33
- | 'Europe/Brussels'
34
- | 'GMT'
35
- | 'Europe/Warsaw'
36
- | 'America/Chicago'
37
- | 'Asia/Kashgar'
38
- | 'Chile/Continental'
39
- | 'Pacific/Yap'
40
- | 'CET'
41
- | 'Etc/GMT-1'
42
- | 'Etc/GMT-0'
43
- | 'Europe/Jersey'
44
- | 'America/Tegucigalpa'
45
- | 'Etc/GMT-5'
46
- | 'Europe/Istanbul'
47
- | 'America/Eirunepe'
48
- | 'Etc/GMT-4'
49
- | 'America/Miquelon'
50
- | 'Etc/GMT-3'
51
- | 'Europe/Luxembourg'
52
- | 'Etc/GMT-2'
53
- | 'Etc/GMT-9'
54
- | 'America/Argentina/Catamarca'
55
- | 'Etc/GMT-8'
56
- | 'Etc/GMT-7'
57
- | 'Etc/GMT-6'
58
- | 'Europe/Zaporozhye'
59
- | 'Canada/Yukon'
60
- | 'Canada/Atlantic'
61
- | 'Atlantic/St_Helena'
62
- | 'Australia/Tasmania'
63
- | 'Libya'
64
- | 'Europe/Guernsey'
65
- | 'America/Grand_Turk'
66
- | 'Asia/Samarkand'
67
- | 'America/Argentina/Cordoba'
68
- | 'Asia/Phnom_Penh'
69
- | 'Africa/Kigali'
70
- | 'Asia/Almaty'
71
- | 'US/Alaska'
72
- | 'Asia/Dubai'
73
- | 'Europe/Isle_of_Man'
74
- | 'America/Araguaina'
75
- | 'Cuba'
76
- | 'Asia/Novosibirsk'
77
- | 'America/Argentina/Salta'
78
- | 'Etc/GMT+3'
79
- | 'Africa/Tunis'
80
- | 'Etc/GMT+2'
81
- | 'Etc/GMT+1'
82
- | 'Pacific/Fakaofo'
83
- | 'Africa/Tripoli'
84
- | 'Etc/GMT+0'
85
- | 'Israel'
86
- | 'Africa/Banjul'
87
- | 'Etc/GMT+7'
88
- | 'Indian/Comoro'
89
- | 'Etc/GMT+6'
90
- | 'Etc/GMT+5'
91
- | 'Etc/GMT+4'
92
- | 'Pacific/Port_Moresby'
93
- | 'US/Arizona'
94
- | 'Antarctica/Syowa'
95
- | 'Indian/Reunion'
96
- | 'Pacific/Palau'
97
- | 'Europe/Kaliningrad'
98
- | 'America/Montevideo'
99
- | 'Africa/Windhoek'
100
- | 'Asia/Karachi'
101
- | 'Africa/Mogadishu'
102
- | 'Australia/Perth'
103
- | 'Brazil/East'
104
- | 'Etc/GMT'
105
- | 'Asia/Chita'
106
- | 'Pacific/Easter'
107
- | 'Antarctica/Davis'
108
- | 'Antarctica/McMurdo'
109
- | 'Asia/Macao'
110
- | 'America/Manaus'
111
- | 'Africa/Freetown'
112
- | 'Europe/Bucharest'
113
- | 'Asia/Tomsk'
114
- | 'America/Argentina/Mendoza'
115
- | 'Asia/Macau'
116
- | 'Europe/Malta'
117
- | 'Mexico/BajaSur'
118
- | 'Pacific/Tahiti'
119
- | 'Africa/Asmera'
120
- | 'Europe/Busingen'
121
- | 'America/Argentina/Rio_Gallegos'
122
- | 'Africa/Malabo'
123
- | 'Europe/Skopje'
124
- | 'America/Catamarca'
125
- | 'America/Godthab'
126
- | 'Europe/Sarajevo'
127
- | 'Australia/ACT'
128
- | 'GB-Eire'
129
- | 'Africa/Lagos'
130
- | 'America/Cordoba'
131
- | 'Europe/Rome'
132
- | 'Asia/Dacca'
133
- | 'Indian/Mauritius'
134
- | 'Pacific/Samoa'
135
- | 'America/Regina'
136
- | 'America/Fort_Wayne'
137
- | 'America/Dawson_Creek'
138
- | 'Africa/Algiers'
139
- | 'Europe/Mariehamn'
140
- | 'America/St_Johns'
141
- | 'America/St_Thomas'
142
- | 'Europe/Zurich'
143
- | 'America/Anguilla'
144
- | 'Asia/Dili'
145
- | 'America/Denver'
146
- | 'Africa/Bamako'
147
- | 'Europe/Saratov'
148
- | 'GB'
149
- | 'Mexico/General'
150
- | 'Pacific/Wallis'
151
- | 'Europe/Gibraltar'
152
- | 'Africa/Conakry'
153
- | 'Africa/Lubumbashi'
154
- | 'Asia/Istanbul'
155
- | 'America/Havana'
156
- | 'NZ-CHAT'
157
- | 'Asia/Choibalsan'
158
- | 'America/Porto_Acre'
159
- | 'Asia/Omsk'
160
- | 'Europe/Vaduz'
161
- | 'US/Michigan'
162
- | 'Asia/Dhaka'
163
- | 'America/Barbados'
164
- | 'Europe/Tiraspol'
165
- | 'Atlantic/Cape_Verde'
166
- | 'Asia/Yekaterinburg'
167
- | 'America/Louisville'
168
- | 'Pacific/Johnston'
169
- | 'Pacific/Chatham'
170
- | 'Europe/Ljubljana'
171
- | 'America/Sao_Paulo'
172
- | 'Asia/Jayapura'
173
- | 'America/Curacao'
174
- | 'Asia/Dushanbe'
175
- | 'America/Guyana'
176
- | 'America/Guayaquil'
177
- | 'America/Martinique'
178
- | 'Portugal'
179
- | 'Europe/Berlin'
180
- | 'Europe/Moscow'
181
- | 'Europe/Chisinau'
182
- | 'America/Puerto_Rico'
183
- | 'America/Rankin_Inlet'
184
- | 'Pacific/Ponape'
185
- | 'Europe/Stockholm'
186
- | 'Europe/Budapest'
187
- | 'America/Argentina/Jujuy'
188
- | 'Australia/Eucla'
189
- | 'Asia/Shanghai'
190
- | 'Universal'
191
- | 'Europe/Zagreb'
192
- | 'America/Port_of_Spain'
193
- | 'Europe/Helsinki'
194
- | 'Asia/Beirut'
195
- | 'Asia/Tel_Aviv'
196
- | 'Pacific/Bougainville'
197
- | 'US/Central'
198
- | 'Africa/Sao_Tome'
199
- | 'Indian/Chagos'
200
- | 'America/Cayenne'
201
- | 'Asia/Yakutsk'
202
- | 'Pacific/Galapagos'
203
- | 'Australia/North'
204
- | 'Europe/Paris'
205
- | 'Africa/Ndjamena'
206
- | 'Pacific/Fiji'
207
- | 'America/Rainy_River'
208
- | 'Indian/Maldives'
209
- | 'Australia/Yancowinna'
210
- | 'SystemV/AST4'
211
- | 'Asia/Oral'
212
- | 'America/Yellowknife'
213
- | 'Pacific/Enderbury'
214
- | 'America/Juneau'
215
- | 'Australia/Victoria'
216
- | 'America/Indiana/Vevay'
217
- | 'Asia/Tashkent'
218
- | 'Asia/Jakarta'
219
- | 'Africa/Ceuta'
220
- | 'Asia/Barnaul'
221
- | 'America/Recife'
222
- | 'America/Buenos_Aires'
223
- | 'America/Noronha'
224
- | 'America/Swift_Current'
225
- | 'Australia/Adelaide'
226
- | 'America/Metlakatla'
227
- | 'Africa/Djibouti'
228
- | 'America/Paramaribo'
229
- | 'Asia/Qostanay'
230
- | 'Europe/Simferopol'
231
- | 'Europe/Sofia'
232
- | 'Africa/Nouakchott'
233
- | 'Europe/Prague'
234
- | 'America/Indiana/Vincennes'
235
- | 'Antarctica/Mawson'
236
- | 'America/Kralendijk'
237
- | 'Antarctica/Troll'
238
- | 'Europe/Samara'
239
- | 'Indian/Christmas'
240
- | 'America/Antigua'
241
- | 'Pacific/Gambier'
242
- | 'America/Indianapolis'
243
- | 'America/Inuvik'
244
- | 'America/Iqaluit'
245
- | 'Pacific/Funafuti'
246
- | 'UTC'
247
- | 'Antarctica/Macquarie'
248
- | 'Canada/Pacific'
249
- | 'America/Moncton'
250
- | 'Africa/Gaborone'
251
- | 'Pacific/Chuuk'
252
- | 'Asia/Pyongyang'
253
- | 'America/St_Vincent'
254
- | 'Asia/Gaza'
255
- | 'Etc/Universal'
256
- | 'PST8PDT'
257
- | 'Atlantic/Faeroe'
258
- | 'Asia/Qyzylorda'
259
- | 'Canada/Newfoundland'
260
- | 'America/Kentucky/Louisville'
261
- | 'America/Yakutat'
262
- | 'Asia/Ho_Chi_Minh'
263
- | 'Antarctica/Casey'
264
- | 'Europe/Copenhagen'
265
- | 'Africa/Asmara'
266
- | 'Atlantic/Azores'
267
- | 'Europe/Vienna'
268
- | 'ROK'
269
- | 'Pacific/Pitcairn'
270
- | 'America/Mazatlan'
271
- | 'Australia/Queensland'
272
- | 'Pacific/Nauru'
273
- | 'Europe/Tirane'
274
- | 'Asia/Kolkata'
275
- | 'SystemV/MST7'
276
- | 'Australia/Canberra'
277
- | 'MET'
278
- | 'Australia/Broken_Hill'
279
- | 'Europe/Riga'
280
- | 'America/Dominica'
281
- | 'Africa/Abidjan'
282
- | 'America/Mendoza'
283
- | 'America/Santarem'
284
- | 'Kwajalein'
285
- | 'America/Asuncion'
286
- | 'Asia/Ulan_Bator'
287
- | 'NZ'
288
- | 'America/Boise'
289
- | 'Australia/Currie'
290
- | 'EST5EDT'
291
- | 'Pacific/Guam'
292
- | 'Pacific/Wake'
293
- | 'Atlantic/Bermuda'
294
- | 'America/Costa_Rica'
295
- | 'America/Dawson'
296
- | 'Asia/Chongqing'
297
- | 'Eire'
298
- | 'Europe/Amsterdam'
299
- | 'America/Indiana/Knox'
300
- | 'America/North_Dakota/Beulah'
301
- | 'Africa/Accra'
302
- | 'Atlantic/Faroe'
303
- | 'Mexico/BajaNorte'
304
- | 'America/Maceio'
305
- | 'Etc/UCT'
306
- | 'Pacific/Apia'
307
- | 'GMT0'
308
- | 'America/Atka'
309
- | 'Pacific/Niue'
310
- | 'Australia/Lord_Howe'
311
- | 'Europe/Dublin'
312
- | 'Pacific/Truk'
313
- | 'MST7MDT'
314
- | 'America/Monterrey'
315
- | 'America/Nassau'
316
- | 'America/Jamaica'
317
- | 'Asia/Bishkek'
318
- | 'America/Atikokan'
319
- | 'Atlantic/Stanley'
320
- | 'Australia/NSW'
321
- | 'US/Hawaii'
322
- | 'SystemV/CST6'
323
- | 'Indian/Mahe'
324
- | 'Asia/Aqtobe'
325
- | 'America/Sitka'
326
- | 'Asia/Vladivostok'
327
- | 'Africa/Libreville'
328
- | 'Africa/Maputo'
329
- | 'Zulu'
330
- | 'America/Kentucky/Monticello'
331
- | 'Africa/El_Aaiun'
332
- | 'Africa/Ouagadougou'
333
- | 'America/Coral_Harbour'
334
- | 'Pacific/Marquesas'
335
- | 'Brazil/West'
336
- | 'America/Aruba'
337
- | 'America/North_Dakota/Center'
338
- | 'America/Cayman'
339
- | 'Asia/Ulaanbaatar'
340
- | 'Asia/Baghdad'
341
- | 'Europe/San_Marino'
342
- | 'America/Indiana/Tell_City'
343
- | 'America/Tijuana'
344
- | 'Pacific/Saipan'
345
- | 'SystemV/YST9'
346
- | 'Africa/Douala'
347
- | 'America/Chihuahua'
348
- | 'America/Ojinaga'
349
- | 'Asia/Hovd'
350
- | 'America/Anchorage'
351
- | 'Chile/EasterIsland'
352
- | 'America/Halifax'
353
- | 'Antarctica/Rothera'
354
- | 'America/Indiana/Indianapolis'
355
- | 'US/Mountain'
356
- | 'Asia/Damascus'
357
- | 'America/Argentina/San_Luis'
358
- | 'America/Santiago'
359
- | 'Asia/Baku'
360
- | 'America/Argentina/Ushuaia'
361
- | 'Atlantic/Reykjavik'
362
- | 'Africa/Brazzaville'
363
- | 'Africa/Porto-Novo'
364
- | 'America/La_Paz'
365
- | 'Antarctica/DumontDUrville'
366
- | 'Asia/Taipei'
367
- | 'Antarctica/South_Pole'
368
- | 'Asia/Manila'
369
- | 'Asia/Bangkok'
370
- | 'Africa/Dar_es_Salaam'
371
- | 'Poland'
372
- | 'Atlantic/Madeira'
373
- | 'Antarctica/Palmer'
374
- | 'America/Thunder_Bay'
375
- | 'Africa/Addis_Ababa'
376
- | 'Asia/Yangon'
377
- | 'Europe/Uzhgorod'
378
- | 'Brazil/DeNoronha'
379
- | 'Asia/Ashkhabad'
380
- | 'Etc/Zulu'
381
- | 'America/Indiana/Marengo'
382
- | 'America/Creston'
383
- | 'America/Punta_Arenas'
384
- | 'America/Mexico_City'
385
- | 'Antarctica/Vostok'
386
- | 'Asia/Jerusalem'
387
- | 'Europe/Andorra'
388
- | 'US/Samoa'
389
- | 'PRC'
390
- | 'Asia/Vientiane'
391
- | 'Pacific/Kiritimati'
392
- | 'America/Matamoros'
393
- | 'America/Blanc-Sablon'
394
- | 'Asia/Riyadh'
395
- | 'Iceland'
396
- | 'Pacific/Pohnpei'
397
- | 'Asia/Ujung_Pandang'
398
- | 'Atlantic/South_Georgia'
399
- | 'Europe/Lisbon'
400
- | 'Asia/Harbin'
401
- | 'Europe/Oslo'
402
- | 'Asia/Novokuznetsk'
403
- | 'CST6CDT'
404
- | 'Atlantic/Canary'
405
- | 'America/Knox_IN'
406
- | 'Asia/Kuwait'
407
- | 'SystemV/HST10'
408
- | 'Pacific/Efate'
409
- | 'Africa/Lome'
410
- | 'America/Bogota'
411
- | 'America/Menominee'
412
- | 'America/Adak'
413
- | 'Pacific/Norfolk'
414
- | 'Europe/Kirov'
415
- | 'America/Resolute'
416
- | 'Pacific/Tarawa'
417
- | 'Africa/Kampala'
418
- | 'Asia/Krasnoyarsk'
419
- | 'Greenwich'
420
- | 'SystemV/EST5'
421
- | 'America/Edmonton'
422
- | 'Europe/Podgorica'
423
- | 'Australia/South'
424
- | 'Canada/Central'
425
- | 'Africa/Bujumbura'
426
- | 'America/Santo_Domingo'
427
- | 'US/Eastern'
428
- | 'Europe/Minsk'
429
- | 'Pacific/Auckland'
430
- | 'Africa/Casablanca'
431
- | 'America/Glace_Bay'
432
- | 'Canada/Eastern'
433
- | 'Asia/Qatar'
434
- | 'Europe/Kiev'
435
- | 'Singapore'
436
- | 'Asia/Magadan'
437
- | 'SystemV/PST8'
438
- | 'America/Port-au-Prince'
439
- | 'Europe/Belfast'
440
- | 'America/St_Barthelemy'
441
- | 'Asia/Ashgabat'
442
- | 'Africa/Luanda'
443
- | 'America/Nipigon'
444
- | 'Atlantic/Jan_Mayen'
445
- | 'Brazil/Acre'
446
- | 'Asia/Muscat'
447
- | 'Asia/Bahrain'
448
- | 'Europe/Vilnius'
449
- | 'America/Fortaleza'
450
- | 'Etc/GMT0'
451
- | 'US/East-Indiana'
452
- | 'America/Hermosillo'
453
- | 'America/Cancun'
454
- | 'Africa/Maseru'
455
- | 'Pacific/Kosrae'
456
- | 'Africa/Kinshasa'
457
- | 'Asia/Kathmandu'
458
- | 'Asia/Seoul'
459
- | 'Australia/Sydney'
460
- | 'America/Lima'
461
- | 'Australia/LHI'
462
- | 'America/St_Lucia'
463
- | 'Europe/Madrid'
464
- | 'America/Bahia_Banderas'
465
- | 'America/Montserrat'
466
- | 'Asia/Brunei'
467
- | 'America/Santa_Isabel'
468
- | 'Canada/Mountain'
469
- | 'America/Cambridge_Bay'
470
- | 'Asia/Colombo'
471
- | 'Australia/West'
472
- | 'Indian/Antananarivo'
473
- | 'Australia/Brisbane'
474
- | 'Indian/Mayotte'
475
- | 'US/Indiana-Starke'
476
- | 'Asia/Urumqi'
477
- | 'US/Aleutian'
478
- | 'Europe/Volgograd'
479
- | 'America/Lower_Princes'
480
- | 'America/Vancouver'
481
- | 'Africa/Blantyre'
482
- | 'America/Rio_Branco'
483
- | 'America/Danmarkshavn'
484
- | 'America/Detroit'
485
- | 'America/Thule'
486
- | 'Africa/Lusaka'
487
- | 'Asia/Hong_Kong'
488
- | 'Iran'
489
- | 'America/Argentina/La_Rioja'
490
- | 'Africa/Dakar'
491
- | 'SystemV/CST6CDT'
492
- | 'America/Tortola'
493
- | 'America/Porto_Velho'
494
- | 'Asia/Sakhalin'
495
- | 'Etc/GMT+10'
496
- | 'America/Scoresbysund'
497
- | 'Asia/Kamchatka'
498
- | 'Asia/Thimbu'
499
- | 'Africa/Harare'
500
- | 'Etc/GMT+12'
501
- | 'Etc/GMT+11'
502
- | 'Navajo'
503
- | 'America/Nome'
504
- | 'Europe/Tallinn'
505
- | 'Turkey'
506
- | 'Africa/Khartoum'
507
- | 'Africa/Johannesburg'
508
- | 'Africa/Bangui'
509
- | 'Europe/Belgrade'
510
- | 'Jamaica'
511
- | 'Africa/Bissau'
512
- | 'Asia/Tehran'
513
- | 'WET'
514
- | 'Europe/Astrakhan'
515
- | 'Africa/Juba'
516
- | 'America/Campo_Grande'
517
- | 'America/Belem'
518
- | 'Etc/Greenwich'
519
- | 'Asia/Saigon'
520
- | 'America/Ensenada'
521
- | 'Pacific/Midway'
522
- | 'America/Jujuy'
523
- | 'Africa/Timbuktu'
524
- | 'America/Bahia'
525
- | 'America/Goose_Bay'
526
- | 'America/Virgin'
527
- | 'America/Pangnirtung'
528
- | 'Asia/Katmandu'
529
- | 'America/Phoenix'
530
- | 'Africa/Niamey'
531
- | 'America/Whitehorse'
532
- | 'Pacific/Noumea'
533
- | 'Asia/Tbilisi'
534
- | 'America/Montreal'
535
- | 'Asia/Makassar'
536
- | 'America/Argentina/San_Juan'
537
- | 'Hongkong'
538
- | 'UCT'
539
- | 'Asia/Nicosia'
540
- | 'America/Indiana/Winamac'
541
- | 'SystemV/MST7MDT'
542
- | 'America/Argentina/ComodRivadavia'
543
- | 'America/Boa_Vista'
544
- | 'America/Grenada'
545
- | 'Asia/Atyrau'
546
- | 'Australia/Darwin'
547
- | 'Asia/Khandyga'
548
- | 'Asia/Kuala_Lumpur'
549
- | 'Asia/Famagusta'
550
- | 'Asia/Thimphu'
551
- | 'Asia/Rangoon'
552
- | 'Europe/Bratislava'
553
- | 'Asia/Calcutta'
554
- | 'America/Argentina/Tucuman'
555
- | 'Asia/Kabul'
556
- | 'Indian/Cocos'
557
- | 'Japan'
558
- | 'Pacific/Tongatapu'
559
- | 'America/New_York'
560
- | 'Etc/GMT-12'
561
- | 'Etc/GMT-11'
562
- | 'America/Nuuk'
563
- | 'Etc/GMT-10'
564
- | 'SystemV/YST9YDT'
565
- | 'Europe/Ulyanovsk'
566
- | 'Etc/GMT-14'
567
- | 'Etc/GMT-13'
568
- | 'W-SU'
569
- | 'America/Merida'
570
- | 'EET'
571
- | 'America/Rosario'
572
- | 'Canada/Saskatchewan'
573
- | 'America/St_Kitts'
574
- | 'Arctic/Longyearbyen'
575
- | 'America/Fort_Nelson'
576
- | 'America/Caracas'
577
- | 'America/Guadeloupe'
578
- | 'Asia/Hebron'
579
- | 'Indian/Kerguelen'
580
- | 'SystemV/PST8PDT'
581
- | 'Africa/Monrovia'
582
- | 'Asia/Ust-Nera'
583
- | 'Egypt'
584
- | 'Asia/Srednekolymsk'
585
- | 'America/North_Dakota/New_Salem'
586
- | 'Asia/Anadyr'
587
- | 'Australia/Melbourne'
588
- | 'Asia/Irkutsk'
589
- | 'America/Shiprock'
590
- | 'America/Winnipeg'
591
- | 'Europe/Vatican'
592
- | 'Asia/Amman'
593
- | 'Etc/UTC'
594
- | 'SystemV/AST4ADT'
595
- | 'Asia/Tokyo'
596
- | 'America/Toronto'
597
- | 'Asia/Singapore'
598
- | 'Australia/Lindeman'
599
- | 'America/Los_Angeles'
600
- | 'SystemV/EST5EDT'
601
- | 'Pacific/Majuro'
602
- | 'America/Argentina/Buenos_Aires'
603
- | 'Europe/Nicosia'
604
- | 'Pacific/Guadalcanal'
605
- | 'Europe/Athens'
606
- | 'US/Pacific'
607
- | 'Europe/Monaco'
608
-
609
- export type ErrorStatus = 400 | 401 | 403 | 409 | 500 | 503 | 501
610
- export type OKStatus = 200 | 201 | 202 | 205
611
-
612
- export interface Artifact {
613
- type: string
614
- version: string
615
- }
616
-
617
- export interface EmptySection {
618
- id: string
619
- body: []
620
- class: 'Section'
621
- }
622
-
623
- export interface Timezone {
624
- value: TimezoneValue
625
- label: string
626
- }
627
-
628
- export type TimezoneMode = 'user' | 'plant'
629
-
630
- export interface ConfigSection {
631
- id: 'config'
632
- view: {
633
- id: 'view'
634
- label: string
635
- view_type: ViewType
636
- parameters: {_ref: ['parameters']; class: 'Section'; _schema: '_ref'}
637
- description: string
638
- color_scheme: string
639
- data_set_sets: {
640
- _ref: ['data_set_sets']
641
- class: 'Section'
642
- _schema: '_ref'
643
- }
644
- }
645
- class: 'SQView'
646
- }
647
-
648
- export interface BasicParametersSection {
649
- id: 'parameters'
650
- body: [
651
- {
652
- id: 'Period'
653
- class: 'Parameter'
654
- parameter: {class: 'Period'; label: 'Period'; initial: Period}
655
- },
656
- {
657
- id: 'Granularity'
658
- class: 'Parameter'
659
- parameter: {
660
- class: 'Granularity'
661
- label: 'Granularity'
662
- initial: Granularity
663
- }
664
- },
665
- ]
666
- class: 'Section'
667
- }
668
-
669
- export type Section = BasicParametersSection | ConfigSection | EmptySection
670
-
671
- export interface SQView {
672
- version: string
673
- artifact: Artifact
674
- body: Section[]
675
- }
676
-
677
- export type Parameters = {
678
- class: string
679
- id: string
680
- }
681
-
682
- export type ViewData = SQView & {
683
- artifact: {
684
- type: string
685
- version: string
686
- }
687
- body: {
688
- body: Parameters[]
689
- class: string
690
- id: string
691
- }[]
692
- version: string
693
- }
694
-
695
- export type ParameterOption = {
696
- options: {value: string; label: string}[]
697
- id: string
698
- label: string
699
- ldType: string
700
- container?: string
701
- value: string
702
- }
703
-
704
- export interface ApiConfig extends RequestInit {
705
- token?: string
706
- body?: any
707
- }
708
-
709
- export type ApiFn = (
710
- endpoint: string,
711
- config?: ApiConfig,
712
- ) => Promise<
713
- {status: ErrorStatus} | {body: Record<string, any>; status: OKStatus}
714
- >
715
-
716
- export type TokenThunk = () => Promise<
717
- {status: OKStatus; body: {token: string}} | {status: ErrorStatus}
718
- >
719
-
720
- export interface InitialisationConfig {
721
- apiFn: ApiFn
722
- }
723
-
724
- export type PeriodTimeMode = 'absolute' | 'local'
725
-
726
- export type ViewType =
727
- | 'time-chart'
728
- | 'object-chart'
729
- | 'object-heatmap'
730
- | 'scatter-chart'
731
- | 'object-table'
732
- | 'time-table'
733
- | 'kpis'
734
-
735
- export type Granularity =
736
- | '1-days'
737
- | '1-hours'
738
- | '1-minutes'
739
- | '1-months'
740
- | '1-weeks'
741
- | '1-years'
742
- | '10-minutes'
743
- | '15-minutes'
744
- | '3-months'
745
- | '30-minutes'
746
- | '5-minutes'
747
- | 'change'
748
- | 'normalized'
749
- | 'raw'
750
- | 'scaled'
751
- | 'statelog'
752
-
753
- export type Period =
754
- | 'last-15-minutes'
755
- | 'last-30-minutes'
756
- | 'last-60-minutes'
757
- | 'last-120-minutes'
758
- | 'last-24-hours'
759
- | 'today'
760
- | 'yesterday'
761
- | 'tomorrow'
762
- | 'last-3-days'
763
- | 'last-7-days'
764
- | 'last-7x24-hours'
765
- | 'last-3x24-hours'
766
- | 'forecast-4-days'
767
- | 'forecast-10-days'
768
- | 'last-week'
769
- | 'current-month'
770
- | 'last-month'
771
- | 'last-30-days'
772
- | 'year-to-date'
773
- | 'last-12-months'
774
- | 'last-year'
775
- | 'since-beginning'
776
- | 'custom'
777
-
778
- export type ShortLDTypeValue =
779
- | 'ac-input'
780
- | 'ac-node'
781
- | 'ac-phase'
782
- | 'account'
783
- | 'battery'
784
- | 'bearing'
785
- | 'blade'
786
- | 'connection'
787
- | 'dc-input'
788
- | 'dc-node'
789
- | 'generator'
790
- | 'inverter'
791
- | 'inverter-device'
792
- | 'logger'
793
- | 'module-group'
794
- | 'mppt'
795
- | 'nacelle'
796
- | 'portfolio'
797
- | 'power-unit'
798
- | 'rotor'
799
- | 'sensor'
800
- | 'site'
801
- | 'site-group'
802
- | 'spv'
803
- | 'strings'
804
- | 'tower'
805
- | 'tracker'
806
- | 'transmission'
807
- | 'turbine'
808
- | 'yaw'
809
-
810
- export type LongLDTypeValue =
811
- | 'sq/ld_type/ac_input'
812
- | 'sq/ld_type/ac_node'
813
- | 'sq/ld_type/ac_phase'
814
- | 'sq/ld_type/account'
815
- | 'sq/ld_type/battery'
816
- | 'sq/ld_type/bearing'
817
- | 'sq/ld_type/blade'
818
- | 'sq/ld_type/connection'
819
- | 'sq/ld_type/dc_input'
820
- | 'sq/ld_type/dc_node'
821
- | 'sq/ld_type/generator'
822
- | 'sq/ld_type/inverter'
823
- | 'sq/ld_type/inverter_device'
824
- | 'sq/ld_type/logger'
825
- | 'sq/ld_type/module_group'
826
- | 'sq/ld_type/mppt'
827
- | 'sq/ld_type/nacelle'
828
- | 'sq/ld_type/portfolio'
829
- | 'sq/ld_type/power_unit'
830
- | 'sq/ld_type/rotor'
831
- | 'sq/ld_type/sensor'
832
- | 'sq/ld_type/site'
833
- | 'sq/ld_type/site_group'
834
- | 'sq/ld_type/spv'
835
- | 'sq/ld_type/strings'
836
- | 'sq/ld_type/tower'
837
- | 'sq/ld_type/tracker'
838
- | 'sq/ld_type/transmission'
839
- | 'sq/ld_type/turbine'
840
- | 'sq/ld_type/yaw'
841
-
842
- export type LdTypeValue = ShortLDTypeValue | LongLDTypeValue
843
-
844
- export type LevelValue =
845
- | 'site-group'
846
- | 'site'
847
- | 'ac-node'
848
- | 'ac-input'
849
- | 'ac-phase'
850
- | 'connection'
851
- | 'dc-input'
852
- | 'dc-node'
853
- | 'inverter'
854
- | 'inverter-device'
855
- | 'logger'
856
- | 'mppt'
857
- | 'module-group'
858
- | 'power-unit'
859
- | 'sensor'
860
- | 'strings'
861
- | 'tracker'
862
- | 'turbine'
863
-
864
- export type DashboardLevel =
865
- | 'site-group'
866
- | 'site'
867
- | 'ac-node'
868
- | 'inverter'
869
- | 'turbine'
870
-
871
- export type RepresentationValue =
872
- | 'line'
873
- | 'line-and-marker'
874
- | 'marker'
875
- | 'spline'
876
- | 'column'
877
- | 'area'
878
-
879
- export type StackingOptionValue = 'no' | 'normal' | 'percent'
880
-
881
- export type StackingOption = {value: StackingOptionValue; label: string}
882
-
883
- export type Representation = {
884
- value: RepresentationValue
885
- label: string
886
- }
887
-
888
- export type Level = {
889
- value: LevelValue
890
- label: string
891
- models?: {label: string; value: string}[]
892
- }
893
-
894
- /**
895
- * Logical device type
896
- */
897
- export type LDType = {
898
- value: string
899
- label: string
900
- }
901
-
902
- export type ContainerValue = string
903
-
904
- /**
905
- * Containers (Actually physical plants)
906
- */
907
- export type Container = {
908
- value: string
909
- label: string
910
- }
911
-
912
- export type Template = {
913
- value: string
914
- label: string
915
- }
916
-
917
- export interface EmptyViewOptions {
918
- viewType: ViewType
919
- label: string
920
- /**
921
- * @default "15-minutes"
922
- */
923
- granularity?: Granularity
924
- /**
925
- * @default "last-24-hours"
926
- */
927
- period?: Period
928
- }
929
-
930
- export interface VisualisationOptions {
931
- showLegend: boolean
932
- showTitle: boolean
933
- }
934
-
935
- /**
936
- * ISO local datetime string (YYYY-MM-DDTHH:mm:ss.SSS).
937
- */
938
- export type ISODateString = string
939
-
940
- export type ColorSchemeValue = 'scheme_blrd' | 'scheme_ylrdbl'
941
-
942
- export type ColorSettings =
943
- | {
944
- label: string
945
- value: string
946
- type: 'palette'
947
- colors: string[]
948
- }
949
- | {label: string; value: string; type: 'fixed'; color: string}
950
-
951
- export type ColorScheme = {
952
- value: ColorSchemeValue
953
- label: string
954
- type?: string
955
- stops?: [number, string][]
956
- }
957
-
958
- export type MeasurementsRowExtraInfo = {
959
- indicator?: {
960
- label: string
961
- indicator_label: string
962
- reference_label: string
963
- unit: string
964
- unit_key: string
965
- description: string
966
- key: string
967
- default_graphical_representation: string
968
- level: LevelValue
969
- }
970
- object?: {
971
- name: string
972
- level: LevelValue
973
- ref: string
974
- }
975
- }
976
-
977
- /**
978
- * Since in a table row the data is represented as: `[object-name, indicator1-value, indicator2-value, ...]`
979
- * while the indicators in the meta are: `[indicator1, indicator2, ...]`
980
- * In order to access the correct indicator in the meta, be sure to go for the `columnIndex - 1` indicator in the `indicators` array from the meta.
981
- *
982
- *
983
- * For objects, the correct object index is the index of the full row
984
- */
985
- export type ObjectsTableMetaRowInfo = {
986
- indicators: {
987
- label: string
988
- indicator_label: string
989
- reference_label: string
990
- unit?: string
991
- unit_key: string
992
- description: string
993
- key: string
994
- default_graphical_representation: string
995
- level: LevelValue
996
- }[]
997
- objects: {
998
- name: string
999
- level: LevelValue
1000
- ref: string
1001
- label: string
1002
- }
1003
- }
1004
-
1005
- export type TimeTableMetaRowInfo = {
1006
- [key: string]: {
1007
- indicator: Indicator
1008
- object: Object
1009
- }
1010
- }
1011
-
1012
- export type MeasurementsTable = {
1013
- meta: {
1014
- rows: MeasurementsRowExtraInfo[]
1015
- primaryObject: string
1016
- }
1017
- header: string[]
1018
- rows: (string | number | null)[][]
1019
- }
1020
-
1021
- export type HighChartsSpec = {
1022
- display: 'highcharts'
1023
- chart: {_SQ_: {type: ViewType}; zoomType: string; animation: boolean}
1024
- } & Highcharts.Options
1025
-
1026
- export type TableSpec = {
1027
- display: 'table'
1028
- meta?: {
1029
- type: 'time_table'
1030
- rows: TimeTableMetaRowInfo
1031
- } | {
1032
- type: 'object_table'
1033
- rows: ObjectsTableMetaRowInfo
1034
- }
1035
- title?: string
1036
- header: string[]
1037
- rows: (number | string)[][]
1038
- }
1039
-
1040
- export type MessageSpec = {
1041
- display: 'message'
1042
- label: string
1043
- value: string
1044
- }
1045
- export type KPI = {
1046
- kpi: string
1047
- value: string | number
1048
- }
1049
-
1050
- export type KPISpec = {
1051
- display: 'kpis'
1052
- title: {text: string}
1053
- object: Object
1054
- kpis: KPI[]
1055
- }
1056
-
1057
- export type VisualizationSpec = TableSpec | MessageSpec | HighChartsSpec | KPISpec
1058
-
1059
-
1060
- export interface Visualization {
1061
- data: {
1062
- datasets: Dataset[]
1063
- date_from: ISODateString
1064
- date_to: ISODateString
1065
- period_time_mode: string
1066
- clock_or_calendar_mode: string
1067
- granularity: Granularity
1068
- }
1069
- error?: boolean
1070
- options: VisualisationOptions
1071
- info: {title: string; type: ViewType; color_scheme: ColorSchemeValue}
1072
- values: {}
1073
- disableIncrementalUpdates: boolean
1074
- spec: VisualizationSpec
1075
- }
1076
-
1077
- export interface LdType {
1078
- sqid: string
1079
- ref: string
1080
- label: string
1081
- }
1082
-
1083
- export interface LDRoot {
1084
- sqid: string
1085
- ref: string
1086
- label: string
1087
- }
1088
-
1089
- export interface Model {
1090
- sqid: string
1091
- ref: string
1092
- label: string
1093
- }
1094
-
1095
- export interface LogicalDevice {
1096
- sqid: string
1097
- ld_type: string
1098
- ref: string
1099
- root: LDRoot
1100
- label: string
1101
- full_name: string
1102
- act_to: Date
1103
- act_from: Date
1104
- model: Model
1105
- }
1106
-
1107
- export interface Indicator {
1108
- default_graphical_representation: RepresentationValue
1109
- description: string
1110
- key: string
1111
- label: string
1112
- level: LevelValue
1113
- unit: string
1114
- unit_key: string
1115
- }
1116
-
1117
- export interface LDIndicator {
1118
- indicator_key: string
1119
- object_ref: string
1120
- unit: string
1121
- unit_key: string
1122
- }
1123
-
1124
- /**
1125
- * Options for representing the dataset
1126
- */
1127
- export interface DatasetOptions {
1128
- graphicalRepresentation?: string
1129
- id?: string
1130
- colorSetting?: string
1131
- stacking?: StackingOptionValue
1132
- showNullsAs?: string
1133
- label?: string
1134
- }
1135
-
1136
- export interface DatasetTemplateSpec {
1137
- selectedLevel: string
1138
- selectedContainer?: string
1139
- selectedTemplate: string
1140
- }
1141
-
1142
- export interface Object {
1143
- name: string
1144
- level: LevelValue
1145
- ref: string
1146
- type: string
1147
- statistics?: {
1148
- median: number
1149
- mean: number
1150
- sum: number
1151
- min: number
1152
- max: number
1153
- }
1154
- }
1155
-
1156
- export interface ObjectSet {
1157
- template: string
1158
- level: string
1159
- objects: Object[]
1160
- }
1161
-
1162
- export interface UnitScale {
1163
- min?: any
1164
- max?: any
1165
- }
1166
-
1167
- export type Scaling = Record<string, UnitScale>
1168
-
1169
- export interface Dataset {
1170
- objects?: Object[]
1171
- colorSetting?: ColorSettings
1172
- indicators: Indicator[]
1173
- objectSet: ObjectSet
1174
- stacking: StackingOptionValue
1175
- showNullsAs?: any
1176
- representation: string
1177
- label?: unknown
1178
- id: string
1179
- scaling: Scaling
1180
- stack?: unknown
1181
- error?: unknown
1182
- idx: number
1183
- objectSetLabel: string
1184
- }
1185
-
1186
- // TODO: Better types for PacoViewParameters
1187
- type PacoViewParameters = unknown
1188
-
1189
- type SaveDataJobStatus =
1190
- | {
1191
- status: 'terminated'
1192
- respResult: {downloadUrl: string}
1193
- completedTime: ISODateString
1194
- respStatus: number
1195
- }
1196
- | {status: 'running'}
1197
-
1198
- export type SaveDataJobResponse = SaveDataJobStatus & {
1199
- actorSqid: string
1200
- numRetries: number
1201
- sqid: string
1202
- maxRetries: number
1203
-
1204
- /**
1205
- * The arguments derived from the visualization given as argument
1206
- * for the `createSaveDataJob` function
1207
- */
1208
- arguments: {
1209
- toDate: ISODateString
1210
- filename: string
1211
- replyTz: string
1212
- fromDate: string
1213
- objectIndicatorSets: {object: string[]
1214
- indicator: string[]}[]
1215
- granularity: Granularity[] // must be a single value
1216
- }
1217
- /**
1218
- * The place in the queue
1219
- */
1220
- priority: number
1221
-
1222
- timeout: number
1223
-
1224
- /**
1225
- * currently can be just save_data
1226
- */
1227
- typeSqid: string
1228
- }
1229
-
1230
- type Parameter = {
1231
- id: string
1232
- class: 'Parameter'
1233
- parameter: {class: string; label: string; initial: unknown; value: unknown}
1234
- }
42
+ export * from './types';
1235
43
 
1236
44
  /**
1237
45
  * Type definitions for all the API
@@ -1501,7 +309,7 @@ declare module '@3e/sqa-common' {
1501
309
  * Gets the container logical devices types to populate
1502
310
  * @param level - level means container
1503
311
  */
1504
- getContainersLdTypes(level: LevelValue): Promise<LDType[]>
312
+ getContainersLdTypes(level: LevelValue): Promise<LdTypeOption[]>
1505
313
 
1506
314
  /**
1507
315
  * Based on the selected level and the Selected Logical Device type, returns