@3e/sqa-common 6.17.0-2 → 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 +48 -1163
  2. package/package.json +6 -2
  3. package/sqa_common.js +1337 -1324
  4. package/types.ts +1230 -0
package/index.d.ts CHANGED
@@ -1,1166 +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 minute'
737
- | '5 minutes'
738
- | '10 minutes'
739
- | '15 minutes'
740
- | '30 minutes'
741
- | '1 hour'
742
- | '1 day'
743
- | '1 week'
744
- | '1 month'
745
- | '3 months'
746
- | '1 year'
747
-
748
- export type Period =
749
- | 'last-15-minutes'
750
- | 'last-30-minutes'
751
- | 'last-60-minutes'
752
- | 'last-120-minutes'
753
- | 'last-24-hours'
754
- | 'today'
755
- | 'yesterday'
756
- | 'tomorrow'
757
- | 'last-3-days'
758
- | 'last-7-days'
759
- | 'last-7x24-hours'
760
- | 'last-3x24-hours'
761
- | 'forecast-4-days'
762
- | 'forecast-10-days'
763
- | 'last-week'
764
- | 'current-month'
765
- | 'last-month'
766
- | 'last-30-days'
767
- | 'year-to-date'
768
- | 'last-12-months'
769
- | 'last-year'
770
- | 'since-beginning'
771
- | 'custom'
772
-
773
- export type LevelValue =
774
- | 'site-group'
775
- | 'site'
776
- | 'ac-node'
777
- | 'ac-input'
778
- | 'ac-phase'
779
- | 'connection'
780
- | 'dc-input'
781
- | 'dc-node'
782
- | 'inverter'
783
- | 'inverter-device'
784
- | 'logger'
785
- | 'mppt'
786
- | 'module-group'
787
- | 'power-unit'
788
- | 'sensor'
789
- | 'strings'
790
- | 'tracker'
791
- | 'turbine'
792
-
793
- export type DashboardLevel =
794
- | 'site-group'
795
- | 'site'
796
- | 'ac-node'
797
- | 'inverter'
798
- | 'turbine'
799
-
800
- export type RepresentationValue =
801
- | 'line'
802
- | 'line-and-marker'
803
- | 'marker'
804
- | 'spline'
805
- | 'column'
806
- | 'area'
807
-
808
- export type StackingOptionValue = 'no' | 'normal' | 'percent'
809
-
810
- export type StackingOption = {value: StackingOptionValue; label: string}
811
-
812
- export type Representation = {
813
- value: RepresentationValue
814
- label: string
815
- }
816
-
817
- export type Level = {
818
- value: LevelValue
819
- label: string
820
- models?: {label: string; value: string}[]
821
- }
822
-
823
- /**
824
- * Logical device type
825
- */
826
- export type LDType = {
827
- value: string
828
- label: string
829
- }
830
-
831
- export type ContainerValue = string
832
-
833
- /**
834
- * Containers (Actually physical plants)
835
- */
836
- export type Container = {
837
- value: string
838
- label: string
839
- }
840
-
841
- export type Template = {
842
- value: string
843
- label: string
844
- }
845
-
846
- export interface EmptyViewOptions {
847
- viewType: ViewType
848
- label: string
849
- /**
850
- * @default "15-minutes"
851
- */
852
- granularity?: Granularity
853
- /**
854
- * @default "last-24-hours"
855
- */
856
- period?: Period
857
- }
858
-
859
- export interface VisualisationOptions {
860
- showLegend: boolean
861
- showTitle: boolean
862
- }
863
-
864
- /**
865
- * ISO local datetime string (YYYY-MM-DDTHH:mm:ss.SSS).
866
- */
867
- export type ISODateString = string
868
-
869
- export type ColorSchemeValue = 'scheme_blrd' | 'scheme_ylrdbl'
870
-
871
- export type ColorSettings =
872
- | {
873
- label: string
874
- value: string
875
- type: 'palette'
876
- colors: string[]
877
- }
878
- | {label: string; value: string; type: 'fixed'; color: string}
879
-
880
- export type ColorScheme = {
881
- value: ColorSchemeValue
882
- label: string
883
- type?: string
884
- stops?: [number, string][]
885
- }
886
-
887
- export type MeasurementsRowExtraInfo = {
888
- indicator?: {
889
- label: string
890
- indicator_label: string
891
- reference_label: string
892
- unit: string
893
- unit_key: string
894
- description: string
895
- key: string
896
- default_graphical_representation: string
897
- level: LevelValue
898
- }
899
- object?: {
900
- name: string
901
- level: LevelValue
902
- ref: string
903
- }
904
- }
905
-
906
- /**
907
- * Since in a table row the data is represented as: `[object-name, indicator1-value, indicator2-value, ...]`
908
- * while the indicators in the meta are: `[indicator1, indicator2, ...]`
909
- * 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.
910
- *
911
- *
912
- * For objects, the correct object index is the index of the full row
913
- */
914
- export type ObjectsTableMetaRowInfo = {
915
- indicators: {
916
- label: string
917
- indicator_label: string
918
- reference_label: string
919
- unit?: string
920
- unit_key: string
921
- description: string
922
- key: string
923
- default_graphical_representation: string
924
- level: LevelValue
925
- }[]
926
- objects: {
927
- name: string
928
- level: LevelValue
929
- ref: string
930
- label: string
931
- }
932
- }
933
-
934
- export type TimeTableMetaRowInfo = {
935
- [key: string]: {
936
- indicator: Indicator
937
- object: Object
938
- }
939
- }
940
-
941
- export type MeasurementsTable = {
942
- meta: {
943
- rows: MeasurementsRowExtraInfo[]
944
- primaryObject: string
945
- }
946
- header: string[]
947
- rows: (string | number | null)[][]
948
- }
949
-
950
- export type HighChartsSpec = {
951
- display: 'highcharts'
952
- chart: {_SQ_: {type: ViewType}; zoomType: string; animation: boolean}
953
- } & Highcharts.Options
954
-
955
- export type TableSpec = {
956
- display: 'table'
957
- meta?: {
958
- type: 'time_table'
959
- rows: TimeTableMetaRowInfo
960
- } | {
961
- type: 'object_table'
962
- rows: ObjectsTableMetaRowInfo
963
- }
964
- title?: string
965
- header: string[]
966
- rows: (number | string)[][]
967
- }
968
-
969
- export type MessageSpec = {
970
- display: 'message'
971
- label: string
972
- value: string
973
- }
974
- export type KPI = {
975
- kpi: string
976
- value: string | number
977
- }
978
-
979
- export type KPISpec = {
980
- display: 'kpis'
981
- title: {text: string}
982
- object: Object
983
- kpis: KPI[]
984
- }
985
-
986
- export type VisualizationSpec = TableSpec | MessageSpec | HighChartsSpec | KPISpec
987
-
988
-
989
- export interface Visualization {
990
- data: {
991
- datasets: Dataset[]
992
- date_from: ISODateString
993
- date_to: ISODateString
994
- period_time_mode: string
995
- clock_or_calendar_mode: string
996
- granularity: Granularity
997
- }
998
- error?: boolean
999
- options: VisualisationOptions
1000
- info: {title: string; type: ViewType; color_scheme: ColorSchemeValue}
1001
- values: {}
1002
- disableIncrementalUpdates: boolean
1003
- spec: VisualizationSpec
1004
- }
1005
-
1006
- export interface LdType {
1007
- sqid: string
1008
- ref: string
1009
- label: string
1010
- }
1011
-
1012
- export interface LDRoot {
1013
- sqid: string
1014
- ref: string
1015
- label: string
1016
- }
1017
-
1018
- export interface Model {
1019
- sqid: string
1020
- ref: string
1021
- label: string
1022
- }
1023
-
1024
- export interface LogicalDevice {
1025
- sqid: string
1026
- ld_type: string
1027
- ref: string
1028
- root: LDRoot
1029
- label: string
1030
- full_name: string
1031
- act_to: Date
1032
- act_from: Date
1033
- model: Model
1034
- }
1035
-
1036
- export interface Indicator {
1037
- default_graphical_representation: RepresentationValue
1038
- description: string
1039
- key: string
1040
- label: string
1041
- level: LevelValue
1042
- unit: string
1043
- unit_key: string
1044
- }
1045
-
1046
- export interface LDIndicator {
1047
- indicator_key: string
1048
- object_ref: string
1049
- unit: string
1050
- unit_key: string
1051
- }
1052
-
1053
- /**
1054
- * Options for representing the dataset
1055
- */
1056
- export interface DatasetOptions {
1057
- graphicalRepresentation?: string
1058
- id?: string
1059
- colorSetting?: string
1060
- stacking?: StackingOptionValue
1061
- showNullsAs?: string
1062
- label?: string
1063
- }
1064
-
1065
- export interface DatasetTemplateSpec {
1066
- selectedLevel: string
1067
- selectedContainer?: string
1068
- selectedTemplate: string
1069
- }
1070
-
1071
- export interface Object {
1072
- name: string
1073
- level: LevelValue
1074
- ref: string
1075
- type: string
1076
- statistics?: {
1077
- median: number
1078
- mean: number
1079
- sum: number
1080
- min: number
1081
- max: number
1082
- }
1083
- }
1084
-
1085
- export interface ObjectSet {
1086
- template: string
1087
- level: string
1088
- objects: Object[]
1089
- }
1090
-
1091
- export interface UnitScale {
1092
- min?: any
1093
- max?: any
1094
- }
1095
-
1096
- export type Scaling = Record<string, UnitScale>
1097
-
1098
- export interface Dataset {
1099
- objects?: Object[]
1100
- colorSetting?: ColorSettings
1101
- indicators: Indicator[]
1102
- objectSet: ObjectSet
1103
- stacking: StackingOptionValue
1104
- showNullsAs?: any
1105
- representation: string
1106
- label?: unknown
1107
- id: string
1108
- scaling: Scaling
1109
- stack?: unknown
1110
- error?: unknown
1111
- idx: number
1112
- objectSetLabel: string
1113
- }
1114
-
1115
- // TODO: Better types for PacoViewParameters
1116
- type PacoViewParameters = unknown
1117
-
1118
- type SaveDataJobStatus =
1119
- | {
1120
- status: 'terminated'
1121
- respResult: {downloadUrl: string}
1122
- completedTime: ISODateString
1123
- respStatus: number
1124
- }
1125
- | {status: 'running'}
1126
-
1127
- export type SaveDataJobResponse = SaveDataJobStatus & {
1128
- actorSqid: string
1129
- numRetries: number
1130
- sqid: string
1131
- maxRetries: number
1132
-
1133
- /**
1134
- * The arguments derived from the visualization given as argument
1135
- * for the `createSaveDataJob` function
1136
- */
1137
- arguments: {
1138
- toDate: ISODateString
1139
- filename: string
1140
- replyTz: string
1141
- fromDate: string
1142
- objectIndicatorSets: {object: string[]
1143
- indicator: string[]}[]
1144
- granularity: Granularity[] // must be a single value
1145
- }
1146
- /**
1147
- * The place in the queue
1148
- */
1149
- priority: number
1150
-
1151
- timeout: number
1152
-
1153
- /**
1154
- * currently can be just save_data
1155
- */
1156
- typeSqid: string
1157
- }
1158
-
1159
- type Parameter = {
1160
- id: string
1161
- class: 'Parameter'
1162
- parameter: {class: string; label: string; initial: unknown; value: unknown}
1163
- }
42
+ export * from './types';
1164
43
 
