-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathRandomOrgClient.js
More file actions
2306 lines (2154 loc) · 120 KB
/
RandomOrgClient.js
File metadata and controls
2306 lines (2154 loc) · 120 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
'use strict';
const {
RandomOrgBadHTTPResponseError,
RandomOrgInsufficientBitsError,
RandomOrgInsufficientRequestsError,
RandomOrgJSONRPCError,
RandomOrgKeyNotRunningError,
RandomOrgRANDOMORGError,
RandomOrgSendTimeoutError
} = require('./RandomOrgErrors.js');
const RandomOrgCache = require('./RandomOrgCache.js');
/* node-import */
const XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest;
/* end-node-import */
/**
* RandomOrgClient main class through which API functions are accessed.
*
* This class provides access to both the signed and unsigned methods of the
* RANDOM.ORG API.
*
* The class also provides access to the creation of a convenience class, RandomOrgCache,
* for precaching API responses when the request is known in advance.
*
* This class will only allow the creation of one instance per API key. If an
* instance of this class already exists for a given key, that instance will be
* returned instead of a new instance.
*
* This class obeys most of the guidelines set forth in https://api.random.org/json-rpc/4
* All requests respect the server's advisoryDelay returned in any responses, or use
* DEFAULT_DELAY if no advisoryDelay is returned. If the supplied API key is paused, i.e.,
* has exceeded its daily bit/request allowance, this implementation will back off until
* midnight UTC.
*/
module.exports = class RandomOrgClient {
// Basic API
static #INTEGER_METHOD = 'generateIntegers';
static #INTEGER_SEQUENCE_METHOD = 'generateIntegerSequences';
static #DECIMAL_FRACTION_METHOD = 'generateDecimalFractions';
static #GAUSSIAN_METHOD = 'generateGaussians';
static #STRING_METHOD = 'generateStrings';
static #UUID_METHOD = 'generateUUIDs';
static #BLOB_METHOD = 'generateBlobs';
static #GET_USAGE_METHOD = 'getUsage';
// Signed API
static #SIGNED_INTEGER_METHOD = 'generateSignedIntegers';
static #SIGNED_INTEGER_SEQUENCE_METHOD = 'generateSignedIntegerSequences';
static #SIGNED_DECIMAL_FRACTION_METHOD = 'generateSignedDecimalFractions';
static #SIGNED_GAUSSIAN_METHOD = 'generateSignedGaussians';
static #SIGNED_STRING_METHOD = 'generateSignedStrings';
static #SIGNED_UUID_METHOD = 'generateSignedUUIDs';
static #SIGNED_BLOB_METHOD = 'generateSignedBlobs';
static #GET_RESULT_METHOD = 'getResult';
static #CREATE_TICKET_METHOD = 'createTickets';
static #LIST_TICKET_METHOD = 'listTickets';
static #REVEAL_TICKET_METHOD = 'revealTickets';
static #GET_TICKET_METHOD = 'getTicket';
static #VERIFY_SIGNATURE_METHOD = 'verifySignature';
// Blob format literals
/** Blob format literal, base64 encoding (default). */
static BLOB_FORMAT_BASE64 = 'base64';
/** Blob format literal, hex encoding. */
static BLOB_FORMAT_HEX = 'hex';
// Default values
/** Default value for the replacement parameter (true). */
static DEFAULT_REPLACEMENT = true;
/** Default value for the base parameter (10). */
static DEFAULT_BASE = 10;
/** Default value for the userData parameter (null). */
static DEFAULT_USER_DATA = null;
/** Default value for the ticketId parameter (null). */
static DEFAULT_TICKET_ID = null;
/** Default value for the pregeneratedRandomization parameter (null). */
static DEFAULT_PREGENERATED_RANDOMIZATION = null;
/** Default value for the licenseData parameter (null). */
static DEFAULT_LICENSE_DATA = null;
/** Size of a single UUID in bits. */
static UUID_SIZE = 122;
/** Default value for the blockingTimeout parameter (1 day). */
static DEFAULT_BLOCKING_TIMEOUT = 24 * 60 * 60 * 1000;
/** Default value for the httpTimeout parameter (2 minutes). */
static DEFAULT_HTTP_TIMEOUT = 120 * 1000;
/** Maximum number of characters allowed in a signature verficiation URL. */
static MAX_URL_LENGTH = 2046;
// Default back-off to use if no advisoryDelay back-off supplied by server (1 second)
static #DEFAULT_DELAY = 1*1000;
// On request fetch fresh allowance state if current state data is older than
// this value (1 hour).
static #ALLOWANCE_STATE_REFRESH_SECONDS = 3600 * 1000;
// Maintains usage statistics from server.
#bitsLeft = -1;
#requestsLeft = -1;
// Back-off info for when the API key is detected as not running, probably
// because the key has exceeded its daily usage limit. Back-off runs until
// midnight UTC.
#backoff = -1;
#backoffError = '';
#apiKey = '';
#blockingTimeout = RandomOrgClient.DEFAULT_BLOCKING_TIMEOUT;
#httpTimeout = RandomOrgClient.DEFAULT_HTTP_TIMEOUT;
// Maintain info to obey server advisory delay
#advisoryDelay = 0;
#lastResponseReceivedTime = 0;
// Maintains a dictionary of API keys and their instances.
static #keyIndexedInstances = {};
static #ERROR_CODES = [ 100, 101, 200, 201, 202, 203, 204, 300,
301, 302, 303, 304, 305, 306, 307, 400, 401, 402, 403, 404,
405, 420, 421, 422, 423, 424, 425, 426, 500, 32000 ];
/**
* Constructor. Ensures only one instance of RandomOrgClient exists per API
* key. Creates a new instance if the supplied key isn't already known,
* otherwise returns the previously instantiated one.
* @constructor
* @param {string} apiKey API key of instance to create/find, obtained from
* RANDOM.ORG, see https://api.random.org/api-keys
* @param {{blockingTimeout?: number, httpTimeout?: number}} options An object
* which may contains any of the following optional parameters:
* @param {number} [options.blockingTimeout = 24 * 60 * 60 * 1000] Maximum
* time in milliseconds to wait before being allowed to send a request.
* Note this is a hint not a guarantee. The advisory delay from server
* must always be obeyed. Supply a value of -1 to allow blocking forever
* (default 24 * 60 * 60 * 1000, i.e., 1 day).
* @param {number} [options.httpTimeout = 120 * 1000] Maximum time in
* milliseconds to wait for the server response to a request (default
* 120*1000).
*/
constructor(apiKey, options = {}) {
if (RandomOrgClient.#keyIndexedInstances && RandomOrgClient.#keyIndexedInstances[apiKey]) {
return RandomOrgClient.#keyIndexedInstances[apiKey];
} else {
this.#apiKey = apiKey;
this.#blockingTimeout = options.blockingTimeout || 24 * 60 * 60 * 1000;
this.#httpTimeout = options.httpTimeout || 120 * 1000;
RandomOrgClient.#keyIndexedInstances[apiKey] = this;
}
}
// Basic API
/**
* Requests and returns an array of true random integers within a user-defined
* range from the server.
*
* See: https://api.random.org/json-rpc/4/basic#generateIntegers
* @param {number} n The number of random integers you need. Must be within
* the [1,1e4] range.
* @param {number} min The lower boundary for the range from which the random
* numbers will be picked. Must be within the [-1e9,1e9] range.
* @param {number} max The upper boundary for the range from which the random
* numbers will be picked. Must be within the [-1e9,1e9] range.
* @param {{replacement?: boolean, base?: number, pregeneratedRandomization?:
* Object}} options An object which may contains any of the following
* optional parameters:
* @param {boolean} [options.replacement=true] Specifies whether the random
* numbers should be picked with replacement. If true, the resulting numbers
* may contain duplicate values, otherwise the numbers will all be unique
* (default true).
* @param {number} [options.base=10] The base that will be used to display
* the numbers. Values allowed are 2, 8, 10 and 16 (default 10).
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @returns {(Promise<number[]>|Promise<string[]>)} A Promise which, if
* resolved successfully, represents an array of true random integers.
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
* */
async generateIntegers(n, min, max, options = {}) {
let request = this.#integerRequest(n, min, max, options);
return this.#extractBasic(this.#sendRequest(request));
}
/**
* Requests and returns an array of true random integer sequences within a
* user-defined range from the server.
*
* See: https://api.random.org/json-rpc/4/basic#generateIntegerSequences
* @param {number} n How many arrays of random integers you need. Must be
* within the [1,1e3] range.
* @param {(number|number[])} length The length of each array of random
* integers requested. For uniform sequences, length must be an integer
* in the [1, 1e4] range. For multiform sequences, length can be an array
* with n integers, each specifying the length of the sequence identified
* by its index. In this case, each value in length must be within the
* [1, 1e4] range and the total sum of all the lengths must be in the
* [1, 1e4] range.
* @param {(number|number[])} min The lower boundary for the range from which
* the random numbers will be picked. For uniform sequences, min must be
* an integer in the [-1e9, 1e9] range. For multiform sequences, min can
* be an array with n integers, each specifying the lower boundary of the
* sequence identified by its index. In this case, each value in min must
* be within the [-1e9, 1e9] range.
* @param {(number|number[])} max The upper boundary for the range from which
* the random numbers will be picked. For uniform sequences, max must be
* an integer in the [-1e9, 1e9] range. For multiform sequences, max can
* be an array with n integers, each specifying the upper boundary of the
* sequence identified by its index. In this case, each value in max must
* be within the [-1e9, 1e9] range.
* @param {{replacement?: boolean|boolean[], base?: number|number[],
* pregeneratedRandomization?: Object}} options An object which may contains
* any of the following optional parameters:
* @param {(boolean|boolean[])} [options.replacement=true] Specifies whether
* the random numbers should be picked with replacement. If true, the
* resulting numbers may contain duplicate values, otherwise the numbers
* will all be unique. For multiform sequences, replacement can be an array
* with n boolean values, each specifying whether the sequence identified
* by its index will be created with (true) or without (false) replacement
* (default true).
* @param {(number|number[])} [options.base=10] The base that will be used
* to display the numbers. Values allowed are 2, 8, 10 and 16. For multiform
* sequences, base can be an array with n integer values taken from the
* same set, each specifying the base that will be used to display the
* sequence identified by its index (default 10).
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @returns {(Promise<number[][]>|Promise<string[][]>)} A Promise which, if
* resolved successfully, represents an array of true random integer
* sequences.
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateIntegerSequences(n, length, min, max, options = {}) {
let request = this.#integerSequenceRequest(n, length, min, max, options);
return this.#extractBasic(this.#sendRequest(request));
}
/**
* Requests and returns a list (size n) of true random decimal fractions,
* from a uniform distribution across the [0,1] interval with a user-defined
* number of decimal places from the server.
*
* See: https://api.random.org/json-rpc/4/basic#generateDecimalFractions
* @param {number} n How many random decimal fractions you need. Must be
* within the [1,1e4] range.
* @param {number} decimalPlaces The number of decimal places to use. Must be
* within the [1,20] range.
* @param {{replacement?: boolean, pregeneratedRandomization?: Object}} options
* An object which may contains any of the following optional parameters:
* @param {boolean} [options.replacement=true] Specifies whether the random
* numbers should be picked with replacement. If true, the resulting numbers
* may contain duplicate values, otherwise the numbers will all be unique
* (default true).
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @returns {Promise<number[]>} A Promise which, if resolved successfully,
* represents an array of true random decimal fractions.
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateDecimalFractions(n, decimalPlaces, options = {}) {
let request = this.#decimalFractionRequest(n, decimalPlaces, options);
return this.#extractBasic(this.#sendRequest(request));
}
/**
* Requests and returns a list (size n) of true random numbers from a
* Gaussian distribution (also known as a normal distribution).
*
* The form uses a Box-Muller Transform to generate the Gaussian distribution
* from uniformly distributed numbers.
* See: https://api.random.org/json-rpc/4/basic#generateGaussians
* @param {number} n How many random numbers you need. Must be within the
* [1,1e4] range.
* @param {number} mean The distribution's mean. Must be within the
* [-1e6,1e6] range.
* @param {number} standardDeviation The distribution's standard deviation.
* Must be within the [-1e6,1e6] range.
* @param {number} significantDigits The number of significant digits to use.
* Must be within the [2,20] range.
* @param {{pregeneratedRandomization?: Object}} options An object which may
* contains any of the following optional parameters:
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @returns {Promise<number[]>} A Promise which, if resolved successfully,
* represents an array of true random numbers from a Gaussian distribution.
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateGaussians(n, mean, standardDeviation, significantDigits, options = {}) {
let request = this.#gaussianRequest(n, mean, standardDeviation,
significantDigits, options);
return this.#extractBasic(this.#sendRequest(request));
}
/**
* Requests and returns a list (size n) of true random unicode strings from
* the server. See: https://api.random.org/json-rpc/4/basic#generateStrings
* @param {number} n How many random strings you need. Must be within the
* [1,1e4] range.
* @param {number} length The length of each string. Must be within the
* [1,20] range. All strings will be of the same length.
* @param {string} characters A string that contains the set of characters
* that are allowed to occur in the random strings. The maximum number
* of characters is 80.
* @param {{replacement?: boolean, pregeneratedRandomization?: Object}} options
* An object which may contains any of the following optional parameters:
* @param {boolean} [options.replacement=true] Specifies whether the random
* strings should be picked with replacement. If true, the resulting list
* of strings may contain duplicates, otherwise the strings will all be
* unique (default true).
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @returns {Promise<string[]>} A Promise which, if resolved successfully,
* represents an array of true random strings.
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateStrings(n, length, characters, options = {}) {
let request = this.#stringRequest(n, length, characters, options);
return this.#extractBasic(this.#sendRequest(request));
}
/**
* Requests and returns a list (size n) of version 4 true random Universally
* Unique IDentifiers (UUIDs) in accordance with section 4.4 of RFC 4122,
* from the server.
*
* See: https://api.random.org/json-rpc/4/basic#generateUUIDs
* @param {number} n How many random UUIDs you need. Must be within the
* [1,1e3] range.
* @param {{pregeneratedRandomization?: Object}} options An object which may
* contains any of the following optional parameters:
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @returns {Promise<string[]>} A Promise which, if resolved successfully,
* represents an array of true random UUIDs.
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateUUIDs(n, options = {}) {
let request = this.#UUIDRequest(n, options);
return this.#extractBasic(this.#sendRequest(request));
}
/**
* Requests and returns a list (size n) of Binary Large OBjects (BLOBs)
* as unicode strings containing true random data from the server.
*
* See: https://api.random.org/json-rpc/4/basic#generateBlobs
* @param {number} n How many random blobs you need. Must be within the
* [1,100] range.
* @param {number} size The size of each blob, measured in bits. Must be
* within the [1,1048576] range and must be divisible by 8.
* @param {{format?: string, pregeneratedRandomization?: Object}} options
* An object which may contains any of the following optional parameters:
* @param {string} [options.format='base64'] Specifies the format in which
* the blobs will be returned. Values allowed are 'base64' and 'hex'
* (default 'base64').
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @returns {Promise<number[]>} A Promise which, if resolved successfully,
* represents an array of true random blobs as strings.
* @see {@link RandomOrgClient#BLOB_FORMAT_BASE64} for 'base64' (default).
* @see {@link RandomOrgClient#BLOB_FORMAT_HEX} for 'hex'.
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateBlobs(n, size, options = {}) {
let request = this.#blobRequest(n, size, options);
return this.#extractBasic(this.#sendRequest(request));
}
// SIGNED API
/**
* Requests a list (size n) of true random integers within a user-defined
* range from the server.
*
* Returns a Promise which, if resolved successfully, respresents an object
* with the parsed integer list mapped to 'data', the original response mapped
* to 'random', and the response's signature mapped to 'signature'.
* See: https://api.random.org/json-rpc/4/signed#generateSignedIntegers
* @param {number} n How many random integers you need. Must be within the
* [1,1e4] range.
* @param {number} min The lower boundary for the range from which the
* random numbers will be picked. Must be within the [-1e9,1e9] range.
* @param {number} max The upper boundary for the range from which the
* random numbers will be picked. Must be within the [-1e9,1e9] range.
* @param {{replacement?: boolean, base?: number, pregeneratedRandomization?:
* Object, licenseData?: Object, userData?: Object|number|string, ticketId?:
* string}} options An object which may contains any of the following
* optional parameters:
* @param {boolean} [options.replacement=true] Specifies whether the random
* numbers should be picked with replacement. If true, the resulting numbers
* may contain duplicate values, otherwise the numbers will all be unique
* (default true).
* @param {number} [options.base=10] The base that will be used to display
* the numbers. Values allowed are 2, 8, 10 and 16 (default 10).
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @param {Object} [options.licenseData=null] A dictionary object which allows
* the caller to include data of relevance to the license that is associated
* with the API Key. This is mandatory for API Keys with the license type
* 'Flexible Gambling' and follows the format { 'maxPayout': { 'currency':
* 'XTS', 'amount': 0.0 }}. This information is used in licensing
* requested random values and in billing. The currently supported
* currencies are: 'USD', 'EUR', 'GBP', 'BTC', 'ETH'. The most up-to-date
* information on the currencies can be found in the Signed API
* documentation, here: https://api.random.org/json-rpc/4/signed
* @param {(string|number|Object)} [options.userData=null] Object that will be
* included in unmodified form. Its maximum size in encoded (string) form is
* 1,000 characters (default null).
* @param {string} [options.ticketId=null] A string with ticket identifier obtained
* via the {@link RandomOrgClient#createTickets} method. Specifying a value
* for ticketId will cause RANDOM.ORG to record that the ticket was used
* to generate the requested random values. Each ticket can only be used
* once (default null).
* @returns {Promise<{data: number[]|string[], random: Object, signature: string}>}
* A Promise which, if resolved successfully, represents an object with the
* following structure:
* * **data**: array of true random integers
* * **random**: random field as returned from the server
* * **signature**: signature string
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateSignedIntegers(n, min, max, options = {}) {
let request = this.#integerRequest(n, min, max, options, true);
return this.#extractSigned(this.#sendRequest(request));
}
/**
* Requests and returns uniform or multiform sequences of true random integers
* within user-defined ranges from the server.
*
* Returns a Promise which, if resolved successfully, respresents an object
* with the parsed array of integer sequences mapped to 'data', the original
* response mapped to 'random', and the response's signature mapped to
* 'signature'.
* See: https://api.random.org/json-rpc/4/signed#generateIntegerSequences
* @param {number} n How many arrays of random integers you need. Must be
* within the [1,1e3] range.
* @param {(number|number[])} length The length of each array of random
* integers requested. For uniform sequences, length must be an integer
* in the [1, 1e4] range. For multiform sequences, length can be an array
* with n integers, each specifying the length of the sequence identified
* by its index. In this case, each value in length must be within the
* [1, 1e4] range and the total sum of all the lengths must be in the
* [1, 1e4] range.
* @param {(number|number[])} min The lower boundary for the range from which
* the random numbers will be picked. For uniform sequences, min must be
* an integer in the [-1e9, 1e9] range. For multiform sequences, min can
* be an array with n integers, each specifying the lower boundary of the
* sequence identified by its index. In this case, each value in min must
* be within the [-1e9, 1e9] range.
* @param {(number|number[])} max The upper boundary for the range from which
* the random numbers will be picked. For uniform sequences, max must be
* an integer in the [-1e9, 1e9] range. For multiform sequences, max can
* be an array with n integers, each specifying the upper boundary of the
* sequence identified by its index. In this case, each value in max must
* be within the [-1e9, 1e9] range.
* @param {{replacement?: boolean|boolean[], base?: number|number[],
* pregeneratedRandomization?: Object, licenseData?: Object, userData?:
* Object|number|string, ticketId?: string}} options An object which may
* contains any of the following optional parameters:
* @param {(boolean|boolean[])} [options.replacement=true] Specifies whether
* the random numbers should be picked with replacement. If true, the
* resulting numbers may contain duplicate values, otherwise the numbers
* will all be unique. For multiform sequences, replacement can be an array
* with n boolean values, each specifying whether the sequence identified by
* its index will be created with (true) or without (false) replacement
* (default true).
* @param {(number|number[])} [options.base=10] The base that will be used to
* display the numbers. Values allowed are 2, 8, 10 and 16. For multiform
* sequences, base can be an array with n integer values taken from the same
* set, each specifying the base that will be used to display the sequence
* identified by its index (default 10).
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @param {Object} [options.licenseData=null] A dictionary object which allows
* the caller to include data of relevance to the license that is associated
* with the API Key. This is mandatory for API Keys with the license type
* 'Flexible Gambling' and follows the format { 'maxPayout': { 'currency':
* 'XTS', 'amount': 0.0 }}. This information is used in licensing
* requested random values and in billing. The currently supported
* currencies are: 'USD', 'EUR', 'GBP', 'BTC', 'ETH'. The most up-to-date
* information on the currencies can be found in the Signed API
* documentation, here: https://api.random.org/json-rpc/4/signed
* @param {(string|number|Object)} [options.userData=null] Object that will be
* included in unmodified form. Its maximum size in encoded (String) form
* is 1,000 characters (default null).
* @param {string} [options.ticketId=null] A string with ticket identifier
* obtained via the {@link RandomOrgClient#createTickets} method. Specifying
* a value for ticketId will cause RANDOM.ORG to record that the ticket was
* used to generate the requested random values. Each ticket can only be used
* once (default null).
* @returns {Promise<{data: number[][]|string[][], random: Object, signature: string}>}
* A Promise which, if resolved successfully, represents an object with the
* following structure:
* * **data**: array of true random integer sequences
* * **random**: random field as returned from the server
* * **signature**: signature string
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateSignedIntegerSequences(n, length, min, max, options = {}) {
let request = this.#integerSequenceRequest(n, length, min, max, options, true);
return this.#extractSigned(this.#sendRequest(request));
}
/**
* Request a list (size n) of true random decimal fractions, from a uniform
* distribution across the [0,1] interval with a user-defined number of
* decimal places from the server.
*
* Returns a Promise which, if resolved successfully, respresents an object
* with the parsed decimal fractions mapped to 'data', the original response
* mapped to 'random', and the response's signature mapped to 'signature'. See:
* https://api.random.org/json-rpc/4/signed#generateSignedDecimalFractions
* @param {number} n How many random decimal fractions you need. Must be
* within the [1,1e4] range.
* @param {number} decimalPlaces The number of decimal places to use. Must
* be within the [1,20] range.
* @param {{replacement?: boolean, pregeneratedRandomization?: Object, licenseData?:
* Object, userData?: Object|number|string, ticketId?: string}} options An
* object which may contains any of the following optional parameters:
* @param {boolean} [options.replacement=true] Specifies whether the random
* numbers should be picked with replacement. If true, the resulting numbers
* may contain duplicate values, otherwise the numbers will all be unique
* (default true).
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @param {Object} [options.licenseData=null] A dictionary object which allows
* the caller to include data of relevance to the license that is associated
* with the API Key. This is mandatory for API Keys with the license type
* 'Flexible Gambling' and follows the format { 'maxPayout': { 'currency':
* 'XTS', 'amount': 0.0 }}. This information is used in licensing
* requested random values and in billing. The currently supported
* currencies are: 'USD', 'EUR', 'GBP', 'BTC', 'ETH'. The most up-to-date
* information on the currencies can be found in the Signed API
* documentation, here: https://api.random.org/json-rpc/4/signed
* @param {(string|number|Object)} [options.userData=null] Object that will be
* included in unmodified form. Its maximum size in encoded (String) form
* is 1,000 characters (default null).
* @param {string} [options.ticketId=null] A string with ticket identifier
* obtained via the {@link RandomOrgClient#createTickets} method. Specifying
* a value for ticketId will cause RANDOM.ORG to record that the ticket was
* used to generate the requested random values. Each ticket can only be used
* once (default null).
* @returns {Promise<{data: number[], random: Object, signature: string}>} A
* Promise which, if resolved successfully, represents an object with the
* following structure:
* * **data**: array of true random decimal fractions
* * **random**: random field as returned from the server
* * **signature**: signature string
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateSignedDecimalFractions(n, decimalPlaces, options = {}) {
let request = this.#decimalFractionRequest(n, decimalPlaces, options, true);
return this.#extractSigned(this.#sendRequest(request));
}
/**
* Request a list (size n) of true random numbers from a Gaussian distribution
* (also known as a normal distribution).
*
* Returns a Promise which, if resolved successfully, respresents an object
* with the parsed numbers mapped to 'data', the original response mapped to
* 'random', and the response's signature mapped to 'signature'. See:
* https://api.random.org/json-rpc/4/signed#generateSignedGaussians
* @param {number} n How many random numbers you need. Must be within the
* [1,1e4] range.
* @param {number} mean The distribution's mean. Must be within the [-1e6,1e6]
* range.
* @param {number} standardDeviation The distribution's standard deviation.
* Must be within the [-1e6,1e6] range.
* @param {number} significantDigits The number of significant digits to use.
* Must be within the [2,20] range.
* @param {{pregeneratedRandomization?: Object, licenseData?: Object, userData?:
* Object|number|string, ticketId?: string}} options An object which may
* contains any of the following optional parameters:
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @param {Object} [options.licenseData=null] A dictionary object which allows
* the caller to include data of relevance to the license that is associated
* with the API Key. This is mandatory for API Keys with the license type
* 'Flexible Gambling' and follows the format { 'maxPayout': { 'currency':
* 'XTS', 'amount': 0.0 }}. This information is used in licensing
* requested random values and in billing. The currently supported
* currencies are: 'USD', 'EUR', 'GBP', 'BTC', 'ETH'. The most up-to-date
* information on the currencies can be found in the Signed API
* documentation, here: https://api.random.org/json-rpc/4/signed
* @param {(string|number|Object)} [options.userData=null] Object that will be
* included in unmodified form. Its maximum size in encoded (String) form
* is 1,000 characters (default null).
* @param {string} [options.ticketId=null] A string with ticket identifier
* obtained via the {@link RandomOrgClient#createTickets} method. Specifying
* a value for ticketId will cause RANDOM.ORG to record that the ticket was
* used to generate the requested random values. Each ticket can only be used
* once (default null).
* @returns {Promise<{data: number[], random: Object, signature: string}>} A
* Promise which, if resolved successfully, represents an object with the
* following structure:
* * **data**: array of true random numbers from a Gaussian distribution
* * **random**: random field as returned from the server
* * **signature**: signature string
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateSignedGaussians(n, mean, standardDeviation, significantDigits, options = {}) {
let request = this.#gaussianRequest(n, mean, standardDeviation, significantDigits,
options, true);
return this.#extractSigned(this.#sendRequest(request));
}
/**
* Request a list (size n) of true random strings from the server.
*
* Returns a Promise which, if resolved successfully, respresents an object
* with the parsed strings mapped to 'data', the original response mapped to
* 'random', and the response's signature mapped to 'signature'. See:
* https://api.random.org/json-rpc/4/signed#generateSignedStrings
* @param {number} n How many random strings you need. Must be within the
* [1,1e4] range.
* @param {number} length The length of each string. Must be within the [1,20]
* range. All strings will be of the same length.
* @param {string} characters A string that contains the set of characters
* that are allowed to occur in the random strings. The maximum number
* of characters is 80.
* @param {{replacement?: boolean, pregeneratedRandomization?: Object, licenseData?:
* Object, userData?: Object|number|string, ticketId?: string}} options An
* object which may contains any of the following optional parameters:
* @param {boolean} [options.replacement=null] Specifies whether the random
* strings should be picked with replacement. If true, the resulting list
* of strings may contain duplicates, otherwise the strings will all be
* unique (default true).
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @param {Object} [options.licenseData=null] A dictionary object which allows
* the caller to include data of relevance to the license that is associated
* with the API Key. This is mandatory for API Keys with the license type
* 'Flexible Gambling' and follows the format { 'maxPayout': { 'currency':
* 'XTS', 'amount': 0.0 }}. This information is used in licensing
* requested random values and in billing. The currently supported
* currencies are: 'USD', 'EUR', 'GBP', 'BTC', 'ETH'. The most up-to-date
* information on the currencies can be found in the Signed API
* documentation, here: https://api.random.org/json-rpc/4/signed
* @param {(string|number|Object)} [options.userData=null] Object that will be
* included in unmodified form. Its maximum size in encoded (String) form
* is 1,000 characters (default null).
* @param {string} [options.ticketId=null] A string with ticket identifier
* obtained via the {@link RandomOrgClient#createTickets} method. Specifying
* a value for ticketId will cause RANDOM.ORG to record that the ticket was
* used to generate the requested random values. Each ticket can only be used
* once (default null).
* @returns {Promise<{data: string[], random: Object, signature: string}>} A
* Promise which, if resolved successfully, represents an object with the
* following structure:
* * **data**: array of true random strings
* * **random**: random field as returned from the server
* * **signature**: signature string
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateSignedStrings(n, length, characters, options = {}) {
let request = this.#stringRequest(n, length, characters, options, true);
return this.#extractSigned(this.#sendRequest(request));
}
/**
* Request a list (size n) of version 4 true random Universally Unique
* IDentifiers (UUIDs) in accordance with section 4.4 of RFC 4122, from
* the server.
*
* Returns a Promise which, if resolved successfully, respresents an object
* with the parsed UUIDs mapped to 'data', the original response mapped to
* 'random', and the response's signature mapped to 'signature'. See:
* https://api.random.org/json-rpc/4/signed#generateSignedUUIDs
* @param {number} n How many random UUIDs you need. Must be within the
* [1,1e3] range.
* @param {{pregeneratedRandomization?: Object, licenseData?: Object, userData?:
* Object|string|number, ticketId?: string}} options An object which may
* contain any of the following optional parameters:
* @param {Object} [options.pregeneratedRandomization=null] A dictionary object
* which allows the client to specify that the random values should be
* generated from a pregenerated, historical randomization instead of a
* one-time on-the-fly randomization. There are three possible cases:
* * **null**: The standard way of calling for random values, i.e.true
* randomness is generated and discarded afterwards.
* * **date**: RANDOM.ORG uses historical true randomness generated on the
* corresponding date (past or present, format: { 'date', 'YYYY-MM-DD' }).
* * **id**: RANDOM.ORG uses historical true randomness derived from the
* corresponding identifier in a deterministic manner. Format: { 'id',
* 'PERSISTENT-IDENTIFIER' } where 'PERSISTENT-IDENTIFIER' is a string
* with length in the [1, 64] range.
* @param {Object} [options.licenseData=null] A dictionary object which allows
* the caller to include data of relevance to the license that is associated
* with the API Key. This is mandatory for API Keys with the license type
* 'Flexible Gambling' and follows the format { 'maxPayout': { 'currency':
* 'XTS', 'amount': 0.0 }}. This information is used in licensing
* requested random values and in billing. The currently supported
* currencies are: 'USD', 'EUR', 'GBP', 'BTC', 'ETH'. The most up-to-date
* information on the currencies can be found in the Signed API
* documentation, here: https://api.random.org/json-rpc/4/signed
* @param {(string|number|Object)} [options.userData=null] Object that will be
* included in unmodified form. Its maximum size in encoded (String) form
* is 1,000 characters (default null).
* @param {string} [options.ticketId=null] A string with ticket identifier
* obtained via the {@link RandomOrgClient#createTickets} method. Specifying
* a value for ticketId will cause RANDOM.ORG to record that the ticket was
* used to generate the requested random values. Each ticket can only be used
* once (default null).
* @returns {Promise<{data: string[], random: Object, signature: string}>} A
* Promise which, if resolved successfully, represents an object with the
* following structure:
* * **data**: array of true random UUIDs
* * **random**: random field as returned from the server
* * **signature**: signature string
* @throws {RandomOrgSendTimeoutError} Thrown when blocking timeout is exceeded
* before the request can be sent.
* @throws {RandomOrgKeyNotRunningError} Thrown when the API key has been
* stopped.
* @throws {RandomOrgInsufficientRequestsError} Thrown when the API key's server
* requests allowance has been exceeded.
* @throws {RandomOrgInsufficientBitsError} Thrown when the API key's server
* bits allowance has been exceeded.
* @throws {RandomOrgBadHTTPResponseError} Thrown when a HTTP 200 OK response
* is not received.
* @throws {RandomOrgRANDOMORGError} Thrown when the server returns a RANDOM.ORG
* Error.
* @throws {RandomOrgJSONRPCError} Thrown when the server returns a JSON-RPC Error.
*/
async generateSignedUUIDs(n, options = {}) {
let request = this.#UUIDRequest(n, options, true);
return this.#extractSigned(this.#sendRequest(request));
}
/**
* Request a list (size n) of Binary Large OBjects (BLOBs) containing true
* random data from the server.
*
* Returns a Promise which, if resolved successfully, respresents an object
* with the parsed BLOBs mapped to 'data', the original response mapped to