-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathindex.d.ts
More file actions
1709 lines (1566 loc) · 45 KB
/
index.d.ts
File metadata and controls
1709 lines (1566 loc) · 45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/// <reference types="react" />
import React$1 from 'react';
import { IconProp } from '@fortawesome/fontawesome-svg-core';
/**
* Bootstrap variants
* @author Gabe Abrams
*/
declare enum Variant {
Primary = "primary",
Secondary = "secondary",
Success = "success",
Warning = "warning",
Info = "info",
Danger = "danger",
Light = "light",
Dark = "dark"
}
/**
* A wrapper for the entire React app that adds global functionality like
* handling for fatal error messages, adds bootstrap support
* @author Gabe Abrams
*/
type Props$m = {
children: React$1.ReactNode;
};
/**
* Redirect to a new page
* @author Gabe Abrams
* @param url the url to redirect to
* @param destination the destination of the redirect, for example "YouTube"
* and will be used in the following text: `Redirecting to ${destination}...`
*/
declare const leaveToURL: (url: string, destination: string) => Promise<void>;
/**
* Show an alert modal with an "Okay" button
* @author Gabe Abrams
* @param title the title text to display at the top of the alert
* @param text the text to display in the alert
*/
declare const alert: (title: string, text: string) => Promise<undefined>;
/**
* Show a confirmation modal with an "Okay" and a "Cancel" button
* (with the option to customize the text of those buttons)
* @author Gabe Abrams
* @param title the title text to display at the top of the alert
* @param text the text to display in the alert
* @param [opts={}] additional options for the confirmation dialog
* @param [opts.confirmButtonText=Okay] the text of the confirm button
* @param [opts.confirmButtonVariant=Variant.Dark] the variant of the confirm
* button
* @param [opts.cancelButtonText=Cancel] the text of the cancel button
* @param [opts.cancelButtonVariant=Variant.Secondary] the variant of the cancel
* button
* @returns true if the user confirmed
*/
declare const confirm: (title: string, text: string, opts?: {
confirmButtonText?: string;
confirmButtonVariant?: Variant;
cancelButtonText?: string;
cancelButtonVariant?: Variant;
}) => Promise<boolean>;
/**
* Show a prompt modal asking the user for input
* @author Yuen Ler Chow
* @param title the title text to display at the top of the prompt
* @param [opts={}] additional options for the prompt dialog
* @param [opts.textAboveInputField] the text to display in the prompt
* @param [opts.defaultText] the default text for the input field
* @param [opts.placeholder] the placeholder text for the input field
* @param [opts.confirmButtonText=Okay] the text of the confirm button
* @param [opts.confirmButtonVariant=Variant.Dark] the variant of the confirm button
* @param [opts.cancelButtonText=Cancel] the text of the cancel button
* @param [opts.cancelButtonVariant=Variant.Secondary] the variant of the cancel button
* @param [opts.minNumChars] the minimum number of characters required for
* the input to be valid
* @param [opts.findValidationError] a function that takes the input text and
* returns an error message if the input is invalid, returns undefined if the
* input is valid
* @param [opts.ariaLabel] the aria label for the input field
* @returns Promise that resolves with the input string or null if canceled
*/
declare const prompt: (title: string, opts?: {
textAboveInputField?: string | undefined;
defaultText?: string | undefined;
placeholder?: string | undefined;
confirmButtonText?: string | undefined;
confirmButtonVariant?: Variant | undefined;
cancelButtonText?: string | undefined;
cancelButtonVariant?: Variant | undefined;
minNumChars?: number | undefined;
findValidationError?: ((text: string) => string | undefined) | undefined;
ariaLabel?: string | undefined;
} | undefined) => Promise<string | null>;
/**
* Show a fatal error message
* @author Gabe Abrams
* @param error the error to show
* @param [errorTitle] title of the error box
*/
declare const showFatalError: (error: any, errorTitle?: string) => Promise<void>;
/**
* Add a handler for when a fatal error occurs (or when a session expiry occurs)
* @author Gabe Abrams
*/
declare const addFatalErrorHandler: (handler: () => void) => void;
declare const AppWrapper: React$1.FC<Props$m>;
/**
* Loading spinner/indicator
* @author Gabe Abrams
*/
declare const LoadingSpinner: () => React$1.JSX.Element;
/**
* Displays an error
* @author Gabe Abrams
*/
type Props$l = {
error: any;
title?: string;
onClose?: () => void;
variant?: Variant;
icon?: IconProp;
};
declare const ErrorBox: React$1.FC<Props$l>;
/**
* Types of buttons in the modal
* @author Gabe Abrams
*/
declare enum ModalButtonType {
Okay = "okay",
Cancel = "cancel",
Yes = "yes",
No = "no",
Abandon = "abandon",
GoBack = "goBack",
Continue = "continue",
ImSure = "imSure",
Delete = "delete",
Confirm = "confirm"
}
/**
* Modal sizes
* @author Gabe Abrams
*/
declare enum ModalSize {
Small = "sm",
Medium = "md",
Large = "lg",
ExtraLarge = "xl"
}
/**
* Types of modals
* @author Gabe Abrams
*/
declare enum ModalType {
Okay = "okay",
Cancel = "cancel",
OkayCancel = "okay-cancel",
YesNo = "yes-no",
YesNoCancel = "yes-no-cancel",
AbandonGoBack = "abandon-goBack",
ImSureCancel = "imSure-cancel",
DeleteCancel = "delete-cancel",
ConfirmCancel = "confirm-cancel",
NoButtons = "-"
}
/**
* Props for the Modal component
* @author Gabe Abrams
*/
type ModalProps = {
key?: string;
type?: ModalType;
size?: ModalSize;
title?: React.ReactNode;
largeTitle?: boolean;
children?: React.ReactNode;
onClose?: (type: ModalButtonType) => void;
dontAllowBackdropExit?: boolean;
dontShowXButton?: boolean;
okayLabel?: string;
okayVariant?: Variant;
cancelLabel?: string;
cancelVariant?: Variant;
yesLabel?: string;
yesVariant?: Variant;
noLabel?: string;
noVariant?: Variant;
abandonLabel?: string;
abandonVariant?: Variant;
goBackLabel?: string;
goBackVariant?: Variant;
continueLabel?: string;
continueVariant?: Variant;
imSureLabel?: string;
imSureVariant?: Variant;
deleteLabel?: string;
deleteVariant?: Variant;
confirmLabel?: string;
confirmVariant?: Variant;
onTopOfOtherModals?: boolean;
isLoading?: boolean;
isLoadingCancelable?: boolean;
};
/**
* The displayable modal component (this is the modal that's added to the
* wrapper, not the one that the programmer renders)
* @author Gabe Abrams
*/
declare const Modal: React$1.FC<ModalProps>;
/**
* A box with a tab on the top that holds buttons and other content
* @author Gabe Abrams
*/
type Props$k = {
title: React$1.ReactNode;
children: React$1.ReactNode;
topRightChildren?: React$1.ReactNode;
noBottomMargin?: boolean;
noBottomPadding?: boolean;
};
declare const TabBox: React$1.FC<Props$k>;
/**
* A radio selection button
* @author Gabe Abrams
*/
type Props$j = {
text: React$1.ReactNode;
onSelected: () => void;
ariaLabel: string;
title?: string;
selected?: boolean;
id?: string;
className?: string;
noMarginOnRight?: boolean;
selectedVariant?: Variant;
unselectedVariant?: Variant;
small?: boolean;
useComplexFormatting?: boolean;
};
declare const RadioButton: React$1.FC<Props$j>;
/**
* A checkbox button
* @author Gabe Abrams
*/
type Props$i = {
text: React$1.ReactNode;
onChanged: (checked: boolean) => void;
ariaLabel: string;
title?: string;
checked?: boolean;
id?: string;
className?: string;
noMarginOnRight?: boolean;
checkedVariant?: Variant;
uncheckedVariant?: Variant;
small?: boolean;
dashed?: boolean;
useComplexFormatting?: boolean;
};
declare const CheckboxButton: React$1.FC<Props$i>;
/**
* Input group with a title and space for buttons
* @author Gabe Abrams
*/
type Props$h = {
label: React$1.ReactNode;
minLabelWidth?: string;
children: React$1.ReactNode;
className?: string;
wrapButtonsAndAddGaps?: boolean;
isAdminFeature?: boolean;
noMarginOnBottom?: boolean;
};
declare const ButtonInputGroup: React$1.FC<Props$h>;
/**
* A very simple, lightweight date chooser
* @author Gabe Abrams
* @author Gardenia Liu
*/
type Props$g = {
ariaLabel: string;
name: string;
month: number;
day: number;
year: number;
/**
* Handler for when date changes
* @param month new 1-indexed month number
* @param day new 1-indexed day number
* @param year new full year number
*/
onChange: (month: number, day: number, year: number) => void;
numMonthsToShow?: number;
dontAllowPast?: boolean;
dontAllowFuture?: boolean;
};
declare const SimpleDateChooser: React$1.FC<Props$g>;
/**
* A very simple, lightweight time chooser
* @author Gardenia Liu
*/
type Props$f = {
ariaLabel: string;
name: string;
hour: number;
minute: number;
/**
* Handler for when time changes
* @param hour new 24hr hour number
* @param minute new minute number
*/
onChange: (hour: number, minute: number) => void;
intervalMin?: number;
};
declare const SimpleTimeChooser: React$1.FC<Props$f>;
/**
* Drawer container
* @author Gabe Abrams
*/
type Props$e = {
grayBackground?: boolean;
customBackgroundColor?: string;
children: React$1.ReactNode;
};
declare const Drawer: React$1.FC<Props$e>;
/**
* Success checkmark that pops into view
* @author Gabe Abrams
*/
type Props$d = {
sizeRem?: number;
circleVariant?: string;
checkVariant?: string;
};
declare const PopSuccessMark: React$1.FC<Props$d>;
/**
* Failure x mark that pops into view
* @author Gabe Abrams
*/
type Props$c = {
sizeRem?: number;
circleVariant?: string;
xVariant?: string;
};
declare const PopFailureMark: React$1.FC<Props$c>;
/**
* Failure pending that pops into view
* @author Gabe Abrams
*/
type Props$b = {
sizeRem?: number;
circleVariant?: string;
hourglassVariant?: string;
};
declare const PopPendingMark: React$1.FC<Props$b>;
/**
* Copiable text box
* @author Gabe Abrams
*/
type Props$a = {
text: string;
maxTextWidthRem?: number;
label?: string;
labelIcon?: any;
minLabelWidthRem?: number;
multiline?: boolean;
numVisibleLines?: number;
onClick?: () => void;
textAreaId?: string;
copyButtonId?: string;
};
declare const CopiableBox: React$1.FC<Props$a>;
/**
* An item that can be chosen (for use within ItemPicker)
* @author Gabe Abrams
*/
type PickableItem = ({
id: number | string;
name: string;
link?: string;
} & ({
isGroup: false;
checked: boolean;
} | {
isGroup: true;
children: PickableItem[];
}));
/**
* Reusable nested item picker
* @author Yuen Ler Chow
*/
type Props$9 = {
title: string;
items: PickableItem[];
/**
* Handler to call when item selection is changed
* @param updatedItems an updated copy of the list of items with checked
* values updated
*/
onChanged: (updatedItems: PickableItem[]) => void;
noBottomMargin?: boolean;
hideSelectAllOrNoneButtons?: boolean;
};
declare const ItemPicker: React$1.FC<Props$9>;
/**
* Type of the context map in a LogMetadata file
* @author Gabe Abrams
*/
type LogMetadataContextMap = {
[k: string]: (string | {
_: string;
[k: string]: string;
});
};
/**
* Type of the tag map inside a LogMetadata file
* @author Gabe Abrams
*/
type LogMetadataTagMap = {
[k: string]: string;
};
/**
* Type of the target map inside a LogMetadata file
* @author Gabe Abrams
*/
type LogMetadataTargetMap = {
[k: string]: string;
};
/**
* Type of a LogMetadata file
* @author Gabe Abrams
*/
type LogMetadataType = {
Context?: LogMetadataContextMap;
Tag?: LogMetadataTagMap;
Target?: LogMetadataTargetMap;
};
/**
* Log reviewer panel that allows users (must be approved admins) to
* review logs written by dce-reactkit
* @author Gabe Abrams
*/
type Props$8 = {
LogMetadata: LogMetadataType;
onClose: () => void;
};
declare const LogReviewer: React$1.FC<Props$8>;
/**
* Server-side API param types
* @author Gabe Abrams
*/
declare enum ParamType {
Boolean = "Boolean",
BooleanOptional = "BooleanOptional",
Float = "Float",
FloatOptional = "FloatOptional",
Int = "Int",
IntOptional = "IntOptional",
JSON = "JSON",
JSONOptional = "JSONOptional",
String = "String",
StringOptional = "StringOptional"
}
/**
* Column description for a column in the IntelliTable
* @author Gabe Abrams
*/
type IntelliTableColumn = {
title: string;
param: string;
type: (ParamType.Boolean | ParamType.Float | ParamType.Int | ParamType.String | ParamType.JSON);
startsHidden?: boolean;
};
/**
* Intelligent table
* @author Gabe Abrams
*/
type Props$7 = {
title: string;
id: string;
data: {
id: string | number;
[k: string]: any;
}[];
columns: IntelliTableColumn[];
csvName?: string;
};
declare const IntelliTable: React$1.FC<Props$7>;
/**
* Button for downloading a csv file
* @author Gabe Abrams
*/
type Props$6 = {
filename: string;
csv: string;
label?: string;
id?: string;
className?: string;
ariaLabel?: string;
style?: {
[k: string]: any;
};
onClick?: () => void;
children?: React$1.ReactNode;
};
declare const CSVDownloadButton: React$1.FC<Props$6>;
/**
* Generic type for an object
* @author Yuen Ler Chow
*/
type DBEntry = {
[k: string]: any;
};
/**
* Options for field types
* @author Yuen Ler Chow
*/
declare enum DBEntryFieldType {
String = "String",
Number = "Number",
Object = "Object",
StringArray = "StringArray",
NumberArray = "NumberArray"
}
/**
* A database entry input field
* @author Yuen Ler Chow
*/
type DBEntryField = ({
label: string;
objectKey: string;
placeholder: string;
lockAfterCreation?: boolean;
required?: boolean;
} & ({
type: DBEntryFieldType.String;
minNumChars?: number;
maxNumChars?: number;
defaultValue?: string;
choices?: {
title: string;
value: string;
}[];
} | {
type: DBEntryFieldType.Number;
minNumber?: number;
maxNumber?: number;
defaultValue?: number;
} | {
type: DBEntryFieldType.StringArray;
minNumElements?: number;
maxNumElements?: number;
defaultValue?: string[];
choices?: {
title: string;
value: string;
}[];
} | {
type: DBEntryFieldType.NumberArray;
minNumElements?: number;
maxNumElements?: number;
minNumber?: number;
maxNumber?: number;
defaultValue?: number[];
} | {
type: DBEntryFieldType.Object;
defaultValue?: {
[k: string]: any;
};
subfields: DBEntryField[];
}));
/**
* DB Entry Manager Panel
* @author Yuen Ler Chow
* @author Gabe Abrams
*/
type Props$5 = {
entryFields: DBEntryField[];
idPropName: string;
titlePropName: string;
descriptionPropName: string;
itemListTitle: string;
itemName: string;
/**
* Function to validate the db entry before sending to the server
* (throws an error if not validate)
* @param dbEntry the db entry to validate
*/
validateEntry?: (dbEntry: DBEntry) => Promise<void>;
/**
* Function to modify the db entry before sending to the server
* @param dbEntry the db entry to modify
* @returns the modified db entry
*/
modifyEntry?: (dbEntry: DBEntry) => Promise<DBEntry> | DBEntry;
disableEdit?: boolean;
collectionName: string;
adminsOnly?: boolean;
filterQuery?: {
[k: string]: any;
};
};
declare const DBEntryManagerPanel: React$1.FC<Props$5>;
/**
* Simple tooltip component
* @author Gabe Abrams
*/
type Props$4 = {
text: string;
children: any;
};
declare const Tooltip: React$1.FC<Props$4>;
/**
* A toggle switch that toggles on or off
* @author Alessandra De Lucas
* @author Gabe Abrams
*/
type Props$3 = {
isOn: boolean;
/**
* A handler to call when the switch is toggled
* @param isOn Updated value for isOn
*/
onToggle: (isOn: boolean) => void;
id?: string;
className?: string;
description: string;
backgroundVariantWhenOn?: Variant;
};
declare const ToggleSwitch: React$1.FC<Props$3>;
/**
* Container that automatically scrolls when new items are added,
* lets the user scroll up to see old items, but resumes
* autoscroll when the user scrolls back to the bottom.
* Note: takes up full height of parent, so parent should
* have a determined height for the scroll to work.
* @author Gabe Abrams
*/
type Props$2 = {
itemsName?: string;
items: AutoScrollItem[];
jumpToBottomButtonVariant?: Variant;
messageBeforeItems?: React$1.ReactNode;
messageAfterItems?: React$1.ReactNode;
};
type AutoScrollItem = {
id: string | number;
item: React$1.ReactNode;
};
declare const AutoscrollToBottomContainer: React$1.FC<Props$2>;
/**
* A switch with multiple options for selection
* @author Alessandra De Lucas
* @author Gabe Abrams
* @author Austen Money
*/
type Props$1 = {
options: Option[];
selectedOptionId: string;
/**
* A handler to call when the switch is changed
* @param selectedOptionId Updated option when switch is changed
*/
onChange: (selectedOptionId: string) => void;
heightRem?: number;
};
type Option = {
label: string;
icon: IconProp;
id: string;
};
declare const MultiSwitch: React$1.FC<Props$1>;
declare enum DropdownItemType {
Header = "Header",
Divider = "Divider",
Item = "Item"
}
/**
* A simple dropdown menu
* @author Alessandra De Lucas
* @author Yuen Ler Chow
* @author Gabe Abrams
*/
type Props = {
items: DropdownItem[];
dropdownButton: {
ariaLabel: string;
id: string;
content?: React$1.ReactNode;
variant?: Variant;
};
};
type DropdownItem = ({
type: DropdownItemType.Header;
content: React$1.ReactNode;
} | {
type: DropdownItemType.Divider;
} | {
type: DropdownItemType.Item;
content: React$1.ReactNode;
ariaLabel: string;
id: string;
onClick: () => void;
});
declare const Dropdown: React$1.FC<Props>;
/**
* An error with a code
* @author Gabe Abrams
*/
declare class ErrorWithCode extends Error {
code: string;
constructor(message: string, code: string);
}
/**
* One minute in ms
* @author Gabe Abrams
*/
declare const MINUTE_IN_MS = 60000;
/**
* One hour in ms
* @author Gabe Abrams
*/
declare const HOUR_IN_MS = 3600000;
/**
* One day in ms
* @author Gabe Abrams
*/
declare const DAY_IN_MS = 86400000;
/**
* Path of the route for storing client-side logs
* @author Gabe Abrams
*/
declare const LOG_REVIEW_ROUTE_PATH_PREFIX: string;
/**
* Path of the route for storing client-side logs
* @author Gabe Abrams
*/
declare const LOG_ROUTE_PATH: string;
/**
* Route for checking the status of the current user's
* access to log review
* @author Gabe Abrams
*/
declare const LOG_REVIEW_STATUS_ROUTE: string;
/**
* Path of the route for getting logs for log review
* @author Gabe Abrams
*/
declare const LOG_REVIEW_GET_LOGS_ROUTE: string;
/**
* Dynamic words determined by the user's platform
* @author Gabe Abrams
*/
declare const DynamicWord: {
Click: string;
ClickCapitalized: string;
App: string;
AppCapitalized: string;
Device: string;
DeviceCapitalized: string;
};
/**
* Type of CACCL's send request function
* @author Gabe Abrams
*/
type SendRequestFunction = (opts: {
path: string;
method: ('GET' | 'POST' | 'DELETE' | 'PUT');
params?: {
[x: string]: any;
} | undefined;
headers?: {
[x: string]: any;
} | undefined;
numRetries?: number | undefined;
}) => Promise<{
body: any;
status: number;
headers: {
[x: string]: any;
};
}>;
/**
* Initialize the client-side version of reactkit
* @author Gabe Abrams
* @param opts object containing all arguments
* @param opts.sendRequest caccl send request functions
* @param [opts.sessionExpiredMessage] a custom session expired message
* @param [opts.darkModeOn] if true, dark mode is enabled
* @param [opts.noServer] if true, there is no server for this app
*/
declare const initClient: (opts: ({
sendRequest: SendRequestFunction;
sessionExpiredMessage?: string;
darkModeOn?: boolean;
noServer?: false;
} | {
darkModeOn?: boolean;
noServer: true;
sendRequest?: undefined;
sessionExpiredMessage?: undefined;
})) => void;
/**
* Shorten text so it fits into a certain number of chars
* @author Gabe Abrams
* @param text the text to abbreviate
* @param maxChars the maximum number of chars to include
* @returns abbreviated text with length no greater than maxChars
* (including ellipses if applicable)
*/
declare const abbreviate: (text: string, maxChars: number) => string;
/**
* Get the average of a set of numbers
* @author Gabe Abrams
* @param nums the numbers to average
* @returns average value or 0 if no numbers
*/
declare const avg: (nums: number[]) => number;
/**
* Round a number (ceiling) to a certain number of decimals
* @author Gabe Abrams
* @param num the number to round
* @param numDecimals the number of decimals to round to
* @returns rounded number
*/
declare const ceilToNumDecimals: (num: number, numDecimals: number) => number;
/**
* Round a number (floor) to a certain number of decimals
* @author Gabe Abrams
* @param num the number to round
* @param numDecimals the number of decimals to round to
* @returns rounded number
*/
declare const floorToNumDecimals: (num: number, numDecimals: number) => number;
/**
* Force a number to stay within specific bounds
* @author Gabe Abrams
* @param num the number to move into the bounds
* @param min the minimum number in the bound
* @param max the maximum number in the bound
* @returns bounded number
*/
declare const forceNumIntoBounds: (num: number, min: number, max: number) => number;
/**
* Pad a number's decimal with zeros on the right
* (e.g. 5.2 becomes 5.20 with 2 digit padding)
* @author Gabe Abrams
* @param num the number to pad
* @param numDigits the minimum number of digits after the decimal
* @returns padded number
*/
declare const padDecimalZeros: (num: number, numDigits: number) => string;
/**
* Pad a number with zeros on the left (e.g. 5 becomes 05 with 2 digit padding)
* @author Gabe Abrams
* @param num the number to pad
* @param numDigits the minimum number of digits before the decimal
* @returns padded number
*/
declare const padZerosLeft: (num: number, numDigits: number) => string;
/**
* Round a number to a certain number of decimals
* @author Gabe Abrams
* @param num the number to round
* @param numDecimals the number of decimals to round to
* @returns rounded number
*/
declare const roundToNumDecimals: (num: number, numDecimals: number) => number;
/**
* Sum the numbers in an array
* @author Gabe Abrams
* @param nums the numbers to sum
* @returns the sum of the numbers
*/
declare const sum: (nums: number[]) => number;
/**
* Wait for a certain number of ms
* @author Gabe Abrams
* @param ms number of ms to wait
*/
declare const waitMs: (ms?: number) => Promise<unknown>;
/**
* Visit an endpoint on the server [for client only]
* @author Gabe Abrams
* @param opts object containing all arguments
* @param opts.path - the path of the server endpoint
* @param [opts.method=GET] - the method of the endpoint
* @param [opts.params] - query/body parameters to include
* @returns response from server
*/
declare const visitServerEndpoint: (opts: {
path: string;
method?: "GET" | "POST" | "DELETE" | "PUT" | undefined;
params?: {
[x: string]: any;
} | undefined;
}) => Promise<any>;
/**
* Get a number's ordinal
* @author Gabe Abrams
* @param num the number being analyzed
* @returns ordinal
*/
declare const getOrdinal: (num: number) => string;
/**
* Get current time info in US Boston Eastern Time, independent of machine
* timezone
* @author Gabe Abrams
* @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
* @returns object with timestamp (ms since epoch) and numbers
* corresponding to ET time values for year, month, day, hour, hour12, minute, second, isPM