1165
44
  /**
1166
45
  * Type definitions for all the API
@@ -1430,7 +309,7 @@ declare module '@3e/sqa-common' {
1430
309
  * Gets the container logical devices types to populate
1431
310
  * @param level - level means container
1432
311
  */
1433
- getContainersLdTypes(level: LevelValue): Promise<LDType[]>
312
+ getContainersLdTypes(level: LevelValue): Promise<LdTypeOption[]>
1434
313
 
1435
314
  /**
1436
315
  * Based on the selected level and the Selected Logical Device type, returns
@@ -1645,7 +524,7 @@ declare module '@3e/sqa-common' {
1645
524
  /**
1646
525
  * Generate a new password for the user
1647
526
  *
1648
- * Password will
527
+ * The Password will:
1649
528
  * - be between 12 and 100 characters
1650
529
  * - contain at least one lower-case character
1651
530
  * - contain at least one upper-case character
@@ -1683,7 +562,7 @@ declare module '@3e/sqa-common' {
1683
562
  * @param ldType - The Logical Device Type to convert. Accepts both short
1684
563
  * form (e.g. 'inverter') or full SQID (e.g. '/sq/ld_type/inverter')
1685
564
  */
1686
- convertLDTypeToRefCategory(ldType: string): string | null
565
+ convertLDTypeToRefCategory(ldType: LdTypeValue): string | null
1687
566
 
1688
567
  /**
1689
568
  * Make a Ref from an LD Type and a SQID
@@ -1695,7 +574,13 @@ declare module '@3e/sqa-common' {
1695
574
  * form (e.g. 'inverter') or full SQID (e.g. '/sq/ld_type/inverter')
1696
575
  * @param sqid - The SQID of the object
1697
576
  */
1698
- refFromLDTypeAndSQID(ldType: string, sqid: string): string | null
577
+ refFromLDTypeAndSQID(ldType: LdTypeValue, sqid: string): string | null
578
+
579
+ /**
580
+ * Returns the refresh period for the view in milliseconds, or null if the view should not be refreshed
581
+ * @param view - the view for which to receive the refresh period
582
+ */
583
+ refreshPeriod(view: SQView): number | null
1699
584
  }
1700
585
 
1701
586
  export const sqa: {