@3e/sqa-common 6.18.0-13 → 6.18.0-14

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